Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use Display consistently when emitting events #6380

Closed
pablosichert opened this issue Feb 6, 2021 · 0 comments · Fixed by #6389
Closed

Use Display consistently when emitting events #6380

pablosichert opened this issue Feb 6, 2021 · 0 comments · Fixed by #6389
Labels
domain: internal docs Anything related to Vector's internal documentation type: tech debt A code change that does not add user value.

Comments

@pablosichert
Copy link
Contributor

The CONTRIBUTING.md docs mention:

Logging style

  • ...
  • Prefer Display over Debug, %error and not ?error.

and provides an example:

Yep!

warn!(message = "Failed to merge value.", error = ?error);

which I suppose should have been error = %error and has therefore introduced an inconsistency in our usage.

The contributing docs and usage in events should be fixed accordingly.
@pablosichert pablosichert added type: tech debt A code change that does not add user value. domain: internal docs Anything related to Vector's internal documentation labels Feb 6, 2021
jszwedko added a commit that referenced this issue Feb 8, 2021
@jszwedko
chore(observability): Prefer using Display for logging errors
a917d7e 
The CONTRIBUTING guide accidentally had an example of using Debug, but
we'd decided to prefer Display for errors.

Fixes #6380

Signed-off-by: Jesse Szwedko <jesse@szwedko.me>
@jszwedko jszwedko mentioned this issue Feb 8, 2021
Merged
jszwedko added a commit that referenced this issue Feb 9, 2021
@jszwedko
chore(observability): Prefer using Display for logging errors (#6389)
b2481db 
* chore(observability): Prefer using Display for logging errors

The CONTRIBUTING guide accidentally had an example of using Debug, but
we'd decided to prefer Display for errors.

Fixes #6380

Signed-off-by: Jesse Szwedko <jesse@szwedko.me>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
domain: internal docs Anything related to Vector's internal documentation type: tech debt A code change that does not add user value.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(observability): Prefer using Display for logging errors vectordotdev/vector
1 participant
@pablosichert