[otep] Propose adding env variables as context carriers to specification #258
+294
−0
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
|
@adrielp thank you for picking up this work. I appreciate that while I’ve been going through a busy time (and not sure when it will wrap up). |
yurishkuro
reviewed
May 26, 2024
yurishkuro
reviewed
May 26, 2024
yurishkuro
reviewed
May 26, 2024
yurishkuro
reviewed
May 26, 2024
adrielp
changed the title
yurishkuro
reviewed
May 27, 2024
pellared
reviewed
Oct 1, 2024
Co-authored-by: Robert Pająk <[email protected]>
lmolkova
approved these changes
Oct 1, 2024
| > Text Map Propagation with a potential set of well-known environment variable | ||
| > names. | ||
|
|
||
| `traceparent` (lowercase), originates in the [W3C Specification][w3c-parent] |
There was a problem hiding this comment.
nit:
Suggested change
| `traceparent` (lowercase), originates in the [W3C Specification][w3c-parent] | |
| `traceparent` (lowercase), originates in the [W3C Trace-Context][w3c-parent] |
| > Text Map Propagation with a potential set of well-known environment variable | ||
| > names. | ||
|
|
||
| `traceparent` (lowercase), originates in the [W3C Specification][w3c-parent] |
There was a problem hiding this comment.
could we be more specific than "originates"? Is it exactly the same format? If so, could we call it out?
| export TRACEPARENT=version=2HEXDIGLC,trace-id=32HEXDIGLC,parent-id=16HEXDIGLC,trace-flags=2HEXDIGLC | ||
| ``` | ||
|
|
||
| `tracestate` (lowercase), originates in the [W3C Specification][w2c-state] and |
There was a problem hiding this comment.
Suggested change
| `tracestate` (lowercase), originates in the [W3C Specification][w2c-state] and | |
| `tracestate` (lowercase), originates in the [W3C Trace-Context][w3c-state] and |
| export TRACEPARENT=version=2HEXDIGLC,trace-id=32HEXDIGLC,parent-id=16HEXDIGLC,trace-flags=2HEXDIGLC | ||
| ``` | ||
|
|
||
| `tracestate` (lowercase), originates in the [W3C Specification][w2c-state] and |
There was a problem hiding this comment.
same note on "originates" - could we call out that the format is the same?
| can include any opaque value in a key-value pair structure. Its goal is to | ||
| provide additional vendor-specific trace information. | ||
|
|
||
| `baggage` (lowercase), also is defined in the [W3C Specification][w3c-bag] and |
There was a problem hiding this comment.
Suggested change
| `baggage` (lowercase), also is defined in the [W3C Specification][w3c-bag] and | |
| `baggage` (lowercase), also is defined in the [W3C Baggage][w3c-bag] and |
magnusbaeck
reviewed
Oct 1, 2024
| spans. One example of this is module version and repository information. This | ||
| information is only determined and known during the `init` process. Subsequent | ||
| processes only know about the module by name. With `BAGGAGE` the rest of the | ||
| proccesses are able to understand a key piece of information which allows |
There was a problem hiding this comment.
Suggested change
| proccesses are able to understand a key piece of information which allows | |
| processes are able to understand a key piece of information which allows |
4 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.
Based on conversations last week in the Specification and Semantic Conventions SIGs, I'm opening this duplicate pull request which was originally set as a Draft and hasn't had movement since last November.
There are real use cases that are coming to fruiting, namely in the CI/CD working group, that will benefit from this being accepted. Once accepted we can work on getting the specification added for both general context propagation and baggage.
On the note of baggage; baggage is a form of context propagation and was not originally mentioned directly by name in this OTEP. It is however, absolutely essential. I've had the pleasure of prototyping out tracing within an OpenTofu controller system where context on available in parent/child at the very start of the trace was available. Baggage was the means of transferring this critical context to subsequent siblings that would've not had it otherwise.
Thanks for all the hard work to the original author (@deejgregor) and opening the draft #241
CC. TC sponsors @jsuereth @carlosalberto