Update tracestate example for header format#585
Open
JoakimBrannstrom wants to merge 1 commit into
Open
Conversation
Clarified example of tracestate header formatting to ensure only the most recent position is included.
| Tracing tools are not supposed to add the same header multiple times. For example, if a vendor name is Congo and a trace started in their system and then went through a system named Rojo and later returned to Congo, the `tracestate` value would not be: | ||
|
|
||
| `congo=congosFirstPosition,rojo=rojosFirstPosition,congo=congosSecondPosition` | ||
| `congo=congosSecondPosition,rojo=rojosFirstPosition,congo=congosFirstPosition` |
There was a problem hiding this comment.
I don't see a reason to change this tracestate value, since the one several lines later in the doc is the correct one. This line is supposed to show a wrong example, so the previous value works just as well as the newly proposed value
Author
There was a problem hiding this comment.
I know that this example shows an invalid tracestate, but it was confusing when I read it, since the order of creation should be from right to left.
I believe it would show the problem in a better way by making the suggested change.
As a side-note, accepting PR's (if they are not flat out wrong) builds more engagement and makes the community stronger :)
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
2 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.
Clarified example of tracestate header formatting to ensure only the most recent position is included.
Preview | Diff