fix(node): Ensure traces are propagated without spans in Node 23+ #16221
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
size-limit report 📦
|
AbhiPrasad
approved these changes
May 8, 2025
packages/node/src/integrations/http/SentryHttpInstrumentation.ts
Outdated
Show resolved
Hide resolved
packages/node/src/integrations/http/SentryHttpInstrumentation.ts
Outdated
Show resolved
Hide resolved
Co-authored-by: Abhijeet Prasad <[email protected]>
mydea
force-pushed
the
fn/propagate-traces-node-http
branch
from
5e3f8a3 to
5d33b15
Compare
andreiborza
approved these changes
May 9, 2025
Comment on lines
+178
to
+179
| // NOTE: This channel only exist since Node 23 | ||
| // Before that, outgoing requests are not patched, sadly |
There was a problem hiding this comment.
Suggested change
| // NOTE: This channel only exist since Node 23 | |
| // Before that, outgoing requests are not patched, sadly | |
| // NOTE: This channel only exist since Node 23 | |
| // Before that, outgoing requests are not patched | |
| // and trace headers are not propagated, sadly. |
Comment on lines
+57
to
+61
| * Whether to propagate Sentry trace headers in outgoing requests. | ||
| * By default this is done by the HttpInstrumentation, but if that is not added (e.g. because tracing is disabled) | ||
| * then this instrumentation can take over. | ||
| * | ||
| * @default `false` |
There was a problem hiding this comment.
q: Should we mention that this only works for Node >= 23?
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.
Today, if the
httpIntegrationis used without spans (e.g. in a custom OTEL setup or when settinghttpIntegration({ spans: false })manually), outgoing requests will not have traces propagated.This PR fixes this by using the
http.client.request.createddiagnostics channel to add the trace headers in this scenario.However, sadly this channel was only added in Node 23, so it does not work on versions before that.
I suppose this is still worth adding because it is better than what we have today (which is that it does not work at all). We may think about making this work for Node <=22, but this would require us monkey patching http again, which we really do not want to do... Also note that as of now this should not really affect the vast majority of cases, as unless you specifically opt out of spans today this will always work as we always add the otel http instrumentation by default. And in custom otel setups, users will usually have this set up anyhow. (Also, fetch works in all environments as expected).
If we want to, in a follow up, avoid adding the otel spans instrumentation if performance is disabled, we need to think about this... an option could be to always adding the instrumentation on node <=22, and only skip it on Node 23+. But this can be looked at separately, this PR at least makes things better than before on Node 23+...
This supersedes #15735