Skip to content

Commit 0a1980b

Browse files
jack-bergjack-berg
authored
Deprecate OtTracePropagator (#8020)
1 parent 3d4ed08 commit 0a1980b

File tree

10 files changed

+24
-55
lines changed

10 files changed

+24
-55
lines changed

‎docs/apidiffs/current_vs_latest/opentelemetry-extension-trace-propagators.txt‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
Comparing source compatibility of opentelemetry-extension-trace-propagators-1.59.0-SNAPSHOT.jar against opentelemetry-extension-trace-propagators-1.58.0.jar
2-
No changes.
2+
=== UNCHANGED CLASS: PUBLIC FINAL io.opentelemetry.extension.trace.propagation.OtTracePropagator (not serializable)
3+
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
4+
+++ NEW ANNOTATION: java.lang.Deprecated

‎extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/OtTraceConfigurablePropagator.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* A {@link ConfigurablePropagatorProvider} which allows enabling the {@link OtTracePropagator} with
1414
* the propagator name {@code ottrace}.
1515
*/
16+
@SuppressWarnings("deprecation")
1617
public final class OtTraceConfigurablePropagator implements ConfigurablePropagatorProvider {
1718
@Override
1819
public TextMapPropagator getPropagator(ConfigProperties config) {

‎extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/OtTracePropagator.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
import io.opentelemetry.api.trace.SpanContext;
1616
import io.opentelemetry.api.trace.SpanId;
1717
import io.opentelemetry.api.trace.TraceId;
18+
import io.opentelemetry.api.trace.propagation.W3CTraceContextPropagator;
1819
import io.opentelemetry.context.Context;
1920
import io.opentelemetry.context.propagation.TextMapGetter;
2021
import io.opentelemetry.context.propagation.TextMapPropagator;
@@ -33,8 +34,13 @@
3334
* See <a
3435
* href=https://github.com/opentracing/basictracer-python/blob/master/basictracer/text_propagator.py>OT
3536
* Python Propagation TextMapPropagator</a>.
37+
*
38+
* @deprecated the OT trace propagation format is deprecated in the OpenTelemetry specification (see
39+
* <a href="https://github.com/open-telemetry/opentelemetry-specification/pull/4851">#4851</a>).
40+
* Please use {@link W3CTraceContextPropagator} instead.
3641
*/
3742
@Immutable
43+
@Deprecated
3844
public final class OtTracePropagator implements TextMapPropagator {
3945

4046
static final String TRACE_ID_HEADER = "ot-tracer-traceid";

‎extensions/trace-propagators/src/main/java/io/opentelemetry/extension/trace/propagation/internal/OtTraceComponentProvider.java‎

Lines changed: 0 additions & 36 deletions
This file was deleted.

‎extensions/trace-propagators/src/main/resources/META-INF/services/io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
io.opentelemetry.extension.trace.propagation.internal.B3ComponentProvider
22
io.opentelemetry.extension.trace.propagation.internal.B3MultiComponentProvider
33
io.opentelemetry.extension.trace.propagation.internal.JaegerComponentProvider
4-
io.opentelemetry.extension.trace.propagation.internal.OtTraceComponentProvider

‎extensions/trace-propagators/src/test/java/io/opentelemetry/extension/trace/propagation/OtTracePropagatorTest.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
import javax.annotation.Nullable;
2626
import org.junit.jupiter.api.Test;
2727

28+
@SuppressWarnings("deprecation")
2829
class OtTracePropagatorTest {
2930

3031
private static final String TRACE_ID = "ff000000000000000000000000000041";

‎sdk-extensions/autoconfigure/src/testFullConfig/java/io/opentelemetry/sdk/autoconfigure/FullConfigTest.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
import io.opentelemetry.api.trace.propagation.W3CTraceContextPropagator;
2525
import io.opentelemetry.extension.trace.propagation.B3Propagator;
2626
import io.opentelemetry.extension.trace.propagation.JaegerPropagator;
27-
import io.opentelemetry.extension.trace.propagation.OtTracePropagator;
2827
import io.opentelemetry.proto.collector.logs.v1.ExportLogsServiceRequest;
2928
import io.opentelemetry.proto.collector.logs.v1.ExportLogsServiceResponse;
3029
import io.opentelemetry.proto.collector.logs.v1.LogsServiceGrpc;
@@ -167,6 +166,7 @@ void afterEach() {
167166
}
168167

169168
@Test
169+
@SuppressWarnings("deprecation")
170170
void configures() throws Exception {
171171
Collection<String> fields =
172172
GlobalOpenTelemetry.get().getPropagators().getTextMapPropagator().fields();
@@ -176,7 +176,8 @@ void configures() throws Exception {
176176
keys.addAll(B3Propagator.injectingSingleHeader().fields());
177177
keys.addAll(B3Propagator.injectingMultiHeaders().fields());
178178
keys.addAll(JaegerPropagator.getInstance().fields());
179-
keys.addAll(OtTracePropagator.getInstance().fields());
179+
keys.addAll(
180+
io.opentelemetry.extension.trace.propagation.OtTracePropagator.getInstance().fields());
180181
// Added by TestPropagatorProvider
181182
keys.add("test");
182183
assertThat(fields).containsExactlyInAnyOrderElementsOf(keys);

‎sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/DeclarativeConfigurationCreateTest.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,10 @@ void parseAndCreate_Examples(@TempDir Path tempDir)
8282
new String(Files.readAllBytes(example.toPath()), StandardCharsets.UTF_8);
8383
String rewrittenExampleContent =
8484
exampleContent
85+
// TODO: remove ottrace workagrounds after updating to next version of declarative
86+
// configuration
87+
.replaceAll(".*- ottrace:.*\n", "")
88+
.replaceAll("ottrace", "")
8589
.replaceAll(
8690
"ca_file: .*\n",
8791
"ca_file: " + certificatePath.replace("\\", "\\\\") + System.lineSeparator())

‎sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/OpenTelemetryConfigurationFactoryTest.java‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
import io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporter;
2121
import io.opentelemetry.extension.trace.propagation.B3Propagator;
2222
import io.opentelemetry.extension.trace.propagation.JaegerPropagator;
23-
import io.opentelemetry.extension.trace.propagation.OtTracePropagator;
2423
import io.opentelemetry.internal.testing.CleanupExtension;
2524
import io.opentelemetry.sdk.OpenTelemetrySdk;
2625
import io.opentelemetry.sdk.autoconfigure.internal.SpiHelper;
@@ -174,6 +173,7 @@ void create_Disabled() {
174173
}
175174

176175
@Test
176+
@SuppressWarnings("deprecation")
177177
void create_Configured() throws NoSuchFieldException, IllegalAccessException {
178178
List<Closeable> closeables = new ArrayList<>();
179179
io.opentelemetry.sdk.resources.Resource expectedResource =
@@ -190,8 +190,7 @@ void create_Configured() throws NoSuchFieldException, IllegalAccessException {
190190
new OpenTelemetryConfigurationModel()
191191
.withFileFormat("1.0-rc.1")
192192
.withPropagator(
193-
new PropagatorModel()
194-
.withCompositeList("tracecontext,baggage,ottrace,b3multi,b3,jaeger"))
193+
new PropagatorModel().withCompositeList("tracecontext,baggage,b3multi,b3,jaeger"))
195194
.withResource(
196195
new ResourceModel()
197196
.withDetectionDevelopment(
@@ -271,7 +270,6 @@ void create_Configured() throws NoSuchFieldException, IllegalAccessException {
271270
TextMapPropagator.composite(
272271
W3CTraceContextPropagator.getInstance(),
273272
W3CBaggagePropagator.getInstance(),
274-
OtTracePropagator.getInstance(),
275273
B3Propagator.injectingMultiHeaders(),
276274
B3Propagator.injectingSingleHeader(),
277275
JaegerPropagator.getInstance())))

‎sdk-extensions/incubator/src/test/java/io/opentelemetry/sdk/extension/incubator/fileconfig/PropagatorFactoryTest.java‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,12 @@
1616
import io.opentelemetry.context.propagation.TextMapPropagator;
1717
import io.opentelemetry.extension.trace.propagation.B3Propagator;
1818
import io.opentelemetry.extension.trace.propagation.JaegerPropagator;
19-
import io.opentelemetry.extension.trace.propagation.OtTracePropagator;
2019
import io.opentelemetry.sdk.autoconfigure.internal.SpiHelper;
2120
import io.opentelemetry.sdk.extension.incubator.fileconfig.component.TextMapPropagatorComponentProvider;
2221
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.B3MultiPropagatorModel;
2322
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.B3PropagatorModel;
2423
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.BaggagePropagatorModel;
2524
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.JaegerPropagatorModel;
26-
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.OpenTracingPropagatorModel;
2725
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.PropagatorModel;
2826
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.TextMapPropagatorModel;
2927
import io.opentelemetry.sdk.extension.incubator.fileconfig.internal.model.TraceContextPropagatorModel;
@@ -48,6 +46,7 @@ void create(PropagatorModel model, ContextPropagators expectedPropagators) {
4846
assertThat(propagators.toString()).isEqualTo(expectedPropagators.toString());
4947
}
5048

49+
@SuppressWarnings("deprecation")
5150
private static Stream<Arguments> createArguments() {
5251
return Stream.of(
5352
// structured list
@@ -58,27 +57,23 @@ private static Stream<Arguments> createArguments() {
5857
new TextMapPropagatorModel()
5958
.withTracecontext(new TraceContextPropagatorModel()),
6059
new TextMapPropagatorModel().withBaggage(new BaggagePropagatorModel()),
61-
new TextMapPropagatorModel().withOttrace(new OpenTracingPropagatorModel()),
6260
new TextMapPropagatorModel().withB3multi(new B3MultiPropagatorModel()),
6361
new TextMapPropagatorModel().withB3(new B3PropagatorModel()),
6462
new TextMapPropagatorModel().withJaeger(new JaegerPropagatorModel()))),
6563
ContextPropagators.create(
6664
TextMapPropagator.composite(
6765
W3CTraceContextPropagator.getInstance(),
6866
W3CBaggagePropagator.getInstance(),
69-
OtTracePropagator.getInstance(),
7067
B3Propagator.injectingMultiHeaders(),
7168
B3Propagator.injectingSingleHeader(),
7269
JaegerPropagator.getInstance()))),
7370
// string list
7471
Arguments.of(
75-
new PropagatorModel()
76-
.withCompositeList("tracecontext,baggage,ottrace,b3multi,b3,jaeger ,none"),
72+
new PropagatorModel().withCompositeList("tracecontext,baggage,b3multi,b3,jaeger ,none"),
7773
ContextPropagators.create(
7874
TextMapPropagator.composite(
7975
W3CTraceContextPropagator.getInstance(),
8076
W3CBaggagePropagator.getInstance(),
81-
OtTracePropagator.getInstance(),
8277
B3Propagator.injectingMultiHeaders(),
8378
B3Propagator.injectingSingleHeader(),
8479
JaegerPropagator.getInstance()))),
@@ -90,12 +85,11 @@ private static Stream<Arguments> createArguments() {
9085
new TextMapPropagatorModel()
9186
.withTracecontext(new TraceContextPropagatorModel()),
9287
new TextMapPropagatorModel().withBaggage(new BaggagePropagatorModel())))
93-
.withCompositeList("ottrace,b3multi,b3,jaeger"),
88+
.withCompositeList("b3multi,b3,jaeger"),
9489
ContextPropagators.create(
9590
TextMapPropagator.composite(
9691
W3CTraceContextPropagator.getInstance(),
9792
W3CBaggagePropagator.getInstance(),
98-
OtTracePropagator.getInstance(),
9993
B3Propagator.injectingMultiHeaders(),
10094
B3Propagator.injectingSingleHeader(),
10195
JaegerPropagator.getInstance()))),
@@ -107,12 +101,11 @@ private static Stream<Arguments> createArguments() {
107101
new TextMapPropagatorModel()
108102
.withTracecontext(new TraceContextPropagatorModel()),
109103
new TextMapPropagatorModel().withBaggage(new BaggagePropagatorModel())))
110-
.withCompositeList("tracecontext,ottrace,b3multi,b3,jaeger"),
104+
.withCompositeList("tracecontext,b3multi,b3,jaeger"),
111105
ContextPropagators.create(
112106
TextMapPropagator.composite(
113107
W3CTraceContextPropagator.getInstance(),
114108
W3CBaggagePropagator.getInstance(),
115-
OtTracePropagator.getInstance(),
116109
B3Propagator.injectingMultiHeaders(),
117110
B3Propagator.injectingSingleHeader(),
118111
JaegerPropagator.getInstance()))),

0 commit comments

Comments
 (0)