feat(remix): Continue transaction from request headers

Author: AbhiPrasad

packages/remix/src/utils/instrumentServer.ts

@@ -2,7 +2,16 @@
 import { captureException, getCurrentHub, Hub } from '@sentry/node';
 import { getActiveTransaction, hasTracingEnabled } from '@sentry/tracing';
 import { Transaction, WrappedFunction } from '@sentry/types';
-import { addExceptionMechanism, fill, isNodeEnv, loadModule, logger, serializeBaggage } from '@sentry/utils';
+import {
+  addExceptionMechanism,
+  extractTraceparentData,
+  fill,
+  isNodeEnv,
+  loadModule,
+  logger,
+  parseBaggageSetMutability,
+  serializeBaggage,
+} from '@sentry/utils';
 import * as domain from 'domain';
 
 import {
@@ -289,26 +298,38 @@ function matchServerRoutes(
  * @param pkg
  */
 export function startRequestHandlerTransaction(
+  hub: Hub,
   url: URL,
-  method: string,
   routes: ServerRoute[],
-  hub: Hub,
-  pkg?: ReactRouterDomPkg,
+  pkg: ReactRouterDomPkg | undefined,
+  request: {
+    headers: {
+      'sentry-trace': string;
+      baggage: string;
+    };
+    method: string;
+  },
 ): Transaction {
   const currentScope = hub.getScope();
   const matches = matchServerRoutes(routes, url.pathname, pkg);
 
+  // If there is a trace header set, we extract the data from it (parentSpanId, traceId, and sampling decision)
+  const traceparentData = extractTraceparentData(request.headers['sentry-trace']);
+  const baggage = parseBaggageSetMutability(request.headers.baggage, traceparentData);
+
   const match = matches && getRequestMatch(url, matches);
   const name = match === null ? url.pathname : match.route.id;
   const source = match === null ? 'url' : 'route';
   const transaction = hub.startTransaction({
     name,
     op: 'http.server',
     tags: {
-      method: method,
+      method: request.method,
     },
+    ...traceparentData,
     metadata: {
       source,
+      baggage,
     },
   });
 
@@ -330,7 +351,13 @@ function wrapRequestHandler(origRequestHandler: RequestHandler, build: ServerBui
       }
 
       const url = new URL(request.url);
-      const transaction = startRequestHandlerTransaction(url, request.method, routes, hub, pkg);
+      const transaction = startRequestHandlerTransaction(hub, url, routes, pkg, {
+        headers: {
+          'sentry-trace': request.headers.get('sentry-trace') || '',
+          baggage: request.headers.get('baggage') || '',
+        },
+        method: request.method,
+      });
 
       const res = (await origRequestHandler.call(this, request, loadContext)) as Response;
 

packages/remix/src/utils/serverAdapters/express.ts

@@ -2,7 +2,7 @@ import { getCurrentHub } from '@sentry/hub';
 import { flush } from '@sentry/node';
 import { hasTracingEnabled } from '@sentry/tracing';
 import { Transaction } from '@sentry/types';
-import { extractRequestData, loadModule, logger } from '@sentry/utils';
+import { extractRequestData, isString, loadModule, logger } from '@sentry/utils';
 
 import {
   createRoutes,
@@ -51,7 +51,13 @@ function wrapExpressRequestHandler(
     }
 
     const url = new URL(request.url);
-    const transaction = startRequestHandlerTransaction(url, request.method, routes, hub, pkg);
+    const transaction = startRequestHandlerTransaction(hub, url, routes, pkg, {
+      headers: {
+        'sentry-trace': (req.headers && isString(req.headers['sentry-trace']) && req.headers['sentry-trace']) || '',
+        baggage: (req.headers && isString(req.headers.baggage) && req.headers.baggage) || '',
+      },
+      method: request.method,
+    });
     // save a link to the transaction on the response, so that even if there's an error (landing us outside of
     // the domain), we can still finish it (albeit possibly missing some scope data)
     (res as AugmentedExpressResponse).__sentryTransaction = transaction;