open-telemetry
/
opentelemetry-java
mirror of https://github.com/open-telemetry/opentelemetry-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

MultiTracePropagator implementation (#1339)

This commit is contained in:
Carlos Alberto Cortez 2020-07-01 19:14:21 +02:00 committed by GitHub
parent 50a424c4b4
commit 890ba28fbc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 454 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
api/src/main/java/io/opentelemetry/trace/propagation/HttpTraceContext.java
View File

@ -125,6 +125,10 @@ public class HttpTraceContext implements HttpTextFormat {
checkNotNull(getter, "getter");
SpanContext spanContext = extractImpl(carrier, getter);
if (!spanContext.isValid()) {
return context;
}
return TracingContextUtils.withSpan(DefaultSpan.create(spanContext), context);
}

10
api/src/test/java/io/opentelemetry/trace/propagation/HttpTraceContextTest.java
View File

@ -30,6 +30,7 @@ import io.opentelemetry.trace.TraceFlags;
import io.opentelemetry.trace.TraceId;
import io.opentelemetry.trace.TraceState;
import io.opentelemetry.trace.TracingContextUtils;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;
@ -162,6 +163,15 @@ public class HttpTraceContextTest {
TRACESTATE_NOT_DEFAULT_ENCODING);
}
@Test
public void extract_Nothing() {
// Context remains untouched.
assertThat(
httpTraceContext.extract(
Context.current(), Collections.<String, String>emptyMap(), Map::get))
.isSameInstanceAs(Context.current());
}
@Test
public void extract_SampledContext() {
Map<String, String> carrier = new LinkedHashMap<>();

4
extensions/trace_propagators/src/main/java/io/opentelemetry/extensions/trace/propagation/AwsXRayPropagator.java
View File

@ -125,6 +125,10 @@ public class AwsXRayPropagator implements HttpTextFormat {
Objects.requireNonNull(getter, "getter");
SpanContext spanContext = getSpanContextFromHeader(carrier, getter);
if (!spanContext.isValid()) {
return context;
}
return TracingContextUtils.withSpan(DefaultSpan.create(spanContext), context);
}

4
extensions/trace_propagators/src/main/java/io/opentelemetry/extensions/trace/propagation/B3PropagatorExtractorMultipleHeaders.java
View File

@ -39,6 +39,10 @@ final class B3PropagatorExtractorMultipleHeaders implements B3PropagatorExtracto
Objects.requireNonNull(carrier, "carrier");
Objects.requireNonNull(getter, "getter");
SpanContext spanContext = getSpanContextFromMultipleHeaders(carrier, getter);
if (!spanContext.isValid()) {
return context;
}
return TracingContextUtils.withSpan(DefaultSpan.create(spanContext), context);
}

4
extensions/trace_propagators/src/main/java/io/opentelemetry/extensions/trace/propagation/B3PropagatorExtractorSingleHeader.java
View File

@ -38,6 +38,10 @@ final class B3PropagatorExtractorSingleHeader implements B3PropagatorExtractor {
Objects.requireNonNull(carrier, "carrier");
Objects.requireNonNull(getter, "getter");
SpanContext spanContext = getSpanContextFromSingleHeader(carrier, getter);
if (!spanContext.isValid()) {
return context;
}
return TracingContextUtils.withSpan(DefaultSpan.create(spanContext), context);
}

3
extensions/trace_propagators/src/main/java/io/opentelemetry/extensions/trace/propagation/JaegerPropagator.java
View File

@ -110,6 +110,9 @@ public class JaegerPropagator implements HttpTextFormat {
Objects.requireNonNull(getter, "getter");
SpanContext spanContext = getSpanContextFromHeader(carrier, getter);
if (!spanContext.isValid()) {
return context;
}
return TracingContextUtils.withSpan(DefaultSpan.create(spanContext), context);
}

184
extensions/trace_propagators/src/main/java/io/opentelemetry/extensions/trace/propagation/TraceMultiPropagator.java Normal file
View File

@ -0,0 +1,184 @@
/*
* Copyright 2020, OpenTelemetry Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.opentelemetry.extensions.trace.propagation;
import io.grpc.Context;
import io.opentelemetry.context.propagation.HttpTextFormat;
import io.opentelemetry.trace.TracingContextUtils;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import javax.annotation.concurrent.Immutable;
/**
* A propagator designed to inject and extract multiple trace {@code HttpTextFormat} propagators,
* intendended for backwards compatibility with existing services using different formats. It works
* in a stack-fashion, starting with the last registered propagator, to the first one.
*
* <p>Upon injection, this propagator invokes {@code HttpTextFormat#inject()} for every registered
* trace propagator. This will result in the carrier containing all the registered formats.
*
* <p>Upon extraction, this propagator invokes {@code HttpTextFormat#extract()} for every registered
* trace propagator, returning immediately when a successful extraction happened.
*
* <pre>{@code
* HttpTextFormat traceFormats = TraceMultiPropagator.builder()
* .addPropagator(new MyCustomTracePropagator())
* .addPropagator(new JaegerPropagator())
* .addPropagator(new HttpTraceContext())
* .build();
* // Register it in the global propagators:
* OpenTelemetry.setPropagators(
* DefaultContextPropagators.builder()
* .addHttpTextFormat(traceFormats)
* .build());
* ...
* // Extraction will be performed in reverse order, i.e. starting with the last
* // registered propagator (HttpTraceContext in this example).
* Context context = OpenTelemetry.getPropagators().getHttpTextFormat()
* .extract(context, carrier, carrierGetter);
* }</pre>
*
* @since 0.6.0
*/
@Immutable
public class TraceMultiPropagator implements HttpTextFormat {
private final HttpTextFormat[] propagators;
private final List<String> propagatorsFields;
private TraceMultiPropagator(List<HttpTextFormat> propagatorList) {
this.propagators = new HttpTextFormat[propagatorList.size()];
propagatorList.toArray(this.propagators);
List<String> fields = new ArrayList<>();
for (HttpTextFormat propagator : propagators) {
fields.addAll(propagator.fields());
}
this.propagatorsFields = Collections.unmodifiableList(fields);
}
/**
* Returns a {@link TraceMultiPropagator.Builder} to create a new {@link TraceMultiPropagator}
* object.
*
* @return a {@link TraceMultiPropagator.Builder}.
* @since 0.6.0
*/
public static Builder builder() {
return new Builder();
}
/**
* The propagation fields defined in all the registered propagators. The returned list will be
* read-only.
*
* @return list of fields defined in all the registered propagators.
* @since 0.6.0
*/
@Override
public List<String> fields() {
return propagatorsFields;
}
/**
* Injects the value downstream invoking all the registered propagators, starting with the last
* one.
*
* @param context the {@code Context} containing the value to be injected.
* @param carrier holds propagation fields. For example, an outgoing message or http request.
* @param setter invoked for each propagation key to add or remove.
* @param <C> carrier of propagation fields, such as an http request
* @since 0.6.0
*/
@Override
public <C> void inject(Context context, C carrier, Setter<C> setter) {
for (int i = propagators.length - 1; i >= 0; i--) {
propagators[i].inject(context, carrier, setter);
}
}
/**
* Extracts the value from upstream invoking all the registered propagators, starting with the
* last one. Iterating over the propagators will stop and return immediately upon the first
* successful extraction.
*
* @param context the {@code Context} used to store the extracted value.
* @param carrier holds propagation fields. For example, an outgoing message or http request.
* @param getter invoked for each propagation key to get.
* @param <C> carrier of propagation fields, such as an http request.
* @return the {@code Context} containing the extracted value.
* @since 0.6.0
*/
@Override
public <C> Context extract(Context context, C carrier, Getter<C> getter) {
for (int i = propagators.length - 1; i >= 0; i--) {
context = propagators[i].extract(context, carrier, getter);
if (isSpanContextExtracted(context)) {
break;
}
}
return context;
}
private static boolean isSpanContextExtracted(Context context) {
return TracingContextUtils.getSpanWithoutDefault(context) != null;
}
/**
* {@link Builder} is used to construct a new {@code TraceMultiPropagator} object with the
* specified propagators.
*
* @since 0.6.0
*/
public static class Builder {
private final List<HttpTextFormat> propagators;
private Builder() {
propagators = new ArrayList<>();
}
/**
* Adds a {@link HttpTextFormat} trace propagator.
*
* <p>Registered propagators will be invoked in reverse order, starting with the last propagator
* to the first one.
*
* @param propagator the propagator to be added.
* @return this.
* @throws NullPointerException if {@code propagator} is {@code null}.
* @since 0.6.0
*/
public Builder addPropagator(HttpTextFormat propagator) {
Objects.requireNonNull(propagator, "propagator");
propagators.add(propagator);
return this;
}
/**
* Builds a new {@code TraceMultiPropagator} with the specified propagators.
*
* @return the newly created {@code TraceMultiPropagator} instance.
* @since 0.6.0
*/
public TraceMultiPropagator build() {
return new TraceMultiPropagator(propagators);
}
}
}

10
extensions/trace_propagators/src/test/java/io/opentelemetry/extensions/trace/propagation/AwsXRayPropagatorTest.java
View File

@ -28,6 +28,7 @@ import io.opentelemetry.trace.TraceFlags;
import io.opentelemetry.trace.TraceId;
import io.opentelemetry.trace.TraceState;
import io.opentelemetry.trace.TracingContextUtils;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;
import javax.annotation.Nullable;
@ -111,6 +112,15 @@ public class AwsXRayPropagatorTest {
"Root=1-8a3c60f7-d188f8fa79d48a391a778fa6;Parent=53995c3f42cd8ad8;Sampled=0");
}
@Test
public void extract_Nothing() {
// Context remains untouched.
assertThat(
xrayPropagator.extract(
Context.current(), Collections.<String, String>emptyMap(), Map::get))
.isSameInstanceAs(Context.current());
}
@Test
public void extract_SampledContext() {
Map<String, String> carrier = new LinkedHashMap<>();

19
extensions/trace_propagators/src/test/java/io/opentelemetry/extensions/trace/propagation/B3PropagatorTest.java
View File

@ -28,6 +28,7 @@ import io.opentelemetry.trace.TraceFlags;
import io.opentelemetry.trace.TraceId;
import io.opentelemetry.trace.TraceState;
import io.opentelemetry.trace.TracingContextUtils;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;
@ -132,6 +133,15 @@ public class B3PropagatorTest {
assertThat(carrier).containsEntry(B3Propagator.SAMPLED_HEADER, "0");
}
@Test
public void extract_Nothing() {
// Context remains untouched.
assertThat(
b3Propagator.extract(
Context.current(), Collections.<String, String>emptyMap(), Map::get))
.isSameInstanceAs(Context.current());
}
@Test
public void extract_SampledContext_Int() {
Map<String, String> carrier = new LinkedHashMap<>();
@ -296,6 +306,15 @@ public class B3PropagatorTest {
B3Propagator.COMBINED_HEADER, TRACE_ID_BASE16 + "-" + SPAN_ID_BASE16 + "-" + "0");
}
@Test
public void extract_Nothing_SingleHeader() {
// Context remains untouched.
assertThat(
b3PropagatorSingleHeader.extract(
Context.current(), Collections.<String, String>emptyMap(), Map::get))
.isSameInstanceAs(Context.current());
}
@Test
public void extract_SampledContext_Int_SingleHeader() {
Map<String, String> carrier = new LinkedHashMap<>();

10
extensions/trace_propagators/src/test/java/io/opentelemetry/extensions/trace/propagation/JaegerPropagatorTest.java
View File

@ -35,6 +35,7 @@ import io.opentelemetry.trace.TraceState;
import io.opentelemetry.trace.TracingContextUtils;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;
import javax.annotation.Nullable;
@ -152,6 +153,15 @@ public class JaegerPropagatorTest {
TRACE_ID_BASE16, SPAN_ID_BASE16, DEPRECATED_PARENT_SPAN, "0"));
}
@Test
public void extract_Nothing() {
// Context remains untouched.
assertThat(
jaegerPropagator.extract(
Context.current(), Collections.<String, String>emptyMap(), Map::get))
.isSameInstanceAs(Context.current());
}
@Test
public void extract_EmptyHeaderValue() {
Map<String, String> invalidHeaders = new LinkedHashMap<>();

202
extensions/trace_propagators/src/test/java/io/opentelemetry/extensions/trace/propagation/TraceMultiPropagatorTest.java Normal file
View File

@ -0,0 +1,202 @@
/*
* Copyright 2020, OpenTelemetry Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.opentelemetry.extensions.trace.propagation;
import static com.google.common.truth.Truth.assertThat;
import static io.opentelemetry.trace.TracingContextUtils.getSpan;
import static io.opentelemetry.trace.TracingContextUtils.withSpan;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import io.grpc.Context;
import io.opentelemetry.context.propagation.HttpTextFormat;
import io.opentelemetry.trace.DefaultSpan;
import io.opentelemetry.trace.Span;
import io.opentelemetry.trace.SpanContext;
import io.opentelemetry.trace.SpanId;
import io.opentelemetry.trace.TraceFlags;
import io.opentelemetry.trace.TraceId;
import io.opentelemetry.trace.TraceState;
import io.opentelemetry.trace.propagation.HttpTraceContext;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.mockito.Mockito;
import org.mockito.MockitoAnnotations;
@RunWith(JUnit4.class)
public class TraceMultiPropagatorTest {
private static final HttpTextFormat PROPAGATOR1 = B3Propagator.getSingleHeaderPropagator();
private static final HttpTextFormat PROPAGATOR2 = B3Propagator.getMultipleHeaderPropagator();
private static final HttpTextFormat PROPAGATOR3 = new HttpTraceContext();
private static final Span SPAN =
DefaultSpan.create(
SpanContext.createFromRemoteParent(
new TraceId(1245, 67890),
new SpanId(12345),
TraceFlags.getDefault(),
TraceState.getDefault()));
@Rule public ExpectedException thrown = ExpectedException.none();
@Before
public void init() {
MockitoAnnotations.initMocks(this);
}
@Test
public void addPropagator_null() {
thrown.expect(NullPointerException.class);
TraceMultiPropagator.builder().addPropagator(null);
}
@Test
public void fields() {
HttpTextFormat prop =
TraceMultiPropagator.builder()
.addPropagator(new EmptyPropagator("foo", "bar"))
.addPropagator(new EmptyPropagator("hello", "world"))
.build();
List<String> fields = prop.fields();
assertThat(fields).hasSize(4);
assertThat(fields).isEqualTo(Arrays.asList("foo", "bar", "hello", "world"));
}
@Test
public void fields_readOnly() {
HttpTextFormat prop =
TraceMultiPropagator.builder()
.addPropagator(new EmptyPropagator("foo", "bar"))
.addPropagator(new EmptyPropagator("hello", "world"))
.build();
List<String> fields = prop.fields();
thrown.expect(UnsupportedOperationException.class);
fields.add("hi");
}
@Test
public void inject_noPropagators() {
HttpTextFormat prop = TraceMultiPropagator.builder().build();
Map<String, String> carrier = new HashMap<>();
Context context = Context.current();
prop.inject(context, carrier, Map::put);
assertThat(carrier).isEmpty();
}
@Test
public void inject_allFormats() {
HttpTextFormat prop =
TraceMultiPropagator.builder()
.addPropagator(PROPAGATOR1)
.addPropagator(PROPAGATOR2)
.addPropagator(PROPAGATOR3)
.build();
Map<String, String> carrier = new HashMap<>();
prop.inject(withSpan(SPAN, Context.current()), carrier, Map::put);
assertThat(getSpan(PROPAGATOR1.extract(Context.current(), carrier, Map::get)).getContext())
.isEqualTo(SPAN.getContext());
assertThat(getSpan(PROPAGATOR2.extract(Context.current(), carrier, Map::get)).getContext())
.isEqualTo(SPAN.getContext());
assertThat(getSpan(PROPAGATOR3.extract(Context.current(), carrier, Map::get)).getContext())
.isEqualTo(SPAN.getContext());
}
@Test
public void extract_noPropagators() {
HttpTextFormat prop = TraceMultiPropagator.builder().build();
Map<String, String> carrier = new HashMap<>();
Context context = Context.current();
Context resContext = prop.extract(context, carrier, Map::get);
assertThat(context).isSameInstanceAs(resContext);
}
@Test
public void extract_found() {
HttpTextFormat prop =
TraceMultiPropagator.builder()
.addPropagator(PROPAGATOR1)
.addPropagator(PROPAGATOR2)
.addPropagator(PROPAGATOR3)
.build();
Map<String, String> carrier = new HashMap<>();
PROPAGATOR2.inject(withSpan(SPAN, Context.current()), carrier, Map::put);
assertThat(getSpan(prop.extract(Context.current(), carrier, Map::get)).getContext())
.isEqualTo(SPAN.getContext());
}
@Test
public void extract_notFound() {
HttpTextFormat prop = TraceMultiPropagator.builder().addPropagator(PROPAGATOR1).build();
Map<String, String> carrier = new HashMap<>();
PROPAGATOR3.inject(withSpan(SPAN, Context.current()), carrier, Map::put);
assertThat(prop.extract(Context.current(), carrier, Map::get)).isEqualTo(Context.current());
}
@Test
public void extract_stopWhenFound() {
HttpTextFormat mockPropagator = Mockito.mock(HttpTextFormat.class);
HttpTextFormat prop =
TraceMultiPropagator.builder()
.addPropagator(mockPropagator)
.addPropagator(PROPAGATOR3)
.build();
Map<String, String> carrier = new HashMap<>();
PROPAGATOR3.inject(withSpan(SPAN, Context.current()), carrier, Map::put);
assertThat(getSpan(prop.extract(Context.current(), carrier, Map::get)).getContext())
.isEqualTo(SPAN.getContext());
verify(mockPropagator).fields();
verifyNoMoreInteractions(mockPropagator);
}
private static class EmptyPropagator implements HttpTextFormat {
List<String> fields;
public EmptyPropagator(String... fields) {
this.fields = Arrays.asList(fields);
}
@Override
public List<String> fields() {
return fields;
}
@Override
public <C> void inject(Context context, C carrier, Setter<C> c) {}
@Override
public <C> Context extract(Context context, C carrier, Getter<C> c) {
return context;
}
}
}