Deprecate JaegerPropagator (#8019)

jack-berg · web-flow · commit b56bc5476b3c · 2026-01-29T13:58:29.000-06:00
diff --git a/docs/apidiffs/current_vs_latest/opentelemetry-extension-trace-propagators.txt b/docs/apidiffs/current_vs_latest/opentelemetry-extension-trace-propagators.txt
@@ -1,4 +1,7 @@
 Comparing source compatibility of opentelemetry-extension-trace-propagators-1.59.0-SNAPSHOT.jar against opentelemetry-extension-trace-propagators-1.58.0.jar
+===  UNCHANGED CLASS: PUBLIC FINAL io.opentelemetry.extension.trace.propagation.JaegerPropagator  (not serializable)
+	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+	+++  NEW ANNOTATION: java.lang.Deprecated
 ===  UNCHANGED CLASS: PUBLIC FINAL io.opentelemetry.extension.trace.propagation.OtTracePropagator  (not serializable)
 	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
 	+++  NEW ANNOTATION: java.lang.Deprecated
diff --git a/exporters/zipkin/src/main/java/io/opentelemetry/exporter/zipkin/ZipkinSpanExporter.java b/exporters/zipkin/src/main/java/io/opentelemetry/exporter/zipkin/ZipkinSpanExporter.java
@@ -34,8 +34,8 @@
  * href="https://github.com/census-instrumentation/opencensus-java/tree/c960b19889de5e4a7b25f90919d28b066590d4f0/exporters/trace/zipkin">OpenCensus
  * zipkin exporter</a> code.
  *
- * @deprecated Zipkin exporter is deprecated in OpenTelemetry spec (see the <a
- *     href="https://github.com/open-telemetry/opentelemetry-specification/pull/4715">PR</a>).
+ * @deprecated Zipkin exporter is deprecated in the OpenTelemetry specification (see <a
+ *     href="https://github.com/open-telemetry/opentelemetry-specification/pull/4715">#4715</a>).
  *     Expect this artifact to no longer be published in approximately 6 months (mid 2026).
  */
 @Deprecated
diff --git a/extensions/trace-propagators/src/jmh/java/io/opentelemetry/extension/trace/propagation/PropagatorContextExtractBenchmark.java b/extensions/trace-propagators/src/jmh/java/io/opentelemetry/extension/trace/propagation/PropagatorContextExtractBenchmark.java
@@ -72,24 +72,25 @@ public void tearDown() {
   }
 
   /** Benchmark for extracting context from Jaeger headers. */
+  @SuppressWarnings("deprecation")
   public static class JaegerContextExtractBenchmark extends AbstractContextExtractBenchmark {
 
     private static final List<Map<String, String>> traceHeaders =
         Arrays.asList(
             Collections.singletonMap(
-                JaegerPropagator.PROPAGATION_HEADER,
+                io.opentelemetry.extension.trace.propagation.JaegerPropagator.PROPAGATION_HEADER,
                 "905734c59b913b4a905734c59b913b4a:9909983295041501:0:1"),
             Collections.singletonMap(
-                JaegerPropagator.PROPAGATION_HEADER,
+                io.opentelemetry.extension.trace.propagation.JaegerPropagator.PROPAGATION_HEADER,
                 "21196a77f299580e21196a77f299580e:993a97ee3691eb26:0:0"),
             Collections.singletonMap(
-                JaegerPropagator.PROPAGATION_HEADER,
+                io.opentelemetry.extension.trace.propagation.JaegerPropagator.PROPAGATION_HEADER,
                 "2e7d0ad2390617702e7d0ad239061770:d49582a2de984b86:0:1"),
             Collections.singletonMap(
-                JaegerPropagator.PROPAGATION_HEADER,
+                io.opentelemetry.extension.trace.propagation.JaegerPropagator.PROPAGATION_HEADER,
                 "905734c59b913b4a905734c59b913b4a:776ff807b787538a:0:0"),
             Collections.singletonMap(
-                JaegerPropagator.PROPAGATION_HEADER,
+                io.opentelemetry.extension.trace.propagation.JaegerPropagator.PROPAGATION_HEADER,
                 "68ec932c33b3f2ee68ec932c33b3f2ee:68ec932c33b3f2ee:0:0"));
 
     private final TextMapGetter<Map<String, String>> getter =
@@ -105,7 +106,8 @@ public String get(Map<String, String> carrier, String key) {
           }
         };
 
-    private final JaegerPropagator jaegerPropagator = JaegerPropagator.getInstance();
+    private final io.opentelemetry.extension.trace.propagation.JaegerPropagator jaegerPropagator =
+        io.opentelemetry.extension.trace.propagation.JaegerPropagator.getInstance();
 
     @Override
     protected Context doExtract() {
@@ -119,25 +121,26 @@ protected List<Map<String, String>> getHeaders() {
   }
 
   /** Benchmark for extracting context from Jaeger headers which are url encoded. */
+  @SuppressWarnings("deprecation")
   public static class JaegerUrlEncodedContextExtractBenchmark
       extends AbstractContextExtractBenchmark {
 
     private static final List<Map<String, String>> traceHeaders =
         Arrays.asList(
             Collections.singletonMap(
-                JaegerPropagator.PROPAGATION_HEADER,
+                io.opentelemetry.extension.trace.propagation.JaegerPropagator.PROPAGATION_HEADER,
                 "905734c59b913b4a905734c59b913b4a%3A9909983295041501%3A0%3A1"),
             Collections.singletonMap(
-                JaegerPropagator.PROPAGATION_HEADER,
+                io.opentelemetry.extension.trace.propagation.JaegerPropagator.PROPAGATION_HEADER,
                 "21196a77f299580e21196a77f299580e%3A993a97ee3691eb26%3A0%3A0"),
             Collections.singletonMap(
-                JaegerPropagator.PROPAGATION_HEADER,
+                io.opentelemetry.extension.trace.propagation.JaegerPropagator.PROPAGATION_HEADER,
                 "2e7d0ad2390617702e7d0ad239061770%3Ad49582a2de984b86%3A0%3A1"),
             Collections.singletonMap(
-                JaegerPropagator.PROPAGATION_HEADER,
+                io.opentelemetry.extension.trace.propagation.JaegerPropagator.PROPAGATION_HEADER,
                 "905734c59b913b4a905734c59b913b4a%3A776ff807b787538a%3A0%3A0"),
             Collections.singletonMap(
-                JaegerPropagator.PROPAGATION_HEADER,
+                io.opentelemetry.extension.trace.propagation.JaegerPropagator.PROPAGATION_HEADER,
                 "68ec932c33b3f2ee68ec932c33b3f2ee%3A68ec932c33b3f2ee%3A0%3A0"));
 
     private final TextMapGetter<Map<String, String>> getter =
@@ -153,7 +156,8 @@ public String get(Map<String, String> carrier, String key) {
           }
         };
 
-    private final JaegerPropagator jaegerPropagator = JaegerPropagator.getInstance();
+    private final io.opentelemetry.extension.trace.propagation.JaegerPropagator jaegerPropagator =
+        io.opentelemetry.extension.trace.propagation.JaegerPropagator.getInstance();
 
     @Override
     protected Context doExtract() {
diff --git a/extensions/trace-propagators/src/jmh/java/io/opentelemetry/extension/trace/propagation/PropagatorContextInjectBenchmark.java b/extensions/trace-propagators/src/jmh/java/io/opentelemetry/extension/trace/propagation/PropagatorContextInjectBenchmark.java
@@ -81,7 +81,10 @@ private static SpanContext createTestSpanContext(String traceId, String spanId)
   /** Benchmark for injecting trace context into Jaeger headers. */
   public static class JaegerContextInjectBenchmark extends AbstractContextInjectBenchmark {
 
-    private final JaegerPropagator jaegerPropagator = JaegerPropagator.getInstance();
+    @SuppressWarnings("deprecation")
+    private final io.opentelemetry.extension.trace.propagation.JaegerPropagator jaegerPropagator =
+        io.opentelemetry.extension.trace.propagation.JaegerPropagator.getInstance();
+
     private final TextMapSetter<Map<String, String>> setter = Map::put;
 
     @Override
diff --git a/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/JaegerConfigurablePropagator.java b/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/JaegerConfigurablePropagator.java
@@ -10,13 +10,15 @@
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigurablePropagatorProvider;
 
 /**
- * A {@link ConfigurablePropagatorProvider} which allows enabling the {@link JaegerPropagator} with
- * the propagator name {@code jaeger}.
+ * A {@link ConfigurablePropagatorProvider} which allows enabling the {@link
+ * io.opentelemetry.extension.trace.propagation.JaegerPropagator} with the propagator name {@code
+ * jaeger}.
  */
+@SuppressWarnings("deprecation")
 public final class JaegerConfigurablePropagator implements ConfigurablePropagatorProvider {
   @Override
   public TextMapPropagator getPropagator(ConfigProperties config) {
-    return JaegerPropagator.getInstance();
+    return io.opentelemetry.extension.trace.propagation.JaegerPropagator.getInstance();
   }
 
   @Override
diff --git a/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/JaegerPropagator.java b/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/JaegerPropagator.java
@@ -15,6 +15,7 @@
 import io.opentelemetry.api.trace.TraceFlags;
 import io.opentelemetry.api.trace.TraceId;
 import io.opentelemetry.api.trace.TraceState;
+import io.opentelemetry.api.trace.propagation.W3CTraceContextPropagator;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.context.propagation.TextMapGetter;
 import io.opentelemetry.context.propagation.TextMapPropagator;
@@ -32,8 +33,13 @@
  * Implementation of the Jaeger propagation protocol. See <a
  * href="https://www.jaegertracing.io/docs/client-libraries/#propagation-format">Jaeger Propagation
  * Format</a>.
+ *
+ * @deprecated the jaeger propagation format is deprecated in the OpenTelemetry specification (see
+ *     <a href="https://github.com/open-telemetry/opentelemetry-specification/pull/4827">#4827</a>).
+ *     Please use {@link W3CTraceContextPropagator} instead.
  */
 @Immutable
+@Deprecated
 public final class JaegerPropagator implements TextMapPropagator {
 
   private static final Logger logger = Logger.getLogger(JaegerPropagator.class.getName());
diff --git a/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/JaegerComponentProvider.java b/extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/JaegerComponentProvider.java
diff --git a/extensions/trace-propagators/src/main/resources/META-INF/services/io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider b/extensions/trace-propagators/src/main/resources/META-INF/services/io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider
@@ -1,3 +1,2 @@
 io.opentelemetry.extension.trace.propagation.internal.B3ComponentProvider
 io.opentelemetry.extension.trace.propagation.internal.B3MultiComponentProvider
-io.opentelemetry.extension.trace.propagation.internal.JaegerComponentProvider
diff --git a/extensions/trace-propagators/src/test/java/io/opentelemetry/extension/trace/propagation/JaegerPropagatorTest.java b/extensions/trace-propagators/src/test/java/io/opentelemetry/extension/trace/propagation/JaegerPropagatorTest.java
@@ -6,11 +6,6 @@
 package io.opentelemetry.extension.trace.propagation;
 
 import static io.opentelemetry.api.baggage.Baggage.fromContext;
-import static io.opentelemetry.extension.trace.propagation.JaegerPropagator.BAGGAGE_HEADER;
-import static io.opentelemetry.extension.trace.propagation.JaegerPropagator.BAGGAGE_PREFIX;
-import static io.opentelemetry.extension.trace.propagation.JaegerPropagator.DEPRECATED_PARENT_SPAN;
-import static io.opentelemetry.extension.trace.propagation.JaegerPropagator.PROPAGATION_HEADER;
-import static io.opentelemetry.extension.trace.propagation.JaegerPropagator.PROPAGATION_HEADER_DELIMITER;
 import static org.assertj.core.api.Assertions.assertThat;
 
 import com.google.common.collect.ImmutableMap;
@@ -36,8 +31,20 @@
 import org.junit.jupiter.api.Test;
 
 /** Unit tests for {@link io.opentelemetry.extension.trace.propagation.JaegerPropagator}. */
+@SuppressWarnings("deprecation")
 class JaegerPropagatorTest {
 
+  private static final String BAGGAGE_HEADER =
+      io.opentelemetry.extension.trace.propagation.JaegerPropagator.BAGGAGE_HEADER;
+  private static final String BAGGAGE_PREFIX =
+      io.opentelemetry.extension.trace.propagation.JaegerPropagator.BAGGAGE_PREFIX;
+  private static final char DEPRECATED_PARENT_SPAN =
+      io.opentelemetry.extension.trace.propagation.JaegerPropagator.DEPRECATED_PARENT_SPAN;
+  private static final String PROPAGATION_HEADER =
+      io.opentelemetry.extension.trace.propagation.JaegerPropagator.PROPAGATION_HEADER;
+  private static final char PROPAGATION_HEADER_DELIMITER =
+      io.opentelemetry.extension.trace.propagation.JaegerPropagator.PROPAGATION_HEADER_DELIMITER;
+
   private static final long TRACE_ID_HI = 77L;
   private static final long TRACE_ID_LOW = 22L;
   private static final String TRACE_ID = "000000000000004d0000000000000016";
@@ -62,7 +69,8 @@ public String get(Map<String, String> carrier, String key) {
         }
       };
 
-  private final JaegerPropagator jaegerPropagator = JaegerPropagator.getInstance();
+  private final io.opentelemetry.extension.trace.propagation.JaegerPropagator jaegerPropagator =
+      io.opentelemetry.extension.trace.propagation.JaegerPropagator.getInstance();
 
   private static SpanContext getSpanContext(Context context) {
     return Span.fromContext(context).getSpanContext();
diff --git a/sdk-extensions/autoconfigure/src/testFullConfig/java/io/opentelemetry/sdk/autoconfigure/FullConfigTest.java b/sdk-extensions/autoconfigure/src/testFullConfig/java/io/opentelemetry/sdk/autoconfigure/FullConfigTest.java
@@ -23,7 +23,6 @@
 import io.opentelemetry.api.metrics.Meter;
 import io.opentelemetry.api.trace.propagation.W3CTraceContextPropagator;
 import io.opentelemetry.extension.trace.propagation.B3Propagator;
-import io.opentelemetry.extension.trace.propagation.JaegerPropagator;
 import io.opentelemetry.proto.collector.logs.v1.ExportLogsServiceRequest;
 import io.opentelemetry.proto.collector.logs.v1.ExportLogsServiceResponse;
 import io.opentelemetry.proto.collector.logs.v1.LogsServiceGrpc;
@@ -175,7 +174,8 @@ void configures() throws Exception {
     keys.addAll(W3CBaggagePropagator.getInstance().fields());
     keys.addAll(B3Propagator.injectingSingleHeader().fields());
     keys.addAll(B3Propagator.injectingMultiHeaders().fields());
-    keys.addAll(JaegerPropagator.getInstance().fields());
+    keys.addAll(
+        io.opentelemetry.extension.trace.propagation.JaegerPropagator.getInstance().fields());
     keys.addAll(
         io.opentelemetry.extension.trace.propagation.OtTracePropagator.getInstance().fields());
     // Added by TestPropagatorProvider
diff --git a/sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/DeclarativeConfigurationCreateTest.java b/sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/DeclarativeConfigurationCreateTest.java
@@ -82,8 +82,9 @@ void parseAndCreate_Examples(@TempDir Path tempDir)
           new String(Files.readAllBytes(example.toPath()), StandardCharsets.UTF_8);
       String rewrittenExampleContent =
           exampleContent
-              // TODO: remove ottrace workagrounds after updating to next version of declarative
-              // configuration
+              // TODO: remove jaeger, ottrace workarounds after next release
+              .replaceAll(".*- jaeger:.*\n", "")
+              .replaceAll("jaeger", "")
               .replaceAll(".*- ottrace:.*\n", "")
               .replaceAll("ottrace", "")
               .replaceAll(
diff --git a/sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/OpenTelemetryConfigurationFactoryTest.java b/sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/OpenTelemetryConfigurationFactoryTest.java
@@ -19,7 +19,6 @@
 import io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporter;
 import io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporter;
 import io.opentelemetry.extension.trace.propagation.B3Propagator;
-import io.opentelemetry.extension.trace.propagation.JaegerPropagator;
 import io.opentelemetry.internal.testing.CleanupExtension;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import io.opentelemetry.sdk.autoconfigure.internal.SpiHelper;
@@ -173,8 +172,7 @@ void create_Disabled() {
   }
 
   @Test
-  @SuppressWarnings("deprecation")
-  void create_Configured() throws NoSuchFieldException, IllegalAccessException {
+  void create_Configured() throws NoSuchFieldException {
     List<Closeable> closeables = new ArrayList<>();
     io.opentelemetry.sdk.resources.Resource expectedResource =
         io.opentelemetry.sdk.resources.Resource.getDefault().toBuilder()
@@ -190,7 +188,7 @@ void create_Configured() throws NoSuchFieldException, IllegalAccessException {
         new OpenTelemetryConfigurationModel()
             .withFileFormat("1.0-rc.1")
             .withPropagator(
-                new PropagatorModel().withCompositeList("tracecontext,baggage,b3multi,b3,jaeger"))
+                new PropagatorModel().withCompositeList("tracecontext,baggage,b3multi,b3"))
             .withResource(
                 new ResourceModel()
                     .withDetectionDevelopment(
@@ -271,8 +269,7 @@ void create_Configured() throws NoSuchFieldException, IllegalAccessException {
                                 W3CTraceContextPropagator.getInstance(),
                                 W3CBaggagePropagator.getInstance(),
                                 B3Propagator.injectingMultiHeaders(),
-                                B3Propagator.injectingSingleHeader(),
-                                JaegerPropagator.getInstance())))
+                                B3Propagator.injectingSingleHeader())))
                     .setLoggerProvider(
                         SdkLoggerProvider.builder()
                             .setResource(expectedResource)
diff --git a/sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/PropagatorFactoryTest.java b/sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/PropagatorFactoryTest.java

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,2 @@`
`1`	`1`	`io.opentelemetry.extension.trace.propagation.internal.B3ComponentProvider`
`2`	`2`	`io.opentelemetry.extension.trace.propagation.internal.B3MultiComponentProvider`
`3`		`-io.opentelemetry.extension.trace.propagation.internal.JaegerComponentProvider`