Ensure correlation via baggage on forwarded spans

* change active-span-check to assert on span-id only to not fail if spans are wrapped (forwarded) e.g. due to auto-tagging
zalando · Apr 15, 2020 · 7c4d008 · 7c4d008
1 parent 472edee
commit 7c4d008
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/.../opentracing-proxy/src/main/java/org/zalando/opentracing/proxy/plugin/LogCorrelation.java b/.../opentracing-proxy/src/main/java/org/zalando/opentracing/proxy/plugin/LogCorrelation.java
@@ -16,6 +16,7 @@
 import java.util.Map.Entry;
 import java.util.Optional;
 import java.util.function.BiFunction;
+import java.util.function.Function;
 
 import static java.util.Collections.singleton;
 import static java.util.Collections.singletonMap;
@@ -86,9 +87,13 @@ public void onBaggage(
             final String baggageKey,
             final String value) {
 
-        @Nullable final Span activeSpan = tracer.activeSpan();
+        final Function<Span, String> toSpanId = s -> s.context().toSpanId();
 
-        if (span.equals(activeSpan)) {
+        @Nullable final String activeSpanId = Optional.ofNullable(tracer.activeSpan())
+                .map(toSpanId)
+                .orElse(null);
+
+        if (toSpanId.apply(span).equals(activeSpanId)) {
             Optional.ofNullable(baggage.get(baggageKey))
                     .ifPresent(contextKey -> MDC.put(contextKey, value));
         }

diff --git a/...ntracing-proxy/src/test/java/org/zalando/opentracing/proxy/plugin/LogCorrelationTest.java b/...ntracing-proxy/src/test/java/org/zalando/opentracing/proxy/plugin/LogCorrelationTest.java
@@ -10,8 +10,8 @@
 import io.opentracing.propagation.TextMapExtractAdapter;
 import org.junit.jupiter.api.Test;
 import org.slf4j.MDC;
+import org.zalando.opentracing.proxy.base.ForwardingSpan;
 import org.zalando.opentracing.proxy.core.ProxyTracer;
-import org.zalando.opentracing.proxy.plugin.LogCorrelation;
 
 import java.util.HashMap;
 
@@ -112,6 +112,17 @@ void doesntCorrelateWhenSpanIsNotActive() {
         }
     }
 
+    @Test
+    void correlatesBaggageWhenSpanIsForwarding() {
+        final Span span = unit.buildSpan("test").start();
+        final ForwardingSpan wrapped = () -> span;
+
+        try (final Scope ignored = unit.activateSpan(wrapped)) {
+            span.setBaggageItem("request-id", "P6QQkzZHfza9GO");
+            assertEquals("P6QQkzZHfza9GO", MDC.get("request_id"));
+        }
+    }
+
     private SpanContext context(final String key, final String value) {
         return unit.extract(TEXT_MAP_EXTRACT,
                 new TextMapExtractAdapter(ImmutableMap.of(