Skip to content

feat(http): refactor node:http client instrumentation for portability #20393

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

Open
isaacs wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

feat(http): refactor node:http client instrumentation for portability #20393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c0f12f7
core: add getDefaultExport method
isaacs Mar 24, 2026
bbb6e92
chore: remove unused imports from test files
isaacs Apr 20, 2026
8ad3dd0
feat(http): portable node:http client instrumentation (#20393)
isaacs Apr 20, 2026
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
4 changes: 2 additions & 2 deletions dev-packages/e2e-tests/test-applications/aws-serverless/tests/layer.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ test.describe('Lambda layer', () => {
expect.objectContaining({
data: expect.objectContaining({
'sentry.op': 'http.client',
'sentry.origin': 'auto.http.otel.http',
'sentry.origin': 'auto.http.client',
url: 'http://example.com/',
}),
description: 'GET http://example.com/',
Expand Down Expand Up @@ -113,7 +113,7 @@ test.describe('Lambda layer', () => {
expect.objectContaining({
data: expect.objectContaining({
'sentry.op': 'http.client',
'sentry.origin': 'auto.http.otel.http',
'sentry.origin': 'auto.http.client',
url: 'http://example.com/',
}),
description: 'GET http://example.com/',
Expand Down
4 changes: 2 additions & 2 deletions dev-packages/e2e-tests/test-applications/aws-serverless/tests/npm.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ test.describe('NPM package', () => {
expect.objectContaining({
data: expect.objectContaining({
'sentry.op': 'http.client',
'sentry.origin': 'auto.http.otel.http',
'sentry.origin': 'auto.http.client',
url: 'http://example.com/',
}),
description: 'GET http://example.com/',
Expand Down Expand Up @@ -113,7 +113,7 @@ test.describe('NPM package', () => {
expect.objectContaining({
data: expect.objectContaining({
'sentry.op': 'http.client',
'sentry.origin': 'auto.http.otel.http',
'sentry.origin': 'auto.http.client',
url: 'http://example.com/',
}),
description: 'GET http://example.com/',
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/nextjs-14/tests/request-instrumentation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ test('Should send a transaction with a fetch span', async ({ page }) => {
data: expect.objectContaining({
'http.method': 'GET',
'sentry.op': 'http.client',
'sentry.origin': 'auto.http.otel.http',
'sentry.origin': 'auto.http.client',
}),
description: 'GET https://github.com/',
}),
Expand Down
2 changes: 1 addition & 1 deletion ...packages/e2e-tests/test-applications/nextjs-app-dir/tests/request-instrumentation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ test.skip('Should send a transaction with a http span', async ({ request }) => {
data: expect.objectContaining({
'http.method': 'GET',
'sentry.op': 'http.client',
'sentry.origin': 'auto.http.otel.http',
'sentry.origin': 'auto.http.client',
}),
description: 'GET https://example.com/',
}),
Expand Down
2 changes: 1 addition & 1 deletion ...ckages/e2e-tests/test-applications/nextjs-pages-dir/tests/request-instrumentation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ test.skip('Should send a transaction with a http span', async ({ request }) => {
data: expect.objectContaining({
'http.method': 'GET',
'sentry.op': 'http.client',
'sentry.origin': 'auto.http.otel.http',
'sentry.origin': 'auto.http.client',
}),
description: 'GET https://example.com/',
}),
Expand Down
6 changes: 3 additions & 3 deletions dev-packages/e2e-tests/test-applications/node-express-esm-preload/tests/server.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ test('Should record spans from http instrumentation', async ({ request }) => {
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
data: expect.objectContaining({
'http.flavor': '1.1',
'http.host': 'example.com:80',
'http.host': 'example.com',
'http.method': 'GET',
'http.response.status_code': 200,
'http.status_code': 200,
Expand All @@ -146,7 +146,7 @@ test('Should record spans from http instrumentation', async ({ request }) => {
'net.transport': 'ip_tcp',
'otel.kind': 'CLIENT',
'sentry.op': 'http.client',
'sentry.origin': 'auto.http.otel.http',
'sentry.origin': 'auto.http.client',
url: 'http://example.com/',
}),
description: 'GET http://example.com/',
Expand All @@ -155,6 +155,6 @@ test('Should record spans from http instrumentation', async ({ request }) => {
timestamp: expect.any(Number),
status: 'ok',
op: 'http.client',
origin: 'auto.http.otel.http',
origin: 'auto.http.client',
});
});
261 changes: 80 additions & 181 deletions ...ages/node-core-integration-tests/suites/tracing/requests/http-no-tracing-no-spans/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,202 +1,101 @@
import { createTestServer } from '@sentry-internal/test-utils';
import { describe, expect } from 'vitest';
import { conditionalTest } from '../../../../utils';
import { createEsmAndCjsTests } from '../../../../utils/runner';

describe('outgoing http requests with tracing & spans disabled', () => {
createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
conditionalTest({ min: 22 })('node >=22', () => {
test('outgoing http requests are correctly instrumented with tracing & spans disabled', async () => {
expect.assertions(11);
test('outgoing http requests are correctly instrumented with tracing & spans disabled', async () => {
expect.assertions(11);

const [SERVER_URL, closeTestServer] = await createTestServer()
.get('/api/v0', headers => {
expect(headers['sentry-trace']).toEqual(expect.stringMatching(/^([a-f\d]{32})-([a-f\d]{16})$/));
expect(headers['sentry-trace']).not.toEqual('00000000000000000000000000000000-0000000000000000');
expect(headers['baggage']).toEqual(expect.any(String));
})
.get('/api/v1', headers => {
expect(headers['sentry-trace']).toEqual(expect.stringMatching(/^([a-f\d]{32})-([a-f\d]{16})$/));
expect(headers['sentry-trace']).not.toEqual('00000000000000000000000000000000-0000000000000000');
expect(headers['baggage']).toEqual(expect.any(String));
})
.get('/api/v2', headers => {
expect(headers['baggage']).toBeUndefined();
expect(headers['sentry-trace']).toBeUndefined();
})
.get('/api/v3', headers => {
expect(headers['baggage']).toBeUndefined();
expect(headers['sentry-trace']).toBeUndefined();
})
.start();
const [SERVER_URL, closeTestServer] = await createTestServer()
.get('/api/v0', headers => {
expect(headers['sentry-trace']).toEqual(expect.stringMatching(/^([a-f\d]{32})-([a-f\d]{16})$/));
expect(headers['sentry-trace']).not.toEqual('00000000000000000000000000000000-0000000000000000');
expect(headers['baggage']).toEqual(expect.any(String));
})
.get('/api/v1', headers => {
expect(headers['sentry-trace']).toEqual(expect.stringMatching(/^([a-f\d]{32})-([a-f\d]{16})$/));
expect(headers['sentry-trace']).not.toEqual('00000000000000000000000000000000-0000000000000000');
expect(headers['baggage']).toEqual(expect.any(String));
})
.get('/api/v2', headers => {
expect(headers['baggage']).toBeUndefined();
expect(headers['sentry-trace']).toBeUndefined();
})
.get('/api/v3', headers => {
expect(headers['baggage']).toBeUndefined();
expect(headers['sentry-trace']).toBeUndefined();
})
.start();

await createRunner()
.withEnv({ SERVER_URL })
.expect({
event: {
exception: {
values: [
{
type: 'Error',
value: 'foo',
},
],
},
breadcrumbs: [
{
message: 'manual breadcrumb',
timestamp: expect.any(Number),
},
{
category: 'http',
data: {
'http.method': 'GET',
url: `${SERVER_URL}/api/v0`,
status_code: 200,
ADDED_PATH: '/api/v0',
},
timestamp: expect.any(Number),
type: 'http',
},
{
category: 'http',
data: {
'http.method': 'GET',
url: `${SERVER_URL}/api/v1`,
status_code: 200,
ADDED_PATH: '/api/v1',
},
timestamp: expect.any(Number),
type: 'http',
},
await createRunner()
.withEnv({ SERVER_URL })
.expect({
event: {
exception: {
values: [
{
category: 'http',
data: {
'http.method': 'GET',
url: `${SERVER_URL}/api/v2`,
status_code: 200,
ADDED_PATH: '/api/v2',
},
timestamp: expect.any(Number),
type: 'http',
},
{
category: 'http',
data: {
'http.method': 'GET',
url: `${SERVER_URL}/api/v3`,
status_code: 200,
ADDED_PATH: '/api/v3',
},
timestamp: expect.any(Number),
type: 'http',
type: 'Error',
value: 'foo',
},
],
},
})
.start()
.completed();

closeTestServer();
});
});

// On older node versions, outgoing requests do not get trace-headers injected, sadly
// This is because the necessary diagnostics channel hook is not available yet
conditionalTest({ max: 21 })('node <22', () => {
test('outgoing http requests generate breadcrumbs correctly with tracing & spans disabled', async () => {
expect.assertions(9);

const [SERVER_URL, closeTestServer] = await createTestServer()
.get('/api/v0', headers => {
// This is not instrumented, sadly
expect(headers['baggage']).toBeUndefined();
expect(headers['sentry-trace']).toBeUndefined();
})
.get('/api/v1', headers => {
// This is not instrumented, sadly
expect(headers['baggage']).toBeUndefined();
expect(headers['sentry-trace']).toBeUndefined();
})
.get('/api/v2', headers => {
expect(headers['baggage']).toBeUndefined();
expect(headers['sentry-trace']).toBeUndefined();
})
.get('/api/v3', headers => {
expect(headers['baggage']).toBeUndefined();
expect(headers['sentry-trace']).toBeUndefined();
})
.start();

await createRunner()
.withEnv({ SERVER_URL })
.expect({
event: {
exception: {
values: [
{
type: 'Error',
value: 'foo',
},
],
breadcrumbs: [
{
message: 'manual breadcrumb',
timestamp: expect.any(Number),
},
breadcrumbs: [
{
message: 'manual breadcrumb',
timestamp: expect.any(Number),
},
{
category: 'http',
data: {
'http.method': 'GET',
url: `${SERVER_URL}/api/v0`,
status_code: 200,
ADDED_PATH: '/api/v0',
},
timestamp: expect.any(Number),
type: 'http',
{
category: 'http',
data: {
'http.method': 'GET',
url: `${SERVER_URL}/api/v0`,
status_code: 200,
ADDED_PATH: '/api/v0',
},
{
category: 'http',
data: {
'http.method': 'GET',
url: `${SERVER_URL}/api/v1`,
status_code: 200,
ADDED_PATH: '/api/v1',
},
timestamp: expect.any(Number),
type: 'http',
timestamp: expect.any(Number),
type: 'http',
},
{
category: 'http',
data: {
'http.method': 'GET',
url: `${SERVER_URL}/api/v1`,
status_code: 200,
ADDED_PATH: '/api/v1',
},
{
category: 'http',
data: {
'http.method': 'GET',
url: `${SERVER_URL}/api/v2`,
status_code: 200,
ADDED_PATH: '/api/v2',
},
timestamp: expect.any(Number),
type: 'http',
timestamp: expect.any(Number),
type: 'http',
},
{
category: 'http',
data: {
'http.method': 'GET',
url: `${SERVER_URL}/api/v2`,
status_code: 200,
ADDED_PATH: '/api/v2',
},
{
category: 'http',
data: {
'http.method': 'GET',
url: `${SERVER_URL}/api/v3`,
status_code: 200,
ADDED_PATH: '/api/v3',
},
timestamp: expect.any(Number),
type: 'http',
timestamp: expect.any(Number),
type: 'http',
},
{
category: 'http',
data: {
'http.method': 'GET',
url: `${SERVER_URL}/api/v3`,
status_code: 200,
ADDED_PATH: '/api/v3',
},
],
},
})
.start()
.completed();
timestamp: expect.any(Number),
type: 'http',
},
],
},
})
.start()
.completed();

closeTestServer();
});
closeTestServer();
});
});
});
4 changes: 2 additions & 2 deletions dev-packages/node-integration-tests/suites/tracing/http-client-spans/http-basic/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ test('captures spans for outgoing http requests', async () => {
expect.objectContaining({
description: expect.stringMatching(/GET .*\/api\/v0/),
op: 'http.client',
origin: 'auto.http.otel.http',
origin: 'auto.http.client',
status: 'ok',
}),
expect.objectContaining({
description: expect.stringMatching(/GET .*\/api\/v1/),
op: 'http.client',
origin: 'auto.http.otel.http',
origin: 'auto.http.client',
status: 'not_found',
data: expect.objectContaining({
'http.response.status_code': 404,
Expand Down
Loading
Loading