feat(node)!: Make channel-based instrumentation the default#22501
feat(node)!: Make channel-based instrumentation the default#22501andreiborza wants to merge 24 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>
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
| // 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.
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.
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 2 potential issues.
There are 3 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 3b3b84b. Configure here.
| process.env._sentryOrchestrionTracingHooksDir || globalWithInjectedValues._sentryOrchestrionTracingHooksDir; | ||
| if (tracingHooksDir && hasSpansEnabled(opts)) { | ||
| registerDiagnosticsChannelInjection({ tracingHooksDir }); | ||
| } |
There was a problem hiding this comment.
Next build injection still opt-in
High Severity
Default @sentry/node integrations now rely on orchestrion diagnostics channels, but withSentryConfig still defaults _experimental.useDiagnosticsChannelInjection to false, so the webpack/Turbopack transform usually does not run. Server bundles may never emit channel events while the SDK only subscribes to the channel path, silently dropping library auto-instrumentation for typical Next apps.
Reviewed by Cursor Bugbot for commit 3b3b84b. Configure here.
| const _mysqlIntegration = (() => { | ||
| return { | ||
| name: INTEGRATION_NAME, | ||
| setupOnce() { |
There was a problem hiding this comment.
Node 18 loses auto tracing
Medium Severity
Default integrations now delegate to orchestrion channel subscribers that no-op when diagnostics_channel.tracingChannel is missing (Node before 18.19), while OTel instrumentations are no longer wired from those factories. With engines.node still >=18, supported 18.0–18.18 runtimes can lose mysql, express, and similar auto-instrumentation entirely.
Reviewed by Cursor Bugbot for commit 3b3b84b. Configure here.
1 participant
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