Fix manual log injection for 128 bit trace_id #2974
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
TonyCTHsu
changed the title
TonyCTHsu
force-pushed
the
tonycthsu/fix-logging-trace-id
branch
from
1bd4e4f to
29bf4d2
Compare
marcotc
reviewed
Jul 17, 2023
| @@ -23,7 +23,6 @@ class Identifier | |||
| :span_resource, | |||
| :span_service, | |||
| :span_type, | |||
| :trace_id, | |||
There was a problem hiding this comment.
I think removing trace_id from the public api of this class is problematic.
I think a better solution is to allow trace_id to continue to be called, but return a string when Datadog.configuration.tracing.trace_id_128_bit_logging_enabled is true. This means users that opt into this new feature get different behavior, but only after enabling this option setting.
marcotc
reviewed
Jul 17, 2023
Comment on lines
+75
to
81
| if Datadog.configuration.tracing.trace_id_128_bit_logging_enabled && | ||
| !Tracing::Utils::TraceId.to_high_order(@trace_id).zero? | ||
| Kernel.format('%032x', @trace_id) | ||
| else | ||
| Tracing::Utils::TraceId.to_low_order(@trace_id) | ||
| end | ||
| end |
There was a problem hiding this comment.
I think this calculation should be repeated for multiple calls of Identifier#trace_id.
I suggest either moving this to #initialize and saving the result to trace_id, or caching it here @trace_id ||= if Datadog.configuration.tracing.trace_id_128_bit_logging_enabled....
marcotc
approved these changes
Jul 20, 2023
Merged
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.
What does this PR do?
https://docs.datadoghq.com/tracing/trace_collection/dd_libraries/ruby/#for-logging-in-ruby-applications
We exposed
Datadog::Tracing.correlation#trace_idas public API, which user ends up with different injection result from manual log injection(returning the entire 128 bit trace ID).This PR enforce the coercion of lower 64 bits trace ID on this API to ensure the correctness of manual log injection.