fix: go-kit/log-slog adapter fixes #9943
Closed
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
|
|
aknuds1
requested changes
Nov 18, 2024
Signed-off-by: Arve Knudsen <[email protected]>
aknuds1
force-pushed
the
arve/upgrade-mimir-prometheus
branch
from
78797ed
to
d920e20
Compare
…w left-open behaviour in Prometheus 3
…left-open interval behaviour
Signed-off-by: Arve Knudsen <[email protected]>
dimitarvdimitrov
previously requested changes
Nov 19, 2024
|
@dimitarvdimitrov this is a PR against my PR :) |
dimitarvdimitrov
dismissed
their stale review
it's all good, I thought we're merging against main here. whew
Changes included:
- log/slog always includes timestamps by default; they are now included
in the go-kit/log output. We make no attempts to adjust/remove any
other timestamp keys (such as the often used `ts` kv pair in go-kit/log
implementations).
- a new function to handle properly appending/nesting our kv pairs for
the logger
- proper handling of nested grouping
- introduction of a `preformatted` field on the goKitHandler struct to
cache previously added kv pairs containing log values. helpful to
maintain the ordering of kv pairs added via multiple/nested/chained
calls to a logger's `.With()` or `.WithGroup()` methods.
- WithGroup() now returns a new handler struct, as opposed to updating
itself (as recommended by slog implementation docs).
- Update test suite to allow stripping timestamps from logs to prevent
non-deterministic output
- Update test suite mock setup to validate correct log formatting, now
that kv pairs for logs follow the pattern `group1.group2.key=value`
Not addressed:
- I haven't found a good way to (programmatically) address call depth
when getting source caller info. Using a call depth of 6 (see code
snippet) seems to properly unwind back to the originating `.Info()` etc
method call, but I haven't checked other options.
Example output, after shimming the following logging calls into the
existing handler test suite:
```go
gkadapterLogger := SlogFromGoKit(log.With(log.NewLogfmtLogger(os.Stderr), "caller", log.Caller(6)))
gkadapterLogger.Info("go-kit/log adapter output")
gkadapterLogger.WithGroup("g1").WithGroup("g2").Info("test1", "hello", "world")
gkadapterLogger.WithGroup("g1").With("hello", "world").Info("test2", "hello", "world")
gkadapterLogger.WithGroup("g1").With("hello", "world").WithGroup("g2").Info("test3", "hello", "world")
gkadapterLogger.With("hello", "world").With("hello", "world").Info("test4", "hello", "world")
// Output:
// level=info caller=slogadapter_test.go:26 time=2024-11-18T13:09:59.674350655-05:00 msg=test1 g1.g2.hello=world
// level=info caller=slogadapter_test.go:27 time=2024-11-18T13:09:59.674376383-05:00 msg=test2 g1.hello=world g1.hello=world
// level=info caller=slogadapter_test.go:28 time=2024-11-18T13:09:59.674392598-05:00 msg=test3 g1.hello=world g1.g2.hello=world
// level=info caller=slogadapter_test.go:29 time=2024-11-18T13:09:59.674419421-05:00 msg=test4 hello=world hello=world hello=world
```
Signed-off-by: TJ Hoplock <[email protected]>
tjhop
force-pushed
the
fix/slog-adapter-tweaks
branch
from
a26e1a8
to
dc6f3da
Compare
|
@dimitarvdimitrov I rebased on @aknuds1's PR, the change set is now accurate (and much more reasonably sized 🙃 ) |
|
i'll leave the reviews to @aknuds1 since he's already involved |
aknuds1
force-pushed
the
arve/upgrade-mimir-prometheus
branch
from
1e5912c
to
e414b00
Compare
charleskorn
force-pushed
the
arve/upgrade-mimir-prometheus
branch
from
d457cc1
to
a4ae1eb
Compare
|
Closing this PR in favor of library adoption in the parent PR |
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.
Changes included:
tskv pair in go-kit/log implementations).preformattedfield on the goKitHandler struct to cache previously added kv pairs containing log values. helpful to maintain the ordering of kv pairs added via multiple/nested/chained calls to a logger's.With()or.WithGroup()methods.Not addressed:
promslogpkg..Info()etc method call, but I haven't checked other options.Example output, after shimming the following logging calls into the existing handler test suite:
What this PR does
Which issue(s) this PR fixes or relates to
Fixes #
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX].about-versioning.mdupdated with experimental features.