feat(node-core): Add outgoing fetch trace propagation to light mode#19262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andreiborza merged 1 commit into from
Feb 11, 2026
Merged

feat(node-core): Add outgoing fetch trace propagation to light mode #19262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions dev-packages/node-core-integration-tests/suites/light-mode/outgoing-fetch/server.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
const http = require('http');
const Sentry = require('@sentry/node-core/light');
const { loggingTransport, sendPortToRunner } = require('@sentry-internal/node-core-integration-tests');

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
transport: loggingTransport,
tracePropagationTargets: [/\/api\/v0/, 'v1'],
});

let capturedV0 = {};
let capturedV1 = {};
let capturedV2 = {};

const targetServer = http.createServer((req, res) => {
const headers = {
'sentry-trace': req.headers['sentry-trace'],
baggage: req.headers['baggage'],
};

if (req.url === '/api/v0') {
capturedV0 = headers;
} else if (req.url === '/api/v1') {
capturedV1 = headers;
} else if (req.url === '/api/v2') {
capturedV2 = headers;
}

res.writeHead(200);
res.end('ok');
});

targetServer.listen(0, () => {
const targetPort = targetServer.address().port;
const targetUrl = `http://localhost:${targetPort}`;

const server = http.createServer(async (req, res) => {
switch (req.url) {
case '/test-auto-propagation': {
capturedV0 = {};
capturedV1 = {};
capturedV2 = {};
await fetch(`${targetUrl}/api/v0`);
await fetch(`${targetUrl}/api/v1`);
await fetch(`${targetUrl}/api/v2`);
res.writeHead(200, { 'Content-Type': 'application/json' });
res.end(JSON.stringify({ '/api/v0': capturedV0, '/api/v1': capturedV1, '/api/v2': capturedV2 }));
break;
}
case '/test-breadcrumbs': {
Sentry.addBreadcrumb({ message: 'manual breadcrumb' });
await fetch(`${targetUrl}/api/v0`);
await fetch(`${targetUrl}/api/v1`);
Sentry.captureException(new Error('foo'));
res.writeHead(200);
res.end('ok');
break;
}
case '/test-suppress-tracing': {
capturedV0 = {};
capturedV1 = {};
await fetch(`${targetUrl}/api/v0`);
await Sentry.suppressTracing(() => fetch(`${targetUrl}/api/v1`));
Sentry.captureException(new Error('foo'));
res.writeHead(200, { 'Content-Type': 'application/json' });
res.end(JSON.stringify({ '/api/v0': capturedV0, '/api/v1': capturedV1 }));
break;
}
default: {
res.writeHead(404);
res.end();
}
}
});

server.listen(0, () => {
sendPortToRunner(server.address().port);
});
});
109 changes: 109 additions & 0 deletions dev-packages/node-core-integration-tests/suites/light-mode/outgoing-fetch/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
import crypto from 'crypto';
import { afterAll, expect, test } from 'vitest';
import { conditionalTest } from '../../../utils';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

afterAll(() => {
cleanupChildProcesses();
});

conditionalTest({ min: 22 })('light mode outgoing fetch', () => {
test('automatically propagates trace headers to outgoing fetch requests matching tracePropagationTargets', async () => {
const traceId = crypto.randomUUID().replace(/-/g, '');
const parentSpanId = traceId.substring(0, 16);

const runner = createRunner(__dirname, 'server.js').start();

const response = await runner.makeRequest<Record<string, { 'sentry-trace'?: string; baggage?: string }>>(
'get',
'/test-auto-propagation',
{
headers: {
'sentry-trace': `${traceId}-${parentSpanId}-1`,
baggage: `sentry-trace_id=${traceId},sentry-environment=test,sentry-public_key=public`,
},
},
);

// /api/v0 matches tracePropagationTargets - should have headers
expect(response?.['/api/v0']?.['sentry-trace']).toMatch(new RegExp(`^${traceId}-[a-f\\d]{16}-1$`));
expect(response?.['/api/v0']?.baggage).toContain(`sentry-trace_id=${traceId}`);

// /api/v1 matches tracePropagationTargets - should have headers
expect(response?.['/api/v1']?.['sentry-trace']).toMatch(new RegExp(`^${traceId}-[a-f\\d]{16}-1$`));
expect(response?.['/api/v1']?.baggage).toContain(`sentry-trace_id=${traceId}`);

// /api/v2 does NOT match tracePropagationTargets - should NOT have headers
expect(response?.['/api/v2']?.['sentry-trace']).toBeUndefined();
expect(response?.['/api/v2']?.baggage).toBeUndefined();
});

test('does not propagate headers or create breadcrumbs when tracing is suppressed', async () => {
const runner = createRunner(__dirname, 'server.js')
.expect({
event: event => {
const breadcrumbs = event.breadcrumbs || [];
const httpBreadcrumbs = breadcrumbs.filter(b => b.category === 'http');

// Only 1 breadcrumb for v0 - the suppressed v1 request should NOT create a breadcrumb
expect(httpBreadcrumbs.length).toBe(1);
expect(httpBreadcrumbs[0]?.data?.url).toContain('/api/v0');
},
})
.start();

const response = await runner.makeRequest<Record<string, { 'sentry-trace'?: string; baggage?: string }>>(
'get',
'/test-suppress-tracing',
);

// v0 (not suppressed) should have trace headers
expect(response?.['/api/v0']?.['sentry-trace']).toBeDefined();
expect(response?.['/api/v0']?.baggage).toBeDefined();

// v1 (suppressed) should NOT have trace headers
expect(response?.['/api/v1']?.['sentry-trace']).toBeUndefined();
expect(response?.['/api/v1']?.baggage).toBeUndefined();

await runner.completed();
});

test('creates breadcrumbs for outgoing fetch requests', async () => {
const runner = createRunner(__dirname, 'server.js')
.expect({
event: event => {
const breadcrumbs = event.breadcrumbs || [];
const httpBreadcrumbs = breadcrumbs.filter(b => b.category === 'http');

expect(httpBreadcrumbs.length).toBe(2);

expect(httpBreadcrumbs[0]).toEqual(
expect.objectContaining({
category: 'http',
type: 'http',
data: expect.objectContaining({
'http.method': 'GET',
status_code: 200,
}),
}),
);

expect(httpBreadcrumbs[1]).toEqual(
expect.objectContaining({
category: 'http',
type: 'http',
data: expect.objectContaining({
'http.method': 'GET',
status_code: 200,
}),
}),
);
},
})
.start();

await runner.makeRequest('get', '/test-breadcrumbs');

await runner.completed();
});
});
161 changes: 8 additions & 153 deletions packages/node-core/src/integrations/node-fetch/SentryNodeFetchInstrumentation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,29 +2,16 @@ import { context } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase } from '@opentelemetry/instrumentation';
import type { SanitizedRequestData } from '@sentry/core';
import {
addBreadcrumb,
getBreadcrumbLogLevelFromHttpStatusCode,
getClient,
getSanitizedUrlString,
getTraceData,
LRUMap,
parseUrl,
SDK_VERSION,
} from '@sentry/core';
import { shouldPropagateTraceForUrl } from '@sentry/opentelemetry';
import { LRUMap, SDK_VERSION } from '@sentry/core';
import * as diagch from 'diagnostics_channel';
import { NODE_MAJOR, NODE_MINOR } from '../../nodeVersion';
import { mergeBaggageHeaders } from '../../utils/baggage';
import {
addFetchRequestBreadcrumb,
addTracePropagationHeadersToFetchRequest,
getAbsoluteUrl,
} from '../../utils/outgoingFetchRequest';
import type { UndiciRequest, UndiciResponse } from './types';

const SENTRY_TRACE_HEADER = 'sentry-trace';
const SENTRY_BAGGAGE_HEADER = 'baggage';

// For baggage, we make sure to merge this into a possibly existing header
const BAGGAGE_HEADER_REGEX = /baggage: (.*)\r\n/;

export type SentryNodeFetchInstrumentationOptions = InstrumentationConfig & {
/**
* Whether breadcrumbs should be recorded for requests.
Expand DownExpand Up@@ -114,7 +101,6 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
* This method is called when a request is created.
* You can still mutate the request here before it is sent.
*/
// eslint-disable-next-line complexity
private _onRequestCreated({ request }: { request: UndiciRequest }): void {
const config = this.getConfig();
const enabled = config.enabled !== false;
Expand All@@ -132,70 +118,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
return;
}

const url = getAbsoluteUrl(request.origin, request.path);

// Manually add the trace headers, if it applies
// Note: We do not use `propagation.inject()` here, because our propagator relies on an active span
// Which we do not have in this case
// The propagator _may_ overwrite this, but this should be fine as it is the same data
const { tracePropagationTargets, propagateTraceparent } = getClient()?.getOptions() || {};
const addedHeaders = shouldPropagateTraceForUrl(url, tracePropagationTargets, this._propagationDecisionMap)
? getTraceData({ propagateTraceparent })
: undefined;

if (!addedHeaders) {
return;
}

const { 'sentry-trace': sentryTrace, baggage, traceparent } = addedHeaders;

// We do not want to overwrite existing headers here
// If the core UndiciInstrumentation is registered, it will already have set the headers
// We do not want to add any then
if (Array.isArray(request.headers)) {
const requestHeaders = request.headers;

// We do not want to overwrite existing header here, if it was already set
if (sentryTrace && !requestHeaders.includes(SENTRY_TRACE_HEADER)) {
requestHeaders.push(SENTRY_TRACE_HEADER, sentryTrace);
}

if (traceparent && !requestHeaders.includes('traceparent')) {
requestHeaders.push('traceparent', traceparent);
}

// For baggage, we make sure to merge this into a possibly existing header
const existingBaggagePos = requestHeaders.findIndex(header => header === SENTRY_BAGGAGE_HEADER);
if (baggage && existingBaggagePos === -1) {
requestHeaders.push(SENTRY_BAGGAGE_HEADER, baggage);
} else if (baggage) {
const existingBaggage = requestHeaders[existingBaggagePos + 1];
const merged = mergeBaggageHeaders(existingBaggage, baggage);
if (merged) {
requestHeaders[existingBaggagePos + 1] = merged;
}
}
} else {
const requestHeaders = request.headers;
// We do not want to overwrite existing header here, if it was already set
if (sentryTrace && !requestHeaders.includes(`${SENTRY_TRACE_HEADER}:`)) {
request.headers += `${SENTRY_TRACE_HEADER}: ${sentryTrace}\r\n`;
}

if (traceparent && !requestHeaders.includes('traceparent:')) {
request.headers += `traceparent: ${traceparent}\r\n`;
}

const existingBaggage = request.headers.match(BAGGAGE_HEADER_REGEX)?.[1];
if (baggage && !existingBaggage) {
request.headers += `${SENTRY_BAGGAGE_HEADER}: ${baggage}\r\n`;
} else if (baggage) {
const merged = mergeBaggageHeaders(existingBaggage, baggage);
if (merged) {
request.headers = request.headers.replace(BAGGAGE_HEADER_REGEX, `baggage: ${merged}\r\n`);
}
}
}
addTracePropagationHeadersToFetchRequest(request, this._propagationDecisionMap);
}

/**
Expand All@@ -215,7 +138,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
const shouldIgnore = this._ignoreOutgoingRequestsMap.get(request);

if (breadCrumbsEnabled && !shouldIgnore) {
addRequestBreadcrumb(request, response);
addFetchRequestBreadcrumb(request, response);
}
}

Expand DownExpand Up@@ -263,71 +186,3 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
return ignoreOutgoingRequests(url);
}
}

/** Add a breadcrumb for outgoing requests. */
function addRequestBreadcrumb(request: UndiciRequest, response: UndiciResponse): void {
const data = getBreadcrumbData(request);

const statusCode = response.statusCode;
const level = getBreadcrumbLogLevelFromHttpStatusCode(statusCode);

addBreadcrumb(
{
category: 'http',
data: {
status_code: statusCode,
...data,
},
type: 'http',
level,
},
{
event: 'response',
request,
response,
},
);
}

function getBreadcrumbData(request: UndiciRequest): Partial<SanitizedRequestData> {
try {
const url = getAbsoluteUrl(request.origin, request.path);
const parsedUrl = parseUrl(url);

const data: Partial<SanitizedRequestData> = {
url: getSanitizedUrlString(parsedUrl),
'http.method': request.method || 'GET',
};

if (parsedUrl.search) {
data['http.query'] = parsedUrl.search;
}
if (parsedUrl.hash) {
data['http.fragment'] = parsedUrl.hash;
}

return data;
} catch {
return {};
}
}

function getAbsoluteUrl(origin: string, path: string = '/'): string {
try {
const url = new URL(path, origin);
return url.toString();
} catch {
// fallback: Construct it on our own
const url = `${origin}`;

if (url.endsWith('/') && path.startsWith('/')) {
return `${url}${path.slice(1)}`;
}

if (!url.endsWith('/') && !path.startsWith('/')) {
return `${url}/${path.slice(1)}`;
}

return `${url}${path}`;
}
}
1 change: 1 addition & 0 deletions packages/node-core/src/light/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ export { LightNodeClient } from './client';
export { init, getDefaultIntegrations, initWithoutDefaultIntegrations } from './sdk';
export { setAsyncLocalStorageAsyncContextStrategy } from './asyncLocalStorageStrategy';
export { httpIntegration } from './integrations/httpIntegration';
export { nativeNodeFetchIntegration } from './integrations/nativeNodeFetchIntegration';

// Common exports shared with the main entry point
export * from '../common-exports';
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(node-core): Add outgoing fetch trace propagation to light mode#19262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

andreiborza
merged 1 commit into

from

Feb 11, 2026
 Merged


feat(node-core): Add outgoing fetch trace propagation to light mode
#19262
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


80 changes: 80 additions & 0 deletions
dev-packages/node-core-integration-tests/suites/light-mode/outgoing-fetch/server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
const http = require('http');
const Sentry = require('@sentry/node-core/light');
const { loggingTransport, sendPortToRunner } = require('@sentry-internal/node-core-integration-tests');

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
 tracePropagationTargets: [/\/api\/v0/, 'v1'],
});

let capturedV0 = {};
let capturedV1 = {};
let capturedV2 = {};

const targetServer = http.createServer((req, res) => {
 const headers = {
 'sentry-trace': req.headers['sentry-trace'],
 baggage: req.headers['baggage'],
 };

 if (req.url === '/api/v0') {
 capturedV0 = headers;
 } else if (req.url === '/api/v1') {
 capturedV1 = headers;
 } else if (req.url === '/api/v2') {
 capturedV2 = headers;
 }

 res.writeHead(200);
 res.end('ok');
});

targetServer.listen(0, () => {
 const targetPort = targetServer.address().port;
 const targetUrl = `http://localhost:${targetPort}`;

 const server = http.createServer(async (req, res) => {
 switch (req.url) {
 case '/test-auto-propagation': {
 capturedV0 = {};
 capturedV1 = {};
 capturedV2 = {};
 await fetch(`${targetUrl}/api/v0`);
 await fetch(`${targetUrl}/api/v1`);
 await fetch(`${targetUrl}/api/v2`);
 res.writeHead(200, { 'Content-Type': 'application/json' });
 res.end(JSON.stringify({ '/api/v0': capturedV0, '/api/v1': capturedV1, '/api/v2': capturedV2 }));
 break;
 }
 case '/test-breadcrumbs': {
 Sentry.addBreadcrumb({ message: 'manual breadcrumb' });
 await fetch(`${targetUrl}/api/v0`);
 await fetch(`${targetUrl}/api/v1`);
 Sentry.captureException(new Error('foo'));
 res.writeHead(200);
 res.end('ok');
 break;
 }
 case '/test-suppress-tracing': {
 capturedV0 = {};
 capturedV1 = {};
 await fetch(`${targetUrl}/api/v0`);
 await Sentry.suppressTracing(() => fetch(`${targetUrl}/api/v1`));
 Sentry.captureException(new Error('foo'));
 res.writeHead(200, { 'Content-Type': 'application/json' });
 res.end(JSON.stringify({ '/api/v0': capturedV0, '/api/v1': capturedV1 }));
 break;
 }
 default: {
 res.writeHead(404);
 res.end();
 }
 }
 });

 server.listen(0, () => {
 sendPortToRunner(server.address().port);
 });
});

109 changes: 109 additions & 0 deletions
dev-packages/node-core-integration-tests/suites/light-mode/outgoing-fetch/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
import crypto from 'crypto';
import { afterAll, expect, test } from 'vitest';
import { conditionalTest } from '../../../utils';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

afterAll(() => {
 cleanupChildProcesses();
});

conditionalTest({ min: 22 })('light mode outgoing fetch', () => {
 test('automatically propagates trace headers to outgoing fetch requests matching tracePropagationTargets', async () => {
 const traceId = crypto.randomUUID().replace(/-/g, '');
 const parentSpanId = traceId.substring(0, 16);

 const runner = createRunner(__dirname, 'server.js').start();

 const response = await runner.makeRequest<Record<string, { 'sentry-trace'?: string; baggage?: string }>>(
 'get',
 '/test-auto-propagation',
 {
 headers: {
 'sentry-trace': `${traceId}-${parentSpanId}-1`,
 baggage: `sentry-trace_id=${traceId},sentry-environment=test,sentry-public_key=public`,
 },
 },
 );

 // /api/v0 matches tracePropagationTargets - should have headers
 expect(response?.['/api/v0']?.['sentry-trace']).toMatch(new RegExp(`^${traceId}-[a-f\\d]{16}-1$`));
 expect(response?.['/api/v0']?.baggage).toContain(`sentry-trace_id=${traceId}`);

 // /api/v1 matches tracePropagationTargets - should have headers
 expect(response?.['/api/v1']?.['sentry-trace']).toMatch(new RegExp(`^${traceId}-[a-f\\d]{16}-1$`));
 expect(response?.['/api/v1']?.baggage).toContain(`sentry-trace_id=${traceId}`);

 // /api/v2 does NOT match tracePropagationTargets - should NOT have headers
 expect(response?.['/api/v2']?.['sentry-trace']).toBeUndefined();
 expect(response?.['/api/v2']?.baggage).toBeUndefined();
 });

 test('does not propagate headers or create breadcrumbs when tracing is suppressed', async () => {
 const runner = createRunner(__dirname, 'server.js')
 .expect({
 event: event => {
 const breadcrumbs = event.breadcrumbs || [];
 const httpBreadcrumbs = breadcrumbs.filter(b => b.category === 'http');

 // Only 1 breadcrumb for v0 - the suppressed v1 request should NOT create a breadcrumb
 expect(httpBreadcrumbs.length).toBe(1);
 expect(httpBreadcrumbs[0]?.data?.url).toContain('/api/v0');
 },
 })
 .start();

 const response = await runner.makeRequest<Record<string, { 'sentry-trace'?: string; baggage?: string }>>(
 'get',
 '/test-suppress-tracing',
 );

 // v0 (not suppressed) should have trace headers
 expect(response?.['/api/v0']?.['sentry-trace']).toBeDefined();
 expect(response?.['/api/v0']?.baggage).toBeDefined();

 // v1 (suppressed) should NOT have trace headers
 expect(response?.['/api/v1']?.['sentry-trace']).toBeUndefined();
 expect(response?.['/api/v1']?.baggage).toBeUndefined();

 await runner.completed();
 });

 test('creates breadcrumbs for outgoing fetch requests', async () => {
 const runner = createRunner(__dirname, 'server.js')
 .expect({
 event: event => {
 const breadcrumbs = event.breadcrumbs || [];
 const httpBreadcrumbs = breadcrumbs.filter(b => b.category === 'http');

 expect(httpBreadcrumbs.length).toBe(2);

 expect(httpBreadcrumbs[0]).toEqual(
 expect.objectContaining({
 category: 'http',
 type: 'http',
 data: expect.objectContaining({
 'http.method': 'GET',
 status_code: 200,
 }),
 }),
 );

 expect(httpBreadcrumbs[1]).toEqual(
 expect.objectContaining({
 category: 'http',
 type: 'http',
 data: expect.objectContaining({
 'http.method': 'GET',
 status_code: 200,
 }),
 }),
 );
 },
 })
 .start();

 await runner.makeRequest('get', '/test-breadcrumbs');

 await runner.completed();
 });
});

161 changes: 8 additions & 153 deletions
packages/node-core/src/integrations/node-fetch/SentryNodeFetchInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,29 +2,16 @@ import { context } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase } from '@opentelemetry/instrumentation';
import type { SanitizedRequestData } from '@sentry/core';
import {
 addBreadcrumb,
 getBreadcrumbLogLevelFromHttpStatusCode,
 getClient,
 getSanitizedUrlString,
 getTraceData,
 LRUMap,
 parseUrl,
 SDK_VERSION,
} from '@sentry/core';
import { shouldPropagateTraceForUrl } from '@sentry/opentelemetry';
import { LRUMap, SDK_VERSION } from '@sentry/core';
import * as diagch from 'diagnostics_channel';
import { NODE_MAJOR, NODE_MINOR } from '../../nodeVersion';
import { mergeBaggageHeaders } from '../../utils/baggage';
import {
 addFetchRequestBreadcrumb,
 addTracePropagationHeadersToFetchRequest,
 getAbsoluteUrl,
} from '../../utils/outgoingFetchRequest';
import type { UndiciRequest, UndiciResponse } from './types';

const SENTRY_TRACE_HEADER = 'sentry-trace';
const SENTRY_BAGGAGE_HEADER = 'baggage';

// For baggage, we make sure to merge this into a possibly existing header
const BAGGAGE_HEADER_REGEX = /baggage: (.*)\r\n/;

export type SentryNodeFetchInstrumentationOptions = InstrumentationConfig & {
 /**
 * Whether breadcrumbs should be recorded for requests.
Expand DownExpand Up@@ -114,7 +101,6 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 * This method is called when a request is created.
 * You can still mutate the request here before it is sent.
 */
 // eslint-disable-next-line complexity
 private _onRequestCreated({ request }: { request: UndiciRequest }): void {
 const config = this.getConfig();
 const enabled = config.enabled !== false;
Expand All@@ -132,70 +118,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 return;
 }

 const url = getAbsoluteUrl(request.origin, request.path);

 // Manually add the trace headers, if it applies
 // Note: We do not use `propagation.inject()` here, because our propagator relies on an active span
 // Which we do not have in this case
 // The propagator _may_ overwrite this, but this should be fine as it is the same data
 const { tracePropagationTargets, propagateTraceparent } = getClient()?.getOptions() || {};
 const addedHeaders = shouldPropagateTraceForUrl(url, tracePropagationTargets, this._propagationDecisionMap)
 ? getTraceData({ propagateTraceparent })
 : undefined;

 if (!addedHeaders) {
 return;
 }

 const { 'sentry-trace': sentryTrace, baggage, traceparent } = addedHeaders;

 // We do not want to overwrite existing headers here
 // If the core UndiciInstrumentation is registered, it will already have set the headers
 // We do not want to add any then
 if (Array.isArray(request.headers)) {
 const requestHeaders = request.headers;

 // We do not want to overwrite existing header here, if it was already set
 if (sentryTrace && !requestHeaders.includes(SENTRY_TRACE_HEADER)) {
 requestHeaders.push(SENTRY_TRACE_HEADER, sentryTrace);
 }

 if (traceparent && !requestHeaders.includes('traceparent')) {
 requestHeaders.push('traceparent', traceparent);
 }

 // For baggage, we make sure to merge this into a possibly existing header
 const existingBaggagePos = requestHeaders.findIndex(header => header === SENTRY_BAGGAGE_HEADER);
 if (baggage && existingBaggagePos === -1) {
 requestHeaders.push(SENTRY_BAGGAGE_HEADER, baggage);
 } else if (baggage) {
 const existingBaggage = requestHeaders[existingBaggagePos + 1];
 const merged = mergeBaggageHeaders(existingBaggage, baggage);
 if (merged) {
 requestHeaders[existingBaggagePos + 1] = merged;
 }
 }
 } else {
 const requestHeaders = request.headers;
 // We do not want to overwrite existing header here, if it was already set
 if (sentryTrace && !requestHeaders.includes(`${SENTRY_TRACE_HEADER}:`)) {
 request.headers += `${SENTRY_TRACE_HEADER}: ${sentryTrace}\r\n`;
 }

 if (traceparent && !requestHeaders.includes('traceparent:')) {
 request.headers += `traceparent: ${traceparent}\r\n`;
 }

 const existingBaggage = request.headers.match(BAGGAGE_HEADER_REGEX)?.[1];
 if (baggage && !existingBaggage) {
 request.headers += `${SENTRY_BAGGAGE_HEADER}: ${baggage}\r\n`;
 } else if (baggage) {
 const merged = mergeBaggageHeaders(existingBaggage, baggage);
 if (merged) {
 request.headers = request.headers.replace(BAGGAGE_HEADER_REGEX, `baggage: ${merged}\r\n`);
 }
 }
 }
 addTracePropagationHeadersToFetchRequest(request, this._propagationDecisionMap);
 }

 /**
Expand All@@ -215,7 +138,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 const shouldIgnore = this._ignoreOutgoingRequestsMap.get(request);

 if (breadCrumbsEnabled && !shouldIgnore) {
addRequestBreadcrumb(request, response);
addFetchRequestBreadcrumb(request, response);
 }
 }

Expand DownExpand Up@@ -263,71 +186,3 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 return ignoreOutgoingRequests(url);
 }
}

/** Add a breadcrumb for outgoing requests. */
function addRequestBreadcrumb(request: UndiciRequest, response: UndiciResponse): void {
 const data = getBreadcrumbData(request);

 const statusCode = response.statusCode;
 const level = getBreadcrumbLogLevelFromHttpStatusCode(statusCode);

 addBreadcrumb(
 {
 category: 'http',
 data: {
 status_code: statusCode,
 ...data,
 },
 type: 'http',
 level,
 },
 {
 event: 'response',
 request,
 response,
 },
 );
}

function getBreadcrumbData(request: UndiciRequest): Partial<SanitizedRequestData> {
 try {
 const url = getAbsoluteUrl(request.origin, request.path);
 const parsedUrl = parseUrl(url);

 const data: Partial<SanitizedRequestData> = {
 url: getSanitizedUrlString(parsedUrl),
 'http.method': request.method || 'GET',
 };

 if (parsedUrl.search) {
 data['http.query'] = parsedUrl.search;
 }
 if (parsedUrl.hash) {
 data['http.fragment'] = parsedUrl.hash;
 }

 return data;
 } catch {
 return {};
 }
}

function getAbsoluteUrl(origin: string, path: string = '/'): string {
 try {
 const url = new URL(path, origin);
 return url.toString();
 } catch {
 // fallback: Construct it on our own
 const url = `${origin}`;

 if (url.endsWith('/') && path.startsWith('/')) {
 return `${url}${path.slice(1)}`;
 }

 if (!url.endsWith('/') && !path.startsWith('/')) {
 return `${url}/${path.slice(1)}`;
 }

 return `${url}${path}`;
 }
}

1 change: 1 addition & 0 deletions
packages/node-core/src/light/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ export { LightNodeClient } from './client';
export { init, getDefaultIntegrations, initWithoutDefaultIntegrations } from './sdk';
export { setAsyncLocalStorageAsyncContextStrategy } from './asyncLocalStorageStrategy';
export { httpIntegration } from './integrations/httpIntegration';
export { nativeNodeFetchIntegration } from './integrations/nativeNodeFetchIntegration';

// Common exports shared with the main entry point
export * from '../common-exports';
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(node-core): Add outgoing fetch trace propagation to light mode#19262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

andreiborza
merged 1 commit into

from

Feb 11, 2026
 Merged


feat(node-core): Add outgoing fetch trace propagation to light mode
#19262
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


80 changes: 80 additions & 0 deletions
dev-packages/node-core-integration-tests/suites/light-mode/outgoing-fetch/server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
const http = require('http');
const Sentry = require('@sentry/node-core/light');
const { loggingTransport, sendPortToRunner } = require('@sentry-internal/node-core-integration-tests');

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
 tracePropagationTargets: [/\/api\/v0/, 'v1'],
});

let capturedV0 = {};
let capturedV1 = {};
let capturedV2 = {};

const targetServer = http.createServer((req, res) => {
 const headers = {
 'sentry-trace': req.headers['sentry-trace'],
 baggage: req.headers['baggage'],
 };

 if (req.url === '/api/v0') {
 capturedV0 = headers;
 } else if (req.url === '/api/v1') {
 capturedV1 = headers;
 } else if (req.url === '/api/v2') {
 capturedV2 = headers;
 }

 res.writeHead(200);
 res.end('ok');
});

targetServer.listen(0, () => {
 const targetPort = targetServer.address().port;
 const targetUrl = `http://localhost:${targetPort}`;

 const server = http.createServer(async (req, res) => {
 switch (req.url) {
 case '/test-auto-propagation': {
 capturedV0 = {};
 capturedV1 = {};
 capturedV2 = {};
 await fetch(`${targetUrl}/api/v0`);
 await fetch(`${targetUrl}/api/v1`);
 await fetch(`${targetUrl}/api/v2`);
 res.writeHead(200, { 'Content-Type': 'application/json' });
 res.end(JSON.stringify({ '/api/v0': capturedV0, '/api/v1': capturedV1, '/api/v2': capturedV2 }));
 break;
 }
 case '/test-breadcrumbs': {
 Sentry.addBreadcrumb({ message: 'manual breadcrumb' });
 await fetch(`${targetUrl}/api/v0`);
 await fetch(`${targetUrl}/api/v1`);
 Sentry.captureException(new Error('foo'));
 res.writeHead(200);
 res.end('ok');
 break;
 }
 case '/test-suppress-tracing': {
 capturedV0 = {};
 capturedV1 = {};
 await fetch(`${targetUrl}/api/v0`);
 await Sentry.suppressTracing(() => fetch(`${targetUrl}/api/v1`));
 Sentry.captureException(new Error('foo'));
 res.writeHead(200, { 'Content-Type': 'application/json' });
 res.end(JSON.stringify({ '/api/v0': capturedV0, '/api/v1': capturedV1 }));
 break;
 }
 default: {
 res.writeHead(404);
 res.end();
 }
 }
 });

 server.listen(0, () => {
 sendPortToRunner(server.address().port);
 });
});

109 changes: 109 additions & 0 deletions
dev-packages/node-core-integration-tests/suites/light-mode/outgoing-fetch/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
import crypto from 'crypto';
import { afterAll, expect, test } from 'vitest';
import { conditionalTest } from '../../../utils';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

afterAll(() => {
 cleanupChildProcesses();
});

conditionalTest({ min: 22 })('light mode outgoing fetch', () => {
 test('automatically propagates trace headers to outgoing fetch requests matching tracePropagationTargets', async () => {
 const traceId = crypto.randomUUID().replace(/-/g, '');
 const parentSpanId = traceId.substring(0, 16);

 const runner = createRunner(__dirname, 'server.js').start();

 const response = await runner.makeRequest<Record<string, { 'sentry-trace'?: string; baggage?: string }>>(
 'get',
 '/test-auto-propagation',
 {
 headers: {
 'sentry-trace': `${traceId}-${parentSpanId}-1`,
 baggage: `sentry-trace_id=${traceId},sentry-environment=test,sentry-public_key=public`,
 },
 },
 );

 // /api/v0 matches tracePropagationTargets - should have headers
 expect(response?.['/api/v0']?.['sentry-trace']).toMatch(new RegExp(`^${traceId}-[a-f\\d]{16}-1$`));
 expect(response?.['/api/v0']?.baggage).toContain(`sentry-trace_id=${traceId}`);

 // /api/v1 matches tracePropagationTargets - should have headers
 expect(response?.['/api/v1']?.['sentry-trace']).toMatch(new RegExp(`^${traceId}-[a-f\\d]{16}-1$`));
 expect(response?.['/api/v1']?.baggage).toContain(`sentry-trace_id=${traceId}`);

 // /api/v2 does NOT match tracePropagationTargets - should NOT have headers
 expect(response?.['/api/v2']?.['sentry-trace']).toBeUndefined();
 expect(response?.['/api/v2']?.baggage).toBeUndefined();
 });

 test('does not propagate headers or create breadcrumbs when tracing is suppressed', async () => {
 const runner = createRunner(__dirname, 'server.js')
 .expect({
 event: event => {
 const breadcrumbs = event.breadcrumbs || [];
 const httpBreadcrumbs = breadcrumbs.filter(b => b.category === 'http');

 // Only 1 breadcrumb for v0 - the suppressed v1 request should NOT create a breadcrumb
 expect(httpBreadcrumbs.length).toBe(1);
 expect(httpBreadcrumbs[0]?.data?.url).toContain('/api/v0');
 },
 })
 .start();

 const response = await runner.makeRequest<Record<string, { 'sentry-trace'?: string; baggage?: string }>>(
 'get',
 '/test-suppress-tracing',
 );

 // v0 (not suppressed) should have trace headers
 expect(response?.['/api/v0']?.['sentry-trace']).toBeDefined();
 expect(response?.['/api/v0']?.baggage).toBeDefined();

 // v1 (suppressed) should NOT have trace headers
 expect(response?.['/api/v1']?.['sentry-trace']).toBeUndefined();
 expect(response?.['/api/v1']?.baggage).toBeUndefined();

 await runner.completed();
 });

 test('creates breadcrumbs for outgoing fetch requests', async () => {
 const runner = createRunner(__dirname, 'server.js')
 .expect({
 event: event => {
 const breadcrumbs = event.breadcrumbs || [];
 const httpBreadcrumbs = breadcrumbs.filter(b => b.category === 'http');

 expect(httpBreadcrumbs.length).toBe(2);

 expect(httpBreadcrumbs[0]).toEqual(
 expect.objectContaining({
 category: 'http',
 type: 'http',
 data: expect.objectContaining({
 'http.method': 'GET',
 status_code: 200,
 }),
 }),
 );

 expect(httpBreadcrumbs[1]).toEqual(
 expect.objectContaining({
 category: 'http',
 type: 'http',
 data: expect.objectContaining({
 'http.method': 'GET',
 status_code: 200,
 }),
 }),
 );
 },
 })
 .start();

 await runner.makeRequest('get', '/test-breadcrumbs');

 await runner.completed();
 });
});

161 changes: 8 additions & 153 deletions
packages/node-core/src/integrations/node-fetch/SentryNodeFetchInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,29 +2,16 @@ import { context } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase } from '@opentelemetry/instrumentation';
import type { SanitizedRequestData } from '@sentry/core';
import {
 addBreadcrumb,
 getBreadcrumbLogLevelFromHttpStatusCode,
 getClient,
 getSanitizedUrlString,
 getTraceData,
 LRUMap,
 parseUrl,
 SDK_VERSION,
} from '@sentry/core';
import { shouldPropagateTraceForUrl } from '@sentry/opentelemetry';
import { LRUMap, SDK_VERSION } from '@sentry/core';
import * as diagch from 'diagnostics_channel';
import { NODE_MAJOR, NODE_MINOR } from '../../nodeVersion';
import { mergeBaggageHeaders } from '../../utils/baggage';
import {
 addFetchRequestBreadcrumb,
 addTracePropagationHeadersToFetchRequest,
 getAbsoluteUrl,
} from '../../utils/outgoingFetchRequest';
import type { UndiciRequest, UndiciResponse } from './types';

const SENTRY_TRACE_HEADER = 'sentry-trace';
const SENTRY_BAGGAGE_HEADER = 'baggage';

// For baggage, we make sure to merge this into a possibly existing header
const BAGGAGE_HEADER_REGEX = /baggage: (.*)\r\n/;

export type SentryNodeFetchInstrumentationOptions = InstrumentationConfig & {
 /**
 * Whether breadcrumbs should be recorded for requests.
Expand DownExpand Up@@ -114,7 +101,6 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 * This method is called when a request is created.
 * You can still mutate the request here before it is sent.
 */
 // eslint-disable-next-line complexity
 private _onRequestCreated({ request }: { request: UndiciRequest }): void {
 const config = this.getConfig();
 const enabled = config.enabled !== false;
Expand All@@ -132,70 +118,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 return;
 }

 const url = getAbsoluteUrl(request.origin, request.path);

 // Manually add the trace headers, if it applies
 // Note: We do not use `propagation.inject()` here, because our propagator relies on an active span
 // Which we do not have in this case
 // The propagator _may_ overwrite this, but this should be fine as it is the same data
 const { tracePropagationTargets, propagateTraceparent } = getClient()?.getOptions() || {};
 const addedHeaders = shouldPropagateTraceForUrl(url, tracePropagationTargets, this._propagationDecisionMap)
 ? getTraceData({ propagateTraceparent })
 : undefined;

 if (!addedHeaders) {
 return;
 }

 const { 'sentry-trace': sentryTrace, baggage, traceparent } = addedHeaders;

 // We do not want to overwrite existing headers here
 // If the core UndiciInstrumentation is registered, it will already have set the headers
 // We do not want to add any then
 if (Array.isArray(request.headers)) {
 const requestHeaders = request.headers;

 // We do not want to overwrite existing header here, if it was already set
 if (sentryTrace && !requestHeaders.includes(SENTRY_TRACE_HEADER)) {
 requestHeaders.push(SENTRY_TRACE_HEADER, sentryTrace);
 }

 if (traceparent && !requestHeaders.includes('traceparent')) {
 requestHeaders.push('traceparent', traceparent);
 }

 // For baggage, we make sure to merge this into a possibly existing header
 const existingBaggagePos = requestHeaders.findIndex(header => header === SENTRY_BAGGAGE_HEADER);
 if (baggage && existingBaggagePos === -1) {
 requestHeaders.push(SENTRY_BAGGAGE_HEADER, baggage);
 } else if (baggage) {
 const existingBaggage = requestHeaders[existingBaggagePos + 1];
 const merged = mergeBaggageHeaders(existingBaggage, baggage);
 if (merged) {
 requestHeaders[existingBaggagePos + 1] = merged;
 }
 }
 } else {
 const requestHeaders = request.headers;
 // We do not want to overwrite existing header here, if it was already set
 if (sentryTrace && !requestHeaders.includes(`${SENTRY_TRACE_HEADER}:`)) {
 request.headers += `${SENTRY_TRACE_HEADER}: ${sentryTrace}\r\n`;
 }

 if (traceparent && !requestHeaders.includes('traceparent:')) {
 request.headers += `traceparent: ${traceparent}\r\n`;
 }

 const existingBaggage = request.headers.match(BAGGAGE_HEADER_REGEX)?.[1];
 if (baggage && !existingBaggage) {
 request.headers += `${SENTRY_BAGGAGE_HEADER}: ${baggage}\r\n`;
 } else if (baggage) {
 const merged = mergeBaggageHeaders(existingBaggage, baggage);
 if (merged) {
 request.headers = request.headers.replace(BAGGAGE_HEADER_REGEX, `baggage: ${merged}\r\n`);
 }
 }
 }
 addTracePropagationHeadersToFetchRequest(request, this._propagationDecisionMap);
 }

 /**
Expand All@@ -215,7 +138,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 const shouldIgnore = this._ignoreOutgoingRequestsMap.get(request);

 if (breadCrumbsEnabled && !shouldIgnore) {
addRequestBreadcrumb(request, response);
addFetchRequestBreadcrumb(request, response);
 }
 }

Expand DownExpand Up@@ -263,71 +186,3 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 return ignoreOutgoingRequests(url);
 }
}

/** Add a breadcrumb for outgoing requests. */
function addRequestBreadcrumb(request: UndiciRequest, response: UndiciResponse): void {
 const data = getBreadcrumbData(request);

 const statusCode = response.statusCode;
 const level = getBreadcrumbLogLevelFromHttpStatusCode(statusCode);

 addBreadcrumb(
 {
 category: 'http',
 data: {
 status_code: statusCode,
 ...data,
 },
 type: 'http',
 level,
 },
 {
 event: 'response',
 request,
 response,
 },
 );
}

function getBreadcrumbData(request: UndiciRequest): Partial<SanitizedRequestData> {
 try {
 const url = getAbsoluteUrl(request.origin, request.path);
 const parsedUrl = parseUrl(url);

 const data: Partial<SanitizedRequestData> = {
 url: getSanitizedUrlString(parsedUrl),
 'http.method': request.method || 'GET',
 };

 if (parsedUrl.search) {
 data['http.query'] = parsedUrl.search;
 }
 if (parsedUrl.hash) {
 data['http.fragment'] = parsedUrl.hash;
 }

 return data;
 } catch {
 return {};
 }
}

function getAbsoluteUrl(origin: string, path: string = '/'): string {
 try {
 const url = new URL(path, origin);
 return url.toString();
 } catch {
 // fallback: Construct it on our own
 const url = `${origin}`;

 if (url.endsWith('/') && path.startsWith('/')) {
 return `${url}${path.slice(1)}`;
 }

 if (!url.endsWith('/') && !path.startsWith('/')) {
 return `${url}/${path.slice(1)}`;
 }

 return `${url}${path}`;
 }
}

1 change: 1 addition & 0 deletions
packages/node-core/src/light/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ export { LightNodeClient } from './client';
export { init, getDefaultIntegrations, initWithoutDefaultIntegrations } from './sdk';
export { setAsyncLocalStorageAsyncContextStrategy } from './asyncLocalStorageStrategy';
export { httpIntegration } from './integrations/httpIntegration';
export { nativeNodeFetchIntegration } from './integrations/nativeNodeFetchIntegration';

// Common exports shared with the main entry point
export * from '../common-exports';
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(node-core): Add outgoing fetch trace propagation to light mode#19262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

andreiborza
merged 1 commit into

from

Feb 11, 2026
 Merged


feat(node-core): Add outgoing fetch trace propagation to light mode
#19262
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


80 changes: 80 additions & 0 deletions
dev-packages/node-core-integration-tests/suites/light-mode/outgoing-fetch/server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
const http = require('http');
const Sentry = require('@sentry/node-core/light');
const { loggingTransport, sendPortToRunner } = require('@sentry-internal/node-core-integration-tests');

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
 tracePropagationTargets: [/\/api\/v0/, 'v1'],
});

let capturedV0 = {};
let capturedV1 = {};
let capturedV2 = {};

const targetServer = http.createServer((req, res) => {
 const headers = {
 'sentry-trace': req.headers['sentry-trace'],
 baggage: req.headers['baggage'],
 };

 if (req.url === '/api/v0') {
 capturedV0 = headers;
 } else if (req.url === '/api/v1') {
 capturedV1 = headers;
 } else if (req.url === '/api/v2') {
 capturedV2 = headers;
 }

 res.writeHead(200);
 res.end('ok');
});

targetServer.listen(0, () => {
 const targetPort = targetServer.address().port;
 const targetUrl = `http://localhost:${targetPort}`;

 const server = http.createServer(async (req, res) => {
 switch (req.url) {
 case '/test-auto-propagation': {
 capturedV0 = {};
 capturedV1 = {};
 capturedV2 = {};
 await fetch(`${targetUrl}/api/v0`);
 await fetch(`${targetUrl}/api/v1`);
 await fetch(`${targetUrl}/api/v2`);
 res.writeHead(200, { 'Content-Type': 'application/json' });
 res.end(JSON.stringify({ '/api/v0': capturedV0, '/api/v1': capturedV1, '/api/v2': capturedV2 }));
 break;
 }
 case '/test-breadcrumbs': {
 Sentry.addBreadcrumb({ message: 'manual breadcrumb' });
 await fetch(`${targetUrl}/api/v0`);
 await fetch(`${targetUrl}/api/v1`);
 Sentry.captureException(new Error('foo'));
 res.writeHead(200);
 res.end('ok');
 break;
 }
 case '/test-suppress-tracing': {
 capturedV0 = {};
 capturedV1 = {};
 await fetch(`${targetUrl}/api/v0`);
 await Sentry.suppressTracing(() => fetch(`${targetUrl}/api/v1`));
 Sentry.captureException(new Error('foo'));
 res.writeHead(200, { 'Content-Type': 'application/json' });
 res.end(JSON.stringify({ '/api/v0': capturedV0, '/api/v1': capturedV1 }));
 break;
 }
 default: {
 res.writeHead(404);
 res.end();
 }
 }
 });

 server.listen(0, () => {
 sendPortToRunner(server.address().port);
 });
});

109 changes: 109 additions & 0 deletions
dev-packages/node-core-integration-tests/suites/light-mode/outgoing-fetch/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
import crypto from 'crypto';
import { afterAll, expect, test } from 'vitest';
import { conditionalTest } from '../../../utils';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

afterAll(() => {
 cleanupChildProcesses();
});

conditionalTest({ min: 22 })('light mode outgoing fetch', () => {
 test('automatically propagates trace headers to outgoing fetch requests matching tracePropagationTargets', async () => {
 const traceId = crypto.randomUUID().replace(/-/g, '');
 const parentSpanId = traceId.substring(0, 16);

 const runner = createRunner(__dirname, 'server.js').start();

 const response = await runner.makeRequest<Record<string, { 'sentry-trace'?: string; baggage?: string }>>(
 'get',
 '/test-auto-propagation',
 {
 headers: {
 'sentry-trace': `${traceId}-${parentSpanId}-1`,
 baggage: `sentry-trace_id=${traceId},sentry-environment=test,sentry-public_key=public`,
 },
 },
 );

 // /api/v0 matches tracePropagationTargets - should have headers
 expect(response?.['/api/v0']?.['sentry-trace']).toMatch(new RegExp(`^${traceId}-[a-f\\d]{16}-1$`));
 expect(response?.['/api/v0']?.baggage).toContain(`sentry-trace_id=${traceId}`);

 // /api/v1 matches tracePropagationTargets - should have headers
 expect(response?.['/api/v1']?.['sentry-trace']).toMatch(new RegExp(`^${traceId}-[a-f\\d]{16}-1$`));
 expect(response?.['/api/v1']?.baggage).toContain(`sentry-trace_id=${traceId}`);

 // /api/v2 does NOT match tracePropagationTargets - should NOT have headers
 expect(response?.['/api/v2']?.['sentry-trace']).toBeUndefined();
 expect(response?.['/api/v2']?.baggage).toBeUndefined();
 });

 test('does not propagate headers or create breadcrumbs when tracing is suppressed', async () => {
 const runner = createRunner(__dirname, 'server.js')
 .expect({
 event: event => {
 const breadcrumbs = event.breadcrumbs || [];
 const httpBreadcrumbs = breadcrumbs.filter(b => b.category === 'http');

 // Only 1 breadcrumb for v0 - the suppressed v1 request should NOT create a breadcrumb
 expect(httpBreadcrumbs.length).toBe(1);
 expect(httpBreadcrumbs[0]?.data?.url).toContain('/api/v0');
 },
 })
 .start();

 const response = await runner.makeRequest<Record<string, { 'sentry-trace'?: string; baggage?: string }>>(
 'get',
 '/test-suppress-tracing',
 );

 // v0 (not suppressed) should have trace headers
 expect(response?.['/api/v0']?.['sentry-trace']).toBeDefined();
 expect(response?.['/api/v0']?.baggage).toBeDefined();

 // v1 (suppressed) should NOT have trace headers
 expect(response?.['/api/v1']?.['sentry-trace']).toBeUndefined();
 expect(response?.['/api/v1']?.baggage).toBeUndefined();

 await runner.completed();
 });

 test('creates breadcrumbs for outgoing fetch requests', async () => {
 const runner = createRunner(__dirname, 'server.js')
 .expect({
 event: event => {
 const breadcrumbs = event.breadcrumbs || [];
 const httpBreadcrumbs = breadcrumbs.filter(b => b.category === 'http');

 expect(httpBreadcrumbs.length).toBe(2);

 expect(httpBreadcrumbs[0]).toEqual(
 expect.objectContaining({
 category: 'http',
 type: 'http',
 data: expect.objectContaining({
 'http.method': 'GET',
 status_code: 200,
 }),
 }),
 );

 expect(httpBreadcrumbs[1]).toEqual(
 expect.objectContaining({
 category: 'http',
 type: 'http',
 data: expect.objectContaining({
 'http.method': 'GET',
 status_code: 200,
 }),
 }),
 );
 },
 })
 .start();

 await runner.makeRequest('get', '/test-breadcrumbs');

 await runner.completed();
 });
});

161 changes: 8 additions & 153 deletions
packages/node-core/src/integrations/node-fetch/SentryNodeFetchInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,29 +2,16 @@ import { context } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase } from '@opentelemetry/instrumentation';
import type { SanitizedRequestData } from '@sentry/core';
import {
 addBreadcrumb,
 getBreadcrumbLogLevelFromHttpStatusCode,
 getClient,
 getSanitizedUrlString,
 getTraceData,
 LRUMap,
 parseUrl,
 SDK_VERSION,
} from '@sentry/core';
import { shouldPropagateTraceForUrl } from '@sentry/opentelemetry';
import { LRUMap, SDK_VERSION } from '@sentry/core';
import * as diagch from 'diagnostics_channel';
import { NODE_MAJOR, NODE_MINOR } from '../../nodeVersion';
import { mergeBaggageHeaders } from '../../utils/baggage';
import {
 addFetchRequestBreadcrumb,
 addTracePropagationHeadersToFetchRequest,
 getAbsoluteUrl,
} from '../../utils/outgoingFetchRequest';
import type { UndiciRequest, UndiciResponse } from './types';

const SENTRY_TRACE_HEADER = 'sentry-trace';
const SENTRY_BAGGAGE_HEADER = 'baggage';

// For baggage, we make sure to merge this into a possibly existing header
const BAGGAGE_HEADER_REGEX = /baggage: (.*)\r\n/;

export type SentryNodeFetchInstrumentationOptions = InstrumentationConfig & {
 /**
 * Whether breadcrumbs should be recorded for requests.
Expand DownExpand Up@@ -114,7 +101,6 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 * This method is called when a request is created.
 * You can still mutate the request here before it is sent.
 */
 // eslint-disable-next-line complexity
 private _onRequestCreated({ request }: { request: UndiciRequest }): void {
 const config = this.getConfig();
 const enabled = config.enabled !== false;
Expand All@@ -132,70 +118,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 return;
 }

 const url = getAbsoluteUrl(request.origin, request.path);

 // Manually add the trace headers, if it applies
 // Note: We do not use `propagation.inject()` here, because our propagator relies on an active span
 // Which we do not have in this case
 // The propagator _may_ overwrite this, but this should be fine as it is the same data
 const { tracePropagationTargets, propagateTraceparent } = getClient()?.getOptions() || {};
 const addedHeaders = shouldPropagateTraceForUrl(url, tracePropagationTargets, this._propagationDecisionMap)
 ? getTraceData({ propagateTraceparent })
 : undefined;

 if (!addedHeaders) {
 return;
 }

 const { 'sentry-trace': sentryTrace, baggage, traceparent } = addedHeaders;

 // We do not want to overwrite existing headers here
 // If the core UndiciInstrumentation is registered, it will already have set the headers
 // We do not want to add any then
 if (Array.isArray(request.headers)) {
 const requestHeaders = request.headers;

 // We do not want to overwrite existing header here, if it was already set
 if (sentryTrace && !requestHeaders.includes(SENTRY_TRACE_HEADER)) {
 requestHeaders.push(SENTRY_TRACE_HEADER, sentryTrace);
 }

 if (traceparent && !requestHeaders.includes('traceparent')) {
 requestHeaders.push('traceparent', traceparent);
 }

 // For baggage, we make sure to merge this into a possibly existing header
 const existingBaggagePos = requestHeaders.findIndex(header => header === SENTRY_BAGGAGE_HEADER);
 if (baggage && existingBaggagePos === -1) {
 requestHeaders.push(SENTRY_BAGGAGE_HEADER, baggage);
 } else if (baggage) {
 const existingBaggage = requestHeaders[existingBaggagePos + 1];
 const merged = mergeBaggageHeaders(existingBaggage, baggage);
 if (merged) {
 requestHeaders[existingBaggagePos + 1] = merged;
 }
 }
 } else {
 const requestHeaders = request.headers;
 // We do not want to overwrite existing header here, if it was already set
 if (sentryTrace && !requestHeaders.includes(`${SENTRY_TRACE_HEADER}:`)) {
 request.headers += `${SENTRY_TRACE_HEADER}: ${sentryTrace}\r\n`;
 }

 if (traceparent && !requestHeaders.includes('traceparent:')) {
 request.headers += `traceparent: ${traceparent}\r\n`;
 }

 const existingBaggage = request.headers.match(BAGGAGE_HEADER_REGEX)?.[1];
 if (baggage && !existingBaggage) {
 request.headers += `${SENTRY_BAGGAGE_HEADER}: ${baggage}\r\n`;
 } else if (baggage) {
 const merged = mergeBaggageHeaders(existingBaggage, baggage);
 if (merged) {
 request.headers = request.headers.replace(BAGGAGE_HEADER_REGEX, `baggage: ${merged}\r\n`);
 }
 }
 }
 addTracePropagationHeadersToFetchRequest(request, this._propagationDecisionMap);
 }

 /**
Expand All@@ -215,7 +138,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 const shouldIgnore = this._ignoreOutgoingRequestsMap.get(request);

 if (breadCrumbsEnabled && !shouldIgnore) {
addRequestBreadcrumb(request, response);
addFetchRequestBreadcrumb(request, response);
 }
 }

Expand DownExpand Up@@ -263,71 +186,3 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 return ignoreOutgoingRequests(url);
 }
}

/** Add a breadcrumb for outgoing requests. */
function addRequestBreadcrumb(request: UndiciRequest, response: UndiciResponse): void {
 const data = getBreadcrumbData(request);

 const statusCode = response.statusCode;
 const level = getBreadcrumbLogLevelFromHttpStatusCode(statusCode);

 addBreadcrumb(
 {
 category: 'http',
 data: {
 status_code: statusCode,
 ...data,
 },
 type: 'http',
 level,
 },
 {
 event: 'response',
 request,
 response,
 },
 );
}

function getBreadcrumbData(request: UndiciRequest): Partial<SanitizedRequestData> {
 try {
 const url = getAbsoluteUrl(request.origin, request.path);
 const parsedUrl = parseUrl(url);

 const data: Partial<SanitizedRequestData> = {
 url: getSanitizedUrlString(parsedUrl),
 'http.method': request.method || 'GET',
 };

 if (parsedUrl.search) {
 data['http.query'] = parsedUrl.search;
 }
 if (parsedUrl.hash) {
 data['http.fragment'] = parsedUrl.hash;
 }

 return data;
 } catch {
 return {};
 }
}

function getAbsoluteUrl(origin: string, path: string = '/'): string {
 try {
 const url = new URL(path, origin);
 return url.toString();
 } catch {
 // fallback: Construct it on our own
 const url = `${origin}`;

 if (url.endsWith('/') && path.startsWith('/')) {
 return `${url}${path.slice(1)}`;
 }

 if (!url.endsWith('/') && !path.startsWith('/')) {
 return `${url}/${path.slice(1)}`;
 }

 return `${url}${path}`;
 }
}

1 change: 1 addition & 0 deletions
packages/node-core/src/light/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ export { LightNodeClient } from './client';
export { init, getDefaultIntegrations, initWithoutDefaultIntegrations } from './sdk';
export { setAsyncLocalStorageAsyncContextStrategy } from './asyncLocalStorageStrategy';
export { httpIntegration } from './integrations/httpIntegration';
export { nativeNodeFetchIntegration } from './integrations/nativeNodeFetchIntegration';

// Common exports shared with the main entry point
export * from '../common-exports';
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(node-core): Add outgoing fetch trace propagation to light mode#19262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

andreiborza
merged 1 commit into

from

Feb 11, 2026
 Merged


feat(node-core): Add outgoing fetch trace propagation to light mode
#19262
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


80 changes: 80 additions & 0 deletions
dev-packages/node-core-integration-tests/suites/light-mode/outgoing-fetch/server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
const http = require('http');
const Sentry = require('@sentry/node-core/light');
const { loggingTransport, sendPortToRunner } = require('@sentry-internal/node-core-integration-tests');

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
 tracePropagationTargets: [/\/api\/v0/, 'v1'],
});

let capturedV0 = {};
let capturedV1 = {};
let capturedV2 = {};

const targetServer = http.createServer((req, res) => {
 const headers = {
 'sentry-trace': req.headers['sentry-trace'],
 baggage: req.headers['baggage'],
 };

 if (req.url === '/api/v0') {
 capturedV0 = headers;
 } else if (req.url === '/api/v1') {
 capturedV1 = headers;
 } else if (req.url === '/api/v2') {
 capturedV2 = headers;
 }

 res.writeHead(200);
 res.end('ok');
});

targetServer.listen(0, () => {
 const targetPort = targetServer.address().port;
 const targetUrl = `http://localhost:${targetPort}`;

 const server = http.createServer(async (req, res) => {
 switch (req.url) {
 case '/test-auto-propagation': {
 capturedV0 = {};
 capturedV1 = {};
 capturedV2 = {};
 await fetch(`${targetUrl}/api/v0`);
 await fetch(`${targetUrl}/api/v1`);
 await fetch(`${targetUrl}/api/v2`);
 res.writeHead(200, { 'Content-Type': 'application/json' });
 res.end(JSON.stringify({ '/api/v0': capturedV0, '/api/v1': capturedV1, '/api/v2': capturedV2 }));
 break;
 }
 case '/test-breadcrumbs': {
 Sentry.addBreadcrumb({ message: 'manual breadcrumb' });
 await fetch(`${targetUrl}/api/v0`);
 await fetch(`${targetUrl}/api/v1`);
 Sentry.captureException(new Error('foo'));
 res.writeHead(200);
 res.end('ok');
 break;
 }
 case '/test-suppress-tracing': {
 capturedV0 = {};
 capturedV1 = {};
 await fetch(`${targetUrl}/api/v0`);
 await Sentry.suppressTracing(() => fetch(`${targetUrl}/api/v1`));
 Sentry.captureException(new Error('foo'));
 res.writeHead(200, { 'Content-Type': 'application/json' });
 res.end(JSON.stringify({ '/api/v0': capturedV0, '/api/v1': capturedV1 }));
 break;
 }
 default: {
 res.writeHead(404);
 res.end();
 }
 }
 });

 server.listen(0, () => {
 sendPortToRunner(server.address().port);
 });
});

109 changes: 109 additions & 0 deletions
dev-packages/node-core-integration-tests/suites/light-mode/outgoing-fetch/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
import crypto from 'crypto';
import { afterAll, expect, test } from 'vitest';
import { conditionalTest } from '../../../utils';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

afterAll(() => {
 cleanupChildProcesses();
});

conditionalTest({ min: 22 })('light mode outgoing fetch', () => {
 test('automatically propagates trace headers to outgoing fetch requests matching tracePropagationTargets', async () => {
 const traceId = crypto.randomUUID().replace(/-/g, '');
 const parentSpanId = traceId.substring(0, 16);

 const runner = createRunner(__dirname, 'server.js').start();

 const response = await runner.makeRequest<Record<string, { 'sentry-trace'?: string; baggage?: string }>>(
 'get',
 '/test-auto-propagation',
 {
 headers: {
 'sentry-trace': `${traceId}-${parentSpanId}-1`,
 baggage: `sentry-trace_id=${traceId},sentry-environment=test,sentry-public_key=public`,
 },
 },
 );

 // /api/v0 matches tracePropagationTargets - should have headers
 expect(response?.['/api/v0']?.['sentry-trace']).toMatch(new RegExp(`^${traceId}-[a-f\\d]{16}-1$`));
 expect(response?.['/api/v0']?.baggage).toContain(`sentry-trace_id=${traceId}`);

 // /api/v1 matches tracePropagationTargets - should have headers
 expect(response?.['/api/v1']?.['sentry-trace']).toMatch(new RegExp(`^${traceId}-[a-f\\d]{16}-1$`));
 expect(response?.['/api/v1']?.baggage).toContain(`sentry-trace_id=${traceId}`);

 // /api/v2 does NOT match tracePropagationTargets - should NOT have headers
 expect(response?.['/api/v2']?.['sentry-trace']).toBeUndefined();
 expect(response?.['/api/v2']?.baggage).toBeUndefined();
 });

 test('does not propagate headers or create breadcrumbs when tracing is suppressed', async () => {
 const runner = createRunner(__dirname, 'server.js')
 .expect({
 event: event => {
 const breadcrumbs = event.breadcrumbs || [];
 const httpBreadcrumbs = breadcrumbs.filter(b => b.category === 'http');

 // Only 1 breadcrumb for v0 - the suppressed v1 request should NOT create a breadcrumb
 expect(httpBreadcrumbs.length).toBe(1);
 expect(httpBreadcrumbs[0]?.data?.url).toContain('/api/v0');
 },
 })
 .start();

 const response = await runner.makeRequest<Record<string, { 'sentry-trace'?: string; baggage?: string }>>(
 'get',
 '/test-suppress-tracing',
 );

 // v0 (not suppressed) should have trace headers
 expect(response?.['/api/v0']?.['sentry-trace']).toBeDefined();
 expect(response?.['/api/v0']?.baggage).toBeDefined();

 // v1 (suppressed) should NOT have trace headers
 expect(response?.['/api/v1']?.['sentry-trace']).toBeUndefined();
 expect(response?.['/api/v1']?.baggage).toBeUndefined();

 await runner.completed();
 });

 test('creates breadcrumbs for outgoing fetch requests', async () => {
 const runner = createRunner(__dirname, 'server.js')
 .expect({
 event: event => {
 const breadcrumbs = event.breadcrumbs || [];
 const httpBreadcrumbs = breadcrumbs.filter(b => b.category === 'http');

 expect(httpBreadcrumbs.length).toBe(2);

 expect(httpBreadcrumbs[0]).toEqual(
 expect.objectContaining({
 category: 'http',
 type: 'http',
 data: expect.objectContaining({
 'http.method': 'GET',
 status_code: 200,
 }),
 }),
 );

 expect(httpBreadcrumbs[1]).toEqual(
 expect.objectContaining({
 category: 'http',
 type: 'http',
 data: expect.objectContaining({
 'http.method': 'GET',
 status_code: 200,
 }),
 }),
 );
 },
 })
 .start();

 await runner.makeRequest('get', '/test-breadcrumbs');

 await runner.completed();
 });
});

161 changes: 8 additions & 153 deletions
packages/node-core/src/integrations/node-fetch/SentryNodeFetchInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,29 +2,16 @@ import { context } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase } from '@opentelemetry/instrumentation';
import type { SanitizedRequestData } from '@sentry/core';
import {
 addBreadcrumb,
 getBreadcrumbLogLevelFromHttpStatusCode,
 getClient,
 getSanitizedUrlString,
 getTraceData,
 LRUMap,
 parseUrl,
 SDK_VERSION,
} from '@sentry/core';
import { shouldPropagateTraceForUrl } from '@sentry/opentelemetry';
import { LRUMap, SDK_VERSION } from '@sentry/core';
import * as diagch from 'diagnostics_channel';
import { NODE_MAJOR, NODE_MINOR } from '../../nodeVersion';
import { mergeBaggageHeaders } from '../../utils/baggage';
import {
 addFetchRequestBreadcrumb,
 addTracePropagationHeadersToFetchRequest,
 getAbsoluteUrl,
} from '../../utils/outgoingFetchRequest';
import type { UndiciRequest, UndiciResponse } from './types';

const SENTRY_TRACE_HEADER = 'sentry-trace';
const SENTRY_BAGGAGE_HEADER = 'baggage';

// For baggage, we make sure to merge this into a possibly existing header
const BAGGAGE_HEADER_REGEX = /baggage: (.*)\r\n/;

export type SentryNodeFetchInstrumentationOptions = InstrumentationConfig & {
 /**
 * Whether breadcrumbs should be recorded for requests.
Expand DownExpand Up@@ -114,7 +101,6 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 * This method is called when a request is created.
 * You can still mutate the request here before it is sent.
 */
 // eslint-disable-next-line complexity
 private _onRequestCreated({ request }: { request: UndiciRequest }): void {
 const config = this.getConfig();
 const enabled = config.enabled !== false;
Expand All@@ -132,70 +118,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 return;
 }

 const url = getAbsoluteUrl(request.origin, request.path);

 // Manually add the trace headers, if it applies
 // Note: We do not use `propagation.inject()` here, because our propagator relies on an active span
 // Which we do not have in this case
 // The propagator _may_ overwrite this, but this should be fine as it is the same data
 const { tracePropagationTargets, propagateTraceparent } = getClient()?.getOptions() || {};
 const addedHeaders = shouldPropagateTraceForUrl(url, tracePropagationTargets, this._propagationDecisionMap)
 ? getTraceData({ propagateTraceparent })
 : undefined;

 if (!addedHeaders) {
 return;
 }

 const { 'sentry-trace': sentryTrace, baggage, traceparent } = addedHeaders;

 // We do not want to overwrite existing headers here
 // If the core UndiciInstrumentation is registered, it will already have set the headers
 // We do not want to add any then
 if (Array.isArray(request.headers)) {
 const requestHeaders = request.headers;

 // We do not want to overwrite existing header here, if it was already set
 if (sentryTrace && !requestHeaders.includes(SENTRY_TRACE_HEADER)) {
 requestHeaders.push(SENTRY_TRACE_HEADER, sentryTrace);
 }

 if (traceparent && !requestHeaders.includes('traceparent')) {
 requestHeaders.push('traceparent', traceparent);
 }

 // For baggage, we make sure to merge this into a possibly existing header
 const existingBaggagePos = requestHeaders.findIndex(header => header === SENTRY_BAGGAGE_HEADER);
 if (baggage && existingBaggagePos === -1) {
 requestHeaders.push(SENTRY_BAGGAGE_HEADER, baggage);
 } else if (baggage) {
 const existingBaggage = requestHeaders[existingBaggagePos + 1];
 const merged = mergeBaggageHeaders(existingBaggage, baggage);
 if (merged) {
 requestHeaders[existingBaggagePos + 1] = merged;
 }
 }
 } else {
 const requestHeaders = request.headers;
 // We do not want to overwrite existing header here, if it was already set
 if (sentryTrace && !requestHeaders.includes(`${SENTRY_TRACE_HEADER}:`)) {
 request.headers += `${SENTRY_TRACE_HEADER}: ${sentryTrace}\r\n`;
 }

 if (traceparent && !requestHeaders.includes('traceparent:')) {
 request.headers += `traceparent: ${traceparent}\r\n`;
 }

 const existingBaggage = request.headers.match(BAGGAGE_HEADER_REGEX)?.[1];
 if (baggage && !existingBaggage) {
 request.headers += `${SENTRY_BAGGAGE_HEADER}: ${baggage}\r\n`;
 } else if (baggage) {
 const merged = mergeBaggageHeaders(existingBaggage, baggage);
 if (merged) {
 request.headers = request.headers.replace(BAGGAGE_HEADER_REGEX, `baggage: ${merged}\r\n`);
 }
 }
 }
 addTracePropagationHeadersToFetchRequest(request, this._propagationDecisionMap);
 }

 /**
Expand All@@ -215,7 +138,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 const shouldIgnore = this._ignoreOutgoingRequestsMap.get(request);

 if (breadCrumbsEnabled && !shouldIgnore) {
addRequestBreadcrumb(request, response);
addFetchRequestBreadcrumb(request, response);
 }
 }

Expand DownExpand Up@@ -263,71 +186,3 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 return ignoreOutgoingRequests(url);
 }
}

/** Add a breadcrumb for outgoing requests. */
function addRequestBreadcrumb(request: UndiciRequest, response: UndiciResponse): void {
 const data = getBreadcrumbData(request);

 const statusCode = response.statusCode;
 const level = getBreadcrumbLogLevelFromHttpStatusCode(statusCode);

 addBreadcrumb(
 {
 category: 'http',
 data: {
 status_code: statusCode,
 ...data,
 },
 type: 'http',
 level,
 },
 {
 event: 'response',
 request,
 response,
 },
 );
}

function getBreadcrumbData(request: UndiciRequest): Partial<SanitizedRequestData> {
 try {
 const url = getAbsoluteUrl(request.origin, request.path);
 const parsedUrl = parseUrl(url);

 const data: Partial<SanitizedRequestData> = {
 url: getSanitizedUrlString(parsedUrl),
 'http.method': request.method || 'GET',
 };

 if (parsedUrl.search) {
 data['http.query'] = parsedUrl.search;
 }
 if (parsedUrl.hash) {
 data['http.fragment'] = parsedUrl.hash;
 }

 return data;
 } catch {
 return {};
 }
}

function getAbsoluteUrl(origin: string, path: string = '/'): string {
 try {
 const url = new URL(path, origin);
 return url.toString();
 } catch {
 // fallback: Construct it on our own
 const url = `${origin}`;

 if (url.endsWith('/') && path.startsWith('/')) {
 return `${url}${path.slice(1)}`;
 }

 if (!url.endsWith('/') && !path.startsWith('/')) {
 return `${url}/${path.slice(1)}`;
 }

 return `${url}${path}`;
 }
}

1 change: 1 addition & 0 deletions
packages/node-core/src/light/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ export { LightNodeClient } from './client';
export { init, getDefaultIntegrations, initWithoutDefaultIntegrations } from './sdk';
export { setAsyncLocalStorageAsyncContextStrategy } from './asyncLocalStorageStrategy';
export { httpIntegration } from './integrations/httpIntegration';
export { nativeNodeFetchIntegration } from './integrations/nativeNodeFetchIntegration';

// Common exports shared with the main entry point
export * from '../common-exports';
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(node-core): Add outgoing fetch trace propagation to light mode#19262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

andreiborza
merged 1 commit into

from

Feb 11, 2026
 Merged


feat(node-core): Add outgoing fetch trace propagation to light mode
#19262
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


80 changes: 80 additions & 0 deletions
dev-packages/node-core-integration-tests/suites/light-mode/outgoing-fetch/server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
const http = require('http');
const Sentry = require('@sentry/node-core/light');
const { loggingTransport, sendPortToRunner } = require('@sentry-internal/node-core-integration-tests');

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
 tracePropagationTargets: [/\/api\/v0/, 'v1'],
});

let capturedV0 = {};
let capturedV1 = {};
let capturedV2 = {};

const targetServer = http.createServer((req, res) => {
 const headers = {
 'sentry-trace': req.headers['sentry-trace'],
 baggage: req.headers['baggage'],
 };

 if (req.url === '/api/v0') {
 capturedV0 = headers;
 } else if (req.url === '/api/v1') {
 capturedV1 = headers;
 } else if (req.url === '/api/v2') {
 capturedV2 = headers;
 }

 res.writeHead(200);
 res.end('ok');
});

targetServer.listen(0, () => {
 const targetPort = targetServer.address().port;
 const targetUrl = `http://localhost:${targetPort}`;

 const server = http.createServer(async (req, res) => {
 switch (req.url) {
 case '/test-auto-propagation': {
 capturedV0 = {};
 capturedV1 = {};
 capturedV2 = {};
 await fetch(`${targetUrl}/api/v0`);
 await fetch(`${targetUrl}/api/v1`);
 await fetch(`${targetUrl}/api/v2`);
 res.writeHead(200, { 'Content-Type': 'application/json' });
 res.end(JSON.stringify({ '/api/v0': capturedV0, '/api/v1': capturedV1, '/api/v2': capturedV2 }));
 break;
 }
 case '/test-breadcrumbs': {
 Sentry.addBreadcrumb({ message: 'manual breadcrumb' });
 await fetch(`${targetUrl}/api/v0`);
 await fetch(`${targetUrl}/api/v1`);
 Sentry.captureException(new Error('foo'));
 res.writeHead(200);
 res.end('ok');
 break;
 }
 case '/test-suppress-tracing': {
 capturedV0 = {};
 capturedV1 = {};
 await fetch(`${targetUrl}/api/v0`);
 await Sentry.suppressTracing(() => fetch(`${targetUrl}/api/v1`));
 Sentry.captureException(new Error('foo'));
 res.writeHead(200, { 'Content-Type': 'application/json' });
 res.end(JSON.stringify({ '/api/v0': capturedV0, '/api/v1': capturedV1 }));
 break;
 }
 default: {
 res.writeHead(404);
 res.end();
 }
 }
 });

 server.listen(0, () => {
 sendPortToRunner(server.address().port);
 });
});

109 changes: 109 additions & 0 deletions
dev-packages/node-core-integration-tests/suites/light-mode/outgoing-fetch/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
import crypto from 'crypto';
import { afterAll, expect, test } from 'vitest';
import { conditionalTest } from '../../../utils';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

afterAll(() => {
 cleanupChildProcesses();
});

conditionalTest({ min: 22 })('light mode outgoing fetch', () => {
 test('automatically propagates trace headers to outgoing fetch requests matching tracePropagationTargets', async () => {
 const traceId = crypto.randomUUID().replace(/-/g, '');
 const parentSpanId = traceId.substring(0, 16);

 const runner = createRunner(__dirname, 'server.js').start();

 const response = await runner.makeRequest<Record<string, { 'sentry-trace'?: string; baggage?: string }>>(
 'get',
 '/test-auto-propagation',
 {
 headers: {
 'sentry-trace': `${traceId}-${parentSpanId}-1`,
 baggage: `sentry-trace_id=${traceId},sentry-environment=test,sentry-public_key=public`,
 },
 },
 );

 // /api/v0 matches tracePropagationTargets - should have headers
 expect(response?.['/api/v0']?.['sentry-trace']).toMatch(new RegExp(`^${traceId}-[a-f\\d]{16}-1$`));
 expect(response?.['/api/v0']?.baggage).toContain(`sentry-trace_id=${traceId}`);

 // /api/v1 matches tracePropagationTargets - should have headers
 expect(response?.['/api/v1']?.['sentry-trace']).toMatch(new RegExp(`^${traceId}-[a-f\\d]{16}-1$`));
 expect(response?.['/api/v1']?.baggage).toContain(`sentry-trace_id=${traceId}`);

 // /api/v2 does NOT match tracePropagationTargets - should NOT have headers
 expect(response?.['/api/v2']?.['sentry-trace']).toBeUndefined();
 expect(response?.['/api/v2']?.baggage).toBeUndefined();
 });

 test('does not propagate headers or create breadcrumbs when tracing is suppressed', async () => {
 const runner = createRunner(__dirname, 'server.js')
 .expect({
 event: event => {
 const breadcrumbs = event.breadcrumbs || [];
 const httpBreadcrumbs = breadcrumbs.filter(b => b.category === 'http');

 // Only 1 breadcrumb for v0 - the suppressed v1 request should NOT create a breadcrumb
 expect(httpBreadcrumbs.length).toBe(1);
 expect(httpBreadcrumbs[0]?.data?.url).toContain('/api/v0');
 },
 })
 .start();

 const response = await runner.makeRequest<Record<string, { 'sentry-trace'?: string; baggage?: string }>>(
 'get',
 '/test-suppress-tracing',
 );

 // v0 (not suppressed) should have trace headers
 expect(response?.['/api/v0']?.['sentry-trace']).toBeDefined();
 expect(response?.['/api/v0']?.baggage).toBeDefined();

 // v1 (suppressed) should NOT have trace headers
 expect(response?.['/api/v1']?.['sentry-trace']).toBeUndefined();
 expect(response?.['/api/v1']?.baggage).toBeUndefined();

 await runner.completed();
 });

 test('creates breadcrumbs for outgoing fetch requests', async () => {
 const runner = createRunner(__dirname, 'server.js')
 .expect({
 event: event => {
 const breadcrumbs = event.breadcrumbs || [];
 const httpBreadcrumbs = breadcrumbs.filter(b => b.category === 'http');

 expect(httpBreadcrumbs.length).toBe(2);

 expect(httpBreadcrumbs[0]).toEqual(
 expect.objectContaining({
 category: 'http',
 type: 'http',
 data: expect.objectContaining({
 'http.method': 'GET',
 status_code: 200,
 }),
 }),
 );

 expect(httpBreadcrumbs[1]).toEqual(
 expect.objectContaining({
 category: 'http',
 type: 'http',
 data: expect.objectContaining({
 'http.method': 'GET',
 status_code: 200,
 }),
 }),
 );
 },
 })
 .start();

 await runner.makeRequest('get', '/test-breadcrumbs');

 await runner.completed();
 });
});

161 changes: 8 additions & 153 deletions
packages/node-core/src/integrations/node-fetch/SentryNodeFetchInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,29 +2,16 @@ import { context } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase } from '@opentelemetry/instrumentation';
import type { SanitizedRequestData } from '@sentry/core';
import {
 addBreadcrumb,
 getBreadcrumbLogLevelFromHttpStatusCode,
 getClient,
 getSanitizedUrlString,
 getTraceData,
 LRUMap,
 parseUrl,
 SDK_VERSION,
} from '@sentry/core';
import { shouldPropagateTraceForUrl } from '@sentry/opentelemetry';
import { LRUMap, SDK_VERSION } from '@sentry/core';
import * as diagch from 'diagnostics_channel';
import { NODE_MAJOR, NODE_MINOR } from '../../nodeVersion';
import { mergeBaggageHeaders } from '../../utils/baggage';
import {
 addFetchRequestBreadcrumb,
 addTracePropagationHeadersToFetchRequest,
 getAbsoluteUrl,
} from '../../utils/outgoingFetchRequest';
import type { UndiciRequest, UndiciResponse } from './types';

const SENTRY_TRACE_HEADER = 'sentry-trace';
const SENTRY_BAGGAGE_HEADER = 'baggage';

// For baggage, we make sure to merge this into a possibly existing header
const BAGGAGE_HEADER_REGEX = /baggage: (.*)\r\n/;

export type SentryNodeFetchInstrumentationOptions = InstrumentationConfig & {
 /**
 * Whether breadcrumbs should be recorded for requests.
Expand DownExpand Up@@ -114,7 +101,6 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 * This method is called when a request is created.
 * You can still mutate the request here before it is sent.
 */
 // eslint-disable-next-line complexity
 private _onRequestCreated({ request }: { request: UndiciRequest }): void {
 const config = this.getConfig();
 const enabled = config.enabled !== false;
Expand All@@ -132,70 +118,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 return;
 }

 const url = getAbsoluteUrl(request.origin, request.path);

 // Manually add the trace headers, if it applies
 // Note: We do not use `propagation.inject()` here, because our propagator relies on an active span
 // Which we do not have in this case
 // The propagator _may_ overwrite this, but this should be fine as it is the same data
 const { tracePropagationTargets, propagateTraceparent } = getClient()?.getOptions() || {};
 const addedHeaders = shouldPropagateTraceForUrl(url, tracePropagationTargets, this._propagationDecisionMap)
 ? getTraceData({ propagateTraceparent })
 : undefined;

 if (!addedHeaders) {
 return;
 }

 const { 'sentry-trace': sentryTrace, baggage, traceparent } = addedHeaders;

 // We do not want to overwrite existing headers here
 // If the core UndiciInstrumentation is registered, it will already have set the headers
 // We do not want to add any then
 if (Array.isArray(request.headers)) {
 const requestHeaders = request.headers;

 // We do not want to overwrite existing header here, if it was already set
 if (sentryTrace && !requestHeaders.includes(SENTRY_TRACE_HEADER)) {
 requestHeaders.push(SENTRY_TRACE_HEADER, sentryTrace);
 }

 if (traceparent && !requestHeaders.includes('traceparent')) {
 requestHeaders.push('traceparent', traceparent);
 }

 // For baggage, we make sure to merge this into a possibly existing header
 const existingBaggagePos = requestHeaders.findIndex(header => header === SENTRY_BAGGAGE_HEADER);
 if (baggage && existingBaggagePos === -1) {
 requestHeaders.push(SENTRY_BAGGAGE_HEADER, baggage);
 } else if (baggage) {
 const existingBaggage = requestHeaders[existingBaggagePos + 1];
 const merged = mergeBaggageHeaders(existingBaggage, baggage);
 if (merged) {
 requestHeaders[existingBaggagePos + 1] = merged;
 }
 }
 } else {
 const requestHeaders = request.headers;
 // We do not want to overwrite existing header here, if it was already set
 if (sentryTrace && !requestHeaders.includes(`${SENTRY_TRACE_HEADER}:`)) {
 request.headers += `${SENTRY_TRACE_HEADER}: ${sentryTrace}\r\n`;
 }

 if (traceparent && !requestHeaders.includes('traceparent:')) {
 request.headers += `traceparent: ${traceparent}\r\n`;
 }

 const existingBaggage = request.headers.match(BAGGAGE_HEADER_REGEX)?.[1];
 if (baggage && !existingBaggage) {
 request.headers += `${SENTRY_BAGGAGE_HEADER}: ${baggage}\r\n`;
 } else if (baggage) {
 const merged = mergeBaggageHeaders(existingBaggage, baggage);
 if (merged) {
 request.headers = request.headers.replace(BAGGAGE_HEADER_REGEX, `baggage: ${merged}\r\n`);
 }
 }
 }
 addTracePropagationHeadersToFetchRequest(request, this._propagationDecisionMap);
 }

 /**
Expand All@@ -215,7 +138,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 const shouldIgnore = this._ignoreOutgoingRequestsMap.get(request);

 if (breadCrumbsEnabled && !shouldIgnore) {
addRequestBreadcrumb(request, response);
addFetchRequestBreadcrumb(request, response);
 }
 }

Expand DownExpand Up@@ -263,71 +186,3 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 return ignoreOutgoingRequests(url);
 }
}

/** Add a breadcrumb for outgoing requests. */
function addRequestBreadcrumb(request: UndiciRequest, response: UndiciResponse): void {
 const data = getBreadcrumbData(request);

 const statusCode = response.statusCode;
 const level = getBreadcrumbLogLevelFromHttpStatusCode(statusCode);

 addBreadcrumb(
 {
 category: 'http',
 data: {
 status_code: statusCode,
 ...data,
 },
 type: 'http',
 level,
 },
 {
 event: 'response',
 request,
 response,
 },
 );
}

function getBreadcrumbData(request: UndiciRequest): Partial<SanitizedRequestData> {
 try {
 const url = getAbsoluteUrl(request.origin, request.path);
 const parsedUrl = parseUrl(url);

 const data: Partial<SanitizedRequestData> = {
 url: getSanitizedUrlString(parsedUrl),
 'http.method': request.method || 'GET',
 };

 if (parsedUrl.search) {
 data['http.query'] = parsedUrl.search;
 }
 if (parsedUrl.hash) {
 data['http.fragment'] = parsedUrl.hash;
 }

 return data;
 } catch {
 return {};
 }
}

function getAbsoluteUrl(origin: string, path: string = '/'): string {
 try {
 const url = new URL(path, origin);
 return url.toString();
 } catch {
 // fallback: Construct it on our own
 const url = `${origin}`;

 if (url.endsWith('/') && path.startsWith('/')) {
 return `${url}${path.slice(1)}`;
 }

 if (!url.endsWith('/') && !path.startsWith('/')) {
 return `${url}/${path.slice(1)}`;
 }

 return `${url}${path}`;
 }
}

1 change: 1 addition & 0 deletions
packages/node-core/src/light/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ export { LightNodeClient } from './client';
export { init, getDefaultIntegrations, initWithoutDefaultIntegrations } from './sdk';
export { setAsyncLocalStorageAsyncContextStrategy } from './asyncLocalStorageStrategy';
export { httpIntegration } from './integrations/httpIntegration';
export { nativeNodeFetchIntegration } from './integrations/nativeNodeFetchIntegration';

// Common exports shared with the main entry point
export * from '../common-exports';
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(node-core): Add outgoing fetch trace propagation to light mode#19262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

andreiborza
merged 1 commit into

from

Feb 11, 2026
 Merged


feat(node-core): Add outgoing fetch trace propagation to light mode
#19262
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


80 changes: 80 additions & 0 deletions
dev-packages/node-core-integration-tests/suites/light-mode/outgoing-fetch/server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
const http = require('http');
const Sentry = require('@sentry/node-core/light');
const { loggingTransport, sendPortToRunner } = require('@sentry-internal/node-core-integration-tests');

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
 tracePropagationTargets: [/\/api\/v0/, 'v1'],
});

let capturedV0 = {};
let capturedV1 = {};
let capturedV2 = {};

const targetServer = http.createServer((req, res) => {
 const headers = {
 'sentry-trace': req.headers['sentry-trace'],
 baggage: req.headers['baggage'],
 };

 if (req.url === '/api/v0') {
 capturedV0 = headers;
 } else if (req.url === '/api/v1') {
 capturedV1 = headers;
 } else if (req.url === '/api/v2') {
 capturedV2 = headers;
 }

 res.writeHead(200);
 res.end('ok');
});

targetServer.listen(0, () => {
 const targetPort = targetServer.address().port;
 const targetUrl = `http://localhost:${targetPort}`;

 const server = http.createServer(async (req, res) => {
 switch (req.url) {
 case '/test-auto-propagation': {
 capturedV0 = {};
 capturedV1 = {};
 capturedV2 = {};
 await fetch(`${targetUrl}/api/v0`);
 await fetch(`${targetUrl}/api/v1`);
 await fetch(`${targetUrl}/api/v2`);
 res.writeHead(200, { 'Content-Type': 'application/json' });
 res.end(JSON.stringify({ '/api/v0': capturedV0, '/api/v1': capturedV1, '/api/v2': capturedV2 }));
 break;
 }
 case '/test-breadcrumbs': {
 Sentry.addBreadcrumb({ message: 'manual breadcrumb' });
 await fetch(`${targetUrl}/api/v0`);
 await fetch(`${targetUrl}/api/v1`);
 Sentry.captureException(new Error('foo'));
 res.writeHead(200);
 res.end('ok');
 break;
 }
 case '/test-suppress-tracing': {
 capturedV0 = {};
 capturedV1 = {};
 await fetch(`${targetUrl}/api/v0`);
 await Sentry.suppressTracing(() => fetch(`${targetUrl}/api/v1`));
 Sentry.captureException(new Error('foo'));
 res.writeHead(200, { 'Content-Type': 'application/json' });
 res.end(JSON.stringify({ '/api/v0': capturedV0, '/api/v1': capturedV1 }));
 break;
 }
 default: {
 res.writeHead(404);
 res.end();
 }
 }
 });

 server.listen(0, () => {
 sendPortToRunner(server.address().port);
 });
});

109 changes: 109 additions & 0 deletions
dev-packages/node-core-integration-tests/suites/light-mode/outgoing-fetch/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
import crypto from 'crypto';
import { afterAll, expect, test } from 'vitest';
import { conditionalTest } from '../../../utils';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

afterAll(() => {
 cleanupChildProcesses();
});

conditionalTest({ min: 22 })('light mode outgoing fetch', () => {
 test('automatically propagates trace headers to outgoing fetch requests matching tracePropagationTargets', async () => {
 const traceId = crypto.randomUUID().replace(/-/g, '');
 const parentSpanId = traceId.substring(0, 16);

 const runner = createRunner(__dirname, 'server.js').start();

 const response = await runner.makeRequest<Record<string, { 'sentry-trace'?: string; baggage?: string }>>(
 'get',
 '/test-auto-propagation',
 {
 headers: {
 'sentry-trace': `${traceId}-${parentSpanId}-1`,
 baggage: `sentry-trace_id=${traceId},sentry-environment=test,sentry-public_key=public`,
 },
 },
 );

 // /api/v0 matches tracePropagationTargets - should have headers
 expect(response?.['/api/v0']?.['sentry-trace']).toMatch(new RegExp(`^${traceId}-[a-f\\d]{16}-1$`));
 expect(response?.['/api/v0']?.baggage).toContain(`sentry-trace_id=${traceId}`);

 // /api/v1 matches tracePropagationTargets - should have headers
 expect(response?.['/api/v1']?.['sentry-trace']).toMatch(new RegExp(`^${traceId}-[a-f\\d]{16}-1$`));
 expect(response?.['/api/v1']?.baggage).toContain(`sentry-trace_id=${traceId}`);

 // /api/v2 does NOT match tracePropagationTargets - should NOT have headers
 expect(response?.['/api/v2']?.['sentry-trace']).toBeUndefined();
 expect(response?.['/api/v2']?.baggage).toBeUndefined();
 });

 test('does not propagate headers or create breadcrumbs when tracing is suppressed', async () => {
 const runner = createRunner(__dirname, 'server.js')
 .expect({
 event: event => {
 const breadcrumbs = event.breadcrumbs || [];
 const httpBreadcrumbs = breadcrumbs.filter(b => b.category === 'http');

 // Only 1 breadcrumb for v0 - the suppressed v1 request should NOT create a breadcrumb
 expect(httpBreadcrumbs.length).toBe(1);
 expect(httpBreadcrumbs[0]?.data?.url).toContain('/api/v0');
 },
 })
 .start();

 const response = await runner.makeRequest<Record<string, { 'sentry-trace'?: string; baggage?: string }>>(
 'get',
 '/test-suppress-tracing',
 );

 // v0 (not suppressed) should have trace headers
 expect(response?.['/api/v0']?.['sentry-trace']).toBeDefined();
 expect(response?.['/api/v0']?.baggage).toBeDefined();

 // v1 (suppressed) should NOT have trace headers
 expect(response?.['/api/v1']?.['sentry-trace']).toBeUndefined();
 expect(response?.['/api/v1']?.baggage).toBeUndefined();

 await runner.completed();
 });

 test('creates breadcrumbs for outgoing fetch requests', async () => {
 const runner = createRunner(__dirname, 'server.js')
 .expect({
 event: event => {
 const breadcrumbs = event.breadcrumbs || [];
 const httpBreadcrumbs = breadcrumbs.filter(b => b.category === 'http');

 expect(httpBreadcrumbs.length).toBe(2);

 expect(httpBreadcrumbs[0]).toEqual(
 expect.objectContaining({
 category: 'http',
 type: 'http',
 data: expect.objectContaining({
 'http.method': 'GET',
 status_code: 200,
 }),
 }),
 );

 expect(httpBreadcrumbs[1]).toEqual(
 expect.objectContaining({
 category: 'http',
 type: 'http',
 data: expect.objectContaining({
 'http.method': 'GET',
 status_code: 200,
 }),
 }),
 );
 },
 })
 .start();

 await runner.makeRequest('get', '/test-breadcrumbs');

 await runner.completed();
 });
});

161 changes: 8 additions & 153 deletions
packages/node-core/src/integrations/node-fetch/SentryNodeFetchInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,29 +2,16 @@ import { context } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase } from '@opentelemetry/instrumentation';
import type { SanitizedRequestData } from '@sentry/core';
import {
 addBreadcrumb,
 getBreadcrumbLogLevelFromHttpStatusCode,
 getClient,
 getSanitizedUrlString,
 getTraceData,
 LRUMap,
 parseUrl,
 SDK_VERSION,
} from '@sentry/core';
import { shouldPropagateTraceForUrl } from '@sentry/opentelemetry';
import { LRUMap, SDK_VERSION } from '@sentry/core';
import * as diagch from 'diagnostics_channel';
import { NODE_MAJOR, NODE_MINOR } from '../../nodeVersion';
import { mergeBaggageHeaders } from '../../utils/baggage';
import {
 addFetchRequestBreadcrumb,
 addTracePropagationHeadersToFetchRequest,
 getAbsoluteUrl,
} from '../../utils/outgoingFetchRequest';
import type { UndiciRequest, UndiciResponse } from './types';

const SENTRY_TRACE_HEADER = 'sentry-trace';
const SENTRY_BAGGAGE_HEADER = 'baggage';

// For baggage, we make sure to merge this into a possibly existing header
const BAGGAGE_HEADER_REGEX = /baggage: (.*)\r\n/;

export type SentryNodeFetchInstrumentationOptions = InstrumentationConfig & {
 /**
 * Whether breadcrumbs should be recorded for requests.
Expand DownExpand Up@@ -114,7 +101,6 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 * This method is called when a request is created.
 * You can still mutate the request here before it is sent.
 */
 // eslint-disable-next-line complexity
 private _onRequestCreated({ request }: { request: UndiciRequest }): void {
 const config = this.getConfig();
 const enabled = config.enabled !== false;
Expand All@@ -132,70 +118,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 return;
 }

 const url = getAbsoluteUrl(request.origin, request.path);

 // Manually add the trace headers, if it applies
 // Note: We do not use `propagation.inject()` here, because our propagator relies on an active span
 // Which we do not have in this case
 // The propagator _may_ overwrite this, but this should be fine as it is the same data
 const { tracePropagationTargets, propagateTraceparent } = getClient()?.getOptions() || {};
 const addedHeaders = shouldPropagateTraceForUrl(url, tracePropagationTargets, this._propagationDecisionMap)
 ? getTraceData({ propagateTraceparent })
 : undefined;

 if (!addedHeaders) {
 return;
 }

 const { 'sentry-trace': sentryTrace, baggage, traceparent } = addedHeaders;

 // We do not want to overwrite existing headers here
 // If the core UndiciInstrumentation is registered, it will already have set the headers
 // We do not want to add any then
 if (Array.isArray(request.headers)) {
 const requestHeaders = request.headers;

 // We do not want to overwrite existing header here, if it was already set
 if (sentryTrace && !requestHeaders.includes(SENTRY_TRACE_HEADER)) {
 requestHeaders.push(SENTRY_TRACE_HEADER, sentryTrace);
 }

 if (traceparent && !requestHeaders.includes('traceparent')) {
 requestHeaders.push('traceparent', traceparent);
 }

 // For baggage, we make sure to merge this into a possibly existing header
 const existingBaggagePos = requestHeaders.findIndex(header => header === SENTRY_BAGGAGE_HEADER);
 if (baggage && existingBaggagePos === -1) {
 requestHeaders.push(SENTRY_BAGGAGE_HEADER, baggage);
 } else if (baggage) {
 const existingBaggage = requestHeaders[existingBaggagePos + 1];
 const merged = mergeBaggageHeaders(existingBaggage, baggage);
 if (merged) {
 requestHeaders[existingBaggagePos + 1] = merged;
 }
 }
 } else {
 const requestHeaders = request.headers;
 // We do not want to overwrite existing header here, if it was already set
 if (sentryTrace && !requestHeaders.includes(`${SENTRY_TRACE_HEADER}:`)) {
 request.headers += `${SENTRY_TRACE_HEADER}: ${sentryTrace}\r\n`;
 }

 if (traceparent && !requestHeaders.includes('traceparent:')) {
 request.headers += `traceparent: ${traceparent}\r\n`;
 }

 const existingBaggage = request.headers.match(BAGGAGE_HEADER_REGEX)?.[1];
 if (baggage && !existingBaggage) {
 request.headers += `${SENTRY_BAGGAGE_HEADER}: ${baggage}\r\n`;
 } else if (baggage) {
 const merged = mergeBaggageHeaders(existingBaggage, baggage);
 if (merged) {
 request.headers = request.headers.replace(BAGGAGE_HEADER_REGEX, `baggage: ${merged}\r\n`);
 }
 }
 }
 addTracePropagationHeadersToFetchRequest(request, this._propagationDecisionMap);
 }

 /**
Expand All@@ -215,7 +138,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 const shouldIgnore = this._ignoreOutgoingRequestsMap.get(request);

 if (breadCrumbsEnabled && !shouldIgnore) {
addRequestBreadcrumb(request, response);
addFetchRequestBreadcrumb(request, response);
 }
 }

Expand DownExpand Up@@ -263,71 +186,3 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 return ignoreOutgoingRequests(url);
 }
}

/** Add a breadcrumb for outgoing requests. */
function addRequestBreadcrumb(request: UndiciRequest, response: UndiciResponse): void {
 const data = getBreadcrumbData(request);

 const statusCode = response.statusCode;
 const level = getBreadcrumbLogLevelFromHttpStatusCode(statusCode);

 addBreadcrumb(
 {
 category: 'http',
 data: {
 status_code: statusCode,
 ...data,
 },
 type: 'http',
 level,
 },
 {
 event: 'response',
 request,
 response,
 },
 );
}

function getBreadcrumbData(request: UndiciRequest): Partial<SanitizedRequestData> {
 try {
 const url = getAbsoluteUrl(request.origin, request.path);
 const parsedUrl = parseUrl(url);

 const data: Partial<SanitizedRequestData> = {
 url: getSanitizedUrlString(parsedUrl),
 'http.method': request.method || 'GET',
 };

 if (parsedUrl.search) {
 data['http.query'] = parsedUrl.search;
 }
 if (parsedUrl.hash) {
 data['http.fragment'] = parsedUrl.hash;
 }

 return data;
 } catch {
 return {};
 }
}

function getAbsoluteUrl(origin: string, path: string = '/'): string {
 try {
 const url = new URL(path, origin);
 return url.toString();
 } catch {
 // fallback: Construct it on our own
 const url = `${origin}`;

 if (url.endsWith('/') && path.startsWith('/')) {
 return `${url}${path.slice(1)}`;
 }

 if (!url.endsWith('/') && !path.startsWith('/')) {
 return `${url}/${path.slice(1)}`;
 }

 return `${url}${path}`;
 }
}

1 change: 1 addition & 0 deletions
packages/node-core/src/light/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ export { LightNodeClient } from './client';
export { init, getDefaultIntegrations, initWithoutDefaultIntegrations } from './sdk';
export { setAsyncLocalStorageAsyncContextStrategy } from './asyncLocalStorageStrategy';
export { httpIntegration } from './integrations/httpIntegration';
export { nativeNodeFetchIntegration } from './integrations/nativeNodeFetchIntegration';

// Common exports shared with the main entry point
export * from '../common-exports';
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(node-core): Add outgoing fetch trace propagation to light mode#19262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

andreiborza
merged 1 commit into

from

Feb 11, 2026
 Merged


feat(node-core): Add outgoing fetch trace propagation to light mode
#19262
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


80 changes: 80 additions & 0 deletions
dev-packages/node-core-integration-tests/suites/light-mode/outgoing-fetch/server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
const http = require('http');
const Sentry = require('@sentry/node-core/light');
const { loggingTransport, sendPortToRunner } = require('@sentry-internal/node-core-integration-tests');

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
 tracePropagationTargets: [/\/api\/v0/, 'v1'],
});

let capturedV0 = {};
let capturedV1 = {};
let capturedV2 = {};

const targetServer = http.createServer((req, res) => {
 const headers = {
 'sentry-trace': req.headers['sentry-trace'],
 baggage: req.headers['baggage'],
 };

 if (req.url === '/api/v0') {
 capturedV0 = headers;
 } else if (req.url === '/api/v1') {
 capturedV1 = headers;
 } else if (req.url === '/api/v2') {
 capturedV2 = headers;
 }

 res.writeHead(200);
 res.end('ok');
});

targetServer.listen(0, () => {
 const targetPort = targetServer.address().port;
 const targetUrl = `http://localhost:${targetPort}`;

 const server = http.createServer(async (req, res) => {
 switch (req.url) {
 case '/test-auto-propagation': {
 capturedV0 = {};
 capturedV1 = {};
 capturedV2 = {};
 await fetch(`${targetUrl}/api/v0`);
 await fetch(`${targetUrl}/api/v1`);
 await fetch(`${targetUrl}/api/v2`);
 res.writeHead(200, { 'Content-Type': 'application/json' });
 res.end(JSON.stringify({ '/api/v0': capturedV0, '/api/v1': capturedV1, '/api/v2': capturedV2 }));
 break;
 }
 case '/test-breadcrumbs': {
 Sentry.addBreadcrumb({ message: 'manual breadcrumb' });
 await fetch(`${targetUrl}/api/v0`);
 await fetch(`${targetUrl}/api/v1`);
 Sentry.captureException(new Error('foo'));
 res.writeHead(200);
 res.end('ok');
 break;
 }
 case '/test-suppress-tracing': {
 capturedV0 = {};
 capturedV1 = {};
 await fetch(`${targetUrl}/api/v0`);
 await Sentry.suppressTracing(() => fetch(`${targetUrl}/api/v1`));
 Sentry.captureException(new Error('foo'));
 res.writeHead(200, { 'Content-Type': 'application/json' });
 res.end(JSON.stringify({ '/api/v0': capturedV0, '/api/v1': capturedV1 }));
 break;
 }
 default: {
 res.writeHead(404);
 res.end();
 }
 }
 });

 server.listen(0, () => {
 sendPortToRunner(server.address().port);
 });
});

109 changes: 109 additions & 0 deletions
dev-packages/node-core-integration-tests/suites/light-mode/outgoing-fetch/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
import crypto from 'crypto';
import { afterAll, expect, test } from 'vitest';
import { conditionalTest } from '../../../utils';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

afterAll(() => {
 cleanupChildProcesses();
});

conditionalTest({ min: 22 })('light mode outgoing fetch', () => {
 test('automatically propagates trace headers to outgoing fetch requests matching tracePropagationTargets', async () => {
 const traceId = crypto.randomUUID().replace(/-/g, '');
 const parentSpanId = traceId.substring(0, 16);

 const runner = createRunner(__dirname, 'server.js').start();

 const response = await runner.makeRequest<Record<string, { 'sentry-trace'?: string; baggage?: string }>>(
 'get',
 '/test-auto-propagation',
 {
 headers: {
 'sentry-trace': `${traceId}-${parentSpanId}-1`,
 baggage: `sentry-trace_id=${traceId},sentry-environment=test,sentry-public_key=public`,
 },
 },
 );

 // /api/v0 matches tracePropagationTargets - should have headers
 expect(response?.['/api/v0']?.['sentry-trace']).toMatch(new RegExp(`^${traceId}-[a-f\\d]{16}-1$`));
 expect(response?.['/api/v0']?.baggage).toContain(`sentry-trace_id=${traceId}`);

 // /api/v1 matches tracePropagationTargets - should have headers
 expect(response?.['/api/v1']?.['sentry-trace']).toMatch(new RegExp(`^${traceId}-[a-f\\d]{16}-1$`));
 expect(response?.['/api/v1']?.baggage).toContain(`sentry-trace_id=${traceId}`);

 // /api/v2 does NOT match tracePropagationTargets - should NOT have headers
 expect(response?.['/api/v2']?.['sentry-trace']).toBeUndefined();
 expect(response?.['/api/v2']?.baggage).toBeUndefined();
 });

 test('does not propagate headers or create breadcrumbs when tracing is suppressed', async () => {
 const runner = createRunner(__dirname, 'server.js')
 .expect({
 event: event => {
 const breadcrumbs = event.breadcrumbs || [];
 const httpBreadcrumbs = breadcrumbs.filter(b => b.category === 'http');

 // Only 1 breadcrumb for v0 - the suppressed v1 request should NOT create a breadcrumb
 expect(httpBreadcrumbs.length).toBe(1);
 expect(httpBreadcrumbs[0]?.data?.url).toContain('/api/v0');
 },
 })
 .start();

 const response = await runner.makeRequest<Record<string, { 'sentry-trace'?: string; baggage?: string }>>(
 'get',
 '/test-suppress-tracing',
 );

 // v0 (not suppressed) should have trace headers
 expect(response?.['/api/v0']?.['sentry-trace']).toBeDefined();
 expect(response?.['/api/v0']?.baggage).toBeDefined();

 // v1 (suppressed) should NOT have trace headers
 expect(response?.['/api/v1']?.['sentry-trace']).toBeUndefined();
 expect(response?.['/api/v1']?.baggage).toBeUndefined();

 await runner.completed();
 });

 test('creates breadcrumbs for outgoing fetch requests', async () => {
 const runner = createRunner(__dirname, 'server.js')
 .expect({
 event: event => {
 const breadcrumbs = event.breadcrumbs || [];
 const httpBreadcrumbs = breadcrumbs.filter(b => b.category === 'http');

 expect(httpBreadcrumbs.length).toBe(2);

 expect(httpBreadcrumbs[0]).toEqual(
 expect.objectContaining({
 category: 'http',
 type: 'http',
 data: expect.objectContaining({
 'http.method': 'GET',
 status_code: 200,
 }),
 }),
 );

 expect(httpBreadcrumbs[1]).toEqual(
 expect.objectContaining({
 category: 'http',
 type: 'http',
 data: expect.objectContaining({
 'http.method': 'GET',
 status_code: 200,
 }),
 }),
 );
 },
 })
 .start();

 await runner.makeRequest('get', '/test-breadcrumbs');

 await runner.completed();
 });
});

161 changes: 8 additions & 153 deletions
packages/node-core/src/integrations/node-fetch/SentryNodeFetchInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,29 +2,16 @@ import { context } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase } from '@opentelemetry/instrumentation';
import type { SanitizedRequestData } from '@sentry/core';
import {
 addBreadcrumb,
 getBreadcrumbLogLevelFromHttpStatusCode,
 getClient,
 getSanitizedUrlString,
 getTraceData,
 LRUMap,
 parseUrl,
 SDK_VERSION,
} from '@sentry/core';
import { shouldPropagateTraceForUrl } from '@sentry/opentelemetry';
import { LRUMap, SDK_VERSION } from '@sentry/core';
import * as diagch from 'diagnostics_channel';
import { NODE_MAJOR, NODE_MINOR } from '../../nodeVersion';
import { mergeBaggageHeaders } from '../../utils/baggage';
import {
 addFetchRequestBreadcrumb,
 addTracePropagationHeadersToFetchRequest,
 getAbsoluteUrl,
} from '../../utils/outgoingFetchRequest';
import type { UndiciRequest, UndiciResponse } from './types';

const SENTRY_TRACE_HEADER = 'sentry-trace';
const SENTRY_BAGGAGE_HEADER = 'baggage';

// For baggage, we make sure to merge this into a possibly existing header
const BAGGAGE_HEADER_REGEX = /baggage: (.*)\r\n/;

export type SentryNodeFetchInstrumentationOptions = InstrumentationConfig & {
 /**
 * Whether breadcrumbs should be recorded for requests.
Expand DownExpand Up@@ -114,7 +101,6 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 * This method is called when a request is created.
 * You can still mutate the request here before it is sent.
 */
 // eslint-disable-next-line complexity
 private _onRequestCreated({ request }: { request: UndiciRequest }): void {
 const config = this.getConfig();
 const enabled = config.enabled !== false;
Expand All@@ -132,70 +118,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 return;
 }

 const url = getAbsoluteUrl(request.origin, request.path);

 // Manually add the trace headers, if it applies
 // Note: We do not use `propagation.inject()` here, because our propagator relies on an active span
 // Which we do not have in this case
 // The propagator _may_ overwrite this, but this should be fine as it is the same data
 const { tracePropagationTargets, propagateTraceparent } = getClient()?.getOptions() || {};
 const addedHeaders = shouldPropagateTraceForUrl(url, tracePropagationTargets, this._propagationDecisionMap)
 ? getTraceData({ propagateTraceparent })
 : undefined;

 if (!addedHeaders) {
 return;
 }

 const { 'sentry-trace': sentryTrace, baggage, traceparent } = addedHeaders;

 // We do not want to overwrite existing headers here
 // If the core UndiciInstrumentation is registered, it will already have set the headers
 // We do not want to add any then
 if (Array.isArray(request.headers)) {
 const requestHeaders = request.headers;

 // We do not want to overwrite existing header here, if it was already set
 if (sentryTrace && !requestHeaders.includes(SENTRY_TRACE_HEADER)) {
 requestHeaders.push(SENTRY_TRACE_HEADER, sentryTrace);
 }

 if (traceparent && !requestHeaders.includes('traceparent')) {
 requestHeaders.push('traceparent', traceparent);
 }

 // For baggage, we make sure to merge this into a possibly existing header
 const existingBaggagePos = requestHeaders.findIndex(header => header === SENTRY_BAGGAGE_HEADER);
 if (baggage && existingBaggagePos === -1) {
 requestHeaders.push(SENTRY_BAGGAGE_HEADER, baggage);
 } else if (baggage) {
 const existingBaggage = requestHeaders[existingBaggagePos + 1];
 const merged = mergeBaggageHeaders(existingBaggage, baggage);
 if (merged) {
 requestHeaders[existingBaggagePos + 1] = merged;
 }
 }
 } else {
 const requestHeaders = request.headers;
 // We do not want to overwrite existing header here, if it was already set
 if (sentryTrace && !requestHeaders.includes(`${SENTRY_TRACE_HEADER}:`)) {
 request.headers += `${SENTRY_TRACE_HEADER}: ${sentryTrace}\r\n`;
 }

 if (traceparent && !requestHeaders.includes('traceparent:')) {
 request.headers += `traceparent: ${traceparent}\r\n`;
 }

 const existingBaggage = request.headers.match(BAGGAGE_HEADER_REGEX)?.[1];
 if (baggage && !existingBaggage) {
 request.headers += `${SENTRY_BAGGAGE_HEADER}: ${baggage}\r\n`;
 } else if (baggage) {
 const merged = mergeBaggageHeaders(existingBaggage, baggage);
 if (merged) {
 request.headers = request.headers.replace(BAGGAGE_HEADER_REGEX, `baggage: ${merged}\r\n`);
 }
 }
 }
 addTracePropagationHeadersToFetchRequest(request, this._propagationDecisionMap);
 }

 /**
Expand All@@ -215,7 +138,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 const shouldIgnore = this._ignoreOutgoingRequestsMap.get(request);

 if (breadCrumbsEnabled && !shouldIgnore) {
addRequestBreadcrumb(request, response);
addFetchRequestBreadcrumb(request, response);
 }
 }

Expand DownExpand Up@@ -263,71 +186,3 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
 return ignoreOutgoingRequests(url);
 }
}

/** Add a breadcrumb for outgoing requests. */
function addRequestBreadcrumb(request: UndiciRequest, response: UndiciResponse): void {
 const data = getBreadcrumbData(request);

 const statusCode = response.statusCode;
 const level = getBreadcrumbLogLevelFromHttpStatusCode(statusCode);

 addBreadcrumb(
 {
 category: 'http',
 data: {
 status_code: statusCode,
 ...data,
 },
 type: 'http',
 level,
 },
 {
 event: 'response',
 request,
 response,
 },
 );
}

function getBreadcrumbData(request: UndiciRequest): Partial<SanitizedRequestData> {
 try {
 const url = getAbsoluteUrl(request.origin, request.path);
 const parsedUrl = parseUrl(url);

 const data: Partial<SanitizedRequestData> = {
 url: getSanitizedUrlString(parsedUrl),
 'http.method': request.method || 'GET',
 };

 if (parsedUrl.search) {
 data['http.query'] = parsedUrl.search;
 }
 if (parsedUrl.hash) {
 data['http.fragment'] = parsedUrl.hash;
 }

 return data;
 } catch {
 return {};
 }
}

function getAbsoluteUrl(origin: string, path: string = '/'): string {
 try {
 const url = new URL(path, origin);
 return url.toString();
 } catch {
 // fallback: Construct it on our own
 const url = `${origin}`;

 if (url.endsWith('/') && path.startsWith('/')) {
 return `${url}${path.slice(1)}`;
 }

 if (!url.endsWith('/') && !path.startsWith('/')) {
 return `${url}/${path.slice(1)}`;
 }

 return `${url}${path}`;
 }
}

1 change: 1 addition & 0 deletions
packages/node-core/src/light/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ export { LightNodeClient } from './client';
export { init, getDefaultIntegrations, initWithoutDefaultIntegrations } from './sdk';
export { setAsyncLocalStorageAsyncContextStrategy } from './asyncLocalStorageStrategy';
export { httpIntegration } from './integrations/httpIntegration';
export { nativeNodeFetchIntegration } from './integrations/nativeNodeFetchIntegration';

// Common exports shared with the main entry point
export * from '../common-exports';
Loading
Loading