Skip to content

feat(node)!: Make channel-based instrumentation the default#22501

Draft
andreiborza wants to merge 37 commits into
developfrom
ab/channel-based-default
Draft

feat(node)!: Make channel-based instrumentation the default#22501
andreiborza wants to merge 37 commits into
developfrom
ab/channel-based-default

Conversation

@andreiborza

@andreiborza andreiborza commented Jul 22, 2026

Copy link
Copy Markdown
Member

What

Make orchestrion diagnostics-channel instrumentation the default in @sentry/node and remove the experimentalUseDiagnosticsChannelInjection() 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

Comment thread packages/aws-serverless/src/init.ts
Comment thread packages/node/src/sdk/index.ts
@github-actions

github-actions Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size % Change Change
@sentry/browser 27.95 kB - -
@sentry/browser - with treeshaking flags 26.39 kB - -
@sentry/browser (incl. Tracing) 46.41 kB - -
@sentry/browser (incl. Tracing + Span Streaming) 48.18 kB - -
@sentry/browser (incl. Tracing, Profiling) 51.21 kB - -
@sentry/browser (incl. Tracing, Replay) 85.69 kB - -
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 75.33 kB - -
@sentry/browser (incl. Tracing, Replay with Canvas) 90.4 kB - -
@sentry/browser (incl. Tracing, Replay, Feedback) 103.06 kB - -
@sentry/browser (incl. Feedback) 45.13 kB - -
@sentry/browser (incl. sendFeedback) 32.74 kB - -
@sentry/browser (incl. FeedbackAsync) 37.8 kB - -
@sentry/browser (incl. Metrics) 29.04 kB - -
@sentry/browser (incl. Logs) 29.26 kB - -
@sentry/browser (incl. Metrics & Logs) 29.97 kB - -
@sentry/react 29.75 kB - -
@sentry/react (incl. Tracing) 48.71 kB - -
@sentry/vue 33.38 kB - -
@sentry/vue (incl. Tracing) 48.4 kB - -
@sentry/svelte 27.97 kB - -
CDN Bundle 30.28 kB - -
CDN Bundle (incl. Tracing) 48.26 kB - -
CDN Bundle (incl. Logs, Metrics) 31.85 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) 49.58 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) 71.13 kB - -
CDN Bundle (incl. Tracing, Replay) 85.83 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) 87.14 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) 91.6 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) 92.89 kB - -
CDN Bundle - uncompressed 90.15 kB - -
CDN Bundle (incl. Tracing) - uncompressed 145.22 kB - -
CDN Bundle (incl. Logs, Metrics) - uncompressed 94.86 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed 149.2 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) - uncompressed 219.62 kB - -
CDN Bundle (incl. Tracing, Replay) - uncompressed 264.46 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) - uncompressed 268.42 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 278.16 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed 282.11 kB - -
@sentry/nextjs (client) 51.24 kB - -
@sentry/sveltekit (client) 46.84 kB - -
@sentry/core/server 80.05 kB - -
@sentry/core/browser 52.01 kB - -
@sentry/node 136.09 kB +10.52% +12.95 kB 🔺
⛔️ @sentry/node (incl. diagnostics channel injection) (max: null) 0 B removed removed
@sentry/node/import (ESM hook with diagnostics-channel injection) 166 B - -
@sentry/node - without tracing 97.04 kB +32.39% +23.74 kB 🔺
@sentry/aws-serverless 105.1 kB +26.92% +22.29 kB 🔺
@sentry/cloudflare (withSentry) - minified 197.05 kB - -
@sentry/cloudflare (withSentry) 484.73 kB - -

View base workflow run

Comment thread packages/nextjs/src/server/index.ts Outdated
Comment thread packages/node/src/integrations/tracing/mysql/index.ts
Comment thread packages/node/src/integrations/tracing/express.ts
Comment thread packages/node/src/integrations/tracing/index.ts
Comment thread dev-packages/e2e-tests/test-applications/node-express/tests/trpc.test.ts Outdated
Comment thread packages/nextjs/src/server/index.ts Outdated
@andreiborza
andreiborza force-pushed the ab/channel-based-default branch from 921217b to e9cde04 Compare July 23, 2026 11:56
Comment thread packages/node/src/integrations/tracing/express.ts Outdated
Comment thread packages/nextjs/src/server/index.ts Outdated
Comment thread packages/node/src/integrations/tracing/index.ts
@andreiborza
andreiborza force-pushed the ab/channel-based-default branch from 404fb86 to c9a6733 Compare July 24, 2026 09:07

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 11d7697. Configure here.

Comment thread packages/node/src/integrations/tracing/redis/index.ts
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>
@andreiborza
andreiborza force-pushed the ab/channel-based-default branch from 3c1a737 to 9808b49 Compare July 24, 2026 16:38
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.
The aws-serverless `awsIntegration` still registered the vendored OTel
`AwsInstrumentation`, emitting `auto.otel.aws` spans, while channel-based
instrumentation is now the default everywhere else. Delegate to the channel
`awsChannelIntegration` from @sentry/server-utils so aws-sdk spans carry the
orchestrion origin, matching @sentry/node.
Channel-based instrumentation is bundled unconditionally now, growing the
@sentry/node bundle. Bump the limits to match (131->141 KB, without-tracing
80->81 KB) and drop the stale `experimentalUseDiagnosticsChannelInjection`
entry, whose export was removed.
Update hardcoded OpenTelemetry origins to the channel values now that
channel-based instrumentation is the default (anthropic, apollo-graphql,
aws-serverless graphql, postgres-streamed). Rename graphql.source to
graphql.document to match the channel path, and guard the anthropic custom
options error-event expectation behind isOrchestrionEnabled() like its sibling
tests (the channel path marks the span errored but does not capture the handled
rejection as an event).
…tion in nextjs

hasSpansEnabled was called with unresolved options, so an app enabling tracing
only via SENTRY_TRACES_SAMPLE_RATE skipped registering the build-resolved
tracingHooksDir, while nodeInit still enabled channel injection with the bare
specifier (which fails in bundled Next server builds). Resolve the env var
first, matching @sentry/node's init.
…hooks

parseFloat of an invalid env value yields NaN, which is not nullish, so
hasSpansEnabled would treat tracing as enabled and disagree with @sentry/node.
Mirror node's getTracesSampleRate and drop non-finite env values.
develop's hook-registration rework (#22443) resolves the bundled-pnpm specifier
via absolute-path webpack externals and dropped the tracingHooksDir option from
registerDiagnosticsChannelInjection and the _sentryOrchestrionTracingHooksDir
build var. Remove the now-broken nextjs workaround that relied on them; node's
init registers the hooks and the externals keep them resolvable.
After rebasing onto develop, the orchestrion runtime chain is bundled into the
node builds (no longer lazy-loaded), growing @sentry/node (141->158 KB),
@sentry/node without tracing (81->97 KB), and @sentry/aws-serverless
(89->106 KB).
CI-measured @sentry/node without tracing (97032B) edged just over the 97 KB
limit; CI gzip runs slightly larger than local. Bump without-tracing to 98 KB
and @sentry/node to 159 KB for margin.
getAutoPerformanceIntegrations now uses the channel integrations from
@sentry/server-utils/orchestrion directly instead of routing through the thin
@sentry/node wrappers. Redis and Fastify keep their node wrappers (cache
responseHook wiring; Fastify v3/v4 coverage). The wrapper files and their public
exports are unchanged; removing them and the vendored OTel is tracked in JS-3074.
@andreiborza
andreiborza force-pushed the ab/channel-based-default branch 2 times, most recently from 9808b49 to 9bd4d80 Compare July 24, 2026 17:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make channel-based instrumentations the default in v11

1 participant