Make API for omitting keys more approachable. #725
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
added 2 commits
June 24, 2019 12:18
Currently encoders will omit fields when encoding log entries if the key configured for that field is set to the empty string. However, this behavior isn't documented or specified explicitly as being part of the interface for encoding. This adds documentation to the `Encoder` interface that explicitly outlines the behavior that should be implemented when omitting fields.
The empty string can be used to omit a key from a log line. However, there's no explicitly exposed API for using this behavior. This cleans up the API for users by allowing them to use a constant for omitting the key instead of throwing around `""` everywhere, or making their own constant and hoping that `""` will always omit the key.
|
|
Codecov Report
@@ Coverage Diff @@
## master #725 +/- ##
=======================================
Coverage 97.43% 97.43%
=======================================
Files 40 40
Lines 2109 2109
=======================================
Hits 2055 2055
Misses 46 46
Partials 8 8
Continue to review full report at Codecov.
|
abhinav
approved these changes
Jun 26, 2019
There was a problem hiding this comment.
Thanks for the change!
This seems pretty reasonable to me. WDYT, @prashantv @jcorbin
cgxxv
pushed a commit
to cgxxv/zap
that referenced
this pull request
Mar 25, 2022
* Explicitly document key omission in encoding Currently encoders will omit fields when encoding log entries if the key configured for that field is set to the empty string. However, this behavior isn't documented or specified explicitly as being part of the interface for encoding. This adds documentation to the `Encoder` interface that explicitly outlines the behavior that should be implemented when omitting fields. * Add key for omission to package API The empty string can be used to omit a key from a log line. However, there's no explicitly exposed API for using this behavior. This cleans up the API for users by allowing them to use a constant for omitting the key instead of throwing around `""` everywhere, or making their own constant and hoping that `""` will always omit the key.
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.
The way to omit keys from log lines can be more obvious to package consumers.
This addresses #724.