fix(node): Do not emit fetch spans when tracing is disabled #13003
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ensure that TWP works with fetch, but we do not emit a span. Otherwise, if a user does not use our tracing functionality but adds their own fetch instrumentation, they get spans twice.
mydea
commented
Jul 22, 2024
| @@ -1,5 +1,5 @@ | |||
| { | |||
| "name": "node-otel-sdk-trace", | |||
| "name": "node-otel-sdk-node", | |||
There was a problem hiding this comment.
noticed this name was actually not consistent.
mydea
commented
Jul 22, 2024
|
|
||
| createTestServer(done) | ||
| .get('/api/v0', headers => { | ||
| expect(headers['sentry-trace']).toEqual(expect.stringMatching(/^([a-f0-9]{32})-([a-f0-9]{16})$/)); | ||
| expect(headers['sentry-trace']).not.toEqual('00000000000000000000000000000000-0000000000000000'); | ||
| expect(headers['baggage']).toEqual(expect.any(String)); | ||
| expect(headers['__requestUrl']).toBeUndefined(); |
There was a problem hiding this comment.
this is actually not needed anymore, we do not set this anywhere, removed it in all places.
mydea
commented
Jul 22, 2024
| const url = request.origin; | ||
| return _ignoreOutgoingRequests && url && _ignoreOutgoingRequests(url); | ||
| ignoreRequestHook: (request: FetchRequest) => { | ||
| const url = getAbsoluteUrl(request.origin, request.path); |
There was a problem hiding this comment.
Noticed that this was actually incorrect, we just took the origin as URL, oops.
size-limit report 📦
|
Lms24
approved these changes
Jul 22, 2024
|
|
||
| test('Sends an API route transaction to OTLP', async ({ baseURL }) => { | ||
| waitForTransaction('node-otel-without-tracing', transactionEvent => { | ||
| throw new Error('THIS SHOULD NEVER HAPPEN!'); |
There was a problem hiding this comment.
nice idea to ensure something is not sent 😅
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ensure that TWP works with fetch, but we do not emit a span. Otherwise, if a user does not use our tracing functionality but adds their own fetch instrumentation, they get spans twice.
The benefit we have with fetch is that fetch is instrumented via diagnostics channel, which means that this can be instrumented multiple times. So if we instrument it, on the plus side this does not interfere with a user instrumenting it again themselves if they want.
However, with the previous implementation our integration would always emit spans. If a user is using our own sampler, this is "OK" because it will sample it out. But if a user does not use our sampler, the spans we emit there get sent unintentionally.
With this change, we ensure to ignore requests if tracing is disabled. In order to make TWP work, we instead manually inject the propagator headers into the fetch request in this scenario.
Part of #12984
Fixes #12969