Skip to content

feat(node): Add incoming request headers as OTel span attributes #17475

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
merged 26 commits into from
Sep 9, 2025
Merged

feat(node): Add incoming request headers as OTel span attributes #17475

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
81ec187
feat(node): Add request headers as OTel span attributes
s1gr1d Aug 28, 2025
a130579
fix some tests
s1gr1d Aug 28, 2025
88c1db5
add check for sendDefaultPii
s1gr1d Sep 1, 2025
c79ca58
fix prettier
s1gr1d Sep 1, 2025
7f69303
fix tests and nextjs
s1gr1d Sep 1, 2025
bbcec87
fix tests
s1gr1d Sep 1, 2025
1db7f93
add headers in nextjs and node-core
s1gr1d Sep 1, 2025
9ea2643
fix CI problems/tests
s1gr1d Sep 1, 2025
07e834d
mock setAttributes
s1gr1d Sep 1, 2025
f58ad68
fix tests
s1gr1d Sep 2, 2025
67b4255
change all to string, not arrays
s1gr1d Sep 2, 2025
31e2899
fix tests
s1gr1d Sep 2, 2025
3e9f94b
fix type assertion
s1gr1d Sep 2, 2025
76dfa2f
Merge branch 'develop' into sig/http-attributes
s1gr1d Sep 8, 2025
5491733
add attributes to incoming-request
s1gr1d Sep 8, 2025
d78fa05
fix problems
s1gr1d Sep 8, 2025
8c9478e
fix tests
s1gr1d Sep 8, 2025
217b751
fix fastify tests
s1gr1d Sep 8, 2025
f5973c7
remove log
s1gr1d Sep 8, 2025
bd476e8
Merge branch 'develop' into sig/http-attributes
s1gr1d Sep 8, 2025
35da063
update lock file
s1gr1d Sep 8, 2025
8f410c1
update lock file
s1gr1d Sep 8, 2025
6153268
exclude turbopack test
s1gr1d Sep 9, 2025
51c1098
exclude turbopack test 2
s1gr1d Sep 9, 2025
5584061
change function name
s1gr1d Sep 9, 2025
15ea0a6
increase size limit
s1gr1d Sep 9, 2025
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
7 changes: 7 additions & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-11/tests/transactions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@ test('Sends an API route transaction', async ({ baseURL }) => {
'http.status_code': 200,
'http.status_text': 'OK',
'http.route': '/test-transaction',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': [expect.any(String)],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
op: 'http.server',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
Expand Down
7 changes: 7 additions & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-8/tests/transactions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@ test('Sends an API route transaction', async ({ baseURL }) => {
'http.status_code': 200,
'http.status_text': 'OK',
'http.route': '/test-transaction',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': [expect.any(String)],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
op: 'http.server',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
Expand Down
7 changes: 7 additions & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-basic/tests/transactions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@ test('Sends an API route transaction', async ({ baseURL }) => {
'http.status_code': 200,
'http.status_text': 'OK',
'http.route': '/test-transaction',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': [expect.any(String)],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
op: 'http.server',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
Expand Down
7 changes: 7 additions & 0 deletions ...packages/e2e-tests/test-applications/nestjs-distributed-tracing/tests/propagation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,13 @@ test('Propagates trace for outgoing http requests', async ({ baseURL }) => {
'http.status_code': 200,
'http.status_text': 'OK',
'http.route': '/test-outgoing-http/:id',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': ['localhost:3030'],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
op: 'http.server',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
Expand Down
14 changes: 14 additions & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-fastify/tests/transactions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@ test('Sends an API route transaction', async ({ baseURL }) => {
'http.status_code': 200,
'http.status_text': 'OK',
'http.route': '/test-transaction',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': [expect.any(String)],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
op: 'http.server',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
Expand Down Expand Up @@ -103,6 +110,13 @@ test('Sends an API route transaction', async ({ baseURL }) => {
'nestjs.controller': 'AppController',
'nestjs.callback': 'testTransaction',
url: '/test-transaction',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': [expect.any(String)],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
description: 'GET /test-transaction',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
Expand Down
7 changes: 7 additions & 0 deletions ...s/e2e-tests/test-applications/nestjs-with-submodules-decorator/tests/transactions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@ test('Sends an API route transaction from module', async ({ baseURL }) => {
'http.status_code': 200,
'http.status_text': 'OK',
'http.route': '/example-module/transaction',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': [expect.any(String)],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
op: 'http.server',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
Expand Down
7 changes: 7 additions & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-with-submodules/tests/transactions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@ test('Sends an API route transaction from module', async ({ baseURL }) => {
'http.status_code': 200,
'http.status_text': 'OK',
'http.route': '/example-module/transaction',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': [expect.any(String)],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
op: 'http.server',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
Expand Down
30 changes: 30 additions & 0 deletions dev-packages/e2e-tests/test-applications/nextjs-15/tests/pageload-tracing.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,33 @@ test('App router transactions should be attached to the pageload request span',
expect(pageloadTraceId).toBeTruthy();
expect(serverTransaction.contexts?.trace?.trace_id).toBe(pageloadTraceId);
});

test('extracts HTTP request headers as span attributes', async ({ baseURL }) => {
const serverTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
return transactionEvent?.transaction === 'GET /pageload-tracing';
});

await fetch(`${baseURL}/pageload-tracing`, {
headers: {
'User-Agent': 'Custom-NextJS-Agent/15.0',
'Content-Type': 'text/html',
'X-NextJS-Test': 'nextjs-header-value',
Accept: 'text/html, application/xhtml+xml',
'X-Framework': 'Next.js',
'X-Request-ID': 'nextjs-789',
},
});

const serverTransaction = await serverTransactionPromise;

expect(serverTransaction.contexts?.trace?.data).toEqual(
expect.objectContaining({
'http.request.header.user_agent': ['Custom-NextJS-Agent/15.0'],
'http.request.header.content_type': ['text/html'],
'http.request.header.x_nextjs_test': ['nextjs-header-value'],
'http.request.header.accept': ['text/html, application/xhtml+xml'],
'http.request.header.x_framework': ['Next.js'],
'http.request.header.x_request_id': ['nextjs-789'],
}),
);
});
7 changes: 7 additions & 0 deletions dev-packages/e2e-tests/test-applications/node-connect/tests/transactions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,13 @@ test('Sends an API route transaction', async ({ baseURL }) => {
'http.status_code': 200,
'http.status_text': 'OK',
'http.route': '/test-transaction',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': [expect.any(String)],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
op: 'http.server',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
Expand Down
7 changes: 7 additions & 0 deletions ...e-tests/test-applications/node-core-express-otel-v1-custom-sampler/tests/sampling.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,13 @@ test('Sends a sampled API route transaction', async ({ baseURL }) => {
'net.peer.port': expect.any(Number),
'http.status_code': 200,
'http.status_text': 'OK',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': ['localhost:3030'],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
origin: 'manual',
op: 'http.server',
Expand Down
7 changes: 7 additions & 0 deletions ...e2e-tests/test-applications/node-core-express-otel-v1-sdk-node/tests/transactions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,13 @@ test('Sends an API route transaction', async ({ baseURL }) => {
'net.peer.port': expect.any(Number),
'http.status_code': 200,
'http.status_text': 'OK',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': [expect.any(String)],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
op: 'http.server',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
Expand Down
7 changes: 7 additions & 0 deletions ...packages/e2e-tests/test-applications/node-core-express-otel-v1/tests/transactions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,13 @@ test('Sends an API route transaction', async ({ baseURL }) => {
'net.peer.port': expect.any(Number),
'http.status_code': 200,
'http.status_text': 'OK',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': [expect.any(String)],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
op: 'http.server',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
Expand Down
7 changes: 7 additions & 0 deletions ...e-tests/test-applications/node-core-express-otel-v2-custom-sampler/tests/sampling.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,13 @@ test('Sends a sampled API route transaction', async ({ baseURL }) => {
'net.peer.port': expect.any(Number),
'http.status_code': 200,
'http.status_text': 'OK',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': ['localhost:3030'],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
origin: 'manual',
op: 'http.server',
Expand Down
7 changes: 7 additions & 0 deletions ...e2e-tests/test-applications/node-core-express-otel-v2-sdk-node/tests/transactions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,13 @@ test('Sends an API route transaction', async ({ baseURL }) => {
'net.peer.port': expect.any(Number),
'http.status_code': 200,
'http.status_text': 'OK',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': [expect.any(String)],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
op: 'http.server',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
Expand Down
7 changes: 7 additions & 0 deletions ...packages/e2e-tests/test-applications/node-core-express-otel-v2/tests/transactions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,13 @@ test('Sends an API route transaction', async ({ baseURL }) => {
'net.peer.port': expect.any(Number),
'http.status_code': 200,
'http.status_text': 'OK',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': [expect.any(String)],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
op: 'http.server',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
Expand Down
7 changes: 7 additions & 0 deletions dev-packages/e2e-tests/test-applications/node-express-v5/tests/transactions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@ test('Sends an API route transaction', async ({ baseURL }) => {
'http.status_code': 200,
'http.status_text': 'OK',
'http.route': '/test-transaction',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': [expect.any(String)],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
op: 'http.server',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
Expand Down
42 changes: 40 additions & 2 deletions dev-packages/e2e-tests/test-applications/node-express/tests/transactions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ test('Sends an API route transaction', async ({ baseURL }) => {
const transactionEvent = await pageloadTransactionEventPromise;

expect(transactionEvent.contexts?.trace).toEqual({
data: {
data: expect.objectContaining({
'sentry.source': 'route',
'sentry.origin': 'auto.http.otel.http',
'sentry.op': 'http.server',
Expand All @@ -38,7 +38,14 @@ test('Sends an API route transaction', async ({ baseURL }) => {
'http.status_code': 200,
'http.status_text': 'OK',
'http.route': '/test-transaction',
},
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': [expect.any(String)],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
}),
op: 'http.server',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
status: 'ok',
Expand Down Expand Up @@ -208,3 +215,34 @@ test('Sends an API route transaction for an errored route', async ({ baseURL })
measurements: {},
});
});

test('Extracts HTTP request headers as span attributes', async ({ baseURL }) => {
const transactionEventPromise = waitForTransaction('node-express', transactionEvent => {
return (
transactionEvent?.contexts?.trace?.op === 'http.server' &&
transactionEvent?.transaction === 'GET /test-transaction'
);
});

await fetch(`${baseURL}/test-transaction`, {
headers: {
'User-Agent': 'Custom-Agent/1.0 (Test)',
'Content-Type': 'application/json',
'X-Custom-Header': 'test-value',
Accept: 'application/json, text/plain',
'X-Request-ID': 'req-123',
},
});

const transactionEvent = await transactionEventPromise;

expect(transactionEvent.contexts?.trace?.data).toEqual(
expect.objectContaining({
'http.request.header.user_agent': ['Custom-Agent/1.0 (Test)'],
'http.request.header.content_type': ['application/json'],
'http.request.header.x_custom_header': ['test-value'],
'http.request.header.accept': ['application/json, text/plain'],
'http.request.header.x_request_id': ['req-123'],
}),
);
});
18 changes: 18 additions & 0 deletions dev-packages/e2e-tests/test-applications/node-fastify-3/tests/propagation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,13 @@ test('Propagates trace for outgoing http requests', async ({ baseURL }) => {
'http.status_code': 200,
'http.status_text': 'OK',
'http.route': '/test-outgoing-http/:id',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': ['localhost:3030'],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
op: 'http.server',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
Expand Down Expand Up @@ -106,6 +113,10 @@ test('Propagates trace for outgoing http requests', async ({ baseURL }) => {
'http.status_code': 200,
'http.status_text': 'OK',
'http.route': '/test-inbound-headers/:id',
'http.request.header.baggage': [expect.any(String)],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': [expect.any(String)],
'http.request.header.sentry_trace': [expect.stringContaining(traceId || '')],
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also add the baggage and sentry_trace headers?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is a general question, not related to this test, then yes please. All request headers 😄

},
op: 'http.server',
parent_span_id: outgoingHttpSpanId,
Expand Down Expand Up @@ -189,6 +200,13 @@ test('Propagates trace for outgoing fetch requests', async ({ baseURL }) => {
'http.status_code': 200,
'http.status_text': 'OK',
'http.route': '/test-outgoing-fetch/:id',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': [expect.any(String)],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
op: 'http.server',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
Expand Down
7 changes: 7 additions & 0 deletions dev-packages/e2e-tests/test-applications/node-fastify-3/tests/transactions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@ test('Sends an API route transaction', async ({ baseURL }) => {
'http.status_code': 200,
'http.status_text': 'OK',
'http.route': '/test-transaction',
'http.request.header.accept': ['*/*'],
'http.request.header.accept_encoding': ['gzip, deflate'],
'http.request.header.accept_language': ['*'],
'http.request.header.connection': ['keep-alive'],
'http.request.header.host': [expect.any(String)],
'http.request.header.sec_fetch_mode': ['cors'],
'http.request.header.user_agent': ['node'],
},
op: 'http.server',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
Expand Down
Loading
Loading