fix: added captureError callback so integrations can set their own mechanisms

Author: logaretm

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

@@ -17,7 +17,7 @@ test('Sends an error event to Sentry', async ({ request }) => {
   expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual(
     expect.objectContaining({
       handled: false,
-      type: 'auto.diagnostic_channels.bind_span',
+      type: 'auto.http.nitro.onTraceError',
     }),
   );
 });

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

@@ -108,6 +108,12 @@ function setupH3TracingChannels(): void {
       return span;
     },
     {
+      captureError: () => ({
+        mechanism: {
+          handled: false,
+          type: 'auto.http.nitro.onTraceError',
+        },
+      }),
       beforeSpanEnd(span, data) {
         applyResponseStatus(span, data);
 

packages/server-utils/src/tracing-channel.ts

@@ -1,6 +1,6 @@
 import type { TracingChannel, TracingChannelSubscribers } from 'node:diagnostics_channel';
 import type { AsyncLocalStorage } from 'node:async_hooks';
-import type { Span } from '@sentry/core';
+import type { ExclusiveEventHintOrCaptureContext, Span } from '@sentry/core';
 import { _INTERNAL_getTracingChannelBinding, debug, captureException, SPAN_STATUS_ERROR } from '@sentry/core';
 import { DEBUG_BUILD } from './debug-build';
 
@@ -39,11 +39,11 @@ interface TracingChannelAutoBindingOptions<TData extends object = object> {
   beforeSpanEnd?: (span: Span, data: TracingChannelPayloadWithSpan<TData>) => void;
 
   /**
-   * Whether a thrown error is captured as a Sentry event. The span is always marked with error
-   * status regardless. Defaults to `true`.
+   * Whether a thrown error is captured as a Sentry event. The span is always marked with error status regardless. Defaults to `true`.
+   * You can alternatively pass a function that sets the ExclusiveEventHintOrCaptureContext on the captured error.
    * Set `false` for instrumentation that only annotates the span and lets the error be captured at the boundary that owns it (e.g. db spans).
    */
-  captureError?: boolean;
+  captureError?: boolean | ((e: unknown) => ExclusiveEventHintOrCaptureContext);
 }
 
 export type TracingChannelBindingOptions<TData extends object = object> =
@@ -95,6 +95,19 @@ export function bindTracingChannelToSpan<TData extends object>(
 
   const beforeSpanEnd = opts?.beforeSpanEnd;
 
+  const getErrorHint = (e: unknown) => {
+    if (typeof opts?.captureError === 'function') {
+      return opts.captureError(e);
+    }
+
+    return {
+      mechanism: {
+        type: 'auto.diagnostic_channels.bind_span',
+        handled: false,
+      },
+    };
+  };
+
   const subscribers: Partial<TracingChannelSubscribers<TracingChannelPayloadWithSpan<TData>>> = {
     start: NOOP,
     asyncStart: NOOP,
@@ -107,13 +120,9 @@ export function bindTracingChannelToSpan<TData extends object>(
     },
     error(data) {
       if (opts?.captureError !== false) {
-        captureException(data.error, {
-          mechanism: {
-            type: 'auto.diagnostic_channels.bind_span',
-            handled: false,
-          },
-        });
+        captureException(data.error, getErrorHint(data.error));
       }
+
       data._sentrySpan?.setStatus({ code: SPAN_STATUS_ERROR, message: getErrorMessage(data.error) });
     },
     asyncEnd(data) {