Logs linter #162

New issue

Closed

opened 2023-03-23 08:28:14 +00:00 by dstepanov-yadro · 3 comments

dstepanov-yadro commented

2023-03-23 08:28:14 +00:00

Member

At the moment, the content of the logs is not controlled in any way. Logs contain entries with errors or incomprehensible content. There is no log proofreading process.

Describe the solution you'd like

We need to add a linter that will check that the log entries are taken from constants or variables in a given package.

## Is your feature request related to a problem? Please describe. At the moment, the content of the logs is not controlled in any way. Logs contain entries with errors or incomprehensible content. There is no log proofreading process. ## Describe the solution you'd like We need to add a linter that will check that the log entries are taken from constants or variables in a given package.

dstepanov-yadro added the

discussion

frostfs-node

triage

labels 2023-03-23 08:28:14 +00:00

ale64bit commented

2023-04-11 08:34:48 +00:00

Member

Could you add some code examples of what sort of things the linter would highlight?

dstepanov-yadro commented

2023-04-11 08:39:44 +00:00

Author

Member

Could you add some code examples of what sort of things the linter would highlight?

For example log.Debug("processing node...") should be

messages.go:

const (
	MsgProcessingNode = "processing node..."
)

usage:

log.Debug(messages.MsgProcessingNode)

> Could you add some code examples of what sort of things the linter would highlight? For example ```log.Debug("processing node...")``` should be ``` messages.go: const ( MsgProcessingNode = "processing node..." ) usage: log.Debug(messages.MsgProcessingNode) ```

dstepanov-yadro commented

2023-04-11 08:41:27 +00:00

Author

Member

All new messages should be added to messages-file(s) that will undergo the proofread process.

👍 1