Do not attach empty sentry-trace and baggage headers

adinauer · adinauer · commit 3e0bd662eaa6 · 2022-11-22T07:58:39.000+01:00
diff --git a/sentry-android-okhttp/src/main/java/io/sentry/android/okhttp/SentryOkHttpInterceptor.kt b/sentry-android-okhttp/src/main/java/io/sentry/android/okhttp/SentryOkHttpInterceptor.kt
@@ -64,7 +64,7 @@ class SentryOkHttpInterceptor(
         var code: Int? = null
         try {
             val requestBuilder = request.newBuilder()
-            if (span != null &&
+            if (span != null && !span.isNoOp &&
                 PropagationTargetsUtils.contain(hub.options.tracePropagationTargets, request.url.toString())
             ) {
                 span.toSentryTrace().let {
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
@@ -33,7 +33,7 @@ class SentryApollo3HttpInterceptor @JvmOverloads constructor(private val hub: IH
 
             var cleanedHeaders = removeSentryInternalHeaders(request.headers).toMutableList()
 
-            if (PropagationTargetsUtils.contain(hub.options.tracePropagationTargets, request.url)) {
+            if (!span.isNoOp && PropagationTargetsUtils.contain(hub.options.tracePropagationTargets, request.url)) {
                 val sentryTraceHeader = span.toSentryTrace()
                 val baggageHeader = span.toBaggageHeader(request.headers.filter { it.name == BaggageHeader.BAGGAGE_HEADER }.map { it.value })
                 cleanedHeaders.add(HttpHeader(sentryTraceHeader.name, sentryTraceHeader.value))
diff --git a/sentry-apollo/src/main/java/io/sentry/apollo/SentryApolloInterceptor.kt b/sentry-apollo/src/main/java/io/sentry/apollo/SentryApolloInterceptor.kt
@@ -37,16 +37,23 @@ class SentryApolloInterceptor(
             chain.proceedAsync(request, dispatcher, callBack)
         } else {
             val span = startChild(request, activeSpan)
-            val sentryTraceHeader = span.toSentryTrace()
 
-            // we have no access to URI, no way to verify tracing origins
-            val requestHeaderBuilder = request.requestHeaders.toBuilder()
-            requestHeaderBuilder.addHeader(sentryTraceHeader.name, sentryTraceHeader.value)
-            span.toBaggageHeader(listOf(request.requestHeaders.headerValue(BaggageHeader.BAGGAGE_HEADER)))?.let {
-                requestHeaderBuilder.addHeader(it.name, it.value)
+            val requestWithHeader = if (span.isNoOp) {
+                request
+            } else {
+                val sentryTraceHeader = span.toSentryTrace()
+
+                // we have no access to URI, no way to verify tracing origins
+                val requestHeaderBuilder = request.requestHeaders.toBuilder()
+                requestHeaderBuilder.addHeader(sentryTraceHeader.name, sentryTraceHeader.value)
+                span.toBaggageHeader(listOf(request.requestHeaders.headerValue(BaggageHeader.BAGGAGE_HEADER)))
+                    ?.let {
+                        requestHeaderBuilder.addHeader(it.name, it.value)
+                    }
+                val headers = requestHeaderBuilder.build()
+                request.toBuilder().requestHeaders(headers).build()
             }
-            val headers = requestHeaderBuilder.build()
-            val requestWithHeader = request.toBuilder().requestHeaders(headers).build()
+
             span.setData("operationId", requestWithHeader.operation.operationId())
             span.setData("variables", requestWithHeader.operation.variables().valueMap().toString())
 
diff --git a/sentry-jdbc/src/main/java/io/sentry/jdbc/SentryJdbcEventListener.java b/sentry-jdbc/src/main/java/io/sentry/jdbc/SentryJdbcEventListener.java
@@ -30,7 +30,7 @@ public SentryJdbcEventListener() {
   @Override
   public void onBeforeAnyExecute(final @NotNull StatementInformation statementInformation) {
     final ISpan parent = hub.getSpan();
-    if (parent != null) {
+    if (parent != null && !parent.isNoOp()) {
       final ISpan span = parent.startChild("db.query", statementInformation.getSql());
       CURRENT_SPAN.set(span);
     }
diff --git a/sentry-openfeign/src/main/java/io/sentry/openfeign/SentryFeignClient.java b/sentry-openfeign/src/main/java/io/sentry/openfeign/SentryFeignClient.java
@@ -55,7 +55,8 @@ public Response execute(final @NotNull Request request, final @NotNull Request.O
 
       final RequestWrapper requestWrapper = new RequestWrapper(request);
 
-      if (PropagationTargetsUtils.contain(hub.getOptions().getTracePropagationTargets(), url)) {
+      if (!span.isNoOp()
+          && PropagationTargetsUtils.contain(hub.getOptions().getTracePropagationTargets(), url)) {
         final SentryTraceHeader sentryTraceHeader = span.toSentryTrace();
         final @Nullable Collection<String> requestBaggageHeader =
             request.headers().get(BaggageHeader.BAGGAGE_HEADER);
diff --git a/sentry-opentelemetry/sentry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/SentryPropagator.java b/sentry-opentelemetry/sentry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/SentryPropagator.java
@@ -39,7 +39,7 @@ public <C> void inject(final Context context, final C carrier, final TextMapSett
       return;
     }
     final @Nullable ISpan sentrySpan = spanStorage.get(otelSpanContext.getSpanId());
-    if (sentrySpan == null) {
+    if (sentrySpan == null || sentrySpan.isNoOp()) {
       return;
     }
 
diff --git a/sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/tracing/SentrySpanAdvice.java b/sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/tracing/SentrySpanAdvice.java
@@ -31,7 +31,7 @@ public SentrySpanAdvice(final @NotNull IHub hub) {
   public Object invoke(final @NotNull MethodInvocation invocation) throws Throwable {
     final ISpan activeSpan = hub.getSpan();
 
-    if (activeSpan == null) {
+    if (activeSpan == null || activeSpan.isNoOp()) {
       // there is no active transaction, we do not start new span
       return invocation.proceed();
     } else {
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
@@ -49,10 +49,9 @@ public SentrySpanClientHttpRequestInterceptor(final @NotNull IHub hub) {
           request.getMethod() != null ? request.getMethod().name() : "unknown";
       span.setDescription(methodName + " " + request.getURI());
 
-      final SentryTraceHeader sentryTraceHeader = span.toSentryTrace();
-
-      if (PropagationTargetsUtils.contain(
+      if (!span.isNoOp() && PropagationTargetsUtils.contain(
           hub.getOptions().getTracePropagationTargets(), request.getURI())) {
+        final SentryTraceHeader sentryTraceHeader = span.toSentryTrace();
         request.getHeaders().add(sentryTraceHeader.getName(), sentryTraceHeader.getValue());
         @Nullable
         BaggageHeader baggage =
diff --git a/sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/tracing/SentrySpanClientWebRequestFilter.java b/sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/tracing/SentrySpanClientWebRequestFilter.java
@@ -41,12 +41,11 @@ public SentrySpanClientWebRequestFilter(final @NotNull IHub hub) {
     final ISpan span = activeSpan.startChild("http.client");
     span.setDescription(request.method().name() + " " + request.url());
 
-    final SentryTraceHeader sentryTraceHeader = span.toSentryTrace();
-
     final ClientRequest.Builder requestBuilder = ClientRequest.from(request);
 
-    if (PropagationTargetsUtils.contain(
+    if (!span.isNoOp() && PropagationTargetsUtils.contain(
         hub.getOptions().getTracePropagationTargets(), request.url())) {
+      final SentryTraceHeader sentryTraceHeader = span.toSentryTrace();
       requestBuilder.header(sentryTraceHeader.getName(), sentryTraceHeader.getValue());
 
       final @Nullable BaggageHeader baggageHeader =
diff --git a/sentry-spring/src/main/java/io/sentry/spring/tracing/SentrySpanAdvice.java b/sentry-spring/src/main/java/io/sentry/spring/tracing/SentrySpanAdvice.java
@@ -31,7 +31,7 @@ public SentrySpanAdvice(final @NotNull IHub hub) {
   public Object invoke(final @NotNull MethodInvocation invocation) throws Throwable {
     final ISpan activeSpan = hub.getSpan();
 
-    if (activeSpan == null) {
+    if (activeSpan == null || activeSpan.isNoOp()) {
       // there is no active transaction, we do not start new span
       return invocation.proceed();
     } else {
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
@@ -49,10 +49,10 @@ public SentrySpanClientHttpRequestInterceptor(final @NotNull IHub hub) {
           request.getMethod() != null ? request.getMethod().name() : "unknown";
       span.setDescription(methodName + " " + request.getURI());
 
-      final SentryTraceHeader sentryTraceHeader = span.toSentryTrace();
-
-      if (PropagationTargetsUtils.contain(
-          hub.getOptions().getTracePropagationTargets(), request.getURI())) {
+      if (!span.isNoOp()
+          && PropagationTargetsUtils.contain(
+              hub.getOptions().getTracePropagationTargets(), request.getURI())) {
+        final SentryTraceHeader sentryTraceHeader = span.toSentryTrace();
         request.getHeaders().add(sentryTraceHeader.getName(), sentryTraceHeader.getValue());
         @Nullable
         BaggageHeader baggage =
diff --git a/sentry-spring/src/main/java/io/sentry/spring/tracing/SentrySpanClientWebRequestFilter.java b/sentry-spring/src/main/java/io/sentry/spring/tracing/SentrySpanClientWebRequestFilter.java
@@ -41,12 +41,13 @@ public SentrySpanClientWebRequestFilter(final @NotNull IHub hub) {
     final ISpan span = activeSpan.startChild("http.client");
     span.setDescription(request.method().name() + " " + request.url());
 
-    final SentryTraceHeader sentryTraceHeader = span.toSentryTrace();
-
     final ClientRequest.Builder requestBuilder = ClientRequest.from(request);
 
-    if (PropagationTargetsUtils.contain(
-        hub.getOptions().getTracePropagationTargets(), request.url())) {
+    if (!span.isNoOp()
+        && PropagationTargetsUtils.contain(
+            hub.getOptions().getTracePropagationTargets(), request.url())) {
+
+      final SentryTraceHeader sentryTraceHeader = span.toSentryTrace();
       requestBuilder.header(sentryTraceHeader.getName(), sentryTraceHeader.getValue());
 
       final @Nullable BaggageHeader baggageHeader =
diff --git a/sentry/api/sentry.api b/sentry/api/sentry.api
@@ -499,6 +499,7 @@ public abstract interface class io/sentry/ISpan {
 	public abstract fun getTag (Ljava/lang/String;)Ljava/lang/String;
 	public abstract fun getThrowable ()Ljava/lang/Throwable;
 	public abstract fun isFinished ()Z
+	public abstract fun isNoOp ()Z
 	public abstract fun setData (Ljava/lang/String;Ljava/lang/Object;)V
 	public abstract fun setDescription (Ljava/lang/String;)V
 	public abstract fun setMeasurement (Ljava/lang/String;Ljava/lang/Number;)V
@@ -747,6 +748,7 @@ public final class io/sentry/NoOpSpan : io/sentry/ISpan {
 	public fun getTag (Ljava/lang/String;)Ljava/lang/String;
 	public fun getThrowable ()Ljava/lang/Throwable;
 	public fun isFinished ()Z
+	public fun isNoOp ()Z
 	public fun setData (Ljava/lang/String;Ljava/lang/Object;)V
 	public fun setDescription (Ljava/lang/String;)V
 	public fun setMeasurement (Ljava/lang/String;Ljava/lang/Number;)V
@@ -783,6 +785,7 @@ public final class io/sentry/NoOpTransaction : io/sentry/ITransaction {
 	public fun getThrowable ()Ljava/lang/Throwable;
 	public fun getTransactionNameSource ()Lio/sentry/protocol/TransactionNameSource;
 	public fun isFinished ()Z
+	public fun isNoOp ()Z
 	public fun isProfileSampled ()Ljava/lang/Boolean;
 	public fun isSampled ()Ljava/lang/Boolean;
 	public fun scheduleFinish ()V
@@ -1587,6 +1590,7 @@ public final class io/sentry/SentryTracer : io/sentry/ITransaction {
 	public fun getTimestamp ()Ljava/lang/Double;
 	public fun getTransactionNameSource ()Lio/sentry/protocol/TransactionNameSource;
 	public fun isFinished ()Z
+	public fun isNoOp ()Z
 	public fun isProfileSampled ()Ljava/lang/Boolean;
 	public fun isSampled ()Ljava/lang/Boolean;
 	public fun scheduleFinish ()V
@@ -1698,6 +1702,7 @@ public final class io/sentry/Span : io/sentry/ISpan {
 	public fun getTimestamp ()Ljava/lang/Double;
 	public fun getTraceId ()Lio/sentry/protocol/SentryId;
 	public fun isFinished ()Z
+	public fun isNoOp ()Z
 	public fun isProfileSampled ()Ljava/lang/Boolean;
 	public fun isSampled ()Ljava/lang/Boolean;
 	public fun setData (Ljava/lang/String;Ljava/lang/Object;)V
diff --git a/sentry/src/main/java/io/sentry/Hub.java b/sentry/src/main/java/io/sentry/Hub.java
@@ -753,7 +753,7 @@ public void flush(long timeoutMillis) {
               SentryLevel.WARNING, "Instance is disabled and this 'traceHeaders' call is a no-op.");
     } else {
       final ISpan span = stack.peek().getScope().getSpan();
-      if (span != null) {
+      if (span != null && !span.isNoOp()) {
         traceHeader = span.toSentryTrace();
       }
     }
diff --git a/sentry/src/main/java/io/sentry/ISpan.java b/sentry/src/main/java/io/sentry/ISpan.java
@@ -205,4 +205,12 @@ ISpan startChild(
    * @param unit the unit the value is measured in
    */
   void setMeasurement(@NotNull String name, @NotNull Number value, @NotNull MeasurementUnit unit);
+
+  /**
+   * Whether this span instance is a NOOP that doesn't collect information
+   *
+   * @return true if NOOP
+   */
+  @ApiStatus.Internal
+  boolean isNoOp();
 }
diff --git a/sentry/src/main/java/io/sentry/NoOpSpan.java b/sentry/src/main/java/io/sentry/NoOpSpan.java
@@ -47,8 +47,8 @@ public static NoOpSpan getInstance() {
   }
 
   @Override
-  public @NotNull BaggageHeader toBaggageHeader(@Nullable List<String> thirdPartyBaggageHeaders) {
-    return new BaggageHeader("");
+  public @Nullable BaggageHeader toBaggageHeader(@Nullable List<String> thirdPartyBaggageHeaders) {
+    return null;
   }
 
   @Override
@@ -124,4 +124,9 @@ public void setMeasurement(@NotNull String name, @NotNull Number value) {}
   @Override
   public void setMeasurement(
       @NotNull String name, @NotNull Number value, @NotNull MeasurementUnit unit) {}
+
+  @Override
+  public boolean isNoOp() {
+    return true;
+  }
 }
diff --git a/sentry/src/main/java/io/sentry/NoOpTransaction.java b/sentry/src/main/java/io/sentry/NoOpTransaction.java
@@ -96,8 +96,8 @@ public boolean isFinished() {
   }
 
   @Override
-  public @NotNull BaggageHeader toBaggageHeader(@Nullable List<String> thirdPartyBaggageHeaders) {
-    return new BaggageHeader("");
+  public @Nullable BaggageHeader toBaggageHeader(@Nullable List<String> thirdPartyBaggageHeaders) {
+    return null;
   }
 
   @Override
@@ -188,4 +188,9 @@ public void setContext(@NotNull String key, @NotNull Object context) {}
   public @NotNull Contexts getContexts() {
     return new Contexts();
   }
+
+  @Override
+  public boolean isNoOp() {
+    return true;
+  }
 }
diff --git a/sentry/src/main/java/io/sentry/SentryTracer.java b/sentry/src/main/java/io/sentry/SentryTracer.java
@@ -675,6 +675,11 @@ public void setContext(final @NotNull String key, final @NotNull Object context)
     return contexts;
   }
 
+  @Override
+  public boolean isNoOp() {
+    return false;
+  }
+
   private static final class FinishStatus {
     static final FinishStatus NOT_FINISHED = FinishStatus.notFinished();
 
diff --git a/sentry/src/main/java/io/sentry/Span.java b/sentry/src/main/java/io/sentry/Span.java
@@ -340,6 +340,11 @@ Long getEndNanos() {
     return endNanos;
   }
 
+  @Override
+  public boolean isNoOp() {
+    return false;
+  }
+
   void setSpanFinishedCallback(final @Nullable SpanFinishedCallback callback) {
     this.spanFinishedCallback = callback;
   }

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public SentryJdbcEventListener() {`
`30`	`30`	`@Override`
`31`	`31`	`public void onBeforeAnyExecute(final @NotNull StatementInformation statementInformation) {`
`32`	`32`	`final ISpan parent = hub.getSpan();`
`33`		`- if (parent != null) {`
	`33`	`+ if (parent != null && !parent.isNoOp()) {`
`34`	`34`	`final ISpan span = parent.startChild("db.query", statementInformation.getSql());`
`35`	`35`	`CURRENT_SPAN.set(span);`
`36`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public <C> void inject(final Context context, final C carrier, final TextMapSett`
`39`	`39`	`return;`
`40`	`40`	`}`
`41`	`41`	`final @Nullable ISpan sentrySpan = spanStorage.get(otelSpanContext.getSpanId());`
`42`		`- if (sentrySpan == null) {`
	`42`	`+ if (sentrySpan == null \|\| sentrySpan.isNoOp()) {`
`43`	`43`	`return;`
`44`	`44`	`}`
`45`	`45`