POTEL 7 - Tracing

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

@@ -1,11 +1,10 @@
 public final class io/sentry/opentelemetry/InternalSemanticAttributes {
-	public static final field BREADCRUMB_TYPE Lio/opentelemetry/api/common/AttributeKey;
 	public static final field IS_REMOTE_PARENT Lio/opentelemetry/api/common/AttributeKey;
-	public static final field OP Lio/opentelemetry/api/common/AttributeKey;
-	public static final field ORIGIN 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;
+	public static final field PROFILE_SAMPLE_RATE Lio/opentelemetry/api/common/AttributeKey;
+	public static final field SAMPLED Lio/opentelemetry/api/common/AttributeKey;
 	public static final field SAMPLE_RATE Lio/opentelemetry/api/common/AttributeKey;
-	public static final field SOURCE Lio/opentelemetry/api/common/AttributeKey;
 	public fun <init> ()V
 }
 
@@ -17,20 +16,21 @@ 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/opentelemetry/api/trace/Span;)V
+	public fun <init> (Lio/opentelemetry/sdk/trace/ReadWriteSpan;Lio/sentry/TracesSamplingDecision;Lio/sentry/opentelemetry/OtelSpanWrapper;)V
 	public fun getStatus ()Lio/sentry/SpanStatus;
 	public fun setStatus (Lio/sentry/SpanStatus;)V
 }
 
 public final class io/sentry/opentelemetry/OtelSpanFactory : io/sentry/ISpanFactory {
 	public fun <init> ()V
-	public fun createSpan (Ljava/lang/String;Ljava/lang/String;Lio/sentry/IScopes;Lio/sentry/SpanOptions;Lio/sentry/ISpan;)Lio/sentry/ISpan;
+	public fun createSpan (Ljava/lang/String;Ljava/lang/String;Lio/sentry/IScopes;Lio/sentry/SpanOptions;Lio/sentry/SpanContext;Lio/sentry/ISpan;)Lio/sentry/ISpan;
 	public fun createTransaction (Lio/sentry/TransactionContext;Lio/sentry/IScopes;Lio/sentry/TransactionOptions;Lio/sentry/TransactionPerformanceCollector;)Lio/sentry/ITransaction;
+	public fun retrieveCurrentSpan (Lio/sentry/IScope;)Lio/sentry/ISpan;
 	public fun retrieveCurrentSpan (Lio/sentry/IScopes;)Lio/sentry/ISpan;
 }
 
 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/opentelemetry/api/trace/Span;)V
+	public fun <init> (Lio/opentelemetry/sdk/trace/ReadWriteSpan;Lio/sentry/IScopes;Lio/sentry/SentryDate;Lio/sentry/TracesSamplingDecision;Lio/sentry/opentelemetry/OtelSpanWrapper;)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

@@ -4,17 +4,22 @@
 
 // TODO [POTEL] context key vs attribute key
 public final class InternalSemanticAttributes {
-  public static final AttributeKey<String> ORIGIN = AttributeKey.stringKey("sentry.origin");
-  public static final AttributeKey<String> OP = AttributeKey.stringKey("sentry.op");
-  public static final AttributeKey<String> SOURCE = AttributeKey.stringKey("sentry.source");
+  //  public static final AttributeKey<String> ORIGIN = AttributeKey.stringKey("sentry.origin");
+  //  public static final AttributeKey<String> OP = AttributeKey.stringKey("sentry.op");
+  //  public static final AttributeKey<String> SOURCE = AttributeKey.stringKey("sentry.source");
+  public static final AttributeKey<Boolean> SAMPLED = AttributeKey.booleanKey("sentry.sampled");
   public static final AttributeKey<Double> SAMPLE_RATE =
       AttributeKey.doubleKey("sentry.sample_rate");
   public static final AttributeKey<Boolean> PARENT_SAMPLED =
-      AttributeKey.booleanKey("sentry.parentSampled");
+      AttributeKey.booleanKey("sentry.parent_sampled");
+  public static final AttributeKey<Boolean> PROFILE_SAMPLED =
+      AttributeKey.booleanKey("sentry.profile_sampled");
+  public static final AttributeKey<Double> PROFILE_SAMPLE_RATE =
+      AttributeKey.doubleKey("sentry.profile_sample_rate");
   public static final AttributeKey<Boolean> IS_REMOTE_PARENT =
-      AttributeKey.booleanKey("sentry.isParentRemote");
-  public static final AttributeKey<String> BREADCRUMB_TYPE =
-      AttributeKey.stringKey("sentry.breadcrumb.type");
+      AttributeKey.booleanKey("sentry.is_remote_parent");
+  //  public static final AttributeKey<String> BREADCRUMB_TYPE =
+  //      AttributeKey.stringKey("sentry.breadcrumb.type");
   //  public static final AttributeKey<SentryLevel> BREADCRUMB_TYPE =
   // InternalAttributeKeyImpl.create("sentry.breadcrumb.type", SentryLevel.class);
   //  BREADCRUMB_TYPE("sentry.breadcrumb.type"),

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

@@ -7,6 +7,7 @@
 import io.sentry.SpanContext;
 import io.sentry.SpanId;
 import io.sentry.SpanStatus;
+import io.sentry.TracesSamplingDecision;
 import io.sentry.protocol.SentryId;
 import java.lang.ref.WeakReference;
 import org.jetbrains.annotations.NotNull;
@@ -22,15 +23,19 @@ public final class OtelSpanContext extends SpanContext {
    */
   private final @NotNull WeakReference<ReadWriteSpan> span;
 
-  public OtelSpanContext(final @NotNull ReadWriteSpan span, final @Nullable Span parentSpan) {
-    // TODO [POTEL] tracesSamplingDecision
+  public OtelSpanContext(
+      final @NotNull ReadWriteSpan span,
+      final @Nullable TracesSamplingDecision samplingDecision,
+      final @Nullable OtelSpanWrapper parentSpan) {
     super(
         new SentryId(span.getSpanContext().getTraceId()),
         new SpanId(span.getSpanContext().getSpanId()),
-        parentSpan == null ? null : new SpanId(parentSpan.getSpanContext().getSpanId()),
+        parentSpan == null ? null : parentSpan.getSpanContext().getSpanId(),
         span.getName(),
         null,
-        null,
+        samplingDecision != null
+            ? samplingDecision
+            : (parentSpan == null ? null : parentSpan.getSamplingDecision()),
         null,
         null);
     this.span = new WeakReference<>(span);

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

@@ -3,19 +3,26 @@
 import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.api.trace.Span;
 import io.opentelemetry.api.trace.SpanBuilder;
+import io.opentelemetry.api.trace.TraceFlags;
+import io.opentelemetry.api.trace.TraceState;
 import io.opentelemetry.api.trace.Tracer;
 import io.opentelemetry.context.Context;
+import io.sentry.IScope;
 import io.sentry.IScopes;
 import io.sentry.ISpan;
 import io.sentry.ISpanFactory;
 import io.sentry.ITransaction;
 import io.sentry.NoOpSpan;
 import io.sentry.NoOpTransaction;
 import io.sentry.SentryDate;
+import io.sentry.SpanContext;
+import io.sentry.SpanId;
 import io.sentry.SpanOptions;
+import io.sentry.TracesSamplingDecision;
 import io.sentry.TransactionContext;
 import io.sentry.TransactionOptions;
 import io.sentry.TransactionPerformanceCollector;
+import io.sentry.protocol.SentryId;
 import java.util.concurrent.TimeUnit;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
@@ -34,7 +41,13 @@ public final class OtelSpanFactory implements ISpanFactory {
       @Nullable TransactionPerformanceCollector transactionPerformanceCollector) {
     final @Nullable OtelSpanWrapper span =
         createSpanInternal(
-            context.getName(), context.getDescription(), scopes, transactionOptions, null);
+            context.getName(),
+            context.getDescription(),
+            scopes,
+            transactionOptions,
+            null,
+            context.getSamplingDecision(),
+            context);
     if (span == null) {
       return NoOpTransaction.getInstance();
     }
@@ -47,9 +60,13 @@ public final class OtelSpanFactory implements ISpanFactory {
       final @Nullable String description,
       final @NotNull IScopes scopes,
       final @NotNull SpanOptions spanOptions,
+      final @NotNull SpanContext spanContext,
       final @Nullable ISpan parentSpan) {
+    final @Nullable TracesSamplingDecision samplingDecision =
+        parentSpan == null ? null : parentSpan.getSamplingDecision();
     final @Nullable OtelSpanWrapper span =
-        createSpanInternal(name, description, scopes, spanOptions, parentSpan);
+        createSpanInternal(
+            name, description, scopes, spanOptions, parentSpan, samplingDecision, spanContext);
     if (span == null) {
       return NoOpSpan.getInstance();
     }
@@ -61,29 +78,72 @@ public final class OtelSpanFactory implements ISpanFactory {
       final @Nullable String description,
       final @NotNull IScopes scopes,
       final @NotNull SpanOptions spanOptions,
-      final @Nullable ISpan parentSpan) {
+      final @Nullable ISpan parentSpan,
+      final @Nullable TracesSamplingDecision samplingDecision,
+      final @NotNull SpanContext spanContext) {
     final @NotNull SpanBuilder spanBuilder = getTracer().spanBuilder(name);
+    // TODO [POTEL] If performance is disabled, can we use otel.SamplingDecision.RECORD_ONLY to
+    // still allow otel to be used for tracing
     if (parentSpan == null) {
-      spanBuilder.setNoParent();
+      final @NotNull SentryId traceId = spanContext.getTraceId();
+      final @Nullable SpanId parentSpanId = spanContext.getParentSpanId();
+      if (parentSpanId == null) {
+        final @NotNull io.opentelemetry.api.trace.SpanContext otelSpanContext =
+            io.opentelemetry.api.trace.SpanContext.create(
+                traceId.toString(),
+                io.opentelemetry.api.trace.SpanId.getInvalid(),
+                TraceFlags.getSampled(),
+                TraceState.getDefault());
+        final @NotNull Span wrappedSpan = Span.wrap(otelSpanContext);
+        spanBuilder.setParent(Context.root().with(wrappedSpan));
+      } else {
+        final @NotNull io.opentelemetry.api.trace.SpanContext otelSpanContext =
+            io.opentelemetry.api.trace.SpanContext.createFromRemoteParent(
+                traceId.toString(),
+                parentSpanId.toString(),
+                TraceFlags.getSampled(),
+                TraceState.getDefault());
+        final @NotNull Span wrappedSpan = Span.wrap(otelSpanContext);
+        spanBuilder.setParent(Context.root().with(wrappedSpan));
+      }
     } else {
       if (parentSpan instanceof OtelSpanWrapper) {
         // TODO [POTEL] retrieve context from span
         //      spanBuilder.setParent()
       }
     }
 
+    // TODO [POTEL] send baggage in (note: won't go through propagators)
+
     final @Nullable SentryDate startTimestampFromOptions = spanOptions.getStartTimestamp();
     final @NotNull SentryDate startTimestamp =
         startTimestampFromOptions == null
             ? scopes.getOptions().getDateProvider().now()
             : startTimestampFromOptions;
     spanBuilder.setStartTimestamp(startTimestamp.nanoTimestamp(), TimeUnit.NANOSECONDS);
 
+    if (samplingDecision != null) {
+      spanBuilder.setAttribute(InternalSemanticAttributes.SAMPLED, samplingDecision.getSampled());
+      spanBuilder.setAttribute(
+          InternalSemanticAttributes.SAMPLE_RATE, samplingDecision.getSampleRate());
+      spanBuilder.setAttribute(
+          InternalSemanticAttributes.PROFILE_SAMPLED, samplingDecision.getProfileSampled());
+      spanBuilder.setAttribute(
+          InternalSemanticAttributes.PROFILE_SAMPLE_RATE, samplingDecision.getProfileSampleRate());
+    }
+
     final @NotNull Span otelSpan = spanBuilder.startSpan();
+
     final @Nullable OtelSpanWrapper sentrySpan = storage.getSentrySpan(otelSpan.getSpanContext());
-    if (sentrySpan != null && description != null) {
-      sentrySpan.setDescription(description);
+    if (sentrySpan != null) {
+      if (description != null) {
+        sentrySpan.setDescription(description);
+      }
+      if (samplingDecision != null) {
+        sentrySpan.getSpanContext().setSamplingDecision(samplingDecision);
+      }
     }
+
     return sentrySpan;
   }
 
@@ -96,6 +156,15 @@ public final class OtelSpanFactory implements ISpanFactory {
     return storage.getSentrySpan(span.getSpanContext());
   }
 
+  @Override
+  public @Nullable ISpan retrieveCurrentSpan(IScope scope) {
+    final @Nullable Span span = Span.fromContextOrNull(Context.current());
+    if (span == null) {
+      return null;
+    }
+    return storage.getSentrySpan(span.getSpanContext());
+  }
+
   private @NotNull Tracer getTracer() {
     return GlobalOpenTelemetry.getTracer(
         "sentry-instrumentation-scope-name", "sentry-instrumentation-scope-version");

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

@@ -28,6 +28,8 @@
 import io.sentry.util.LazyEvaluator;
 import io.sentry.util.Objects;
 import java.lang.ref.WeakReference;
+import java.util.ArrayDeque;
+import java.util.Deque;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
@@ -74,15 +76,18 @@ public final class OtelSpanWrapper implements ISpan {
   /** A throwable thrown during the execution of the span. */
   private @Nullable Throwable throwable;
 
+  private @NotNull Deque<ISentryLifecycleToken> tokensToCleanup = new ArrayDeque<>(1);
+
   public OtelSpanWrapper(
       final @NotNull ReadWriteSpan span,
       final @NotNull IScopes scopes,
       final @NotNull SentryDate startTimestamp,
-      final @Nullable Span parentSpan) {
+      final @Nullable TracesSamplingDecision samplingDecision,
+      final @Nullable OtelSpanWrapper parentSpan) {
     this.scopes = Objects.requireNonNull(scopes, "scopes are required");
     this.span = new WeakReference<>(span);
     this.startTimestamp = startTimestamp;
-    this.context = new OtelSpanContext(span, parentSpan);
+    this.context = new OtelSpanContext(span, samplingDecision, parentSpan);
   }
 
   @Override
@@ -100,7 +105,7 @@ public OtelSpanWrapper(
     return scopes
         .getOptions()
         .getSpanFactory()
-        .createSpan(operation, description, scopes, spanOptions, this);
+        .createSpan(operation, description, scopes, spanOptions, context, this);
   }
 
   @Override
@@ -131,7 +136,7 @@ public OtelSpanWrapper(
     return scopes
         .getOptions()
         .getSpanFactory()
-        .createSpan(operation, description, scopes, spanOptions, this);
+        .createSpan(operation, description, scopes, spanOptions, context, this);
   }
 
   @Override
@@ -143,7 +148,7 @@ public OtelSpanWrapper(
     return scopes
         .getOptions()
         .getSpanFactory()
-        .createSpan(operation, description, scopes, new SpanOptions(), this);
+        .createSpan(operation, description, scopes, new SpanOptions(), context, this);
   }
 
   @Override
@@ -185,6 +190,10 @@ public void finish(@Nullable SpanStatus status) {
     if (otelSpan != null) {
       otelSpan.end();
     }
+
+    for (ISentryLifecycleToken token : tokensToCleanup) {
+      token.close();
+    }
   }
 
   @Override
@@ -425,12 +434,19 @@ public Map<String, MeasurementValue> getMeasurements() {
   }
 
   @SuppressWarnings("MustBeClosedChecker")
+  @ApiStatus.Internal
   @Override
   public @NotNull ISentryLifecycleToken makeCurrent() {
     final @Nullable Span otelSpan = getSpan();
     if (otelSpan != null) {
       final @NotNull Scope otelScope = otelSpan.makeCurrent();
-      return new OtelContextSpanStorageToken(otelScope);
+      // TODO [POTEL] should we keep an ordered list of otel scopes and close them in reverse order
+      // on finish?
+      // TODO [POTEL] should we make transaction/span implement ISentryLifecycleToken instead?
+      final @NotNull OtelContextSpanStorageToken token = new OtelContextSpanStorageToken(otelScope);
+      // to iterate LIFO when closing
+      tokensToCleanup.addFirst(token);
+      return token;
     }
     return NoOpScopesStorage.NoOpScopesLifecycleToken.getInstance();
   }

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

@@ -255,6 +255,7 @@ public boolean isNoOp() {
     return rootSpan.getEventId();
   }
 
+  @ApiStatus.Internal
   @Override
   public @NotNull ISentryLifecycleToken makeCurrent() {
     return rootSpan.makeCurrent();