Commit dc33969
Remove misleading implementation guidance for context propagation via environment variables (#5003)
Per
#4961 (comment)
and other similar feedback
## Changes
This PR removes the non-normative guidance that presented a dedicated
`EnvironmentContextPropagator` as a first-class alternative for
environment variable context propagation.
The supplementary guidance now describes the carrier-based pattern
directly:
- use the existing `TextMapPropagator` with environment-specific
carriers (`EnvironmentGetter` and `EnvironmentSetter`)
- reference the existing C++, Go, Java, and Python implementation (I
also created a PR for Swift that follows the same pattern
open-telemetry/opentelemetry-swift-core#47)
The previous (removed) “Approach 1” guidance suggested that a dedicated
environment-variable-specific propagator was a viable recommendation.
Based on the discussion in #4961, that approach is seen as
misleading/buggy:
- the environment variable carrier should remain format-agnostic
- propagator-specific behavior belongs in the propagator, not in the
carrier
- the Swift example did not reflect the direction we want to recommend
here
This change keeps the document aligned with the carrier-based model used
by the referenced implementations.
## Side note
I think we can look into stabilization of this document after this PR is
merged. I plan to create a stabilization issue and update the compliance
matrix.
---------
Co-authored-by: Alex Boten <223565+codeboten@users.noreply.github.com>1 parent f41d2af commit dc33969
2 files changed
+5
-32
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| 17 | + | |
| 18 | + | |
17 | 19 | | |
18 | 20 | | |
19 | 21 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
18 | | - | |
19 | | - | |
20 | | - | |
21 | 18 | | |
22 | 19 | | |
23 | 20 | | |
| |||
117 | 114 | | |
118 | 115 | | |
119 | 116 | | |
120 | | - | |
121 | | - | |
122 | | - | |
123 | | - | |
124 | | - | |
125 | | - | |
126 | | - | |
127 | | - | |
128 | | - | |
129 | | - | |
130 | | - | |
131 | | - | |
132 | | - | |
133 | | - | |
134 | | - | |
135 | | - | |
136 | | - | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
137 | 120 | | |
138 | 121 | | |
139 | 122 | | |
| |||
151 | 134 | | |
152 | 135 | | |
153 | 136 | | |
154 | | - | |
155 | | - | |
156 | | - | |
157 | | - | |
158 | | - | |
159 | | - | |
160 | | - | |
161 | | - | |
162 | | - | |
163 | | - | |
164 | | - | |
165 | | - | |
0 commit comments