Add traceheader to integrattions, address feedback

markushi · markushi · commit be3676bc2a07 · 2025-08-28T12:01:13.000+02:00
diff --git a/sentry-apollo-3/src/main/java/io/sentry/apollo3/SentryApollo3HttpInterceptor.kt b/sentry-apollo-3/src/main/java/io/sentry/apollo3/SentryApollo3HttpInterceptor.kt
@@ -132,6 +132,9 @@ constructor(
                 .toMutableList()
                 .apply { add(HttpHeader(baggageHeader.name, baggageHeader.value)) }
           }
+          it.w3cTraceparentHeader?.let { w3cHeader ->
+            cleanedHeaders.add(HttpHeader(w3cHeader.name, w3cHeader.value))
+          }
         }
     }
 
diff --git a/sentry-apollo-4/src/main/java/io/sentry/apollo4/SentryApollo4HttpInterceptor.kt b/sentry-apollo-4/src/main/java/io/sentry/apollo4/SentryApollo4HttpInterceptor.kt
@@ -132,6 +132,9 @@ constructor(
                 .toMutableList()
                 .apply { add(HttpHeader(baggageHeader.name, baggageHeader.value)) }
           }
+          it.w3cTraceparentHeader?.let { w3cHeader ->
+            cleanedHeaders.add(HttpHeader(w3cHeader.name, w3cHeader.value))
+          }
         }
     }
 
diff --git a/sentry-ktor-client/src/main/java/io/sentry/ktorClient/SentryKtorClientPlugin.kt b/sentry-ktor-client/src/main/java/io/sentry/ktorClient/SentryKtorClientPlugin.kt
@@ -137,6 +137,9 @@ public val SentryKtorClientPlugin: ClientPlugin<SentryKtorClientPluginConfig> =
               request.headers.remove(BaggageHeader.BAGGAGE_HEADER)
               request.headers[it.name] = it.value
             }
+            tracingHeaders.w3cTraceparentHeader?.let {
+              request.headers[it.name] = it.value
+            }
           }
       }
     }
diff --git a/sentry-okhttp/src/main/java/io/sentry/okhttp/SentryOkHttpInterceptor.kt b/sentry-okhttp/src/main/java/io/sentry/okhttp/SentryOkHttpInterceptor.kt
@@ -116,6 +116,9 @@ public open class SentryOkHttpInterceptor(
               requestBuilder.removeHeader(BaggageHeader.BAGGAGE_HEADER)
               requestBuilder.addHeader(it.name, it.value)
             }
+            tracingHeaders.w3cTraceparentHeader?.let {
+              requestBuilder.addHeader(it.name, it.value)
+            }
           }
       }
 
diff --git a/sentry-okhttp/src/test/java/io/sentry/okhttp/SentryOkHttpInterceptorTest.kt b/sentry-okhttp/src/test/java/io/sentry/okhttp/SentryOkHttpInterceptorTest.kt
@@ -645,4 +645,40 @@ class SentryOkHttpInterceptorTest {
     val okHttpEvent = SentryOkHttpEventListener.eventMap[call]!!
     assertTrue(okHttpEvent.isEventFinished.get())
   }
+
+  @Test
+  fun `adds W3C traceparent header when propagateTraceparent is enabled`() {
+    val client = fixture.getSut(
+      optionsConfiguration = Sentry.OptionsConfiguration { it.isPropagateTraceparent = true }
+    )
+    
+    fixture.server.enqueue(MockResponse().setResponseCode(200))
+
+    val request = getRequest("/test")
+    client.newCall(request).execute()
+
+    val recordedRequest = fixture.server.takeRequest()
+    assertNotNull(recordedRequest.getHeader("sentry-trace"))
+    assertNotNull(recordedRequest.getHeader("traceparent"))
+    
+    val traceparent = recordedRequest.getHeader("traceparent")!!
+    assertTrue(traceparent.startsWith("00-"))
+    assertEquals(4, traceparent.split("-").size)
+  }
+
+  @Test
+  fun `does not add W3C traceparent header when propagateTraceparent is disabled`() {
+    val client = fixture.getSut(
+      optionsConfiguration = Sentry.OptionsConfiguration { it.isPropagateTraceparent = false }
+    )
+    
+    fixture.server.enqueue(MockResponse().setResponseCode(200))
+
+    val request = getRequest("/test")
+    client.newCall(request).execute()
+
+    val recordedRequest = fixture.server.takeRequest()
+    assertNotNull(recordedRequest.getHeader("sentry-trace"))
+    assertNull(recordedRequest.getHeader("traceparent"))
+  }
 }
diff --git a/sentry-openfeign/src/main/java/io/sentry/openfeign/SentryFeignClient.java b/sentry-openfeign/src/main/java/io/sentry/openfeign/SentryFeignClient.java
@@ -17,6 +17,7 @@
 import io.sentry.SpanDataConvention;
 import io.sentry.SpanOptions;
 import io.sentry.SpanStatus;
+import io.sentry.W3CTraceparentHeader;
 import io.sentry.util.Objects;
 import io.sentry.util.SpanUtils;
 import io.sentry.util.TracingUtils;
@@ -137,6 +138,11 @@ public Response execute(final @NotNull Request request, final @NotNull Request.O
         requestWrapper.removeHeader(BaggageHeader.BAGGAGE_HEADER);
         requestWrapper.header(baggageHeader.getName(), baggageHeader.getValue());
       }
+
+      final @Nullable W3CTraceparentHeader w3cTraceparentHeader = tracingHeaders.getW3cTraceparentHeader();
+      if (w3cTraceparentHeader != null) {
+        requestWrapper.header(w3cTraceparentHeader.getName(), w3cTraceparentHeader.getValue());
+      }
     }
 
     return requestWrapper.build();
diff --git a/sentry-spring-7/src/main/java/io/sentry/spring7/tracing/SentrySpanClientHttpRequestInterceptor.java b/sentry-spring-7/src/main/java/io/sentry/spring7/tracing/SentrySpanClientHttpRequestInterceptor.java
@@ -6,6 +6,7 @@
 
 import com.jakewharton.nopen.annotation.Open;
 import io.sentry.BaggageHeader;
+import io.sentry.W3CTraceparentHeader;
 import io.sentry.Breadcrumb;
 import io.sentry.Hint;
 import io.sentry.IScopes;
@@ -113,6 +114,11 @@ private void maybeAddTracingHeaders(
       if (baggageHeader != null) {
         request.getHeaders().set(baggageHeader.getName(), baggageHeader.getValue());
       }
+
+      final @Nullable W3CTraceparentHeader w3cTraceparentHeader = tracingHeaders.getW3cTraceparentHeader();
+      if (w3cTraceparentHeader != null) {
+        request.getHeaders().add(w3cTraceparentHeader.getName(), w3cTraceparentHeader.getValue());
+      }
     }
   }
 
diff --git a/sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/tracing/SentrySpanClientHttpRequestInterceptor.java b/sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/tracing/SentrySpanClientHttpRequestInterceptor.java
@@ -6,6 +6,7 @@
 
 import com.jakewharton.nopen.annotation.Open;
 import io.sentry.BaggageHeader;
+import io.sentry.W3CTraceparentHeader;
 import io.sentry.Breadcrumb;
 import io.sentry.Hint;
 import io.sentry.IScopes;
@@ -113,6 +114,11 @@ private void maybeAddTracingHeaders(
       if (baggageHeader != null) {
         request.getHeaders().set(baggageHeader.getName(), baggageHeader.getValue());
       }
+
+      final @Nullable W3CTraceparentHeader w3cTraceparentHeader = tracingHeaders.getW3cTraceparentHeader();
+      if (w3cTraceparentHeader != null) {
+        request.getHeaders().add(w3cTraceparentHeader.getName(), w3cTraceparentHeader.getValue());
+      }
     }
   }
 
diff --git a/sentry-spring/src/main/java/io/sentry/spring/tracing/SentrySpanClientHttpRequestInterceptor.java b/sentry-spring/src/main/java/io/sentry/spring/tracing/SentrySpanClientHttpRequestInterceptor.java
@@ -13,6 +13,7 @@
 import io.sentry.SpanDataConvention;
 import io.sentry.SpanOptions;
 import io.sentry.SpanStatus;
+import io.sentry.W3CTraceparentHeader;
 import io.sentry.util.Objects;
 import io.sentry.util.SpanUtils;
 import io.sentry.util.TracingUtils;
@@ -105,6 +106,11 @@ private void maybeAddTracingHeaders(
       if (baggageHeader != null) {
         request.getHeaders().set(baggageHeader.getName(), baggageHeader.getValue());
       }
+
+      final @Nullable W3CTraceparentHeader w3cTraceparentHeader = tracingHeaders.getW3cTraceparentHeader();
+      if (w3cTraceparentHeader != null) {
+        request.getHeaders().add(w3cTraceparentHeader.getName(), w3cTraceparentHeader.getValue());
+      }
     }
   }
 
diff --git a/sentry/api/sentry.api b/sentry/api/sentry.api
@@ -4328,10 +4328,7 @@ public final class io/sentry/W3CTraceparentHeader {
 	public static final field TRACEPARENT_HEADER Ljava/lang/String;
 	public fun <init> (Lio/sentry/protocol/SentryId;Lio/sentry/SpanId;Ljava/lang/Boolean;)V
 	public fun getName ()Ljava/lang/String;
-	public fun getSpanId ()Lio/sentry/SpanId;
-	public fun getTraceId ()Lio/sentry/protocol/SentryId;
 	public fun getValue ()Ljava/lang/String;
-	public fun isSampled ()Ljava/lang/Boolean;
 }
 
 public final class io/sentry/backpressure/BackpressureMonitor : io/sentry/backpressure/IBackpressureMonitor, java/lang/Runnable {
diff --git a/sentry/src/main/java/io/sentry/W3CTraceparentHeader.java b/sentry/src/main/java/io/sentry/W3CTraceparentHeader.java
@@ -27,18 +27,7 @@ public W3CTraceparentHeader(
 
   public @NotNull String getValue() {
     String sampledFlag = sampled != null && sampled ? "01" : "00";
-    return String.format("00-%s-%s-%s", traceId, spanId, sampledFlag);
+    return String.format("%s-%s-%s", traceId, spanId, sampledFlag);
   }
 
-  public @NotNull SentryId getTraceId() {
-    return traceId;
-  }
-
-  public @NotNull SpanId getSpanId() {
-    return spanId;
-  }
-
-  public @Nullable Boolean isSampled() {
-    return sampled;
-  }
 }
diff --git a/sentry/src/test/java/io/sentry/W3CTraceparentHeaderTest.kt b/sentry/src/test/java/io/sentry/W3CTraceparentHeaderTest.kt
@@ -3,8 +3,6 @@ package io.sentry
 import io.sentry.protocol.SentryId
 import kotlin.test.Test
 import kotlin.test.assertEquals
-import kotlin.test.assertNull
-import kotlin.test.assertTrue
 
 class W3CTraceparentHeaderTest {
 
@@ -15,10 +13,7 @@ class W3CTraceparentHeaderTest {
     val header = W3CTraceparentHeader(traceId, spanId, true)
 
     assertEquals("traceparent", header.name)
-    assertEquals("00-12345678123456781234567812345678-1234567812345678-01", header.value)
-    assertEquals(traceId, header.traceId)
-    assertEquals(spanId, header.spanId)
-    assertTrue(header.isSampled() ?: false)
+    assertEquals("12345678123456781234567812345678-1234567812345678-01", header.value)
   }
 
   @Test
@@ -28,10 +23,7 @@ class W3CTraceparentHeaderTest {
     val header = W3CTraceparentHeader(traceId, spanId, false)
 
     assertEquals("traceparent", header.name)
-    assertEquals("00-12345678123456781234567812345678-1234567812345678-00", header.value)
-    assertEquals(traceId, header.traceId)
-    assertEquals(spanId, header.spanId)
-    assertEquals(false, header.isSampled())
+    assertEquals("12345678123456781234567812345678-1234567812345678-00", header.value)
   }
 
   @Test
@@ -41,10 +33,7 @@ class W3CTraceparentHeaderTest {
     val header = W3CTraceparentHeader(traceId, spanId, null)
 
     assertEquals("traceparent", header.name)
-    assertEquals("00-12345678123456781234567812345678-1234567812345678-00", header.value)
-    assertEquals(traceId, header.traceId)
-    assertEquals(spanId, header.spanId)
-    assertNull(header.isSampled())
+    assertEquals("12345678123456781234567812345678-1234567812345678-00", header.value)
   }
 
   @Test
@@ -56,10 +45,9 @@ class W3CTraceparentHeaderTest {
     val value = header.value
     val parts = value.split("-")
 
-    assertEquals(4, parts.size)
-    assertEquals("00", parts[0]) // Version
-    assertEquals("abcdefabcdefabcdabcdefabcdefabcd", parts[1]) // Trace ID (32 hex chars)
-    assertEquals("abcdefabcdefabcd", parts[2]) // Span ID (16 hex chars)
-    assertEquals("01", parts[3]) // Sampled flag
+    assertEquals(3, parts.size)
+    assertEquals("abcdefabcdefabcdabcdefabcdefabcd", parts[0]) // Trace ID (32 chars)
+    assertEquals("abcdefabcdefabcd", parts[1]) // Span ID (16 chars)
+    assertEquals("01", parts[2]) // Sampled flag (2 chars)
   }
 }
diff --git a/sentry/src/test/java/io/sentry/util/TracingUtilsTest.kt b/sentry/src/test/java/io/sentry/util/TracingUtilsTest.kt
@@ -469,8 +469,14 @@ class TracingUtilsTest {
     assertNotNull(tracingHeaders.sentryTraceHeader)
     assertNotNull(tracingHeaders.w3cTraceparentHeader)
     assertEquals("traceparent", tracingHeaders.w3cTraceparentHeader!!.name)
-    assertEquals(fixture.span.spanContext.traceId, tracingHeaders.w3cTraceparentHeader!!.traceId)
-    assertEquals(fixture.span.spanContext.spanId, tracingHeaders.w3cTraceparentHeader!!.spanId)
+    
+    val headerValue = tracingHeaders.w3cTraceparentHeader!!.value
+    assertTrue(headerValue.startsWith("00-"))
+    
+    val parts = headerValue.split("-")
+    assertEquals(4, parts.size)
+    assertEquals(fixture.span.spanContext.traceId.toString(), parts[1])
+    assertEquals(fixture.span.spanContext.spanId.toString(), parts[2])
   }
 
   @Test
@@ -483,7 +489,17 @@ class TracingUtilsTest {
 
     assertNotNull(tracingHeaders)
     val w3cHeader = tracingHeaders.w3cTraceparentHeader!!
-    assertEquals(fixture.span.toSentryTrace().isSampled(), w3cHeader.isSampled())
+    assertEquals("traceparent", w3cHeader.name)
+    
+    val headerValue = w3cHeader.value
+    assertTrue(headerValue.startsWith("00-"))
+    
+    val parts = headerValue.split("-")
+    assertEquals(4, parts.size)
+    
+    val sentryTrace = fixture.span.toSentryTrace()
+    val expectedFlag = if (sentryTrace.isSampled() == true) "01" else "00"
+    assertEquals(expectedFlag, parts[3])
   }
 
   @Test
@@ -498,11 +514,13 @@ class TracingUtilsTest {
     assertNotNull(tracingHeaders.sentryTraceHeader)
     assertNotNull(tracingHeaders.w3cTraceparentHeader)
 
-    val sentryTrace = tracingHeaders.sentryTraceHeader
     val w3cTrace = tracingHeaders.w3cTraceparentHeader!!
-
-    assertEquals(sentryTrace.traceId, w3cTrace.traceId)
-    assertEquals(sentryTrace.spanId, w3cTrace.spanId)
-    assertEquals(sentryTrace.isSampled(), w3cTrace.isSampled())
+    assertEquals("traceparent", w3cTrace.name)
+    
+    val headerValue = w3cTrace.value
+    assertTrue(headerValue.startsWith("00-"))
+    
+    val parts = headerValue.split("-")
+    assertEquals(4, parts.size)
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -132,6 +132,9 @@ constructor(`
`132`	`132`	`.toMutableList()`
`133`	`133`	`.apply { add(HttpHeader(baggageHeader.name, baggageHeader.value)) }`
`134`	`134`	`}`
	`135`	`+ it.w3cTraceparentHeader?.let { w3cHeader ->`
	`136`	`+ cleanedHeaders.add(HttpHeader(w3cHeader.name, w3cHeader.value))`
	`137`	`+ }`
`135`	`138`	`}`
`136`	`139`	`}`
`137`	`140`
Original file line number	Diff line number	Diff line change
`@@ -137,6 +137,9 @@ public val SentryKtorClientPlugin: ClientPlugin<SentryKtorClientPluginConfig> =`
`137`	`137`	`request.headers.remove(BaggageHeader.BAGGAGE_HEADER)`
`138`	`138`	`request.headers[it.name] = it.value`
`139`	`139`	`}`
	`140`	`+ tracingHeaders.w3cTraceparentHeader?.let {`
	`141`	`+ request.headers[it.name] = it.value`
	`142`	`+ }`
`140`	`143`	`}`
`141`	`144`	`}`
`142`	`145`	`}`
Original file line number	Diff line number	Diff line change
`@@ -116,6 +116,9 @@ public open class SentryOkHttpInterceptor(`
`116`	`116`	`requestBuilder.removeHeader(BaggageHeader.BAGGAGE_HEADER)`
`117`	`117`	`requestBuilder.addHeader(it.name, it.value)`
`118`	`118`	`}`
	`119`	`+ tracingHeaders.w3cTraceparentHeader?.let {`
	`120`	`+ requestBuilder.addHeader(it.name, it.value)`
	`121`	`+ }`
`119`	`122`	`}`
`120`	`123`	`}`
`121`	`124`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`
`7`	`7`	`import com.jakewharton.nopen.annotation.Open;`
`8`	`8`	`import io.sentry.BaggageHeader;`
	`9`	`+import io.sentry.W3CTraceparentHeader;`
`9`	`10`	`import io.sentry.Breadcrumb;`
`10`	`11`	`import io.sentry.Hint;`
`11`	`12`	`import io.sentry.IScopes;`
`@@ -113,6 +114,11 @@ private void maybeAddTracingHeaders(`
`113`	`114`	`if (baggageHeader != null) {`
`114`	`115`	`request.getHeaders().set(baggageHeader.getName(), baggageHeader.getValue());`
`115`	`116`	`}`
	`117`	`+`
	`118`	`+ final @Nullable W3CTraceparentHeader w3cTraceparentHeader = tracingHeaders.getW3cTraceparentHeader();`
	`119`	`+ if (w3cTraceparentHeader != null) {`
	`120`	`+ request.getHeaders().add(w3cTraceparentHeader.getName(), w3cTraceparentHeader.getValue());`
	`121`	`+ }`
`116`	`122`	`}`
`117`	`123`	`}`
`118`	`124`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`	`import io.sentry.SpanDataConvention;`
`14`	`14`	`import io.sentry.SpanOptions;`
`15`	`15`	`import io.sentry.SpanStatus;`
	`16`	`+import io.sentry.W3CTraceparentHeader;`
`16`	`17`	`import io.sentry.util.Objects;`
`17`	`18`	`import io.sentry.util.SpanUtils;`
`18`	`19`	`import io.sentry.util.TracingUtils;`
`@@ -105,6 +106,11 @@ private void maybeAddTracingHeaders(`
`105`	`106`	`if (baggageHeader != null) {`
`106`	`107`	`request.getHeaders().set(baggageHeader.getName(), baggageHeader.getValue());`
`107`	`108`	`}`
	`109`	`+`
	`110`	`+ final @Nullable W3CTraceparentHeader w3cTraceparentHeader = tracingHeaders.getW3cTraceparentHeader();`
	`111`	`+ if (w3cTraceparentHeader != null) {`
	`112`	`+ request.getHeaders().add(w3cTraceparentHeader.getName(), w3cTraceparentHeader.getValue());`
	`113`	`+ }`
`108`	`114`	`}`
`109`	`115`	`}`
`110`	`116`