feat(nestjs): Stop creating spans for TracingInterceptor (#16501)

Author: chargome

dev-packages/e2e-tests/test-applications/nestjs-fastify/tests/transactions.test.ts

@@ -112,36 +112,6 @@ test('Sends an API route transaction', async ({ baseURL }) => {
           op: 'request_context.nestjs',
           origin: 'auto.http.otel.nestjs',
         },
-        {
-          span_id: expect.stringMatching(/[a-f0-9]{16}/),
-          trace_id: expect.stringMatching(/[a-f0-9]{32}/),
-          data: {
-            'sentry.origin': 'auto.middleware.nestjs',
-            'sentry.op': 'middleware.nestjs',
-          },
-          description: 'SentryTracingInterceptor',
-          parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
-          start_timestamp: expect.any(Number),
-          timestamp: expect.any(Number),
-          status: 'ok',
-          op: 'middleware.nestjs',
-          origin: 'auto.middleware.nestjs',
-        },
-        {
-          span_id: expect.stringMatching(/[a-f0-9]{16}/),
-          trace_id: expect.stringMatching(/[a-f0-9]{32}/),
-          data: {
-            'sentry.origin': 'auto.middleware.nestjs',
-            'sentry.op': 'middleware.nestjs',
-          },
-          description: 'SentryTracingInterceptor',
-          parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
-          start_timestamp: expect.any(Number),
-          timestamp: expect.any(Number),
-          status: 'ok',
-          op: 'middleware.nestjs',
-          origin: 'auto.middleware.nestjs',
-        },
         {
           span_id: expect.stringMatching(/[a-f0-9]{16}/),
           trace_id: expect.stringMatching(/[a-f0-9]{32}/),
@@ -183,29 +153,19 @@ test('Sends an API route transaction', async ({ baseURL }) => {
           status: 'ok',
           origin: 'manual',
         },
-        {
-          span_id: expect.stringMatching(/[a-f0-9]{16}/),
-          trace_id: expect.stringMatching(/[a-f0-9]{32}/),
-          data: {
-            'sentry.origin': 'auto.middleware.nestjs',
-            'sentry.op': 'middleware.nestjs',
-          },
-          description: 'Interceptors - After Route',
-          parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
-          start_timestamp: expect.any(Number),
-          timestamp: expect.any(Number),
-          status: 'ok',
-          op: 'middleware.nestjs',
-          origin: 'auto.middleware.nestjs',
-        },
       ]),
+      start_timestamp: expect.any(Number),
+      timestamp: expect.any(Number),
       transaction: 'GET /test-transaction',
-      type: 'transaction',
       transaction_info: {
         source: 'route',
       },
+      type: 'transaction',
     }),
   );
+
+  const spanDescriptions = transactionEvent.spans.map(span => span.description);
+  expect(spanDescriptions).not.toContain('SentryTracingInterceptor');
 });
 
 test('API route transaction includes nest middleware span. Spans created in and after middleware are nested correctly', async ({

packages/nestjs/src/integrations/sentry-nest-instrumentation.ts

@@ -183,8 +183,12 @@ export class SentryNestInstrumentation extends InstrumentationBase {
                 const parentSpan = getActiveSpan();
                 let afterSpan: Span | undefined;
 
-                // Check that we can reasonably assume that the target is an interceptor.
-                if (!context || !next || typeof next.handle !== 'function') {
+                if (
+                  !context ||
+                  !next ||
+                  typeof next.handle !== 'function' || // Check that we can reasonably assume that the target is an interceptor.
+                  target.name === 'SentryTracingInterceptor' // We don't want to trace this internal interceptor
+                ) {
                   return originalIntercept.apply(thisArgIntercept, argsIntercept);
                 }