fix: built-in attributes are not grouped #30
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
Built-in attributes are not considered part of a logger's group
as specified by `WithGroup`.
Doing so means that if a user makes a log statement like the following,
log.WithGroup("foo").Info("bar")
ReplaceAttr will be called with `groups = [foo]` for all built-in keys,
and therefore the [included code sample][1] for creating a logger
without the time key will not work.
[1]: https://github.com/lmittmann/tint#customize-attributes
This change fixes invocations of ReplaceAttr to call it with
an empty groups slice for built-in attributes.
This matches the behavior of `log/slog`'s default handlers
which set `groups = nil` for the built-in attributes ([src][2])
before restoring it for non-built-ins ([src][3]).
[2]: https://cs.opensource.google/go/go/+/refs/tags/go1.21.0:src/log/slog/handler.go;l=265-266
[3]: https://cs.opensource.google/go/go/+/refs/tags/go1.21.0:src/log/slog/handler.go;l=300-301
Includes tests for omitting all built-in attributes.
|
Thanks for the fix! |
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.
Built-in attributes are not considered part of a logger's group
as specified by
WithGroup.Doing so means that if a user makes a log statement like the following,
ReplaceAttr will be called with
groups = [foo]for all built-in keys,and therefore the included code sample for creating a logger
without the time key will not work.
This change fixes invocations of ReplaceAttr to call it with
an empty groups slice for built-in attributes.
This matches the behavior of
log/slog's default handlerswhich set
groups = nilfor the built-in attributes (src)before restoring it for non-built-ins (src).
Includes tests for omitting all built-in attributes.