contrib/log/slog: avoid logging 0 value trace/span IDs#2994
Merged
Conversation
rarguelloF
approved these changes
Jan 21, 2025
rarguelloF
left a comment
rarguelloF
left a comment
Contributor
There was a problem hiding this comment.
LGTM, thanks for the contribution! @rliebz
darccio
approved these changes
Jan 21, 2025
If the tracer is started but explicitly deactivated, there will be a span on the context, but the span ID and trace ID will be set to 0. Adding this information to log outputs seems like unintentional noise (although it's certainly possible there's a use case I'm not aware of), so I figured disabling it would be preferred. The change to explicitly add `tracer.WithTraceEnabled(true)` was so that the test would be resilient to folks who might have `DD_TRACE_ENABLED` set explicitly, which is true on my machine.
rliebz
force-pushed
the
slog-no-zero-ids
branch
from
January 21, 2025 15:25
5d00d07 to
c78fcac
Compare
Contributor
Author
|
Test conflicts resolved, should be good to go |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
If the tracer is started but explicitly deactivated, there will be a span on the context, but the span ID and trace ID will be set to 0. Adding this information to log outputs seems like unintentional noise (although it's certainly possible there's a use case I'm not aware of), so I figured disabling it would be preferred.
The change to explicitly add
tracer.WithTraceEnabled(true)was so that the test would be resilient to folks who might haveDD_TRACE_ENABLEDset explicitly, which is true on my machine.What does this PR do?
Removes
dd.trace_id=0anddd.span_id=0values from logs when the tracer is disabled.Motivation
I was actually using a closed-source implementation of a
log/sloghandler from before this package was available. I swapped this version into our test suite to compare behavior, and figured this was probably something that could be upstreamed.It's unclear to me that there would be value in including these zero values in the logs.
Reviewer's Checklist
Unsure? Have a question? Request a review!