Fix returning Sentry trace header from Span.

CHANGELOG.md

@@ -1,6 +1,7 @@
 # vNext
 
 * Feat: Support logging via JUL (#1211)
+* Fix: Fix returning Sentry trace header from Span (#1217)
 
 # 4.0.0
 

sentry-spring-boot-starter/src/test/kotlin/io/sentry/spring/boot/SentrySpanRestTemplateCustomizerTest.kt

@@ -10,7 +10,6 @@ import io.sentry.SpanContext
 import io.sentry.SpanStatus
 import kotlin.test.Test
 import org.assertj.core.api.Assertions.assertThat
-import org.hamcrest.core.IsNull
 import org.springframework.http.HttpMethod
 import org.springframework.http.HttpStatus
 import org.springframework.http.MediaType
@@ -24,7 +23,7 @@ class SentrySpanRestTemplateCustomizerTest {
         val hub = mock<IHub>()
         val restTemplate = RestTemplate()
         var mockServer = MockRestServiceServer.createServer(restTemplate)
-        val transaction = SentryTransaction("aTransaction", SpanContext(), hub)
+        val transaction = SentryTransaction("aTransaction", SpanContext(true), hub)
         internal val customizer = SentrySpanRestTemplateCustomizer(hub)
 
         fun getSut(isTransactionActive: Boolean, status: HttpStatus = HttpStatus.OK): RestTemplate {
@@ -37,7 +36,12 @@ class SentrySpanRestTemplateCustomizerTest {
 
                 mockServer.expect(MockRestRequestMatchers.requestTo("/test/123"))
                     .andExpect(MockRestRequestMatchers.method(HttpMethod.GET))
-                    .andExpect(MockRestRequestMatchers.header("sentry-trace", IsNull.notNullValue()))
+                    .andExpect {
+                        // must have trace id from the parent transaction and must not contain spanId from the parent transaction
+                        assertThat(it.headers["sentry-trace"]!!.first()).startsWith(transaction.spanContext.traceId.toString())
+                            .endsWith("-1")
+                            .doesNotContain(transaction.spanContext.spanId.toString())
+                    }
                     .andRespond(MockRestResponseCreators.withStatus(status).body("OK").contentType(MediaType.APPLICATION_JSON))
             } else {
                 mockServer.expect(MockRestRequestMatchers.requestTo("/test/123"))

sentry-spring/src/main/java/io/sentry/spring/tracing/SentrySpanClientHttpRequestInterceptor.java

@@ -45,7 +45,7 @@ public SentrySpanClientHttpRequestInterceptor(final @NotNull IHub hub) {
     span.setDescription(
         request.getMethodValue() + " " + ensureLeadingSlash(urlTemplate.get().poll()));
 
-    final SentryTraceHeader sentryTraceHeader = activeSpan.toSentryTrace();
+    final SentryTraceHeader sentryTraceHeader = span.toSentryTrace();
     request.getHeaders().add(sentryTraceHeader.getName(), sentryTraceHeader.getValue());
     try {
       final ClientHttpResponse response = execution.execute(request, body);

sentry/api/sentry.api

@@ -937,8 +937,10 @@ public class io/sentry/SpanContext : java/lang/Cloneable {
 	public fun getOperation ()Ljava/lang/String;
 	public fun getParentSpanId ()Lio/sentry/SpanId;
 	public fun getSampled ()Ljava/lang/Boolean;
+	public fun getSpanId ()Lio/sentry/SpanId;
 	public fun getStatus ()Lio/sentry/SpanStatus;
 	public fun getTags ()Ljava/util/Map;
+	public fun getTraceId ()Lio/sentry/protocol/SentryId;
 	public fun setDescription (Ljava/lang/String;)V
 	public fun setOperation (Ljava/lang/String;)V
 	public fun setStatus (Lio/sentry/SpanStatus;)V

sentry/src/main/java/io/sentry/Span.java

@@ -56,7 +56,7 @@ public final class Span extends SpanContext implements ISpan {
 
   @Override
   public @NotNull SentryTraceHeader toSentryTrace() {
-    return transaction.toSentryTrace();
+    return new SentryTraceHeader(getTraceId(), getSpanId(), getSampled());
   }
 
   @Override

sentry/src/main/java/io/sentry/SpanContext.java

@@ -80,12 +80,12 @@ public void setStatus(final @Nullable SpanStatus status) {
   }
 
   @NotNull
-  SentryId getTraceId() {
+  public SentryId getTraceId() {
     return traceId;
   }
 
   @NotNull
-  SpanId getSpanId() {
+  public SpanId getSpanId() {
     return spanId;
   }
 

sentry/src/test/java/io/sentry/SpanTest.kt

@@ -50,6 +50,20 @@ class SpanTest {
         assertEquals("description", child.description)
     }
 
+    @Test
+    fun `converts to Sentry trace header`() {
+        val traceId = SentryId()
+        val parentSpanId = SpanId()
+        val hub = mock<IHub>()
+        val span = Span(traceId, parentSpanId, SentryTransaction(TransactionContext("name", true), hub), hub)
+        val sentryTrace = span.toSentryTrace()
+        assertEquals(traceId, sentryTrace.traceId)
+        assertEquals(span.spanId, sentryTrace.spanId)
+        assertNotNull(sentryTrace.isSampled) {
+            assertTrue(it)
+        }
+    }
+
     @Test
     fun `starting a child with details adds span to transaction`() {
         val transaction = SentryTransaction("name")