new option ignoreStandaloneClientSpans; prefer spans created via Sentry API as fallback root

Author: adinauer

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

@@ -21,4 +21,5 @@ public final class InternalSemanticAttributes {
   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<Boolean> CREATED_VIA_SENTRY_API = AttributeKey.booleanKey("sentry.is_created_via_sentry_api");
 }

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

@@ -1,5 +1,7 @@
 package io.sentry.opentelemetry;
 
+import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.api.trace.Span;
 import io.opentelemetry.api.trace.SpanContext;
 import io.opentelemetry.context.internal.shaded.WeakConcurrentMap;
 import io.sentry.ISentryLifecycleToken;
@@ -46,12 +48,33 @@ private SentryWeakSpanStorage() {}
 
   public void storeSentrySpan(
       final @NotNull SpanContext otelSpan, final @NotNull IOtelSpanWrapper sentrySpan) {
+    System.out.println("storing span: " + sentrySpan.getOperation());
     this.sentrySpans.put(otelSpan, sentrySpan);
-    if (sentrySpan.isRoot()) {
+    if (shouldStoreSpanAsRootSpan(sentrySpan)) {
+      System.out.println("storing span as last known root: " + sentrySpan.getOperation());
       lastKnownRootSpan = new WeakReference<>(sentrySpan);
     }
   }
 
+  private boolean shouldStoreSpanAsRootSpan(final @NotNull IOtelSpanWrapper sentrySpan) {
+    if (!sentrySpan.isRoot()) {
+      return false;
+    }
+
+    final @Nullable IOtelSpanWrapper previousRootSpan = getLastKnownUnfinishedRootSpan();
+    if (previousRootSpan == null) {
+      return true;
+    }
+
+    final @Nullable Attributes attributes = previousRootSpan.getOpenTelemetrySpanAttributes();
+    if (attributes == null) {
+      return true;
+    }
+
+    final @Nullable Boolean isCreatedViaSentryApi = attributes.get(InternalSemanticAttributes.CREATED_VIA_SENTRY_API);
+    return isCreatedViaSentryApi == true;
+  }
+
   public @Nullable IOtelSpanWrapper getLastKnownUnfinishedRootSpan() {
     final @Nullable IOtelSpanWrapper span = lastKnownRootSpan.get();
     if (span != null && !span.isFinished()) {

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

@@ -66,18 +66,22 @@ public SamplingResult shouldSample(
       if (samplingDecision != null) {
         return new SentrySamplingResult(samplingDecision);
       } else {
-        return handleRootOtelSpan(traceId, parentContext, attributes);
+        return handleRootOtelSpan(traceId, parentContext, attributes, spanKind);
       }
     }
   }
 
   private @NotNull SamplingResult handleRootOtelSpan(
       final @NotNull String traceId,
       final @NotNull Context parentContext,
-      final @NotNull Attributes attributes) {
+      final @NotNull Attributes attributes,
+      final @NotNull SpanKind spanKind) {
     if (!scopes.getOptions().isTracingEnabled()) {
       return SamplingResult.create(SamplingDecision.RECORD_ONLY);
     }
+    if (scopes.getOptions().isIgnoreStandaloneClientSpans() && SpanKind.CLIENT.equals(spanKind)) {
+      return SamplingResult.create(SamplingDecision.DROP);
+    }
     @Nullable Baggage baggage = null;
     @Nullable
     SentryTraceHeader sentryTraceHeader = parentContext.get(SentryOtelKeys.SENTRY_TRACE_KEY);

sentry/src/main/java/io/sentry/SentryOptions.java

@@ -568,6 +568,8 @@ public class SentryOptions {
 
   private @NotNull ISocketTagger socketTagger = NoOpSocketTagger.getInstance();
 
+  private boolean ignoreStandaloneClientSpans = false;
+
   /**
    * Adds an event processor
    *
@@ -2847,6 +2849,16 @@ public void setSocketTagger(final @Nullable ISocketTagger socketTagger) {
     this.socketTagger = socketTagger != null ? socketTagger : NoOpSocketTagger.getInstance();
   }
 
+  @ApiStatus.Experimental
+  public void setIgnoreStandaloneClientSpans(final boolean ignoreStandaloneClientSpans) {
+    this.ignoreStandaloneClientSpans = ignoreStandaloneClientSpans;
+  }
+
+  @ApiStatus.Experimental
+  public boolean isIgnoreStandaloneClientSpans() {
+    return ignoreStandaloneClientSpans;
+  }
+
   /**
    * Load the lazy fields. Useful to load in the background, so that results are already cached. DO
    * NOT CALL THIS METHOD ON THE MAIN THREAD.