Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
transport: loggingTransport,
traceLifecycle: 'stream',
dataCollection: {
userInfo: false,
},
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
transport: loggingTransport,
traceLifecycle: 'stream',
dataCollection: {
userInfo: true,
},
});
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,79 @@ describe('requestData-streamed', () => {
});
});

createEsmAndCjsTests(__dirname, 'server.mjs', 'instrument-with-datacollection.mjs', (createRunner, test) => {
test('applies request data attributes when using dataCollection config', async () => {
const runner = createRunner()
.expect({
span: container => {
const serverSpan = container.items.find(item => item.is_segment);

expect(serverSpan).toBeDefined();

expect(serverSpan?.attributes?.['url.full']).toEqual({
type: 'string',
value: expect.stringContaining('/test?foo=bar'),
});

expect(serverSpan?.attributes?.['http.request.method']).toEqual({
type: 'string',
value: 'GET',
});

expect(serverSpan?.attributes?.['url.query']).toEqual({
type: 'string',
value: 'foo=bar',
});

expect(serverSpan?.attributes?.['http.request.header.host']).toEqual({
type: 'string',
value: expect.any(String),
});

expect(serverSpan?.attributes?.['user.ip_address']).toEqual({
type: 'string',
value: expect.any(String),
});
},
})
.start();

await runner.makeRequest('get', '/test?foo=bar');

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

createEsmAndCjsTests(
__dirname,
'server.mjs',
'instrument-with-datacollection-no-userinfo.mjs',
(createRunner, test) => {
test('does not include user.ip_address when dataCollection.userInfo is false', async () => {
const runner = createRunner()
.expect({
span: container => {
const serverSpan = container.items.find(item => item.is_segment);

expect(serverSpan).toBeDefined();

expect(serverSpan?.attributes?.['http.request.header.host']).toEqual({
type: 'string',
value: expect.any(String),
});

expect(serverSpan?.attributes?.['user.ip_address']).toBeUndefined();
},
})
.start();

await runner.makeRequest('get', '/test?foo=bar');

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

createEsmAndCjsTests(__dirname, 'server.mjs', 'instrument-without-request-data.mjs', (createRunner, test) => {
test('does not apply request data attributes when requestDataIntegration is removed', async () => {
const runner = createRunner()
Expand Down
7 changes: 2 additions & 5 deletions packages/core/src/integrations/http/server-subscription.ts
Original file line number Diff line number Diff line change
Expand Up @@ -309,10 +309,7 @@ function buildServerSpanWrap(
'http.flavor': httpVersion,
'net.transport': httpVersion?.toUpperCase() === 'QUIC' ? 'ip_udp' : 'ip_tcp',
...getRequestContentLengthAttribute(request),
...httpHeadersToSpanAttributes(
normalizedRequest.headers || {},
client.getOptions().sendDefaultPii ?? false,
),
...httpHeadersToSpanAttributes(normalizedRequest.headers || {}, client.getDataCollectionOptions()),
},
},
span => {
Expand All @@ -334,7 +331,7 @@ function buildServerSpanWrap(
'http.status_code': response.statusCode,
...httpHeadersToSpanAttributes(
headersToDict(response.headers),
client?.getOptions().sendDefaultPii ?? false,
client?.getDataCollectionOptions() ?? false,
'response',
),
});
Expand Down
68 changes: 41 additions & 27 deletions packages/core/src/integrations/requestdata.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import type { Client } from '../client';
import { getIsolationScope } from '../currentScopes';
import { defineIntegration } from '../integration';
import { SEMANTIC_ATTRIBUTE_USER_IP_ADDRESS } from '../semanticAttributes';
import type { ResolvedDataCollection } from '../types/datacollection';
import type { Event } from '../types/event';
import type { IntegrationFn } from '../types/integration';
import type { QueryParams, RequestEventData } from '../types/request';
Expand All @@ -26,36 +28,52 @@ type RequestDataIntegrationOptions = {
include?: RequestDataIncludeOptions;
};

// TODO(v11): Change defaults based on `sendDefaultPii`
const DEFAULT_INCLUDE: RequestDataIncludeOptions = {
cookies: true,
data: true,
headers: true,
query_string: true,
url: true,
};

const INTEGRATION_NAME = 'RequestData';

const _requestDataIntegration = ((options: RequestDataIntegrationOptions = {}) => {
const include = {
...DEFAULT_INCLUDE,
...options.include,
};
// Per spec, integration-level options override global dataCollection.
// When include overrides a category back on that dataCollection turned off,
// we flip the dataCollection behavior to true (default denylist filtering).
function resolveIncludeAndDataCollection(client: Client): {
include: RequestDataIncludeOptions;
dataCollection: ResolvedDataCollection;
} {
const dc = client.getDataCollectionOptions();
const dataCollection: ResolvedDataCollection = {
...dc,
...(options.include?.cookies === true && dc.cookies === false && { cookies: true as const }),
...(options.include?.headers === true &&
dc.httpHeaders.request === false && {
httpHeaders: { ...dc.httpHeaders, request: true as const },
}),
};

return {
dataCollection,
include: {
cookies: dataCollection.cookies !== false,
// Always attach body data that's already on the scope — dataCollection.httpBodies gates write-time, not read-time
data: true,
headers: dataCollection.httpHeaders.request !== false,
ip: dataCollection.userInfo,
query_string: dataCollection.queryParams !== false,
// No dataCollection equivalent — URL is always included
url: true,
...options.include,
},
};
}

return {
name: INTEGRATION_NAME,
processEvent(event, _hint, client) {
const { sdkProcessingMetadata = {} } = event;
const { normalizedRequest, ipAddress } = sdkProcessingMetadata;

const includeWithDefaultPiiApplied: RequestDataIncludeOptions = {
...include,
ip: include.ip ?? client.getOptions().sendDefaultPii,
};
const { include } = resolveIncludeAndDataCollection(client);

if (normalizedRequest) {
addNormalizedRequestDataToEvent(event, normalizedRequest, { ipAddress }, includeWithDefaultPiiApplied);
addNormalizedRequestDataToEvent(event, normalizedRequest, { ipAddress }, include);
}

return event;
Expand All @@ -68,13 +86,9 @@ const _requestDataIntegration = ((options: RequestDataIntegrationOptions = {}) =
return;
}

const { sendDefaultPii } = client.getOptions();
const includeWithDefaultPiiApplied: RequestDataIncludeOptions = {
...include,
ip: include.ip ?? sendDefaultPii,
};
const { include, dataCollection } = resolveIncludeAndDataCollection(client);

addNormalizedRequestDataToSpan(span, normalizedRequest, ipAddress, includeWithDefaultPiiApplied, sendDefaultPii);
addNormalizedRequestDataToSpan(span, normalizedRequest, ipAddress, include, dataCollection);
Comment thread
chargome marked this conversation as resolved.
},
};
}) satisfies IntegrationFn;
Expand Down Expand Up @@ -117,7 +131,7 @@ function addNormalizedRequestDataToSpan(
normalizedRequest: RequestEventData,
ipAddress: string | undefined,
include: RequestDataIncludeOptions,
sendDefaultPii: boolean | undefined,
dataCollection: ResolvedDataCollection,
): void {
const requestData = extractNormalizedRequestData(normalizedRequest, include);
const attributes: Record<string, unknown> = {};
Expand All @@ -142,12 +156,12 @@ function addNormalizedRequestDataToSpan(
const cookieString = Object.entries(requestData.cookies)
.map(([name, value]) => `${name}=${value}`)
.join('; ');
const cookieAttributes = httpHeadersToSpanAttributes({ cookie: cookieString }, sendDefaultPii ?? false, 'request');
const cookieAttributes = httpHeadersToSpanAttributes({ cookie: cookieString }, dataCollection, 'request');
safeSetSpanJSONAttributes(span, cookieAttributes);
}

if (requestData.headers) {
const headerAttributes = httpHeadersToSpanAttributes(requestData.headers, sendDefaultPii ?? false, 'request');
const headerAttributes = httpHeadersToSpanAttributes(requestData.headers, dataCollection, 'request');
safeSetSpanJSONAttributes(span, headerAttributes);
}

Expand Down
Loading
Loading