POTEL 9 - Tracing Fixes and Baggage

sentry-opentelemetry/sentry-opentelemetry-bootstrap/api/sentry-opentelemetry-bootstrap.api

@@ -1,4 +1,6 @@
 public final class io/sentry/opentelemetry/InternalSemanticAttributes {
+	public static final field BAGGAGE Lio/opentelemetry/api/common/AttributeKey;
+	public static final field BAGGAGE_MUTABLE Lio/opentelemetry/api/common/AttributeKey;
 	public static final field IS_REMOTE_PARENT Lio/opentelemetry/api/common/AttributeKey;
 	public static final field PARENT_SAMPLED Lio/opentelemetry/api/common/AttributeKey;
 	public static final field PROFILE_SAMPLED Lio/opentelemetry/api/common/AttributeKey;
@@ -16,7 +18,7 @@ public final class io/sentry/opentelemetry/OtelContextScopesStorage : io/sentry/
 }
 
 public final class io/sentry/opentelemetry/OtelSpanContext : io/sentry/SpanContext {
-	public fun <init> (Lio/opentelemetry/sdk/trace/ReadWriteSpan;Lio/sentry/TracesSamplingDecision;Lio/sentry/opentelemetry/OtelSpanWrapper;)V
+	public fun <init> (Lio/opentelemetry/sdk/trace/ReadWriteSpan;Lio/sentry/TracesSamplingDecision;Lio/sentry/opentelemetry/OtelSpanWrapper;Lio/sentry/Baggage;)V
 	public fun getStatus ()Lio/sentry/SpanStatus;
 	public fun setStatus (Lio/sentry/SpanStatus;)V
 }
@@ -30,7 +32,7 @@ public final class io/sentry/opentelemetry/OtelSpanFactory : io/sentry/ISpanFact
 }
 
 public final class io/sentry/opentelemetry/OtelSpanWrapper : io/sentry/ISpan {
-	public fun <init> (Lio/opentelemetry/sdk/trace/ReadWriteSpan;Lio/sentry/IScopes;Lio/sentry/SentryDate;Lio/sentry/TracesSamplingDecision;Lio/sentry/opentelemetry/OtelSpanWrapper;)V
+	public fun <init> (Lio/opentelemetry/sdk/trace/ReadWriteSpan;Lio/sentry/IScopes;Lio/sentry/SentryDate;Lio/sentry/TracesSamplingDecision;Lio/sentry/opentelemetry/OtelSpanWrapper;Lio/sentry/Baggage;)V
 	public fun finish ()V
 	public fun finish (Lio/sentry/SpanStatus;)V
 	public fun finish (Lio/sentry/SpanStatus;Lio/sentry/SentryDate;)V

sentry-opentelemetry/sentry-opentelemetry-bootstrap/src/main/java/io/sentry/opentelemetry/InternalSemanticAttributes.java

@@ -18,6 +18,9 @@ public final class InternalSemanticAttributes {
       AttributeKey.doubleKey("sentry.profile_sample_rate");
   public static final AttributeKey<Boolean> IS_REMOTE_PARENT =
       AttributeKey.booleanKey("sentry.is_remote_parent");
+  public static final AttributeKey<String> BAGGAGE = AttributeKey.stringKey("sentry.baggage");
+  public static final AttributeKey<Boolean> BAGGAGE_MUTABLE =
+      AttributeKey.booleanKey("sentry.baggage_mutable");
   //  public static final AttributeKey<String> BREADCRUMB_TYPE =
   //      AttributeKey.stringKey("sentry.breadcrumb.type");
   //  public static final AttributeKey<SentryLevel> BREADCRUMB_TYPE =

sentry-opentelemetry/sentry-opentelemetry-bootstrap/src/main/java/io/sentry/opentelemetry/OtelSpanContext.java

@@ -4,6 +4,7 @@
 import io.opentelemetry.api.trace.StatusCode;
 import io.opentelemetry.sdk.trace.ReadWriteSpan;
 import io.opentelemetry.sdk.trace.data.StatusData;
+import io.sentry.Baggage;
 import io.sentry.SpanContext;
 import io.sentry.SpanId;
 import io.sentry.SpanStatus;
@@ -26,7 +27,8 @@ public final class OtelSpanContext extends SpanContext {
   public OtelSpanContext(
       final @NotNull ReadWriteSpan span,
       final @Nullable TracesSamplingDecision samplingDecision,
-      final @Nullable OtelSpanWrapper parentSpan) {
+      final @Nullable OtelSpanWrapper parentSpan,
+      final @Nullable Baggage baggage) {
     super(
         new SentryId(span.getSpanContext().getTraceId()),
         new SpanId(span.getSpanContext().getSpanId()),
@@ -39,6 +41,7 @@ public OtelSpanContext(
         null,
         null);
     this.span = new WeakReference<>(span);
+    this.baggage = baggage;
   }
 
   @Override

sentry-opentelemetry/sentry-opentelemetry-bootstrap/src/main/java/io/sentry/opentelemetry/OtelSpanFactory.java

@@ -7,6 +7,7 @@
 import io.opentelemetry.api.trace.TraceState;
 import io.opentelemetry.api.trace.Tracer;
 import io.opentelemetry.context.Context;
+import io.sentry.Baggage;
 import io.sentry.IScope;
 import io.sentry.IScopes;
 import io.sentry.ISpan;
@@ -104,7 +105,12 @@ public final class OtelSpanFactory implements ISpanFactory {
       }
     }
 
-    // TODO [POTEL] send baggage in (note: won't go through propagators)
+    // note: won't go through propagators
+    final @Nullable Baggage baggage = spanContext.getBaggage();
+    if (baggage != null) {
+      spanBuilder.setAttribute(InternalSemanticAttributes.BAGGAGE_MUTABLE, baggage.isMutable());
+      spanBuilder.setAttribute(InternalSemanticAttributes.BAGGAGE, baggage.toHeaderString(null));
+    }
 
     final @Nullable SentryDate startTimestampFromOptions = spanOptions.getStartTimestamp();
     final @NotNull SentryDate startTimestamp =

sentry-opentelemetry/sentry-opentelemetry-bootstrap/src/main/java/io/sentry/opentelemetry/OtelSpanWrapper.java

@@ -3,6 +3,7 @@
 import io.opentelemetry.api.trace.Span;
 import io.opentelemetry.context.Scope;
 import io.opentelemetry.sdk.trace.ReadWriteSpan;
+import io.sentry.Baggage;
 import io.sentry.BaggageHeader;
 import io.sentry.IScopes;
 import io.sentry.ISentryLifecycleToken;
@@ -25,6 +26,7 @@
 import io.sentry.protocol.MeasurementValue;
 import io.sentry.protocol.SentryId;
 import io.sentry.protocol.TransactionNameSource;
+import io.sentry.protocol.User;
 import io.sentry.util.LazyEvaluator;
 import io.sentry.util.Objects;
 import java.lang.ref.WeakReference;
@@ -34,6 +36,7 @@
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicReference;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -62,6 +65,7 @@ public final class OtelSpanWrapper implements ISpan {
   private final @NotNull Contexts contexts = new Contexts();
   private @Nullable String transactionName;
   private @Nullable TransactionNameSource transactionNameSource;
+  private final @Nullable Baggage baggage;
 
   // TODO [POTEL]
   //  private @Nullable SpanFinishedCallback spanFinishedCallback;
@@ -78,16 +82,28 @@ public final class OtelSpanWrapper implements ISpan {
 
   private @NotNull Deque<ISentryLifecycleToken> tokensToCleanup = new ArrayDeque<>(1);
 
+  // TODO [POTEL] reference root span? for getting root baggage
   public OtelSpanWrapper(
       final @NotNull ReadWriteSpan span,
       final @NotNull IScopes scopes,
       final @NotNull SentryDate startTimestamp,
       final @Nullable TracesSamplingDecision samplingDecision,
-      final @Nullable OtelSpanWrapper parentSpan) {
+      final @Nullable OtelSpanWrapper parentSpan,
+      final @Nullable Baggage baggage) {
     this.scopes = Objects.requireNonNull(scopes, "scopes are required");
     this.span = new WeakReference<>(span);
     this.startTimestamp = startTimestamp;
-    this.context = new OtelSpanContext(span, samplingDecision, parentSpan);
+
+    if (parentSpan != null) {
+      this.baggage = parentSpan.getSpanContext().getBaggage();
+    } else if (baggage != null) {
+      this.baggage = baggage;
+    } else {
+      this.baggage = null;
+      //      this.baggage = new Baggage(scopes.getOptions().getLogger());
+    }
+
+    this.context = new OtelSpanContext(span, samplingDecision, parentSpan, this.baggage);
   }
 
   @Override
@@ -178,15 +194,43 @@ public OtelSpanWrapper(
 
   @Override
   public @Nullable TraceContext traceContext() {
-    //    return transaction.traceContext();
-    // TODO [POTEL]
+    if (scopes.getOptions().isTraceSampling()) {
+      if (baggage != null) {
+        updateBaggageValues();
+        return baggage.toTraceContext();
+      }
+    }
     return null;
   }
 
+  private void updateBaggageValues() {
+    synchronized (this) {
+      if (baggage != null && baggage.isMutable()) {
+        final AtomicReference<User> userAtomicReference = new AtomicReference<>();
+        scopes.configureScope(
+            scope -> {
+              userAtomicReference.set(scope.getUser());
+            });
+        baggage.setValuesFromTransaction(
+            getSpanContext().getTraceId(),
+            userAtomicReference.get(),
+            scopes.getOptions(),
+            this.getSamplingDecision(),
+            getTransactionName(),
+            getTransactionNameSource());
+        baggage.freeze();
+      }
+    }
+  }
+
   @Override
   public @Nullable BaggageHeader toBaggageHeader(@Nullable List<String> thirdPartyBaggageHeaders) {
-    //    return transaction.toBaggageHeader(thirdPartyBaggageHeaders);
-    // TODO [POTEL]
+    if (scopes.getOptions().isTraceSampling()) {
+      if (baggage != null) {
+        updateBaggageValues();
+        return BaggageHeader.fromBaggageAndOutgoingHeader(baggage, thirdPartyBaggageHeaders);
+      }
+    }
     return null;
   }
 

sentry-opentelemetry/sentry-opentelemetry-bootstrap/src/main/java/io/sentry/opentelemetry/OtelTransactionSpanForwarder.java

@@ -77,19 +77,16 @@ public OtelTransactionSpanForwarder(final @NotNull OtelSpanWrapper rootSpan) {
 
   @Override
   public @NotNull SentryTraceHeader toSentryTrace() {
-    // TODO [POTEL] root span?
     return rootSpan.toSentryTrace();
   }
 
   @Override
   public @Nullable TraceContext traceContext() {
-    // TODO [POTEL] root span?
     return rootSpan.traceContext();
   }
 
   @Override
   public @Nullable BaggageHeader toBaggageHeader(@Nullable List<String> thirdPartyBaggageHeaders) {
-    // TODO [POTEL] root span?
     return rootSpan.toBaggageHeader(thirdPartyBaggageHeaders);
   }
 

sentry-opentelemetry/sentry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/PotelSentryPropagator.java

@@ -10,6 +10,7 @@
 import io.opentelemetry.context.propagation.TextMapGetter;
 import io.opentelemetry.context.propagation.TextMapPropagator;
 import io.opentelemetry.context.propagation.TextMapSetter;
+import io.sentry.Baggage;
 import io.sentry.BaggageHeader;
 import io.sentry.IScopes;
 import io.sentry.PropagationContext;
@@ -100,6 +101,7 @@ public <C> Context extract(
       SentryTraceHeader sentryTraceHeader = new SentryTraceHeader(sentryTraceString);
 
       final @Nullable String baggageString = getter.get(carrier, BaggageHeader.BAGGAGE_HEADER);
+      final Baggage baggage = Baggage.fromHeader(baggageString);
       final @NotNull TraceState traceState = TraceState.getDefault();
 
       SpanContext otelSpanContext =
@@ -112,7 +114,11 @@ public <C> Context extract(
       Span wrappedSpan = Span.wrap(otelSpanContext);
 
       final @NotNull Context modifiedContext =
-          context.with(wrappedSpan).with(SENTRY_SCOPES_KEY, scopesToUse);
+          context
+              .with(wrappedSpan)
+              .with(SENTRY_SCOPES_KEY, scopesToUse)
+              .with(SentryOtelKeys.SENTRY_TRACE_KEY, sentryTraceHeader)
+              .with(SentryOtelKeys.SENTRY_BAGGAGE_KEY, baggage);
 
       scopes
           .getOptions()

sentry-opentelemetry/sentry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/PotelSentrySpanProcessor.java

@@ -8,6 +8,7 @@
 import io.opentelemetry.sdk.trace.ReadWriteSpan;
 import io.opentelemetry.sdk.trace.ReadableSpan;
 import io.opentelemetry.sdk.trace.SpanProcessor;
+import io.sentry.Baggage;
 import io.sentry.IScopes;
 import io.sentry.PropagationContext;
 import io.sentry.SamplingContext;
@@ -16,6 +17,7 @@
 import io.sentry.SentryDate;
 import io.sentry.SentryLevel;
 import io.sentry.SentryLongDate;
+import io.sentry.SentryTraceHeader;
 import io.sentry.SpanId;
 import io.sentry.TracesSampler;
 import io.sentry.TracesSamplingDecision;
@@ -54,8 +56,20 @@ public void onStart(final @NotNull Context parentContext, final @NotNull ReadWri
     final @Nullable OtelSpanWrapper sentryParentSpan =
         spanStorage.getSentrySpan(otelSpan.getParentSpanContext());
     @Nullable TracesSamplingDecision samplingDecision = null;
+    // TODO [POTEL] baggage from propagator should be honored
+    @Nullable Baggage baggage = null;
     otelSpan.setAttribute(IS_REMOTE_PARENT, otelSpan.getParentSpanContext().isRemote());
     if (sentryParentSpan == null) {
+      final @Nullable Boolean baggageMutable =
+          otelSpan.getAttribute(InternalSemanticAttributes.BAGGAGE_MUTABLE);
+      final @Nullable String baggageString =
+          otelSpan.getAttribute(InternalSemanticAttributes.BAGGAGE);
+      if (baggageString != null) {
+        baggage = Baggage.fromHeader(baggageString);
+        if (baggageMutable == true) {
+          baggage.freeze();
+        }
+      }
       final @Nullable Boolean sampled = otelSpan.getAttribute(InternalSemanticAttributes.SAMPLED);
       final @Nullable Double sampleRate =
           otelSpan.getAttribute(InternalSemanticAttributes.SAMPLE_RATE);
@@ -73,7 +87,11 @@ public void onStart(final @NotNull Context parentContext, final @NotNull ReadWri
 
         final @NotNull PropagationContext propagationContext =
             new PropagationContext(
-                new SentryId(traceId), new SpanId(spanId), new SpanId(parentSpanId), null, sampled);
+                new SentryId(traceId),
+                new SpanId(spanId),
+                new SpanId(parentSpanId),
+                baggage,
+                sampled);
 
         scopes.configureScope(
             scope -> {
@@ -96,9 +114,19 @@ public void onStart(final @NotNull Context parentContext, final @NotNull ReadWri
 
         final @NotNull String traceId = otelSpan.getSpanContext().getTraceId();
         final @NotNull String spanId = otelSpan.getSpanContext().getSpanId();
+        final @NotNull SpanId sentrySpanId = new SpanId(spanId);
+
+        @Nullable
+        SentryTraceHeader sentryTraceHeader = parentContext.get(SentryOtelKeys.SENTRY_TRACE_KEY);
+        @Nullable Baggage baggageFromContext = parentContext.get(SentryOtelKeys.SENTRY_BAGGAGE_KEY);
+        if (sentryTraceHeader != null) {
+          baggage = baggageFromContext;
+        }
 
         final @NotNull PropagationContext propagationContext =
-            new PropagationContext(new SentryId(traceId), new SpanId(spanId), null, null, null);
+            sentryTraceHeader == null
+                ? new PropagationContext(new SentryId(traceId), sentrySpanId, null, baggage, null)
+                : PropagationContext.fromHeaders(sentryTraceHeader, baggage, sentrySpanId);
 
         scopes.configureScope(
             scope -> {
@@ -118,7 +146,8 @@ public void onStart(final @NotNull Context parentContext, final @NotNull ReadWri
         new SentryLongDate(otelSpan.toSpanData().getStartEpochNanos());
     spanStorage.storeSentrySpan(
         spanContext,
-        new OtelSpanWrapper(otelSpan, scopes, startTimestamp, samplingDecision, sentryParentSpan));
+        new OtelSpanWrapper(
+            otelSpan, scopes, startTimestamp, samplingDecision, sentryParentSpan, baggage));
   }
 
   @Override