[pdata] Deprecate HexString func on SpanID and TraceID #6530
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
Codecov ReportBase: 91.32% // Head: 91.33% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #6530 +/- ##
=======================================
Coverage 91.32% 91.33%
=======================================
Files 242 242
Lines 13878 13888 +10
=======================================
+ Hits 12674 12684 +10
Misses 959 959
Partials 245 245
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
`[SpanID|TraceID].HexString` methods currently return an empty string for empty SpanID and TraceID instances. This behavior is not defined in the OTel spec and contradicts with w3c recommendations. We don't want to promote a behavior which possibly can be changed in future. Additionally we introduce `[SpanID|TraceID].String` methods that have the same logic as `HexString` and implement `fmt.Stringer` interface to allow `SpanID` and `TraceID` instances to be used in log statements and avoid unnecessary allocation when log is not emitted. But the `String` method is not encouraged to be used as a replacement for `HexString` because of the concerns as described above.
dmitryax
force-pushed
the
deprecate-hex-string
branch
from
e5cbe08 to
82a1436
Compare
bogdandrutu
approved these changes
Nov 11, 2022
3 tasks
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.
[SpanID|TraceID].HexStringmethods currently return an empty string for empty SpanID and TraceID instances. This behavior is not defined in the OTel spec and contradicts with w3c recommendations. We don't want to promote a behavior which possibly can be changed in future.Additionally we introduce
[SpanID|TraceID].Stringmethods that have the same logic asHexStringand implementfmt.Stringerinterface to allowSpanIDandTraceIDinstances to be used in log statements and avoid unnecessary allocation when log is not emitted. But theStringmethod is not encouraged to be used as a replacement forHexStringbecause of the concerns described above.Updates #6514