feat: ensure trace channel spans has correct origins

Author: logaretm

dev-packages/e2e-tests/test-applications/nitro-3/server/middleware/test.ts

@@ -0,0 +1,6 @@
+import { defineHandler, setResponseHeader } from 'nitro/h3';
+
+export default defineHandler(event => {
+  // Simple middleware that adds a custom header to verify it ran
+  setResponseHeader(event, 'x-sentry-test-middleware', 'executed');
+});

dev-packages/e2e-tests/test-applications/nitro-3/tests/middleware.test.ts

@@ -0,0 +1,20 @@
+import { expect, test } from '@playwright/test';
+import { waitForTransaction } from '@sentry-internal/test-utils';
+
+test('Creates middleware spans for requests', async ({ request }) => {
+  const transactionEventPromise = waitForTransaction('nitro-3', event => {
+    return event?.transaction === 'GET /api/test-transaction';
+  });
+
+  const response = await request.get('/api/test-transaction');
+
+  expect(response.headers()['x-sentry-test-middleware']).toBe('executed');
+
+  const transactionEvent = await transactionEventPromise;
+
+  // h3 middleware spans have origin auto.http.nitro.h3 and op middleware.nitro
+  const h3MiddlewareSpans = transactionEvent.spans?.filter(
+    span => span.origin === 'auto.http.nitro.h3' && span.op === 'middleware.nitro',
+  );
+  expect(h3MiddlewareSpans?.length).toBeGreaterThanOrEqual(1);
+});

dev-packages/e2e-tests/test-applications/nitro-3/tests/transactions.test.ts

@@ -17,13 +17,13 @@ test('Sends a transaction event for a successful route', async ({ request }) =>
     }),
   );
 
-  expect(transactionEvent.contexts?.trace).toEqual(
-    expect.objectContaining({
-      op: expect.stringContaining('http'),
-      span_id: expect.stringMatching(/[a-f0-9]{16}/),
-      trace_id: expect.stringMatching(/[a-f0-9]{32}/),
-    }),
-  );
+  // srvx.request creates a span for the request
+  const srvxSpans = transactionEvent.spans?.filter(span => span.origin === 'auto.http.nitro.srvx');
+  expect(srvxSpans?.length).toBeGreaterThanOrEqual(1);
+
+  // h3 creates a child span for the route handler
+  const h3Spans = transactionEvent.spans?.filter(span => span.origin === 'auto.http.nitro.h3');
+  expect(h3Spans?.length).toBeGreaterThanOrEqual(1);
 });
 
 test('Sets correct HTTP status code on transaction', async ({ request }) => {

packages/nitro/src/runtime/hooks/captureTracingEvents.ts

@@ -7,6 +7,7 @@ import {
   httpHeadersToSpanAttributes,
   parseStringToURLObject,
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
+  SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
   setHttpStatus,
   type Span,
   SPAN_STATUS_ERROR,
@@ -80,6 +81,7 @@ function setupH3TracingChannels(): void {
         name: spanName,
         attributes: {
           ...urlAttributes,
+          [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.nitro.h3',
           [SEMANTIC_ATTRIBUTE_SENTRY_OP]: data?.type === 'middleware' ? 'middleware.nitro' : 'http.server',
         },
       },
@@ -119,6 +121,7 @@ function setupSrvxTracingChannels(): void {
         attributes: {
           ...urlAttributes,
           ...headerAttributes,
+          [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.nitro.srvx',
           [SEMANTIC_ATTRIBUTE_SENTRY_OP]: data.middleware ? 'middleware.nitro' : 'http.server',
           'server.port': data.server.options.port,
         },
@@ -155,7 +158,7 @@ function setupSrvxTracingChannels(): void {
     }
 
     const parsedUrl = data.request._url ? parseStringToURLObject(data.request._url.href) : undefined;
-    const [, urlAttributes] = getHttpSpanDetailsFromUrlObject(parsedUrl, 'server', 'auto.http.nitro.srvx.middleware', {
+    const [, urlAttributes] = getHttpSpanDetailsFromUrlObject(parsedUrl, 'server', 'auto.http.nitro.srvx', {
       method: data.request.method,
     });
 
@@ -165,6 +168,7 @@ function setupSrvxTracingChannels(): void {
         name: `${data.middleware?.handler.name ?? 'unknown'} - ${data.request.method} ${data.request._url?.pathname}`,
         attributes: {
           ...urlAttributes,
+          [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.nitro.srvx',
           [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'middleware.nitro',
         },
         parentSpan: requestParentSpan || undefined,