dont record sampling client outcome for suppressed spans

Author: Lms24

dev-packages/node-integration-tests/suites/tracing/ignoreSpans-streamed/children/server.mjs

@@ -31,13 +31,13 @@ app.get('/test/express', (_req, res) => {
     },
   );
 
-  Sentry.startSpan({ name: 'name-passes-but-op-not-span-1', op: 'ignored-op' }, () => {}),
-  Sentry.startSpan(
-    // sentry.op attribute has precedence over top op argument
-    { name: 'name-passes-but-op-not-span-2', /*op: 'keep',*/ attributes: { 'sentry.op': 'ignored-op' } },
-    () => {},
-  ),
-  res.send({ response: 'response 1' });
+  (Sentry.startSpan({ name: 'name-passes-but-op-not-span-1', op: 'ignored-op' }, () => {}),
+    Sentry.startSpan(
+      // sentry.op attribute has precedence over top op argument
+      { name: 'name-passes-but-op-not-span-2', /*op: 'keep',*/ attributes: { 'sentry.op': 'ignored-op' } },
+      () => {},
+    ),
+    res.send({ response: 'response 1' }));
 });
 
 Sentry.setupExpressErrorHandler(app);

packages/core/src/tracing/trace.ts

@@ -489,7 +489,7 @@ function _startRootSpan(spanArguments: SentrySpanArguments, scope: Scope, parent
     sampled,
   });
 
-  if (!sampled && client) {
+  if (!sampled && client && !scope.getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY]) {
     DEBUG_BUILD && debug.log('[Tracing] Discarding root span because its trace was not chosen to be sampled.');
     client.recordDroppedEvent('sample_rate', hasSpanStreamingEnabled(client) ? 'span' : 'transaction');
   }
@@ -533,7 +533,7 @@ function _startChildSpan(parentSpan: Span, scope: Scope, spanArguments: SentrySp
       // record a client outcome for the child.
       childSpan.dropReason = parentSpan.dropReason;
       client.recordDroppedEvent(parentSpan.dropReason, 'span');
-    } else {
+    } else if (!scope.getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY]) {
       // Otherwise, the child is not sampled due to sampling of the parent span,
       // hence we record a sample_rate client outcome for the child.
       childSpan.dropReason = 'sample_rate';

packages/core/test/lib/tracing/trace.test.ts

@@ -573,12 +573,15 @@ describe('startSpan', () => {
 
   describe('onlyIfParent', () => {
     it('starts a non recording span if there is no parent', () => {
+      const spyOnDroppedEvent = vi.spyOn(client, 'recordDroppedEvent');
+
       const span = startSpan({ name: 'test span', onlyIfParent: true }, span => {
         return span;
       });
 
       expect(span).toBeDefined();
       expect(span).toBeInstanceOf(SentryNonRecordingSpan);
+      expect(spyOnDroppedEvent).not.toHaveBeenCalled();
     });
 
     it('creates a span if there is a parent', () => {
@@ -2305,7 +2308,7 @@ describe('suppressTracing', () => {
     vi.clearAllMocks();
   });
 
-  it('works for a root span', () => {
+  it('suppresses a root span', () => {
     const span = suppressTracing(() => {
       return startInactiveSpan({ name: 'span' });
     });
@@ -2314,7 +2317,7 @@ describe('suppressTracing', () => {
     expect(spanIsSampled(span)).toBe(false);
   });
 
-  it('works for a child span', () => {
+  it('suppresses a child span', () => {
     startSpan({ name: 'outer' }, span => {
       expect(span.isRecording()).toBe(true);
       expect(spanIsSampled(span)).toBe(true);
@@ -2333,7 +2336,7 @@ describe('suppressTracing', () => {
     });
   });
 
-  it('works for a child span with forceTransaction=true', () => {
+  it('suppresses a child span with forceTransaction=true', () => {
     startSpan({ name: 'outer' }, span => {
       expect(span.isRecording()).toBe(true);
       expect(spanIsSampled(span)).toBe(true);
@@ -2347,6 +2350,42 @@ describe('suppressTracing', () => {
     });
   });
 
+  it("doesn't record a client outcome for suppressed spans", () => {
+    getCurrentScope().clear();
+    getIsolationScope().clear();
+    getGlobalScope().clear();
+
+    setAsyncContextStrategy(undefined);
+
+    const options = getDefaultTestClientOptions({ tracesSampleRate: 1, traceLifecycle: 'stream' });
+    client = new TestClient(options);
+    setCurrentClient(client);
+    client.init();
+
+    const spyOnDroppedEvent = vi.spyOn(client, 'recordDroppedEvent');
+
+    const span1 = suppressTracing(() => {
+      return startInactiveSpan({ name: 'span' });
+    });
+
+    expect(span1.isRecording()).toBe(false);
+    expect(spanIsSampled(span1)).toBe(false);
+
+    startSpan({ name: 'outer' }, span => {
+      expect(span.isRecording()).toBe(true);
+      expect(spanIsSampled(span)).toBe(true);
+
+      const child = suppressTracing(() => {
+        return startInactiveSpan({ name: 'span' });
+      });
+
+      expect(child.isRecording()).toBe(false);
+      expect(spanIsSampled(child)).toBe(false);
+    });
+
+    expect(spyOnDroppedEvent).not.toHaveBeenCalled();
+  });
+
   it('works with parallel processes', async () => {
     const span = suppressTracing(() => {
       return startInactiveSpan({ name: 'span' });