feat(node)!: Make channel-based instrumentation the default#22501
Draft
andreiborza wants to merge 27 commits into
Draft
feat(node)!: Make channel-based instrumentation the default#22501andreiborza wants to merge 27 commits into
andreiborza wants to merge 27 commits into
Conversation
Make orchestrion diagnostics-channel injection the default in `@sentry/node` and remove the `experimentalUseDiagnosticsChannelInjection()` opt-in. `Sentry.init()` now installs the channel-injection module hooks unconditionally when span recording is enabled, so the opt-in function, its loader indirection, and the name-based OTel->channel integration swap are gone. The self-selecting `dataloader` and `knex` integrations pick the channel path automatically now that `isOrchestrionInjected()` is true by default. Redis stays a composite integration: the native diagnostics-channel subscribers (node-redis >=5.12, ioredis >=5.11, batches) plus the orchestrion subscribers for the older ranges, all sharing the node cache `responseHook`. The vendored OTel patchers only run on runtimes without `tracingChannel` (Node <18.19). BREAKING CHANGE: `experimentalUseDiagnosticsChannelInjection()`, `diagnosticsChannelInjectionIntegrations()`, `isDiagnosticsChannelInjectionEnabled()` and `applyDiagnosticsChannelInjectionIntegrations()` are removed from `@sentry/node`. Channel-based instrumentation is now always on; no opt-in call is needed. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
| // No-op otherwise. | ||
| return applyDiagnosticsChannelInjectionIntegrations(integrations, options); | ||
| export function getDefaultIntegrations(_options: Options): Integration[] { | ||
| return [...getDefaultIntegrationsWithoutPerformance(), awsIntegration(), awsLambdaIntegration()]; |
There was a problem hiding this comment.
AWS serverless drops performance integrations
High Severity
Removing applyDiagnosticsChannelInjectionIntegrations from getDefaultIntegrations leaves @sentry/aws-serverless defaults without any auto-performance integrations when tracing is on. Sentry.init() still registers orchestrion hooks, but the slim default list never includes channel subscribers such as postgresIntegration() or expressIntegration(), so Lambda apps lose DB and framework spans that the opt-in path used to append.
Reviewed by Cursor Bugbot for commit 89607ae. Configure here.
Contributor
size-limit report 📦
|
Forward build-resolved tracingHooksDir in @sentry/nextjs server init so bundled pnpm apps load the channel-injection hook. Update span origins to orchestrion values (koa, hapi, nestjs, firebase functions) and add error.type to errored express request_handler spans. Skip preload and bring-your-own-OTel apps (node-express-cjs/esm-preload, node-otel-sdk-node, node-otel-custom-sampler); fixme AI (ai@v3), trpc, and firebase functions tests pending follow-ups.
node-koa: anonymous router middleware now resolves as 'middleware' via code.function.name under the channel path. Fixme trpc tests in tsx-express and node-express-v5 (same channel Express mount-path naming gap as node-express).
Same channel Vercel AI v3-unsupported gap as nextjs-16; the turbo/latest variants share this app dir so they're covered too.
…ress
The channel-based Express integration only resolved the route for
request_handler layers, so routes served through mounted middleware
(app.use('/trpc', handler)) never set http.route on the root span and their
transactions kept the raw URL name. Compute the matched route for every layer
type, mirroring the OTel Express integration's per-layer route resolution.
Re-enables the previously fixme'd trpc tests in node-express, tsx-express and
node-express-v5.
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
There are 2 total unresolved issues (including 1 from previous review).
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 921217b. Configure here.
| process.env._sentryOrchestrionTracingHooksDir || globalWithInjectedValues._sentryOrchestrionTracingHooksDir; | ||
| if (tracingHooksDir && hasSpansEnabled(opts)) { | ||
| registerDiagnosticsChannelInjection({ tracingHooksDir }); | ||
| } |
There was a problem hiding this comment.
Next env tracing skips hooks dir
Medium Severity
The early registerDiagnosticsChannelInjection({ tracingHooksDir }) call is gated on hasSpansEnabled(opts), but opts does not resolve SENTRY_TRACES_SAMPLE_RATE the way @sentry/node init does via getTracesSampleRate. When tracing is enabled only through that env var, Next skips registration with tracingHooksDir, while nodeInit still enables channel injection using the bare specifier—often failing for bundled Next server builds that need the build-time hooks path.
Reviewed by Cursor Bugbot for commit 921217b. Configure here.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What
Make orchestrion diagnostics-channel instrumentation the default in
@sentry/nodeand remove theexperimentalUseDiagnosticsChannelInjection()opt-in.Why
The channel-based instrumentations shipped opt-in in v10. Making them the default in v11 unlocks instrumentation at run and build time.
Removal of the vendored OTel/IITM code is intentionally out of scope; it is tracked separately as follow-up.
Closes: #22345