doc: guidance on PMD guard log statement warning #5220
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
jdrueckert
added
Category: Doc
docs/Code-Conventions.md
Outdated
| log.atDebug().log("log something {} and {}", method(), param); | ||
| ``` | ||
|
|
||
| Please do not use the more verbose variant(s) of the fluent logging API to keep complexity low and your log statements readable. |
There was a problem hiding this comment.
Could you also provide an example here of a more "verbose variant"?
Something like this?
logger.atError().addArgument(() -> entry.getValue()).addArgument(e).log("log some exception: {}");There was a problem hiding this comment.
I wanted to avoid this because I know people tend to skim through text and just copy anything 🙈
That's why I didn't want to provide an example for the version we don't want.
If you think we need it though, I can add it. What do you think @BenjaminAmos ?
There was a problem hiding this comment.
Good point. That particular example was what inspired these guidelines, I believe?
Would something more vague work? For example:
Suggested change
| Please do not use the more verbose variant(s) of the fluent logging API to keep complexity low and your log statements readable. | |
| Please do not use the more verbose variant(s) of the fluent logging API (such as `LoggingEventBuilder#addArgument`) to keep complexity low and your log statements readable. |
There was a problem hiding this comment.
yes, I think that's okay. I'll adjust it
There was a problem hiding this comment.
changed it. is it alright like that?
Co-authored-by: BenjaminAmos <24301287+BenjaminAmos@users.noreply.github.com>
BenjaminAmos
approved these changes
Mar 10, 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.
Based on our discussion on Discord, see link.