Skip to content

Commit 732a83f

Browse files
Kielekpellared
andauthored
Deprecate Jaeger propagator (#4827)
Fixes #4786 ## Changes Deprecate Jaeger propagator and make the implementation optional. It was already deprecated by the Jaeger team: https://www.jaegertracing.io/sdk-migration/#propagation-format * [x] Related issues #4786 * ~~[ ] Related [OTEP(s)](https://github.com/open-telemetry/oteps) #~~ * ~~[ ] Links to the prototypes (when adding or changing features)~~ * [x] [`CHANGELOG.md`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/CHANGELOG.md) file updated for non-trivial changes * For trivial changes, include `[chore]` in the PR title to skip the changelog check * [x] [Spec compliance matrix](https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix/template.yaml) updated if necessary --------- Co-authored-by: Robert Pająk <[email protected]>
1 parent 55d0572 commit 732a83f

File tree

5 files changed

+12
-6
lines changed

5 files changed

+12
-6
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ release.
99

1010
### Context
1111

12+
- Deprecate Jaeger propagator and make propagator implementation optional.
13+
([#4827](https://github.com/open-telemetry/opentelemetry-specification/pull/4827))
14+
1215
### Traces
1316

1417
### Metrics

spec-compliance-matrix.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ Disclaimer: this list of features is still a work in progress, please refer to t
239239
| Global Propagator | | + | + | + | + | + | + | + | + | + | + | + |
240240
| TraceContext Propagator | | + | + | + | + | + | + | + | + | + | + | + |
241241
| B3 Propagator | | + | + | + | + | + | + | + | + | + | + | + |
242-
| Jaeger Propagator | | + | + | + | + | + | + | + | + | + | - | + |
242+
| Jaeger Propagator | X | + | + | + | + | + | + | + | + | + | - | + |
243243
| OT Propagator | | + | + | + | + | | | | | | | |
244244
| OpenCensus Binary Propagator | | + | | | | | | | | | | |
245245
| [TextMapPropagator](specification/context/api-propagators.md#textmap-propagator) | | + | + | | + | + | | + | | + | | |

spec-compliance-matrix/template.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,6 +273,7 @@ sections:
273273
- name: TraceContext Propagator
274274
- name: B3 Propagator
275275
- name: Jaeger Propagator
276+
optional: true
276277
- name: OT Propagator
277278
- name: OpenCensus Binary Propagator
278279
- name: '[TextMapPropagator](specification/context/api-propagators.md#textmap-propagator)'

specification/configuration/sdk-environment-variables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Known values for `OTEL_PROPAGATORS` are:
125125
- `"baggage"`: [W3C Baggage](https://www.w3.org/TR/baggage/)
126126
- `"b3"`: [B3 Single](../context/api-propagators.md#configuration)
127127
- `"b3multi"`: [B3 Multi](../context/api-propagators.md#configuration)
128-
- `"jaeger"`: [Jaeger](https://www.jaegertracing.io/sdk-migration/#propagation-format)
128+
- `"jaeger"`: [Jaeger](https://www.jaegertracing.io/sdk-migration/#propagation-format) - **Status**: [Deprecated](../document-status.md)
129129
- `"xray"`: [AWS X-Ray](https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader) (_third party_)
130130
- `"ottrace"`: [OT Trace](https://github.com/opentracing?q=basic&type=&language=) (_third party_)
131131
- `"none"`: No automatically configured propagator.

specification/context/api-propagators.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Propagators API
22

3-
**Status**: [Stable](../document-status.md)
3+
**Status**: [Stable](../document-status.md) except where otherwise specified
44

55
<details>
66
<summary>Table of Contents</summary>
@@ -215,8 +215,8 @@ Required arguments:
215215
The `Keys` function can be called by `Propagator`s which are using variable key names in order to
216216
iterate over all the keys in the specified carrier.
217217

218-
For example, it can be used to detect all keys following the `uberctx-{user-defined-key}` pattern, as defined by the
219-
[Jaeger Propagation Format](https://www.jaegertracing.io/docs/1.76/architecture/#baggage).
218+
For example, it can be used to detect all keys following the `X-B3-${name}` pattern, as defined by the
219+
[B3 Propagation: Multiple Headers](https://github.com/openzipkin/b3-propagation/blob/master/README.md#multiple-headers).
220220

221221
##### Get
222222

@@ -357,11 +357,13 @@ organization and MUST be distributed as OpenTelemetry extension packages:
357357
* [W3C Baggage](https://www.w3.org/TR/baggage/). MAY alternatively
358358
be distributed as part of the OpenTelemetry API.
359359
* [B3](https://github.com/openzipkin/b3-propagation).
360-
* [Jaeger](https://www.jaegertracing.io/sdk-migration/#propagation-format).
361360

362361
This is a list of additional propagators that MAY be maintained and distributed
363362
as OpenTelemetry extension packages:
364363

364+
* [Jaeger](https://www.jaegertracing.io/sdk-migration/#propagation-format).
365+
**Status**: [Deprecated](../document-status.md), use the
366+
[W3C TraceContext](https://www.w3.org/TR/trace-context/) instead.
365367
* [OT Trace](https://github.com/opentracing?q=basic&type=&language=). Propagation format
366368
used by the OpenTracing Basic Tracers. It MUST NOT use `OpenTracing` in the resulting
367369
propagator name as it is not widely adopted format in the OpenTracing ecosystem.

0 commit comments

Comments
 (0)