feat: remove transaction and SDK metadata setting from the wrapper

Author: logaretm

packages/nextjs/src/common/pages-router-instrumentation/wrapApiHandlerWithSentry.ts

@@ -1,14 +1,5 @@
-import {
-  captureException,
-  debug,
-  getActiveSpan,
-  getIsolationScope,
-  getRootSpan,
-  httpRequestToRequestData,
-  objectify,
-} from '@sentry/core';
+import { captureException, debug, objectify } from '@sentry/core';
 import type { NextApiRequest } from 'next';
-import { TRANSACTION_ATTR_SENTRY_ROUTE_BACKFILL } from '../span-attributes-with-logic-attached';
 import type { AugmentedNextApiResponse, NextApiHandler } from '../types';
 import { flushSafelyWithTimeout } from '../utils/responseEnd';
 
@@ -52,24 +43,6 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
 
         req.__withSentry_applied__ = true;
 
-        // Set transaction name on isolation scope to ensure parameterized routes are used
-        // The HTTP server integration sets it on isolation scope, so we need to match that
-        const method = req.method || 'GET';
-        const isolationScope = getIsolationScope();
-        isolationScope.setTransactionName(`${method} ${parameterizedRoute}`);
-        // Set SDK processing metadata
-        isolationScope.setSDKProcessingMetadata({
-          normalizedRequest: httpRequestToRequestData(req),
-        });
-
-        // Set the route backfill attribute on the root span so that the transaction name
-        // gets updated to use the parameterized route during event processing
-        const activeSpan = getActiveSpan();
-        if (activeSpan) {
-          const rootSpan = getRootSpan(activeSpan);
-          rootSpan.setAttribute(TRANSACTION_ATTR_SENTRY_ROUTE_BACKFILL, parameterizedRoute);
-        }
-
         return await wrappingTarget.apply(thisArg, args);
       } catch (e) {
         // In case we have a primitive, wrap it in the equivalent wrapper class (string -> String, etc.) so that we can

packages/nextjs/src/common/span-attributes-with-logic-attached.ts

@@ -6,3 +6,5 @@ export const TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION = 'sentry.drop_transaction
 export const TRANSACTION_ATTR_SENTRY_TRACE_BACKFILL = 'sentry.sentry_trace_backfill';
 
 export const TRANSACTION_ATTR_SENTRY_ROUTE_BACKFILL = 'sentry.route_backfill';
+
+export const ATTR_NEXT_PAGES_API_ROUTE_TYPE = 'executing api route (pages)';

packages/nextjs/src/edge/index.ts

@@ -4,6 +4,7 @@
 import { context } from '@opentelemetry/api';
 import {
   applySdkMetadata,
+  type Event,
   type EventProcessor,
   getCapturedScopesOnSpan,
   getCurrentScope,
@@ -18,11 +19,16 @@ import {
   setCapturedScopesOnSpan,
   spanToJSON,
   stripUrlQueryAndFragment,
+  type TransactionEvent,
 } from '@sentry/core';
 import { getScopesFromContext } from '@sentry/opentelemetry';
 import type { VercelEdgeOptions } from '@sentry/vercel-edge';
 import { getDefaultIntegrations, init as vercelEdgeInit } from '@sentry/vercel-edge';
-import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../common/span-attributes-with-logic-attached';
+import { ATTR_NEXT_SPAN_NAME, ATTR_NEXT_SPAN_TYPE } from '../common/nextSpanAttributes';
+import {
+  ATTR_NEXT_PAGES_API_ROUTE_TYPE,
+  TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION,
+} from '../common/span-attributes-with-logic-attached';
 import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
 import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
 import { isBuild } from '../common/utils/isBuild';
@@ -82,12 +88,21 @@ export function init(options: VercelEdgeOptions = {}): void {
     dropMiddlewareTunnelRequests(span, spanAttributes);
 
     // Mark all spans generated by Next.js as 'auto'
-    if (spanAttributes?.['next.span_type'] !== undefined) {
+    if (spanAttributes?.[ATTR_NEXT_SPAN_TYPE] !== undefined) {
       span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto');
     }
 
+    // Backfill span attributes for api route pages because we removed it from the wrapper
+    if (
+      spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'Node.runHandler' &&
+      String(spanAttributes?.['next.span_name']).startsWith(ATTR_NEXT_PAGES_API_ROUTE_TYPE)
+    ) {
+      span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'http.server');
+      span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');
+    }
+
     // Make sure middleware spans get the right op
-    if (spanAttributes?.['next.span_type'] === 'Middleware.execute') {
+    if (spanAttributes?.[ATTR_NEXT_SPAN_TYPE] === 'Middleware.execute') {
       span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'http.server.middleware');
       span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'url');
 
@@ -119,8 +134,8 @@ export function init(options: VercelEdgeOptions = {}): void {
     // The otel auto inference will clobber the transaction name because the span has an http.target
     if (
       event.type === 'transaction' &&
-      event.contexts?.trace?.data?.['next.span_type'] === 'Middleware.execute' &&
-      event.contexts?.trace?.data?.['next.span_name']
+      event.contexts?.trace?.data?.[ATTR_NEXT_SPAN_TYPE] === 'Middleware.execute' &&
+      event.contexts?.trace?.data?.[ATTR_NEXT_SPAN_NAME] !== undefined
     ) {
       if (event.transaction) {
         // Older nextjs versions pass the full url appended to the middleware name, which results in high cardinality transaction names.
@@ -139,6 +154,20 @@ export function init(options: VercelEdgeOptions = {}): void {
       }
     }
 
+    // Backfill the transaction name for api route pages because we removed it from the wrapper
+    if (
+      event.type === 'transaction' &&
+      event.contexts?.trace?.data?.[ATTR_NEXT_SPAN_TYPE] === 'Node.runHandler' &&
+      String(event.contexts.trace.data['next.span_name']).startsWith(ATTR_NEXT_PAGES_API_ROUTE_TYPE)
+    ) {
+      let path = String(event.contexts.trace.data['next.span_name']).replace(ATTR_NEXT_PAGES_API_ROUTE_TYPE, '').trim();
+      // Set transaction name on isolation scope to ensure parameterized routes are used
+      // The HTTP server integration sets it on isolation scope, so we need to match that
+      const method = event.request?.method || 'GET';
+      path = path ?? event.request?.url ?? '/';
+      event.transaction = `${method} ${path}`;
+    }
+
     setUrlProcessingMetadata(event);
   });