fix(node): Ensure ignoreOutgoingRequests of httpIntegration applies to breadcrumbs#13970

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
Lms24 merged 2 commits into from
Oct 16, 2024
Merged

fix(node): Ensure ignoreOutgoingRequests of httpIntegration applies to breadcrumbs #13970

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1138c54
fix(node): Ensure `ignoreOutgoingRequests` applies to breadcrumbs
Lms24 Oct 14, 2024
032ff91
cleanup
Lms24 Oct 14, 2024
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
50 changes: 30 additions & 20 deletions ...es/node-integration-tests/suites/tracing/httpIntegration/server-ignoreOutgoingRequests.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,11 @@ Sentry.init({
integrations: [
Sentry.httpIntegration({
ignoreOutgoingRequests: (url, request) => {
if (url.includes('example.com')) {
if (url === 'http://example.com/blockUrl') {
return true;
}
if (request.method === 'POST' && request.path === '/path') {

if (request.hostname === 'example.com' && request.path === '/blockRequest') {
return true;
}
return false;
Expand All@@ -32,28 +33,37 @@ const app = express();

app.use(cors());

app.get('/test', (_req, response) => {
http
.request('http://example.com/', res => {
res.on('data', () => {});
res.on('end', () => {
response.send({ response: 'done' });
});
})
.end();
app.get('/testUrl', (_req, response) => {
makeHttpRequest('http://example.com/blockUrl').then(() => {
makeHttpRequest('http://example.com/pass').then(() => {
response.send({ response: 'done' });
});
});
});

app.post('/testPath', (_req, response) => {
http
.request('http://example.com/path', res => {
res.on('data', () => {});
res.on('end', () => {
response.send({ response: 'done' });
});
})
.end();
app.get('/testRequest', (_req, response) => {
makeHttpRequest('http://example.com/blockRequest').then(() => {
makeHttpRequest('http://example.com/pass').then(() => {
response.send({ response: 'done' });
});
});
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);

function makeHttpRequest(url) {
return new Promise((resolve, reject) => {
http
.get(url, res => {
res.on('data', () => {});
res.on('end', () => {
resolve();
});
})
.on('error', error => {
reject(error);
});
});
}
66 changes: 23 additions & 43 deletions dev-packages/node-integration-tests/suites/tracing/httpIntegration/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -128,65 +128,45 @@ describe('httpIntegration', () => {
});
});

describe("doesn't create child spans for outgoing requests ignored via `ignoreOutgoingRequests`", () => {
describe("doesn't create child spans or breadcrumbs for outgoing requests ignored via `ignoreOutgoingRequests`", () => {
test('via the url param', done => {
const runner = createRunner(__dirname, 'server-ignoreOutgoingRequests.js')
.expect({
transaction: {
contexts: {
trace: {
span_id: expect.any(String),
trace_id: expect.any(String),
data: {
url: expect.stringMatching(/\/test$/),
'http.response.status_code': 200,
},
op: 'http.server',
status: 'ok',
},
},
transaction: 'GET /test',
spans: [
expect.objectContaining({ op: 'middleware.express', description: 'query' }),
expect.objectContaining({ op: 'middleware.express', description: 'expressInit' }),
expect.objectContaining({ op: 'middleware.express', description: 'corsMiddleware' }),
expect.objectContaining({ op: 'request_handler.express', description: '/test' }),
],
transaction: event => {
expect(event.transaction).toBe('GET /testUrl');

const requestSpans = event.spans?.filter(span => span.op === 'http.client');
expect(requestSpans).toHaveLength(1);
expect(requestSpans![0]?.description).toBe('GET http://example.com/pass');

const breadcrumbs = event.breadcrumbs?.filter(b => b.category === 'http');
expect(breadcrumbs).toHaveLength(1);
expect(breadcrumbs![0]?.data?.url).toEqual('http://example.com/pass');
},
})
.start(done);

runner.makeRequest('get', '/test');
runner.makeRequest('get', '/testUrl');
});

test('via the request param', done => {
const runner = createRunner(__dirname, 'server-ignoreOutgoingRequests.js')
.expect({
transaction: {
contexts: {
trace: {
span_id: expect.any(String),
trace_id: expect.any(String),
data: {
url: expect.stringMatching(/\/testPath$/),
'http.response.status_code': 200,
},
op: 'http.server',
status: 'ok',
},
},
transaction: 'POST /testPath',
spans: [
expect.objectContaining({ op: 'middleware.express', description: 'query' }),
expect.objectContaining({ op: 'middleware.express', description: 'expressInit' }),
expect.objectContaining({ op: 'middleware.express', description: 'corsMiddleware' }),
expect.objectContaining({ op: 'request_handler.express', description: '/testPath' }),
],
transaction: event => {
expect(event.transaction).toBe('GET /testRequest');

const requestSpans = event.spans?.filter(span => span.op === 'http.client');
expect(requestSpans).toHaveLength(1);
expect(requestSpans![0]?.description).toBe('GET http://example.com/pass');

const breadcrumbs = event.breadcrumbs?.filter(b => b.category === 'http');
expect(breadcrumbs).toHaveLength(1);
expect(breadcrumbs![0]?.data?.url).toEqual('http://example.com/pass');
},
})
.start(done);

runner.makeRequest('post', '/testPath');
runner.makeRequest('get', '/testRequest');
});
});
});
49 changes: 45 additions & 4 deletions packages/node/src/integrations/http/SentryHttpInstrumentation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
import type * as http from 'node:http';
import type { RequestOptions } from 'node:http';
import type * as https from 'node:https';
import { VERSION } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import { getRequestInfo } from '@opentelemetry/instrumentation-http';
import { addBreadcrumb, getClient, getIsolationScope, withIsolationScope } from '@sentry/core';
import type { SanitizedRequestData } from '@sentry/types';
import {
Expand All@@ -12,12 +14,29 @@ import {
stripUrlQueryAndFragment,
} from '@sentry/utils';
import type { NodeClient } from '../../sdk/client';
import { getRequestUrl } from '../../utils/getRequestUrl';

type Http = typeof http;
type Https = typeof https;

type SentryHttpInstrumentationOptions = InstrumentationConfig & {
/**
* Whether breadcrumbs should be recorded for requests.
*
* @default `true`
*/
breadcrumbs?: boolean;

/**
* Do not capture breadcrumbs for outgoing HTTP requests to URLs where the given callback returns `true`.
* For the scope of this instrumentation, this callback only controls breadcrumb creation.
* The same option can be passed to the top-level httpIntegration where it controls both, breadcrumb and
* span creation.
*
* @param url Contains the entire URL, including query string (if any), protocol, host, etc. of the outgoing request.
* @param request Contains the {@type RequestOptions} object used to make the outgoing request.
*/
ignoreOutgoingRequests?: (url: string, request: RequestOptions) => boolean;
};

/**
Expand DownExpand Up@@ -140,20 +159,42 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
private _getPatchOutgoingRequestFunction(): (
// eslint-disable-next-line @typescript-eslint/no-explicit-any
original: (...args: any[]) => http.ClientRequest,
) => (...args: unknown[]) => http.ClientRequest {
) => (options: URL | http.RequestOptions | string, ...args: unknown[]) => http.ClientRequest {
// eslint-disable-next-line @typescript-eslint/no-this-alias
const instrumentation = this;

return (original: (...args: unknown[]) => http.ClientRequest): ((...args: unknown[]) => http.ClientRequest) => {
return function outgoingRequest(this: unknown, ...args: unknown[]): http.ClientRequest {
instrumentation._diag.debug('http instrumentation for outgoing requests');

// Making a copy to avoid mutating the original args array
// We need to access and reconstruct the request options object passed to `ignoreOutgoingRequests`
// so that it matches what Otel instrumentation passes to `ignoreOutgoingRequestHook`.
// @see https://github.com/open-telemetry/opentelemetry-js/blob/7293e69c1e55ca62e15d0724d22605e61bd58952/experimental/packages/opentelemetry-instrumentation-http/src/http.ts#L756-L789
const argsCopy = [...args];

const options = argsCopy.shift() as URL | http.RequestOptions | string;

const extraOptions =
typeof argsCopy[0] === 'object' && (typeof options === 'string' || options instanceof URL)
? (argsCopy.shift() as http.RequestOptions)
: undefined;

const { optionsParsed } = getRequestInfo(options, extraOptions);

const request = original.apply(this, args) as ReturnType<typeof http.request>;

request.prependListener('response', (response: http.IncomingMessage) => {
const breadcrumbs = instrumentation.getConfig().breadcrumbs;
const _breadcrumbs = typeof breadcrumbs === 'undefined' ? true : breadcrumbs;
if (_breadcrumbs) {
const _breadcrumbs = instrumentation.getConfig().breadcrumbs;
const breadCrumbsEnabled = typeof _breadcrumbs === 'undefined' ? true : _breadcrumbs;

const _ignoreOutgoingRequests = instrumentation.getConfig().ignoreOutgoingRequests;
const shouldCreateBreadcrumb =
typeof _ignoreOutgoingRequests === 'function'
? !_ignoreOutgoingRequests(getRequestUrl(request), optionsParsed)
: true;

if (breadCrumbsEnabled && shouldCreateBreadcrumb) {
addRequestBreadcrumb(request, response);
}
});
Expand Down
21 changes: 12 additions & 9 deletions packages/node/src/integrations/http/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ const INSTRUMENTATION_NAME = '@opentelemetry_sentry-patched/instrumentation-http

interface HttpOptions {
/**
* Whether breadcrumbs should be recorded for requests.
* Whether breadcrumbs should be recorded for outgoing requests.
* Defaults to true
*/
breadcrumbs?: boolean;
Expand All@@ -45,8 +45,8 @@ interface HttpOptions {
ignoreOutgoingRequests?: (url: string, request: RequestOptions) => boolean;

/**
* Do not capture spans or breadcrumbs for incoming HTTP requests to URLs where the given callback returns `true`.
* This controls both span & breadcrumb creation - spans will be non recording if tracing is disabled.
* Do not capture spans for incoming HTTP requests to URLs where the given callback returns `true`.
* Spans will be non recording if tracing is disabled.
Comment on lines +48 to +49

@Lms24Lms24Oct 14, 2024•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I also adjusted the JSDoc of ignoreIncomingRequests because it wrongfully claimed that incoming requests also generate breadcrumbs. Which isn't the case now and wasn't the case before:

sentry-javascript/packages/node/src/integrations/http.ts

Lines 245 to 248 in d7749ae

// Only generate breadcrumbs for outgoing requests
if(!_isClientRequest(request)){
return;
}

*
* The `urlPath` param consists of the URL path and query string (if any) of the incoming request.
* For example: `'/users/details?id=123'`
Expand DownExpand Up@@ -82,12 +82,15 @@ interface HttpOptions {
};
}

export const instrumentSentryHttp = generateInstrumentOnce<{ breadcrumbs?: boolean }>(
`${INTEGRATION_NAME}.sentry`,
options => {
return new SentryHttpInstrumentation({ breadcrumbs: options?.breadcrumbs });
},
);
export const instrumentSentryHttp = generateInstrumentOnce<{
breadcrumbs?: HttpOptions['breadcrumbs'];
ignoreOutgoingRequests?: HttpOptions['ignoreOutgoingRequests'];
}>(`${INTEGRATION_NAME}.sentry`, options => {
return new SentryHttpInstrumentation({
breadcrumbs: options?.breadcrumbs,
ignoreOutgoingRequests: options?.ignoreOutgoingRequests,
});
});

export const instrumentOtelHttp = generateInstrumentOnce<HttpInstrumentationConfig>(INTEGRATION_NAME, config => {
const instrumentation = new HttpInstrumentation(config);
Expand Down
, '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
fix(node): Ensure ignoreOutgoingRequests of httpIntegration applies to breadcrumbs#13970

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

Lms24
merged 2 commits into

from

Oct 16, 2024
 Merged


fix(node): Ensure ignoreOutgoingRequests of httpIntegration applies to breadcrumbs
#13970
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1138c54

fix(node): Ensure `ignoreOutgoingRequests` applies to breadcrumbs


Lms24 Oct 14, 2024
032ff91

cleanup


Lms24 Oct 14, 2024

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


50 changes: 30 additions & 20 deletions
...es/node-integration-tests/suites/tracing/httpIntegration/server-ignoreOutgoingRequests.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,11 @@ Sentry.init({
 integrations: [
 Sentry.httpIntegration({
 ignoreOutgoingRequests: (url, request) => {
 if (url.includes('example.com')) {
 if (url === 'http://example.com/blockUrl') {
 return true;
 }
 if (request.method === 'POST' && request.path === '/path') {

 if (request.hostname === 'example.com' && request.path === '/blockRequest') {
 return true;
 }
 return false;
Expand All@@ -32,28 +33,37 @@ const app = express();

app.use(cors());

app.get('/test', (_req, response) => {
 http
 .request('http://example.com/', res => {
 res.on('data', () => {});
 res.on('end', () => {
 response.send({ response: 'done' });
 });
 })
 .end();
app.get('/testUrl', (_req, response) => {
 makeHttpRequest('http://example.com/blockUrl').then(() => {
 makeHttpRequest('http://example.com/pass').then(() => {
 response.send({ response: 'done' });
 });
 });
});

app.post('/testPath', (_req, response) => {
 http
 .request('http://example.com/path', res => {
 res.on('data', () => {});
 res.on('end', () => {
 response.send({ response: 'done' });
 });
 })
 .end();
app.get('/testRequest', (_req, response) => {
 makeHttpRequest('http://example.com/blockRequest').then(() => {
 makeHttpRequest('http://example.com/pass').then(() => {
 response.send({ response: 'done' });
 });
 });
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);

function makeHttpRequest(url) {
 return new Promise((resolve, reject) => {
 http
 .get(url, res => {
 res.on('data', () => {});
 res.on('end', () => {
 resolve();
 });
 })
 .on('error', error => {
 reject(error);
 });
 });
}

66 changes: 23 additions & 43 deletions
dev-packages/node-integration-tests/suites/tracing/httpIntegration/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,65 +128,45 @@ describe('httpIntegration', () => {
 });
 });

 describe("doesn't create child spans for outgoing requests ignored via `ignoreOutgoingRequests`", () => {
 describe("doesn't create child spans or breadcrumbs for outgoing requests ignored via `ignoreOutgoingRequests`", () => {
 test('via the url param', done => {
 const runner = createRunner(__dirname, 'server-ignoreOutgoingRequests.js')
 .expect({
 transaction: {
 contexts: {
 trace: {
 span_id: expect.any(String),
 trace_id: expect.any(String),
 data: {
 url: expect.stringMatching(/\/test$/),
 'http.response.status_code': 200,
 },
 op: 'http.server',
 status: 'ok',
 },
 },
 transaction: 'GET /test',
 spans: [
 expect.objectContaining({ op: 'middleware.express', description: 'query' }),
 expect.objectContaining({ op: 'middleware.express', description: 'expressInit' }),
 expect.objectContaining({ op: 'middleware.express', description: 'corsMiddleware' }),
 expect.objectContaining({ op: 'request_handler.express', description: '/test' }),
 ],
 transaction: event => {
 expect(event.transaction).toBe('GET /testUrl');

 const requestSpans = event.spans?.filter(span => span.op === 'http.client');
 expect(requestSpans).toHaveLength(1);
 expect(requestSpans![0]?.description).toBe('GET http://example.com/pass');

 const breadcrumbs = event.breadcrumbs?.filter(b => b.category === 'http');
 expect(breadcrumbs).toHaveLength(1);
 expect(breadcrumbs![0]?.data?.url).toEqual('http://example.com/pass');
 },
 })
 .start(done);

 runner.makeRequest('get', '/test');
 runner.makeRequest('get', '/testUrl');
 });

 test('via the request param', done => {
 const runner = createRunner(__dirname, 'server-ignoreOutgoingRequests.js')
 .expect({
 transaction: {
 contexts: {
 trace: {
 span_id: expect.any(String),
 trace_id: expect.any(String),
 data: {
 url: expect.stringMatching(/\/testPath$/),
 'http.response.status_code': 200,
 },
 op: 'http.server',
 status: 'ok',
 },
 },
 transaction: 'POST /testPath',
 spans: [
 expect.objectContaining({ op: 'middleware.express', description: 'query' }),
 expect.objectContaining({ op: 'middleware.express', description: 'expressInit' }),
 expect.objectContaining({ op: 'middleware.express', description: 'corsMiddleware' }),
 expect.objectContaining({ op: 'request_handler.express', description: '/testPath' }),
 ],
 transaction: event => {
 expect(event.transaction).toBe('GET /testRequest');

 const requestSpans = event.spans?.filter(span => span.op === 'http.client');
 expect(requestSpans).toHaveLength(1);
 expect(requestSpans![0]?.description).toBe('GET http://example.com/pass');

 const breadcrumbs = event.breadcrumbs?.filter(b => b.category === 'http');
 expect(breadcrumbs).toHaveLength(1);
 expect(breadcrumbs![0]?.data?.url).toEqual('http://example.com/pass');
 },
 })
 .start(done);

 runner.makeRequest('post', '/testPath');
 runner.makeRequest('get', '/testRequest');
 });
 });
});

49 changes: 45 additions & 4 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
import type * as http from 'node:http';
import type { RequestOptions } from 'node:http';
import type * as https from 'node:https';
import { VERSION } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import { getRequestInfo } from '@opentelemetry/instrumentation-http';
import { addBreadcrumb, getClient, getIsolationScope, withIsolationScope } from '@sentry/core';
import type { SanitizedRequestData } from '@sentry/types';
import {
Expand All@@ -12,12 +14,29 @@ import {
 stripUrlQueryAndFragment,
} from '@sentry/utils';
import type { NodeClient } from '../../sdk/client';
import { getRequestUrl } from '../../utils/getRequestUrl';

type Http = typeof http;
type Https = typeof https;

type SentryHttpInstrumentationOptions = InstrumentationConfig & {
 /**
 * Whether breadcrumbs should be recorded for requests.
 *
 * @default `true`
 */
 breadcrumbs?: boolean;

 /**
 * Do not capture breadcrumbs for outgoing HTTP requests to URLs where the given callback returns `true`.
 * For the scope of this instrumentation, this callback only controls breadcrumb creation.
 * The same option can be passed to the top-level httpIntegration where it controls both, breadcrumb and
 * span creation.
 *
 * @param url Contains the entire URL, including query string (if any), protocol, host, etc. of the outgoing request.
 * @param request Contains the {@type RequestOptions} object used to make the outgoing request.
 */
 ignoreOutgoingRequests?: (url: string, request: RequestOptions) => boolean;
};

/**
Expand DownExpand Up@@ -140,20 +159,42 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 private _getPatchOutgoingRequestFunction(): (
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 original: (...args: any[]) => http.ClientRequest,
 ) => (...args: unknown[]) => http.ClientRequest {
 ) => (options: URL | http.RequestOptions | string, ...args: unknown[]) => http.ClientRequest {
 // eslint-disable-next-line @typescript-eslint/no-this-alias
 const instrumentation = this;

 return (original: (...args: unknown[]) => http.ClientRequest): ((...args: unknown[]) => http.ClientRequest) => {
 return function outgoingRequest(this: unknown, ...args: unknown[]): http.ClientRequest {
 instrumentation._diag.debug('http instrumentation for outgoing requests');

 // Making a copy to avoid mutating the original args array
 // We need to access and reconstruct the request options object passed to `ignoreOutgoingRequests`
 // so that it matches what Otel instrumentation passes to `ignoreOutgoingRequestHook`.
 // @see https://github.com/open-telemetry/opentelemetry-js/blob/7293e69c1e55ca62e15d0724d22605e61bd58952/experimental/packages/opentelemetry-instrumentation-http/src/http.ts#L756-L789
 const argsCopy = [...args];

 const options = argsCopy.shift() as URL | http.RequestOptions | string;

 const extraOptions =
 typeof argsCopy[0] === 'object' && (typeof options === 'string' || options instanceof URL)
 ? (argsCopy.shift() as http.RequestOptions)
 : undefined;

 const { optionsParsed } = getRequestInfo(options, extraOptions);

 const request = original.apply(this, args) as ReturnType<typeof http.request>;

 request.prependListener('response', (response: http.IncomingMessage) => {
 const breadcrumbs = instrumentation.getConfig().breadcrumbs;
 const _breadcrumbs = typeof breadcrumbs === 'undefined' ? true : breadcrumbs;
 if (_breadcrumbs) {
 const _breadcrumbs = instrumentation.getConfig().breadcrumbs;
 const breadCrumbsEnabled = typeof _breadcrumbs === 'undefined' ? true : _breadcrumbs;

 const _ignoreOutgoingRequests = instrumentation.getConfig().ignoreOutgoingRequests;
 const shouldCreateBreadcrumb =
 typeof _ignoreOutgoingRequests === 'function'
 ? !_ignoreOutgoingRequests(getRequestUrl(request), optionsParsed)
 : true;

 if (breadCrumbsEnabled && shouldCreateBreadcrumb) {
 addRequestBreadcrumb(request, response);
 }
 });
Expand Down

21 changes: 12 additions & 9 deletions
packages/node/src/integrations/http/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ const INSTRUMENTATION_NAME = '@opentelemetry_sentry-patched/instrumentation-http

interface HttpOptions {
 /**
 * Whether breadcrumbs should be recorded for requests.
 * Whether breadcrumbs should be recorded for outgoing requests.
 * Defaults to true
 */
 breadcrumbs?: boolean;
Expand All@@ -45,8 +45,8 @@ interface HttpOptions {
 ignoreOutgoingRequests?: (url: string, request: RequestOptions) => boolean;

 /**
 * Do not capture spans or breadcrumbs for incoming HTTP requests to URLs where the given callback returns `true`.
 * This controls both span & breadcrumb creation - spans will be non recording if tracing is disabled.
 * Do not capture spans for incoming HTTP requests to URLs where the given callback returns `true`.
 * Spans will be non recording if tracing is disabled.

Comment on lines

+48
 to 
+49

@Lms24Lms24Oct 14, 2024•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I also adjusted the JSDoc of ignoreIncomingRequests because it wrongfully claimed that incoming requests also generate breadcrumbs. Which isn't the case now and wasn't the case before: 
sentry-javascript/packages/node/src/integrations/http.ts

Lines 245 to 248
in
d7749ae
// Only generate breadcrumbs for outgoing requests
if(!_isClientRequest(request)){
return;
}
 *
 * The `urlPath` param consists of the URL path and query string (if any) of the incoming request.
 * For example: `'/users/details?id=123'`
Expand DownExpand Up@@ -82,12 +82,15 @@ interface HttpOptions {
 };
}

export const instrumentSentryHttp = generateInstrumentOnce<{ breadcrumbs?: boolean }>(
 `${INTEGRATION_NAME}.sentry`,
 options => {
 return new SentryHttpInstrumentation({ breadcrumbs: options?.breadcrumbs });
 },
);
export const instrumentSentryHttp = generateInstrumentOnce<{
 breadcrumbs?: HttpOptions['breadcrumbs'];
 ignoreOutgoingRequests?: HttpOptions['ignoreOutgoingRequests'];
}>(`${INTEGRATION_NAME}.sentry`, options => {
 return new SentryHttpInstrumentation({
 breadcrumbs: options?.breadcrumbs,
 ignoreOutgoingRequests: options?.ignoreOutgoingRequests,
 });
});

export const instrumentOtelHttp = generateInstrumentOnce<HttpInstrumentationConfig>(INTEGRATION_NAME, config => {
 const instrumentation = new HttpInstrumentation(config);
Expand Down

, '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
fix(node): Ensure ignoreOutgoingRequests of httpIntegration applies to breadcrumbs#13970

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

Lms24
merged 2 commits into

from

Oct 16, 2024
 Merged


fix(node): Ensure ignoreOutgoingRequests of httpIntegration applies to breadcrumbs
#13970
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1138c54

fix(node): Ensure `ignoreOutgoingRequests` applies to breadcrumbs


Lms24 Oct 14, 2024
032ff91

cleanup


Lms24 Oct 14, 2024

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


50 changes: 30 additions & 20 deletions
...es/node-integration-tests/suites/tracing/httpIntegration/server-ignoreOutgoingRequests.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,11 @@ Sentry.init({
 integrations: [
 Sentry.httpIntegration({
 ignoreOutgoingRequests: (url, request) => {
 if (url.includes('example.com')) {
 if (url === 'http://example.com/blockUrl') {
 return true;
 }
 if (request.method === 'POST' && request.path === '/path') {

 if (request.hostname === 'example.com' && request.path === '/blockRequest') {
 return true;
 }
 return false;
Expand All@@ -32,28 +33,37 @@ const app = express();

app.use(cors());

app.get('/test', (_req, response) => {
 http
 .request('http://example.com/', res => {
 res.on('data', () => {});
 res.on('end', () => {
 response.send({ response: 'done' });
 });
 })
 .end();
app.get('/testUrl', (_req, response) => {
 makeHttpRequest('http://example.com/blockUrl').then(() => {
 makeHttpRequest('http://example.com/pass').then(() => {
 response.send({ response: 'done' });
 });
 });
});

app.post('/testPath', (_req, response) => {
 http
 .request('http://example.com/path', res => {
 res.on('data', () => {});
 res.on('end', () => {
 response.send({ response: 'done' });
 });
 })
 .end();
app.get('/testRequest', (_req, response) => {
 makeHttpRequest('http://example.com/blockRequest').then(() => {
 makeHttpRequest('http://example.com/pass').then(() => {
 response.send({ response: 'done' });
 });
 });
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);

function makeHttpRequest(url) {
 return new Promise((resolve, reject) => {
 http
 .get(url, res => {
 res.on('data', () => {});
 res.on('end', () => {
 resolve();
 });
 })
 .on('error', error => {
 reject(error);
 });
 });
}

66 changes: 23 additions & 43 deletions
dev-packages/node-integration-tests/suites/tracing/httpIntegration/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,65 +128,45 @@ describe('httpIntegration', () => {
 });
 });

 describe("doesn't create child spans for outgoing requests ignored via `ignoreOutgoingRequests`", () => {
 describe("doesn't create child spans or breadcrumbs for outgoing requests ignored via `ignoreOutgoingRequests`", () => {
 test('via the url param', done => {
 const runner = createRunner(__dirname, 'server-ignoreOutgoingRequests.js')
 .expect({
 transaction: {
 contexts: {
 trace: {
 span_id: expect.any(String),
 trace_id: expect.any(String),
 data: {
 url: expect.stringMatching(/\/test$/),
 'http.response.status_code': 200,
 },
 op: 'http.server',
 status: 'ok',
 },
 },
 transaction: 'GET /test',
 spans: [
 expect.objectContaining({ op: 'middleware.express', description: 'query' }),
 expect.objectContaining({ op: 'middleware.express', description: 'expressInit' }),
 expect.objectContaining({ op: 'middleware.express', description: 'corsMiddleware' }),
 expect.objectContaining({ op: 'request_handler.express', description: '/test' }),
 ],
 transaction: event => {
 expect(event.transaction).toBe('GET /testUrl');

 const requestSpans = event.spans?.filter(span => span.op === 'http.client');
 expect(requestSpans).toHaveLength(1);
 expect(requestSpans![0]?.description).toBe('GET http://example.com/pass');

 const breadcrumbs = event.breadcrumbs?.filter(b => b.category === 'http');
 expect(breadcrumbs).toHaveLength(1);
 expect(breadcrumbs![0]?.data?.url).toEqual('http://example.com/pass');
 },
 })
 .start(done);

 runner.makeRequest('get', '/test');
 runner.makeRequest('get', '/testUrl');
 });

 test('via the request param', done => {
 const runner = createRunner(__dirname, 'server-ignoreOutgoingRequests.js')
 .expect({
 transaction: {
 contexts: {
 trace: {
 span_id: expect.any(String),
 trace_id: expect.any(String),
 data: {
 url: expect.stringMatching(/\/testPath$/),
 'http.response.status_code': 200,
 },
 op: 'http.server',
 status: 'ok',
 },
 },
 transaction: 'POST /testPath',
 spans: [
 expect.objectContaining({ op: 'middleware.express', description: 'query' }),
 expect.objectContaining({ op: 'middleware.express', description: 'expressInit' }),
 expect.objectContaining({ op: 'middleware.express', description: 'corsMiddleware' }),
 expect.objectContaining({ op: 'request_handler.express', description: '/testPath' }),
 ],
 transaction: event => {
 expect(event.transaction).toBe('GET /testRequest');

 const requestSpans = event.spans?.filter(span => span.op === 'http.client');
 expect(requestSpans).toHaveLength(1);
 expect(requestSpans![0]?.description).toBe('GET http://example.com/pass');

 const breadcrumbs = event.breadcrumbs?.filter(b => b.category === 'http');
 expect(breadcrumbs).toHaveLength(1);
 expect(breadcrumbs![0]?.data?.url).toEqual('http://example.com/pass');
 },
 })
 .start(done);

 runner.makeRequest('post', '/testPath');
 runner.makeRequest('get', '/testRequest');
 });
 });
});

49 changes: 45 additions & 4 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
import type * as http from 'node:http';
import type { RequestOptions } from 'node:http';
import type * as https from 'node:https';
import { VERSION } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import { getRequestInfo } from '@opentelemetry/instrumentation-http';
import { addBreadcrumb, getClient, getIsolationScope, withIsolationScope } from '@sentry/core';
import type { SanitizedRequestData } from '@sentry/types';
import {
Expand All@@ -12,12 +14,29 @@ import {
 stripUrlQueryAndFragment,
} from '@sentry/utils';
import type { NodeClient } from '../../sdk/client';
import { getRequestUrl } from '../../utils/getRequestUrl';

type Http = typeof http;
type Https = typeof https;

type SentryHttpInstrumentationOptions = InstrumentationConfig & {
 /**
 * Whether breadcrumbs should be recorded for requests.
 *
 * @default `true`
 */
 breadcrumbs?: boolean;

 /**
 * Do not capture breadcrumbs for outgoing HTTP requests to URLs where the given callback returns `true`.
 * For the scope of this instrumentation, this callback only controls breadcrumb creation.
 * The same option can be passed to the top-level httpIntegration where it controls both, breadcrumb and
 * span creation.
 *
 * @param url Contains the entire URL, including query string (if any), protocol, host, etc. of the outgoing request.
 * @param request Contains the {@type RequestOptions} object used to make the outgoing request.
 */
 ignoreOutgoingRequests?: (url: string, request: RequestOptions) => boolean;
};

/**
Expand DownExpand Up@@ -140,20 +159,42 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 private _getPatchOutgoingRequestFunction(): (
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 original: (...args: any[]) => http.ClientRequest,
 ) => (...args: unknown[]) => http.ClientRequest {
 ) => (options: URL | http.RequestOptions | string, ...args: unknown[]) => http.ClientRequest {
 // eslint-disable-next-line @typescript-eslint/no-this-alias
 const instrumentation = this;

 return (original: (...args: unknown[]) => http.ClientRequest): ((...args: unknown[]) => http.ClientRequest) => {
 return function outgoingRequest(this: unknown, ...args: unknown[]): http.ClientRequest {
 instrumentation._diag.debug('http instrumentation for outgoing requests');

 // Making a copy to avoid mutating the original args array
 // We need to access and reconstruct the request options object passed to `ignoreOutgoingRequests`
 // so that it matches what Otel instrumentation passes to `ignoreOutgoingRequestHook`.
 // @see https://github.com/open-telemetry/opentelemetry-js/blob/7293e69c1e55ca62e15d0724d22605e61bd58952/experimental/packages/opentelemetry-instrumentation-http/src/http.ts#L756-L789
 const argsCopy = [...args];

 const options = argsCopy.shift() as URL | http.RequestOptions | string;

 const extraOptions =
 typeof argsCopy[0] === 'object' && (typeof options === 'string' || options instanceof URL)
 ? (argsCopy.shift() as http.RequestOptions)
 : undefined;

 const { optionsParsed } = getRequestInfo(options, extraOptions);

 const request = original.apply(this, args) as ReturnType<typeof http.request>;

 request.prependListener('response', (response: http.IncomingMessage) => {
 const breadcrumbs = instrumentation.getConfig().breadcrumbs;
 const _breadcrumbs = typeof breadcrumbs === 'undefined' ? true : breadcrumbs;
 if (_breadcrumbs) {
 const _breadcrumbs = instrumentation.getConfig().breadcrumbs;
 const breadCrumbsEnabled = typeof _breadcrumbs === 'undefined' ? true : _breadcrumbs;

 const _ignoreOutgoingRequests = instrumentation.getConfig().ignoreOutgoingRequests;
 const shouldCreateBreadcrumb =
 typeof _ignoreOutgoingRequests === 'function'
 ? !_ignoreOutgoingRequests(getRequestUrl(request), optionsParsed)
 : true;

 if (breadCrumbsEnabled && shouldCreateBreadcrumb) {
 addRequestBreadcrumb(request, response);
 }
 });
Expand Down

21 changes: 12 additions & 9 deletions
packages/node/src/integrations/http/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ const INSTRUMENTATION_NAME = '@opentelemetry_sentry-patched/instrumentation-http

interface HttpOptions {
 /**
 * Whether breadcrumbs should be recorded for requests.
 * Whether breadcrumbs should be recorded for outgoing requests.
 * Defaults to true
 */
 breadcrumbs?: boolean;
Expand All@@ -45,8 +45,8 @@ interface HttpOptions {
 ignoreOutgoingRequests?: (url: string, request: RequestOptions) => boolean;

 /**
 * Do not capture spans or breadcrumbs for incoming HTTP requests to URLs where the given callback returns `true`.
 * This controls both span & breadcrumb creation - spans will be non recording if tracing is disabled.
 * Do not capture spans for incoming HTTP requests to URLs where the given callback returns `true`.
 * Spans will be non recording if tracing is disabled.

Comment on lines

+48
 to 
+49

@Lms24Lms24Oct 14, 2024•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I also adjusted the JSDoc of ignoreIncomingRequests because it wrongfully claimed that incoming requests also generate breadcrumbs. Which isn't the case now and wasn't the case before: 
sentry-javascript/packages/node/src/integrations/http.ts

Lines 245 to 248
in
d7749ae
// Only generate breadcrumbs for outgoing requests
if(!_isClientRequest(request)){
return;
}
 *
 * The `urlPath` param consists of the URL path and query string (if any) of the incoming request.
 * For example: `'/users/details?id=123'`
Expand DownExpand Up@@ -82,12 +82,15 @@ interface HttpOptions {
 };
}

export const instrumentSentryHttp = generateInstrumentOnce<{ breadcrumbs?: boolean }>(
 `${INTEGRATION_NAME}.sentry`,
 options => {
 return new SentryHttpInstrumentation({ breadcrumbs: options?.breadcrumbs });
 },
);
export const instrumentSentryHttp = generateInstrumentOnce<{
 breadcrumbs?: HttpOptions['breadcrumbs'];
 ignoreOutgoingRequests?: HttpOptions['ignoreOutgoingRequests'];
}>(`${INTEGRATION_NAME}.sentry`, options => {
 return new SentryHttpInstrumentation({
 breadcrumbs: options?.breadcrumbs,
 ignoreOutgoingRequests: options?.ignoreOutgoingRequests,
 });
});

export const instrumentOtelHttp = generateInstrumentOnce<HttpInstrumentationConfig>(INTEGRATION_NAME, config => {
 const instrumentation = new HttpInstrumentation(config);
Expand Down

, '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
fix(node): Ensure ignoreOutgoingRequests of httpIntegration applies to breadcrumbs#13970

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

Lms24
merged 2 commits into

from

Oct 16, 2024
 Merged


fix(node): Ensure ignoreOutgoingRequests of httpIntegration applies to breadcrumbs
#13970
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1138c54

fix(node): Ensure `ignoreOutgoingRequests` applies to breadcrumbs


Lms24 Oct 14, 2024
032ff91

cleanup


Lms24 Oct 14, 2024

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


50 changes: 30 additions & 20 deletions
...es/node-integration-tests/suites/tracing/httpIntegration/server-ignoreOutgoingRequests.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,11 @@ Sentry.init({
 integrations: [
 Sentry.httpIntegration({
 ignoreOutgoingRequests: (url, request) => {
 if (url.includes('example.com')) {
 if (url === 'http://example.com/blockUrl') {
 return true;
 }
 if (request.method === 'POST' && request.path === '/path') {

 if (request.hostname === 'example.com' && request.path === '/blockRequest') {
 return true;
 }
 return false;
Expand All@@ -32,28 +33,37 @@ const app = express();

app.use(cors());

app.get('/test', (_req, response) => {
 http
 .request('http://example.com/', res => {
 res.on('data', () => {});
 res.on('end', () => {
 response.send({ response: 'done' });
 });
 })
 .end();
app.get('/testUrl', (_req, response) => {
 makeHttpRequest('http://example.com/blockUrl').then(() => {
 makeHttpRequest('http://example.com/pass').then(() => {
 response.send({ response: 'done' });
 });
 });
});

app.post('/testPath', (_req, response) => {
 http
 .request('http://example.com/path', res => {
 res.on('data', () => {});
 res.on('end', () => {
 response.send({ response: 'done' });
 });
 })
 .end();
app.get('/testRequest', (_req, response) => {
 makeHttpRequest('http://example.com/blockRequest').then(() => {
 makeHttpRequest('http://example.com/pass').then(() => {
 response.send({ response: 'done' });
 });
 });
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);

function makeHttpRequest(url) {
 return new Promise((resolve, reject) => {
 http
 .get(url, res => {
 res.on('data', () => {});
 res.on('end', () => {
 resolve();
 });
 })
 .on('error', error => {
 reject(error);
 });
 });
}

66 changes: 23 additions & 43 deletions
dev-packages/node-integration-tests/suites/tracing/httpIntegration/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,65 +128,45 @@ describe('httpIntegration', () => {
 });
 });

 describe("doesn't create child spans for outgoing requests ignored via `ignoreOutgoingRequests`", () => {
 describe("doesn't create child spans or breadcrumbs for outgoing requests ignored via `ignoreOutgoingRequests`", () => {
 test('via the url param', done => {
 const runner = createRunner(__dirname, 'server-ignoreOutgoingRequests.js')
 .expect({
 transaction: {
 contexts: {
 trace: {
 span_id: expect.any(String),
 trace_id: expect.any(String),
 data: {
 url: expect.stringMatching(/\/test$/),
 'http.response.status_code': 200,
 },
 op: 'http.server',
 status: 'ok',
 },
 },
 transaction: 'GET /test',
 spans: [
 expect.objectContaining({ op: 'middleware.express', description: 'query' }),
 expect.objectContaining({ op: 'middleware.express', description: 'expressInit' }),
 expect.objectContaining({ op: 'middleware.express', description: 'corsMiddleware' }),
 expect.objectContaining({ op: 'request_handler.express', description: '/test' }),
 ],
 transaction: event => {
 expect(event.transaction).toBe('GET /testUrl');

 const requestSpans = event.spans?.filter(span => span.op === 'http.client');
 expect(requestSpans).toHaveLength(1);
 expect(requestSpans![0]?.description).toBe('GET http://example.com/pass');

 const breadcrumbs = event.breadcrumbs?.filter(b => b.category === 'http');
 expect(breadcrumbs).toHaveLength(1);
 expect(breadcrumbs![0]?.data?.url).toEqual('http://example.com/pass');
 },
 })
 .start(done);

 runner.makeRequest('get', '/test');
 runner.makeRequest('get', '/testUrl');
 });

 test('via the request param', done => {
 const runner = createRunner(__dirname, 'server-ignoreOutgoingRequests.js')
 .expect({
 transaction: {
 contexts: {
 trace: {
 span_id: expect.any(String),
 trace_id: expect.any(String),
 data: {
 url: expect.stringMatching(/\/testPath$/),
 'http.response.status_code': 200,
 },
 op: 'http.server',
 status: 'ok',
 },
 },
 transaction: 'POST /testPath',
 spans: [
 expect.objectContaining({ op: 'middleware.express', description: 'query' }),
 expect.objectContaining({ op: 'middleware.express', description: 'expressInit' }),
 expect.objectContaining({ op: 'middleware.express', description: 'corsMiddleware' }),
 expect.objectContaining({ op: 'request_handler.express', description: '/testPath' }),
 ],
 transaction: event => {
 expect(event.transaction).toBe('GET /testRequest');

 const requestSpans = event.spans?.filter(span => span.op === 'http.client');
 expect(requestSpans).toHaveLength(1);
 expect(requestSpans![0]?.description).toBe('GET http://example.com/pass');

 const breadcrumbs = event.breadcrumbs?.filter(b => b.category === 'http');
 expect(breadcrumbs).toHaveLength(1);
 expect(breadcrumbs![0]?.data?.url).toEqual('http://example.com/pass');
 },
 })
 .start(done);

 runner.makeRequest('post', '/testPath');
 runner.makeRequest('get', '/testRequest');
 });
 });
});

49 changes: 45 additions & 4 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
import type * as http from 'node:http';
import type { RequestOptions } from 'node:http';
import type * as https from 'node:https';
import { VERSION } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import { getRequestInfo } from '@opentelemetry/instrumentation-http';
import { addBreadcrumb, getClient, getIsolationScope, withIsolationScope } from '@sentry/core';
import type { SanitizedRequestData } from '@sentry/types';
import {
Expand All@@ -12,12 +14,29 @@ import {
 stripUrlQueryAndFragment,
} from '@sentry/utils';
import type { NodeClient } from '../../sdk/client';
import { getRequestUrl } from '../../utils/getRequestUrl';

type Http = typeof http;
type Https = typeof https;

type SentryHttpInstrumentationOptions = InstrumentationConfig & {
 /**
 * Whether breadcrumbs should be recorded for requests.
 *
 * @default `true`
 */
 breadcrumbs?: boolean;

 /**
 * Do not capture breadcrumbs for outgoing HTTP requests to URLs where the given callback returns `true`.
 * For the scope of this instrumentation, this callback only controls breadcrumb creation.
 * The same option can be passed to the top-level httpIntegration where it controls both, breadcrumb and
 * span creation.
 *
 * @param url Contains the entire URL, including query string (if any), protocol, host, etc. of the outgoing request.
 * @param request Contains the {@type RequestOptions} object used to make the outgoing request.
 */
 ignoreOutgoingRequests?: (url: string, request: RequestOptions) => boolean;
};

/**
Expand DownExpand Up@@ -140,20 +159,42 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 private _getPatchOutgoingRequestFunction(): (
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 original: (...args: any[]) => http.ClientRequest,
 ) => (...args: unknown[]) => http.ClientRequest {
 ) => (options: URL | http.RequestOptions | string, ...args: unknown[]) => http.ClientRequest {
 // eslint-disable-next-line @typescript-eslint/no-this-alias
 const instrumentation = this;

 return (original: (...args: unknown[]) => http.ClientRequest): ((...args: unknown[]) => http.ClientRequest) => {
 return function outgoingRequest(this: unknown, ...args: unknown[]): http.ClientRequest {
 instrumentation._diag.debug('http instrumentation for outgoing requests');

 // Making a copy to avoid mutating the original args array
 // We need to access and reconstruct the request options object passed to `ignoreOutgoingRequests`
 // so that it matches what Otel instrumentation passes to `ignoreOutgoingRequestHook`.
 // @see https://github.com/open-telemetry/opentelemetry-js/blob/7293e69c1e55ca62e15d0724d22605e61bd58952/experimental/packages/opentelemetry-instrumentation-http/src/http.ts#L756-L789
 const argsCopy = [...args];

 const options = argsCopy.shift() as URL | http.RequestOptions | string;

 const extraOptions =
 typeof argsCopy[0] === 'object' && (typeof options === 'string' || options instanceof URL)
 ? (argsCopy.shift() as http.RequestOptions)
 : undefined;

 const { optionsParsed } = getRequestInfo(options, extraOptions);

 const request = original.apply(this, args) as ReturnType<typeof http.request>;

 request.prependListener('response', (response: http.IncomingMessage) => {
 const breadcrumbs = instrumentation.getConfig().breadcrumbs;
 const _breadcrumbs = typeof breadcrumbs === 'undefined' ? true : breadcrumbs;
 if (_breadcrumbs) {
 const _breadcrumbs = instrumentation.getConfig().breadcrumbs;
 const breadCrumbsEnabled = typeof _breadcrumbs === 'undefined' ? true : _breadcrumbs;

 const _ignoreOutgoingRequests = instrumentation.getConfig().ignoreOutgoingRequests;
 const shouldCreateBreadcrumb =
 typeof _ignoreOutgoingRequests === 'function'
 ? !_ignoreOutgoingRequests(getRequestUrl(request), optionsParsed)
 : true;

 if (breadCrumbsEnabled && shouldCreateBreadcrumb) {
 addRequestBreadcrumb(request, response);
 }
 });
Expand Down

21 changes: 12 additions & 9 deletions
packages/node/src/integrations/http/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ const INSTRUMENTATION_NAME = '@opentelemetry_sentry-patched/instrumentation-http

interface HttpOptions {
 /**
 * Whether breadcrumbs should be recorded for requests.
 * Whether breadcrumbs should be recorded for outgoing requests.
 * Defaults to true
 */
 breadcrumbs?: boolean;
Expand All@@ -45,8 +45,8 @@ interface HttpOptions {
 ignoreOutgoingRequests?: (url: string, request: RequestOptions) => boolean;

 /**
 * Do not capture spans or breadcrumbs for incoming HTTP requests to URLs where the given callback returns `true`.
 * This controls both span & breadcrumb creation - spans will be non recording if tracing is disabled.
 * Do not capture spans for incoming HTTP requests to URLs where the given callback returns `true`.
 * Spans will be non recording if tracing is disabled.

Comment on lines

+48
 to 
+49

@Lms24Lms24Oct 14, 2024•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I also adjusted the JSDoc of ignoreIncomingRequests because it wrongfully claimed that incoming requests also generate breadcrumbs. Which isn't the case now and wasn't the case before: 
sentry-javascript/packages/node/src/integrations/http.ts

Lines 245 to 248
in
d7749ae
// Only generate breadcrumbs for outgoing requests
if(!_isClientRequest(request)){
return;
}
 *
 * The `urlPath` param consists of the URL path and query string (if any) of the incoming request.
 * For example: `'/users/details?id=123'`
Expand DownExpand Up@@ -82,12 +82,15 @@ interface HttpOptions {
 };
}

export const instrumentSentryHttp = generateInstrumentOnce<{ breadcrumbs?: boolean }>(
 `${INTEGRATION_NAME}.sentry`,
 options => {
 return new SentryHttpInstrumentation({ breadcrumbs: options?.breadcrumbs });
 },
);
export const instrumentSentryHttp = generateInstrumentOnce<{
 breadcrumbs?: HttpOptions['breadcrumbs'];
 ignoreOutgoingRequests?: HttpOptions['ignoreOutgoingRequests'];
}>(`${INTEGRATION_NAME}.sentry`, options => {
 return new SentryHttpInstrumentation({
 breadcrumbs: options?.breadcrumbs,
 ignoreOutgoingRequests: options?.ignoreOutgoingRequests,
 });
});

export const instrumentOtelHttp = generateInstrumentOnce<HttpInstrumentationConfig>(INTEGRATION_NAME, config => {
 const instrumentation = new HttpInstrumentation(config);
Expand Down

, '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
fix(node): Ensure ignoreOutgoingRequests of httpIntegration applies to breadcrumbs#13970

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

Lms24
merged 2 commits into

from

Oct 16, 2024
 Merged


fix(node): Ensure ignoreOutgoingRequests of httpIntegration applies to breadcrumbs
#13970
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1138c54

fix(node): Ensure `ignoreOutgoingRequests` applies to breadcrumbs


Lms24 Oct 14, 2024
032ff91

cleanup


Lms24 Oct 14, 2024

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


50 changes: 30 additions & 20 deletions
...es/node-integration-tests/suites/tracing/httpIntegration/server-ignoreOutgoingRequests.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,11 @@ Sentry.init({
 integrations: [
 Sentry.httpIntegration({
 ignoreOutgoingRequests: (url, request) => {
 if (url.includes('example.com')) {
 if (url === 'http://example.com/blockUrl') {
 return true;
 }
 if (request.method === 'POST' && request.path === '/path') {

 if (request.hostname === 'example.com' && request.path === '/blockRequest') {
 return true;
 }
 return false;
Expand All@@ -32,28 +33,37 @@ const app = express();

app.use(cors());

app.get('/test', (_req, response) => {
 http
 .request('http://example.com/', res => {
 res.on('data', () => {});
 res.on('end', () => {
 response.send({ response: 'done' });
 });
 })
 .end();
app.get('/testUrl', (_req, response) => {
 makeHttpRequest('http://example.com/blockUrl').then(() => {
 makeHttpRequest('http://example.com/pass').then(() => {
 response.send({ response: 'done' });
 });
 });
});

app.post('/testPath', (_req, response) => {
 http
 .request('http://example.com/path', res => {
 res.on('data', () => {});
 res.on('end', () => {
 response.send({ response: 'done' });
 });
 })
 .end();
app.get('/testRequest', (_req, response) => {
 makeHttpRequest('http://example.com/blockRequest').then(() => {
 makeHttpRequest('http://example.com/pass').then(() => {
 response.send({ response: 'done' });
 });
 });
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);

function makeHttpRequest(url) {
 return new Promise((resolve, reject) => {
 http
 .get(url, res => {
 res.on('data', () => {});
 res.on('end', () => {
 resolve();
 });
 })
 .on('error', error => {
 reject(error);
 });
 });
}

66 changes: 23 additions & 43 deletions
dev-packages/node-integration-tests/suites/tracing/httpIntegration/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,65 +128,45 @@ describe('httpIntegration', () => {
 });
 });

 describe("doesn't create child spans for outgoing requests ignored via `ignoreOutgoingRequests`", () => {
 describe("doesn't create child spans or breadcrumbs for outgoing requests ignored via `ignoreOutgoingRequests`", () => {
 test('via the url param', done => {
 const runner = createRunner(__dirname, 'server-ignoreOutgoingRequests.js')
 .expect({
 transaction: {
 contexts: {
 trace: {
 span_id: expect.any(String),
 trace_id: expect.any(String),
 data: {
 url: expect.stringMatching(/\/test$/),
 'http.response.status_code': 200,
 },
 op: 'http.server',
 status: 'ok',
 },
 },
 transaction: 'GET /test',
 spans: [
 expect.objectContaining({ op: 'middleware.express', description: 'query' }),
 expect.objectContaining({ op: 'middleware.express', description: 'expressInit' }),
 expect.objectContaining({ op: 'middleware.express', description: 'corsMiddleware' }),
 expect.objectContaining({ op: 'request_handler.express', description: '/test' }),
 ],
 transaction: event => {
 expect(event.transaction).toBe('GET /testUrl');

 const requestSpans = event.spans?.filter(span => span.op === 'http.client');
 expect(requestSpans).toHaveLength(1);
 expect(requestSpans![0]?.description).toBe('GET http://example.com/pass');

 const breadcrumbs = event.breadcrumbs?.filter(b => b.category === 'http');
 expect(breadcrumbs).toHaveLength(1);
 expect(breadcrumbs![0]?.data?.url).toEqual('http://example.com/pass');
 },
 })
 .start(done);

 runner.makeRequest('get', '/test');
 runner.makeRequest('get', '/testUrl');
 });

 test('via the request param', done => {
 const runner = createRunner(__dirname, 'server-ignoreOutgoingRequests.js')
 .expect({
 transaction: {
 contexts: {
 trace: {
 span_id: expect.any(String),
 trace_id: expect.any(String),
 data: {
 url: expect.stringMatching(/\/testPath$/),
 'http.response.status_code': 200,
 },
 op: 'http.server',
 status: 'ok',
 },
 },
 transaction: 'POST /testPath',
 spans: [
 expect.objectContaining({ op: 'middleware.express', description: 'query' }),
 expect.objectContaining({ op: 'middleware.express', description: 'expressInit' }),
 expect.objectContaining({ op: 'middleware.express', description: 'corsMiddleware' }),
 expect.objectContaining({ op: 'request_handler.express', description: '/testPath' }),
 ],
 transaction: event => {
 expect(event.transaction).toBe('GET /testRequest');

 const requestSpans = event.spans?.filter(span => span.op === 'http.client');
 expect(requestSpans).toHaveLength(1);
 expect(requestSpans![0]?.description).toBe('GET http://example.com/pass');

 const breadcrumbs = event.breadcrumbs?.filter(b => b.category === 'http');
 expect(breadcrumbs).toHaveLength(1);
 expect(breadcrumbs![0]?.data?.url).toEqual('http://example.com/pass');
 },
 })
 .start(done);

 runner.makeRequest('post', '/testPath');
 runner.makeRequest('get', '/testRequest');
 });
 });
});

49 changes: 45 additions & 4 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
import type * as http from 'node:http';
import type { RequestOptions } from 'node:http';
import type * as https from 'node:https';
import { VERSION } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import { getRequestInfo } from '@opentelemetry/instrumentation-http';
import { addBreadcrumb, getClient, getIsolationScope, withIsolationScope } from '@sentry/core';
import type { SanitizedRequestData } from '@sentry/types';
import {
Expand All@@ -12,12 +14,29 @@ import {
 stripUrlQueryAndFragment,
} from '@sentry/utils';
import type { NodeClient } from '../../sdk/client';
import { getRequestUrl } from '../../utils/getRequestUrl';

type Http = typeof http;
type Https = typeof https;

type SentryHttpInstrumentationOptions = InstrumentationConfig & {
 /**
 * Whether breadcrumbs should be recorded for requests.
 *
 * @default `true`
 */
 breadcrumbs?: boolean;

 /**
 * Do not capture breadcrumbs for outgoing HTTP requests to URLs where the given callback returns `true`.
 * For the scope of this instrumentation, this callback only controls breadcrumb creation.
 * The same option can be passed to the top-level httpIntegration where it controls both, breadcrumb and
 * span creation.
 *
 * @param url Contains the entire URL, including query string (if any), protocol, host, etc. of the outgoing request.
 * @param request Contains the {@type RequestOptions} object used to make the outgoing request.
 */
 ignoreOutgoingRequests?: (url: string, request: RequestOptions) => boolean;
};

/**
Expand DownExpand Up@@ -140,20 +159,42 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 private _getPatchOutgoingRequestFunction(): (
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 original: (...args: any[]) => http.ClientRequest,
 ) => (...args: unknown[]) => http.ClientRequest {
 ) => (options: URL | http.RequestOptions | string, ...args: unknown[]) => http.ClientRequest {
 // eslint-disable-next-line @typescript-eslint/no-this-alias
 const instrumentation = this;

 return (original: (...args: unknown[]) => http.ClientRequest): ((...args: unknown[]) => http.ClientRequest) => {
 return function outgoingRequest(this: unknown, ...args: unknown[]): http.ClientRequest {
 instrumentation._diag.debug('http instrumentation for outgoing requests');

 // Making a copy to avoid mutating the original args array
 // We need to access and reconstruct the request options object passed to `ignoreOutgoingRequests`
 // so that it matches what Otel instrumentation passes to `ignoreOutgoingRequestHook`.
 // @see https://github.com/open-telemetry/opentelemetry-js/blob/7293e69c1e55ca62e15d0724d22605e61bd58952/experimental/packages/opentelemetry-instrumentation-http/src/http.ts#L756-L789
 const argsCopy = [...args];

 const options = argsCopy.shift() as URL | http.RequestOptions | string;

 const extraOptions =
 typeof argsCopy[0] === 'object' && (typeof options === 'string' || options instanceof URL)
 ? (argsCopy.shift() as http.RequestOptions)
 : undefined;

 const { optionsParsed } = getRequestInfo(options, extraOptions);

 const request = original.apply(this, args) as ReturnType<typeof http.request>;

 request.prependListener('response', (response: http.IncomingMessage) => {
 const breadcrumbs = instrumentation.getConfig().breadcrumbs;
 const _breadcrumbs = typeof breadcrumbs === 'undefined' ? true : breadcrumbs;
 if (_breadcrumbs) {
 const _breadcrumbs = instrumentation.getConfig().breadcrumbs;
 const breadCrumbsEnabled = typeof _breadcrumbs === 'undefined' ? true : _breadcrumbs;

 const _ignoreOutgoingRequests = instrumentation.getConfig().ignoreOutgoingRequests;
 const shouldCreateBreadcrumb =
 typeof _ignoreOutgoingRequests === 'function'
 ? !_ignoreOutgoingRequests(getRequestUrl(request), optionsParsed)
 : true;

 if (breadCrumbsEnabled && shouldCreateBreadcrumb) {
 addRequestBreadcrumb(request, response);
 }
 });
Expand Down

21 changes: 12 additions & 9 deletions
packages/node/src/integrations/http/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ const INSTRUMENTATION_NAME = '@opentelemetry_sentry-patched/instrumentation-http

interface HttpOptions {
 /**
 * Whether breadcrumbs should be recorded for requests.
 * Whether breadcrumbs should be recorded for outgoing requests.
 * Defaults to true
 */
 breadcrumbs?: boolean;
Expand All@@ -45,8 +45,8 @@ interface HttpOptions {
 ignoreOutgoingRequests?: (url: string, request: RequestOptions) => boolean;

 /**
 * Do not capture spans or breadcrumbs for incoming HTTP requests to URLs where the given callback returns `true`.
 * This controls both span & breadcrumb creation - spans will be non recording if tracing is disabled.
 * Do not capture spans for incoming HTTP requests to URLs where the given callback returns `true`.
 * Spans will be non recording if tracing is disabled.

Comment on lines

+48
 to 
+49

@Lms24Lms24Oct 14, 2024•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I also adjusted the JSDoc of ignoreIncomingRequests because it wrongfully claimed that incoming requests also generate breadcrumbs. Which isn't the case now and wasn't the case before: 
sentry-javascript/packages/node/src/integrations/http.ts

Lines 245 to 248
in
d7749ae
// Only generate breadcrumbs for outgoing requests
if(!_isClientRequest(request)){
return;
}
 *
 * The `urlPath` param consists of the URL path and query string (if any) of the incoming request.
 * For example: `'/users/details?id=123'`
Expand DownExpand Up@@ -82,12 +82,15 @@ interface HttpOptions {
 };
}

export const instrumentSentryHttp = generateInstrumentOnce<{ breadcrumbs?: boolean }>(
 `${INTEGRATION_NAME}.sentry`,
 options => {
 return new SentryHttpInstrumentation({ breadcrumbs: options?.breadcrumbs });
 },
);
export const instrumentSentryHttp = generateInstrumentOnce<{
 breadcrumbs?: HttpOptions['breadcrumbs'];
 ignoreOutgoingRequests?: HttpOptions['ignoreOutgoingRequests'];
}>(`${INTEGRATION_NAME}.sentry`, options => {
 return new SentryHttpInstrumentation({
 breadcrumbs: options?.breadcrumbs,
 ignoreOutgoingRequests: options?.ignoreOutgoingRequests,
 });
});

export const instrumentOtelHttp = generateInstrumentOnce<HttpInstrumentationConfig>(INTEGRATION_NAME, config => {
 const instrumentation = new HttpInstrumentation(config);
Expand Down

, '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
fix(node): Ensure ignoreOutgoingRequests of httpIntegration applies to breadcrumbs#13970

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

Lms24
merged 2 commits into

from

Oct 16, 2024
 Merged


fix(node): Ensure ignoreOutgoingRequests of httpIntegration applies to breadcrumbs
#13970
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1138c54

fix(node): Ensure `ignoreOutgoingRequests` applies to breadcrumbs


Lms24 Oct 14, 2024
032ff91

cleanup


Lms24 Oct 14, 2024

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


50 changes: 30 additions & 20 deletions
...es/node-integration-tests/suites/tracing/httpIntegration/server-ignoreOutgoingRequests.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,11 @@ Sentry.init({
 integrations: [
 Sentry.httpIntegration({
 ignoreOutgoingRequests: (url, request) => {
 if (url.includes('example.com')) {
 if (url === 'http://example.com/blockUrl') {
 return true;
 }
 if (request.method === 'POST' && request.path === '/path') {

 if (request.hostname === 'example.com' && request.path === '/blockRequest') {
 return true;
 }
 return false;
Expand All@@ -32,28 +33,37 @@ const app = express();

app.use(cors());

app.get('/test', (_req, response) => {
 http
 .request('http://example.com/', res => {
 res.on('data', () => {});
 res.on('end', () => {
 response.send({ response: 'done' });
 });
 })
 .end();
app.get('/testUrl', (_req, response) => {
 makeHttpRequest('http://example.com/blockUrl').then(() => {
 makeHttpRequest('http://example.com/pass').then(() => {
 response.send({ response: 'done' });
 });
 });
});

app.post('/testPath', (_req, response) => {
 http
 .request('http://example.com/path', res => {
 res.on('data', () => {});
 res.on('end', () => {
 response.send({ response: 'done' });
 });
 })
 .end();
app.get('/testRequest', (_req, response) => {
 makeHttpRequest('http://example.com/blockRequest').then(() => {
 makeHttpRequest('http://example.com/pass').then(() => {
 response.send({ response: 'done' });
 });
 });
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);

function makeHttpRequest(url) {
 return new Promise((resolve, reject) => {
 http
 .get(url, res => {
 res.on('data', () => {});
 res.on('end', () => {
 resolve();
 });
 })
 .on('error', error => {
 reject(error);
 });
 });
}

66 changes: 23 additions & 43 deletions
dev-packages/node-integration-tests/suites/tracing/httpIntegration/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,65 +128,45 @@ describe('httpIntegration', () => {
 });
 });

 describe("doesn't create child spans for outgoing requests ignored via `ignoreOutgoingRequests`", () => {
 describe("doesn't create child spans or breadcrumbs for outgoing requests ignored via `ignoreOutgoingRequests`", () => {
 test('via the url param', done => {
 const runner = createRunner(__dirname, 'server-ignoreOutgoingRequests.js')
 .expect({
 transaction: {
 contexts: {
 trace: {
 span_id: expect.any(String),
 trace_id: expect.any(String),
 data: {
 url: expect.stringMatching(/\/test$/),
 'http.response.status_code': 200,
 },
 op: 'http.server',
 status: 'ok',
 },
 },
 transaction: 'GET /test',
 spans: [
 expect.objectContaining({ op: 'middleware.express', description: 'query' }),
 expect.objectContaining({ op: 'middleware.express', description: 'expressInit' }),
 expect.objectContaining({ op: 'middleware.express', description: 'corsMiddleware' }),
 expect.objectContaining({ op: 'request_handler.express', description: '/test' }),
 ],
 transaction: event => {
 expect(event.transaction).toBe('GET /testUrl');

 const requestSpans = event.spans?.filter(span => span.op === 'http.client');
 expect(requestSpans).toHaveLength(1);
 expect(requestSpans![0]?.description).toBe('GET http://example.com/pass');

 const breadcrumbs = event.breadcrumbs?.filter(b => b.category === 'http');
 expect(breadcrumbs).toHaveLength(1);
 expect(breadcrumbs![0]?.data?.url).toEqual('http://example.com/pass');
 },
 })
 .start(done);

 runner.makeRequest('get', '/test');
 runner.makeRequest('get', '/testUrl');
 });

 test('via the request param', done => {
 const runner = createRunner(__dirname, 'server-ignoreOutgoingRequests.js')
 .expect({
 transaction: {
 contexts: {
 trace: {
 span_id: expect.any(String),
 trace_id: expect.any(String),
 data: {
 url: expect.stringMatching(/\/testPath$/),
 'http.response.status_code': 200,
 },
 op: 'http.server',
 status: 'ok',
 },
 },
 transaction: 'POST /testPath',
 spans: [
 expect.objectContaining({ op: 'middleware.express', description: 'query' }),
 expect.objectContaining({ op: 'middleware.express', description: 'expressInit' }),
 expect.objectContaining({ op: 'middleware.express', description: 'corsMiddleware' }),
 expect.objectContaining({ op: 'request_handler.express', description: '/testPath' }),
 ],
 transaction: event => {
 expect(event.transaction).toBe('GET /testRequest');

 const requestSpans = event.spans?.filter(span => span.op === 'http.client');
 expect(requestSpans).toHaveLength(1);
 expect(requestSpans![0]?.description).toBe('GET http://example.com/pass');

 const breadcrumbs = event.breadcrumbs?.filter(b => b.category === 'http');
 expect(breadcrumbs).toHaveLength(1);
 expect(breadcrumbs![0]?.data?.url).toEqual('http://example.com/pass');
 },
 })
 .start(done);

 runner.makeRequest('post', '/testPath');
 runner.makeRequest('get', '/testRequest');
 });
 });
});

49 changes: 45 additions & 4 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
import type * as http from 'node:http';
import type { RequestOptions } from 'node:http';
import type * as https from 'node:https';
import { VERSION } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import { getRequestInfo } from '@opentelemetry/instrumentation-http';
import { addBreadcrumb, getClient, getIsolationScope, withIsolationScope } from '@sentry/core';
import type { SanitizedRequestData } from '@sentry/types';
import {
Expand All@@ -12,12 +14,29 @@ import {
 stripUrlQueryAndFragment,
} from '@sentry/utils';
import type { NodeClient } from '../../sdk/client';
import { getRequestUrl } from '../../utils/getRequestUrl';

type Http = typeof http;
type Https = typeof https;

type SentryHttpInstrumentationOptions = InstrumentationConfig & {
 /**
 * Whether breadcrumbs should be recorded for requests.
 *
 * @default `true`
 */
 breadcrumbs?: boolean;

 /**
 * Do not capture breadcrumbs for outgoing HTTP requests to URLs where the given callback returns `true`.
 * For the scope of this instrumentation, this callback only controls breadcrumb creation.
 * The same option can be passed to the top-level httpIntegration where it controls both, breadcrumb and
 * span creation.
 *
 * @param url Contains the entire URL, including query string (if any), protocol, host, etc. of the outgoing request.
 * @param request Contains the {@type RequestOptions} object used to make the outgoing request.
 */
 ignoreOutgoingRequests?: (url: string, request: RequestOptions) => boolean;
};

/**
Expand DownExpand Up@@ -140,20 +159,42 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 private _getPatchOutgoingRequestFunction(): (
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 original: (...args: any[]) => http.ClientRequest,
 ) => (...args: unknown[]) => http.ClientRequest {
 ) => (options: URL | http.RequestOptions | string, ...args: unknown[]) => http.ClientRequest {
 // eslint-disable-next-line @typescript-eslint/no-this-alias
 const instrumentation = this;

 return (original: (...args: unknown[]) => http.ClientRequest): ((...args: unknown[]) => http.ClientRequest) => {
 return function outgoingRequest(this: unknown, ...args: unknown[]): http.ClientRequest {
 instrumentation._diag.debug('http instrumentation for outgoing requests');

 // Making a copy to avoid mutating the original args array
 // We need to access and reconstruct the request options object passed to `ignoreOutgoingRequests`
 // so that it matches what Otel instrumentation passes to `ignoreOutgoingRequestHook`.
 // @see https://github.com/open-telemetry/opentelemetry-js/blob/7293e69c1e55ca62e15d0724d22605e61bd58952/experimental/packages/opentelemetry-instrumentation-http/src/http.ts#L756-L789
 const argsCopy = [...args];

 const options = argsCopy.shift() as URL | http.RequestOptions | string;

 const extraOptions =
 typeof argsCopy[0] === 'object' && (typeof options === 'string' || options instanceof URL)
 ? (argsCopy.shift() as http.RequestOptions)
 : undefined;

 const { optionsParsed } = getRequestInfo(options, extraOptions);

 const request = original.apply(this, args) as ReturnType<typeof http.request>;

 request.prependListener('response', (response: http.IncomingMessage) => {
 const breadcrumbs = instrumentation.getConfig().breadcrumbs;
 const _breadcrumbs = typeof breadcrumbs === 'undefined' ? true : breadcrumbs;
 if (_breadcrumbs) {
 const _breadcrumbs = instrumentation.getConfig().breadcrumbs;
 const breadCrumbsEnabled = typeof _breadcrumbs === 'undefined' ? true : _breadcrumbs;

 const _ignoreOutgoingRequests = instrumentation.getConfig().ignoreOutgoingRequests;
 const shouldCreateBreadcrumb =
 typeof _ignoreOutgoingRequests === 'function'
 ? !_ignoreOutgoingRequests(getRequestUrl(request), optionsParsed)
 : true;

 if (breadCrumbsEnabled && shouldCreateBreadcrumb) {
 addRequestBreadcrumb(request, response);
 }
 });
Expand Down

21 changes: 12 additions & 9 deletions
packages/node/src/integrations/http/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ const INSTRUMENTATION_NAME = '@opentelemetry_sentry-patched/instrumentation-http

interface HttpOptions {
 /**
 * Whether breadcrumbs should be recorded for requests.
 * Whether breadcrumbs should be recorded for outgoing requests.
 * Defaults to true
 */
 breadcrumbs?: boolean;
Expand All@@ -45,8 +45,8 @@ interface HttpOptions {
 ignoreOutgoingRequests?: (url: string, request: RequestOptions) => boolean;

 /**
 * Do not capture spans or breadcrumbs for incoming HTTP requests to URLs where the given callback returns `true`.
 * This controls both span & breadcrumb creation - spans will be non recording if tracing is disabled.
 * Do not capture spans for incoming HTTP requests to URLs where the given callback returns `true`.
 * Spans will be non recording if tracing is disabled.

Comment on lines

+48
 to 
+49

@Lms24Lms24Oct 14, 2024•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I also adjusted the JSDoc of ignoreIncomingRequests because it wrongfully claimed that incoming requests also generate breadcrumbs. Which isn't the case now and wasn't the case before: 
sentry-javascript/packages/node/src/integrations/http.ts

Lines 245 to 248
in
d7749ae
// Only generate breadcrumbs for outgoing requests
if(!_isClientRequest(request)){
return;
}
 *
 * The `urlPath` param consists of the URL path and query string (if any) of the incoming request.
 * For example: `'/users/details?id=123'`
Expand DownExpand Up@@ -82,12 +82,15 @@ interface HttpOptions {
 };
}

export const instrumentSentryHttp = generateInstrumentOnce<{ breadcrumbs?: boolean }>(
 `${INTEGRATION_NAME}.sentry`,
 options => {
 return new SentryHttpInstrumentation({ breadcrumbs: options?.breadcrumbs });
 },
);
export const instrumentSentryHttp = generateInstrumentOnce<{
 breadcrumbs?: HttpOptions['breadcrumbs'];
 ignoreOutgoingRequests?: HttpOptions['ignoreOutgoingRequests'];
}>(`${INTEGRATION_NAME}.sentry`, options => {
 return new SentryHttpInstrumentation({
 breadcrumbs: options?.breadcrumbs,
 ignoreOutgoingRequests: options?.ignoreOutgoingRequests,
 });
});

export const instrumentOtelHttp = generateInstrumentOnce<HttpInstrumentationConfig>(INTEGRATION_NAME, config => {
 const instrumentation = new HttpInstrumentation(config);
Expand Down

, '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
fix(node): Ensure ignoreOutgoingRequests of httpIntegration applies to breadcrumbs#13970

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

Lms24
merged 2 commits into

from

Oct 16, 2024
 Merged


fix(node): Ensure ignoreOutgoingRequests of httpIntegration applies to breadcrumbs
#13970
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1138c54

fix(node): Ensure `ignoreOutgoingRequests` applies to breadcrumbs


Lms24 Oct 14, 2024
032ff91

cleanup


Lms24 Oct 14, 2024

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


50 changes: 30 additions & 20 deletions
...es/node-integration-tests/suites/tracing/httpIntegration/server-ignoreOutgoingRequests.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,11 @@ Sentry.init({
 integrations: [
 Sentry.httpIntegration({
 ignoreOutgoingRequests: (url, request) => {
 if (url.includes('example.com')) {
 if (url === 'http://example.com/blockUrl') {
 return true;
 }
 if (request.method === 'POST' && request.path === '/path') {

 if (request.hostname === 'example.com' && request.path === '/blockRequest') {
 return true;
 }
 return false;
Expand All@@ -32,28 +33,37 @@ const app = express();

app.use(cors());

app.get('/test', (_req, response) => {
 http
 .request('http://example.com/', res => {
 res.on('data', () => {});
 res.on('end', () => {
 response.send({ response: 'done' });
 });
 })
 .end();
app.get('/testUrl', (_req, response) => {
 makeHttpRequest('http://example.com/blockUrl').then(() => {
 makeHttpRequest('http://example.com/pass').then(() => {
 response.send({ response: 'done' });
 });
 });
});

app.post('/testPath', (_req, response) => {
 http
 .request('http://example.com/path', res => {
 res.on('data', () => {});
 res.on('end', () => {
 response.send({ response: 'done' });
 });
 })
 .end();
app.get('/testRequest', (_req, response) => {
 makeHttpRequest('http://example.com/blockRequest').then(() => {
 makeHttpRequest('http://example.com/pass').then(() => {
 response.send({ response: 'done' });
 });
 });
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);

function makeHttpRequest(url) {
 return new Promise((resolve, reject) => {
 http
 .get(url, res => {
 res.on('data', () => {});
 res.on('end', () => {
 resolve();
 });
 })
 .on('error', error => {
 reject(error);
 });
 });
}

66 changes: 23 additions & 43 deletions
dev-packages/node-integration-tests/suites/tracing/httpIntegration/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,65 +128,45 @@ describe('httpIntegration', () => {
 });
 });

 describe("doesn't create child spans for outgoing requests ignored via `ignoreOutgoingRequests`", () => {
 describe("doesn't create child spans or breadcrumbs for outgoing requests ignored via `ignoreOutgoingRequests`", () => {
 test('via the url param', done => {
 const runner = createRunner(__dirname, 'server-ignoreOutgoingRequests.js')
 .expect({
 transaction: {
 contexts: {
 trace: {
 span_id: expect.any(String),
 trace_id: expect.any(String),
 data: {
 url: expect.stringMatching(/\/test$/),
 'http.response.status_code': 200,
 },
 op: 'http.server',
 status: 'ok',
 },
 },
 transaction: 'GET /test',
 spans: [
 expect.objectContaining({ op: 'middleware.express', description: 'query' }),
 expect.objectContaining({ op: 'middleware.express', description: 'expressInit' }),
 expect.objectContaining({ op: 'middleware.express', description: 'corsMiddleware' }),
 expect.objectContaining({ op: 'request_handler.express', description: '/test' }),
 ],
 transaction: event => {
 expect(event.transaction).toBe('GET /testUrl');

 const requestSpans = event.spans?.filter(span => span.op === 'http.client');
 expect(requestSpans).toHaveLength(1);
 expect(requestSpans![0]?.description).toBe('GET http://example.com/pass');

 const breadcrumbs = event.breadcrumbs?.filter(b => b.category === 'http');
 expect(breadcrumbs).toHaveLength(1);
 expect(breadcrumbs![0]?.data?.url).toEqual('http://example.com/pass');
 },
 })
 .start(done);

 runner.makeRequest('get', '/test');
 runner.makeRequest('get', '/testUrl');
 });

 test('via the request param', done => {
 const runner = createRunner(__dirname, 'server-ignoreOutgoingRequests.js')
 .expect({
 transaction: {
 contexts: {
 trace: {
 span_id: expect.any(String),
 trace_id: expect.any(String),
 data: {
 url: expect.stringMatching(/\/testPath$/),
 'http.response.status_code': 200,
 },
 op: 'http.server',
 status: 'ok',
 },
 },
 transaction: 'POST /testPath',
 spans: [
 expect.objectContaining({ op: 'middleware.express', description: 'query' }),
 expect.objectContaining({ op: 'middleware.express', description: 'expressInit' }),
 expect.objectContaining({ op: 'middleware.express', description: 'corsMiddleware' }),
 expect.objectContaining({ op: 'request_handler.express', description: '/testPath' }),
 ],
 transaction: event => {
 expect(event.transaction).toBe('GET /testRequest');

 const requestSpans = event.spans?.filter(span => span.op === 'http.client');
 expect(requestSpans).toHaveLength(1);
 expect(requestSpans![0]?.description).toBe('GET http://example.com/pass');

 const breadcrumbs = event.breadcrumbs?.filter(b => b.category === 'http');
 expect(breadcrumbs).toHaveLength(1);
 expect(breadcrumbs![0]?.data?.url).toEqual('http://example.com/pass');
 },
 })
 .start(done);

 runner.makeRequest('post', '/testPath');
 runner.makeRequest('get', '/testRequest');
 });
 });
});

49 changes: 45 additions & 4 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
import type * as http from 'node:http';
import type { RequestOptions } from 'node:http';
import type * as https from 'node:https';
import { VERSION } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import { getRequestInfo } from '@opentelemetry/instrumentation-http';
import { addBreadcrumb, getClient, getIsolationScope, withIsolationScope } from '@sentry/core';
import type { SanitizedRequestData } from '@sentry/types';
import {
Expand All@@ -12,12 +14,29 @@ import {
 stripUrlQueryAndFragment,
} from '@sentry/utils';
import type { NodeClient } from '../../sdk/client';
import { getRequestUrl } from '../../utils/getRequestUrl';

type Http = typeof http;
type Https = typeof https;

type SentryHttpInstrumentationOptions = InstrumentationConfig & {
 /**
 * Whether breadcrumbs should be recorded for requests.
 *
 * @default `true`
 */
 breadcrumbs?: boolean;

 /**
 * Do not capture breadcrumbs for outgoing HTTP requests to URLs where the given callback returns `true`.
 * For the scope of this instrumentation, this callback only controls breadcrumb creation.
 * The same option can be passed to the top-level httpIntegration where it controls both, breadcrumb and
 * span creation.
 *
 * @param url Contains the entire URL, including query string (if any), protocol, host, etc. of the outgoing request.
 * @param request Contains the {@type RequestOptions} object used to make the outgoing request.
 */
 ignoreOutgoingRequests?: (url: string, request: RequestOptions) => boolean;
};

/**
Expand DownExpand Up@@ -140,20 +159,42 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 private _getPatchOutgoingRequestFunction(): (
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 original: (...args: any[]) => http.ClientRequest,
 ) => (...args: unknown[]) => http.ClientRequest {
 ) => (options: URL | http.RequestOptions | string, ...args: unknown[]) => http.ClientRequest {
 // eslint-disable-next-line @typescript-eslint/no-this-alias
 const instrumentation = this;

 return (original: (...args: unknown[]) => http.ClientRequest): ((...args: unknown[]) => http.ClientRequest) => {
 return function outgoingRequest(this: unknown, ...args: unknown[]): http.ClientRequest {
 instrumentation._diag.debug('http instrumentation for outgoing requests');

 // Making a copy to avoid mutating the original args array
 // We need to access and reconstruct the request options object passed to `ignoreOutgoingRequests`
 // so that it matches what Otel instrumentation passes to `ignoreOutgoingRequestHook`.
 // @see https://github.com/open-telemetry/opentelemetry-js/blob/7293e69c1e55ca62e15d0724d22605e61bd58952/experimental/packages/opentelemetry-instrumentation-http/src/http.ts#L756-L789
 const argsCopy = [...args];

 const options = argsCopy.shift() as URL | http.RequestOptions | string;

 const extraOptions =
 typeof argsCopy[0] === 'object' && (typeof options === 'string' || options instanceof URL)
 ? (argsCopy.shift() as http.RequestOptions)
 : undefined;

 const { optionsParsed } = getRequestInfo(options, extraOptions);

 const request = original.apply(this, args) as ReturnType<typeof http.request>;

 request.prependListener('response', (response: http.IncomingMessage) => {
 const breadcrumbs = instrumentation.getConfig().breadcrumbs;
 const _breadcrumbs = typeof breadcrumbs === 'undefined' ? true : breadcrumbs;
 if (_breadcrumbs) {
 const _breadcrumbs = instrumentation.getConfig().breadcrumbs;
 const breadCrumbsEnabled = typeof _breadcrumbs === 'undefined' ? true : _breadcrumbs;

 const _ignoreOutgoingRequests = instrumentation.getConfig().ignoreOutgoingRequests;
 const shouldCreateBreadcrumb =
 typeof _ignoreOutgoingRequests === 'function'
 ? !_ignoreOutgoingRequests(getRequestUrl(request), optionsParsed)
 : true;

 if (breadCrumbsEnabled && shouldCreateBreadcrumb) {
 addRequestBreadcrumb(request, response);
 }
 });
Expand Down

21 changes: 12 additions & 9 deletions
packages/node/src/integrations/http/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ const INSTRUMENTATION_NAME = '@opentelemetry_sentry-patched/instrumentation-http

interface HttpOptions {
 /**
 * Whether breadcrumbs should be recorded for requests.
 * Whether breadcrumbs should be recorded for outgoing requests.
 * Defaults to true
 */
 breadcrumbs?: boolean;
Expand All@@ -45,8 +45,8 @@ interface HttpOptions {
 ignoreOutgoingRequests?: (url: string, request: RequestOptions) => boolean;

 /**
 * Do not capture spans or breadcrumbs for incoming HTTP requests to URLs where the given callback returns `true`.
 * This controls both span & breadcrumb creation - spans will be non recording if tracing is disabled.
 * Do not capture spans for incoming HTTP requests to URLs where the given callback returns `true`.
 * Spans will be non recording if tracing is disabled.

Comment on lines

+48
 to 
+49

@Lms24Lms24Oct 14, 2024•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I also adjusted the JSDoc of ignoreIncomingRequests because it wrongfully claimed that incoming requests also generate breadcrumbs. Which isn't the case now and wasn't the case before: 
sentry-javascript/packages/node/src/integrations/http.ts

Lines 245 to 248
in
d7749ae
// Only generate breadcrumbs for outgoing requests
if(!_isClientRequest(request)){
return;
}
 *
 * The `urlPath` param consists of the URL path and query string (if any) of the incoming request.
 * For example: `'/users/details?id=123'`
Expand DownExpand Up@@ -82,12 +82,15 @@ interface HttpOptions {
 };
}

export const instrumentSentryHttp = generateInstrumentOnce<{ breadcrumbs?: boolean }>(
 `${INTEGRATION_NAME}.sentry`,
 options => {
 return new SentryHttpInstrumentation({ breadcrumbs: options?.breadcrumbs });
 },
);
export const instrumentSentryHttp = generateInstrumentOnce<{
 breadcrumbs?: HttpOptions['breadcrumbs'];
 ignoreOutgoingRequests?: HttpOptions['ignoreOutgoingRequests'];
}>(`${INTEGRATION_NAME}.sentry`, options => {
 return new SentryHttpInstrumentation({
 breadcrumbs: options?.breadcrumbs,
 ignoreOutgoingRequests: options?.ignoreOutgoingRequests,
 });
});

export const instrumentOtelHttp = generateInstrumentOnce<HttpInstrumentationConfig>(INTEGRATION_NAME, config => {
 const instrumentation = new HttpInstrumentation(config);
Expand Down

, '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
fix(node): Ensure ignoreOutgoingRequests of httpIntegration applies to breadcrumbs#13970

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

Lms24
merged 2 commits into

from

Oct 16, 2024
 Merged


fix(node): Ensure ignoreOutgoingRequests of httpIntegration applies to breadcrumbs
#13970
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
1138c54

fix(node): Ensure `ignoreOutgoingRequests` applies to breadcrumbs


Lms24 Oct 14, 2024
032ff91

cleanup


Lms24 Oct 14, 2024

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


50 changes: 30 additions & 20 deletions
...es/node-integration-tests/suites/tracing/httpIntegration/server-ignoreOutgoingRequests.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,11 @@ Sentry.init({
 integrations: [
 Sentry.httpIntegration({
 ignoreOutgoingRequests: (url, request) => {
 if (url.includes('example.com')) {
 if (url === 'http://example.com/blockUrl') {
 return true;
 }
 if (request.method === 'POST' && request.path === '/path') {

 if (request.hostname === 'example.com' && request.path === '/blockRequest') {
 return true;
 }
 return false;
Expand All@@ -32,28 +33,37 @@ const app = express();

app.use(cors());

app.get('/test', (_req, response) => {
 http
 .request('http://example.com/', res => {
 res.on('data', () => {});
 res.on('end', () => {
 response.send({ response: 'done' });
 });
 })
 .end();
app.get('/testUrl', (_req, response) => {
 makeHttpRequest('http://example.com/blockUrl').then(() => {
 makeHttpRequest('http://example.com/pass').then(() => {
 response.send({ response: 'done' });
 });
 });
});

app.post('/testPath', (_req, response) => {
 http
 .request('http://example.com/path', res => {
 res.on('data', () => {});
 res.on('end', () => {
 response.send({ response: 'done' });
 });
 })
 .end();
app.get('/testRequest', (_req, response) => {
 makeHttpRequest('http://example.com/blockRequest').then(() => {
 makeHttpRequest('http://example.com/pass').then(() => {
 response.send({ response: 'done' });
 });
 });
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);

function makeHttpRequest(url) {
 return new Promise((resolve, reject) => {
 http
 .get(url, res => {
 res.on('data', () => {});
 res.on('end', () => {
 resolve();
 });
 })
 .on('error', error => {
 reject(error);
 });
 });
}

66 changes: 23 additions & 43 deletions
dev-packages/node-integration-tests/suites/tracing/httpIntegration/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,65 +128,45 @@ describe('httpIntegration', () => {
 });
 });

 describe("doesn't create child spans for outgoing requests ignored via `ignoreOutgoingRequests`", () => {
 describe("doesn't create child spans or breadcrumbs for outgoing requests ignored via `ignoreOutgoingRequests`", () => {
 test('via the url param', done => {
 const runner = createRunner(__dirname, 'server-ignoreOutgoingRequests.js')
 .expect({
 transaction: {
 contexts: {
 trace: {
 span_id: expect.any(String),
 trace_id: expect.any(String),
 data: {
 url: expect.stringMatching(/\/test$/),
 'http.response.status_code': 200,
 },
 op: 'http.server',
 status: 'ok',
 },
 },
 transaction: 'GET /test',
 spans: [
 expect.objectContaining({ op: 'middleware.express', description: 'query' }),
 expect.objectContaining({ op: 'middleware.express', description: 'expressInit' }),
 expect.objectContaining({ op: 'middleware.express', description: 'corsMiddleware' }),
 expect.objectContaining({ op: 'request_handler.express', description: '/test' }),
 ],
 transaction: event => {
 expect(event.transaction).toBe('GET /testUrl');

 const requestSpans = event.spans?.filter(span => span.op === 'http.client');
 expect(requestSpans).toHaveLength(1);
 expect(requestSpans![0]?.description).toBe('GET http://example.com/pass');

 const breadcrumbs = event.breadcrumbs?.filter(b => b.category === 'http');
 expect(breadcrumbs).toHaveLength(1);
 expect(breadcrumbs![0]?.data?.url).toEqual('http://example.com/pass');
 },
 })
 .start(done);

 runner.makeRequest('get', '/test');
 runner.makeRequest('get', '/testUrl');
 });

 test('via the request param', done => {
 const runner = createRunner(__dirname, 'server-ignoreOutgoingRequests.js')
 .expect({
 transaction: {
 contexts: {
 trace: {
 span_id: expect.any(String),
 trace_id: expect.any(String),
 data: {
 url: expect.stringMatching(/\/testPath$/),
 'http.response.status_code': 200,
 },
 op: 'http.server',
 status: 'ok',
 },
 },
 transaction: 'POST /testPath',
 spans: [
 expect.objectContaining({ op: 'middleware.express', description: 'query' }),
 expect.objectContaining({ op: 'middleware.express', description: 'expressInit' }),
 expect.objectContaining({ op: 'middleware.express', description: 'corsMiddleware' }),
 expect.objectContaining({ op: 'request_handler.express', description: '/testPath' }),
 ],
 transaction: event => {
 expect(event.transaction).toBe('GET /testRequest');

 const requestSpans = event.spans?.filter(span => span.op === 'http.client');
 expect(requestSpans).toHaveLength(1);
 expect(requestSpans![0]?.description).toBe('GET http://example.com/pass');

 const breadcrumbs = event.breadcrumbs?.filter(b => b.category === 'http');
 expect(breadcrumbs).toHaveLength(1);
 expect(breadcrumbs![0]?.data?.url).toEqual('http://example.com/pass');
 },
 })
 .start(done);

 runner.makeRequest('post', '/testPath');
 runner.makeRequest('get', '/testRequest');
 });
 });
});

49 changes: 45 additions & 4 deletions
packages/node/src/integrations/http/SentryHttpInstrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
import type * as http from 'node:http';
import type { RequestOptions } from 'node:http';
import type * as https from 'node:https';
import { VERSION } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import { getRequestInfo } from '@opentelemetry/instrumentation-http';
import { addBreadcrumb, getClient, getIsolationScope, withIsolationScope } from '@sentry/core';
import type { SanitizedRequestData } from '@sentry/types';
import {
Expand All@@ -12,12 +14,29 @@ import {
 stripUrlQueryAndFragment,
} from '@sentry/utils';
import type { NodeClient } from '../../sdk/client';
import { getRequestUrl } from '../../utils/getRequestUrl';

type Http = typeof http;
type Https = typeof https;

type SentryHttpInstrumentationOptions = InstrumentationConfig & {
 /**
 * Whether breadcrumbs should be recorded for requests.
 *
 * @default `true`
 */
 breadcrumbs?: boolean;

 /**
 * Do not capture breadcrumbs for outgoing HTTP requests to URLs where the given callback returns `true`.
 * For the scope of this instrumentation, this callback only controls breadcrumb creation.
 * The same option can be passed to the top-level httpIntegration where it controls both, breadcrumb and
 * span creation.
 *
 * @param url Contains the entire URL, including query string (if any), protocol, host, etc. of the outgoing request.
 * @param request Contains the {@type RequestOptions} object used to make the outgoing request.
 */
 ignoreOutgoingRequests?: (url: string, request: RequestOptions) => boolean;
};

/**
Expand DownExpand Up@@ -140,20 +159,42 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
 private _getPatchOutgoingRequestFunction(): (
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 original: (...args: any[]) => http.ClientRequest,
 ) => (...args: unknown[]) => http.ClientRequest {
 ) => (options: URL | http.RequestOptions | string, ...args: unknown[]) => http.ClientRequest {
 // eslint-disable-next-line @typescript-eslint/no-this-alias
 const instrumentation = this;

 return (original: (...args: unknown[]) => http.ClientRequest): ((...args: unknown[]) => http.ClientRequest) => {
 return function outgoingRequest(this: unknown, ...args: unknown[]): http.ClientRequest {
 instrumentation._diag.debug('http instrumentation for outgoing requests');

 // Making a copy to avoid mutating the original args array
 // We need to access and reconstruct the request options object passed to `ignoreOutgoingRequests`
 // so that it matches what Otel instrumentation passes to `ignoreOutgoingRequestHook`.
 // @see https://github.com/open-telemetry/opentelemetry-js/blob/7293e69c1e55ca62e15d0724d22605e61bd58952/experimental/packages/opentelemetry-instrumentation-http/src/http.ts#L756-L789
 const argsCopy = [...args];

 const options = argsCopy.shift() as URL | http.RequestOptions | string;

 const extraOptions =
 typeof argsCopy[0] === 'object' && (typeof options === 'string' || options instanceof URL)
 ? (argsCopy.shift() as http.RequestOptions)
 : undefined;

 const { optionsParsed } = getRequestInfo(options, extraOptions);

 const request = original.apply(this, args) as ReturnType<typeof http.request>;

 request.prependListener('response', (response: http.IncomingMessage) => {
 const breadcrumbs = instrumentation.getConfig().breadcrumbs;
 const _breadcrumbs = typeof breadcrumbs === 'undefined' ? true : breadcrumbs;
 if (_breadcrumbs) {
 const _breadcrumbs = instrumentation.getConfig().breadcrumbs;
 const breadCrumbsEnabled = typeof _breadcrumbs === 'undefined' ? true : _breadcrumbs;

 const _ignoreOutgoingRequests = instrumentation.getConfig().ignoreOutgoingRequests;
 const shouldCreateBreadcrumb =
 typeof _ignoreOutgoingRequests === 'function'
 ? !_ignoreOutgoingRequests(getRequestUrl(request), optionsParsed)
 : true;

 if (breadCrumbsEnabled && shouldCreateBreadcrumb) {
 addRequestBreadcrumb(request, response);
 }
 });
Expand Down

21 changes: 12 additions & 9 deletions
packages/node/src/integrations/http/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,7 @@ const INSTRUMENTATION_NAME = '@opentelemetry_sentry-patched/instrumentation-http

interface HttpOptions {
 /**
 * Whether breadcrumbs should be recorded for requests.
 * Whether breadcrumbs should be recorded for outgoing requests.
 * Defaults to true
 */
 breadcrumbs?: boolean;
Expand All@@ -45,8 +45,8 @@ interface HttpOptions {
 ignoreOutgoingRequests?: (url: string, request: RequestOptions) => boolean;

 /**
 * Do not capture spans or breadcrumbs for incoming HTTP requests to URLs where the given callback returns `true`.
 * This controls both span & breadcrumb creation - spans will be non recording if tracing is disabled.
 * Do not capture spans for incoming HTTP requests to URLs where the given callback returns `true`.
 * Spans will be non recording if tracing is disabled.

Comment on lines

+48
 to 
+49

@Lms24Lms24Oct 14, 2024•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I also adjusted the JSDoc of ignoreIncomingRequests because it wrongfully claimed that incoming requests also generate breadcrumbs. Which isn't the case now and wasn't the case before: 
sentry-javascript/packages/node/src/integrations/http.ts

Lines 245 to 248
in
d7749ae
// Only generate breadcrumbs for outgoing requests
if(!_isClientRequest(request)){
return;
}
 *
 * The `urlPath` param consists of the URL path and query string (if any) of the incoming request.
 * For example: `'/users/details?id=123'`
Expand DownExpand Up@@ -82,12 +82,15 @@ interface HttpOptions {
 };
}

export const instrumentSentryHttp = generateInstrumentOnce<{ breadcrumbs?: boolean }>(
 `${INTEGRATION_NAME}.sentry`,
 options => {
 return new SentryHttpInstrumentation({ breadcrumbs: options?.breadcrumbs });
 },
);
export const instrumentSentryHttp = generateInstrumentOnce<{
 breadcrumbs?: HttpOptions['breadcrumbs'];
 ignoreOutgoingRequests?: HttpOptions['ignoreOutgoingRequests'];
}>(`${INTEGRATION_NAME}.sentry`, options => {
 return new SentryHttpInstrumentation({
 breadcrumbs: options?.breadcrumbs,
 ignoreOutgoingRequests: options?.ignoreOutgoingRequests,
 });
});

export const instrumentOtelHttp = generateInstrumentOnce<HttpInstrumentationConfig>(INTEGRATION_NAME, config => {
 const instrumentation = new HttpInstrumentation(config);
Expand Down