-
Notifications
You must be signed in to change notification settings - Fork 744
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.
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
Fix/cluster-log-formatting #4759
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nathanwilk7
force-pushed
the
fix/cluster-log-formatting
branch
from
April 24, 2024 16:48
b7b008d
to
8b8733a
Compare
moogacs
reviewed
Apr 24, 2024
moogacs
previously approved these changes
Apr 24, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, nice refactor
Quality Gate passedIssues Measures |
moogacs
approved these changes
Apr 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What's being changed:
The raft logging was recently updated to use logrus instead of slog (see #4753). However, most uses of the logger in the
cluster/
directory (and some outside of that directory) were not updated to use theWithField
(and similar functions) functionality of logrus.For example, without this PR some of the logs look like this (note that all the strings are concatenated):
After this PR the logs will look like this:
INFO[0000] tcp transport address="192.168.0.14:8300" tcpMaxPool=3 tcpTimeout=10s
This PR updates (most of) the logger usage following these conventions:
WithField
for dynamic values.WithFields
instead ofWithField
.WithError
and log a static error message.Infof
instead ofInfo
) when needed.It's likely that I missed some poorly formatted logs, but hopefully I found the majority of them (used a combo of grepping and following references). Any bad logging calls I missed can be fixed in follow up PRs.
This PR should be a fairly low risk change.
Review checklist