feat(server-utils): Migrate `@opentelemetry/instrumentation-ioredis` to orchestrion by chargome · Pull Request #21849 · getsentry/sentry-javascript

chargome · 2026-06-29T15:27:33Z

Migrates ioredis instrumentation from the otel to orchestrion diagnostics-channel injection.

Orchestrion covers ioredis <5.11.0; >=5.11.0 keeps using ioredis' own ioredis:* diagnostics_channel (unchanged).
New subscriber in @sentry/server-utils produces the same db spans as before with raw args redacted via the shared defaultDbStatementSerializer.
The OTel Redis integration stays in place (it still handles node-redis and ioredis ≥5.11) — only its ioredis monkey-patch is turned off when injection is on, except on Node <18.19, where orchestrion isn't available.

closes#20755

Resolve conflict in experimentalUseDiagnosticsChannelInjection.ts: keep develop's derive-from-names for the 1:1 channel replacements (mysql, lru-memoizer) and add ioredisChannelIntegration separately, kept out of replacedOtelIntegrationNames since it only supersedes the ioredis sub-part of the composite OTel 'Redis'. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

…rvives bundling ioredis' connect() calls standard-as-callback's CJS default export; left external it resolves to a non-function in the nitro/Rollup bundle. Inline it alongside ioredis so the interop links consistently. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

chargome · 2026-06-30T09:52:33Z

bugbot run

- Keep the OTel ioredis monkey-patch on Node without tracingChannel (<18.19) even when injection is opted in, since orchestrion can't run there — otherwise ioredis <5.11.0 would lose tracing entirely. - Defer the orchestrion ioredis bindTracingChannelToSpan calls via waitForTracingChannelBinding, matching the native redis diagnostics-channel subscriber, so the async-context binding registered by initOpenTelemetry() is available before binding. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

chargome · 2026-06-30T12:56:49Z

bugbot run

…nstrumentation The orchestrion opt-in imports cacheResponseHook; importing it from redis/index transitively pulled the vendored OTel IORedisInstrumentation/RedisInstrumentation into the opt-in module graph. Move cacheResponseHook + _redisOptions into redis/cache.ts (no OTel instrumentation imports) so apps using injection only for mysql/lru-memoizer don't bundle the redis OTel instrumentation. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

chargome · 2026-06-30T13:52:21Z

bugbot run

cursor

✅ Bugbot reviewed your changes and found no new issues!

Comment @cursor review or bugbot run to trigger another review on this PR

^{Reviewed by Cursor Bugbot for commit da258e2. Configure here.}

cursor

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

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

^{Reviewed by Cursor Bugbot for commit da258e2. Configure here.}

…rion

develop now runs all node-integration tests a second time with INJECT_ORCHESTRION (#21911). Under orchestrion, ioredis <5.11 is instrumented by the diagnostics-channel subscriber, so its span origin is 'auto.db.orchestrion.redis' instead of the OTel monkey-patch's 'auto.db.otel.redis'. Branch the expected ioredis origin on isOrchestrionEnabled(); node-redis (redis-4/redis-5) is not ported and keeps the OTel origin. All other span attributes are identical. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

nicohrubec

lgtm

…rion # Conflicts: # packages/node/src/sdk/experimentalUseDiagnosticsChannelInjection.ts # packages/server-utils/src/orchestrion/channels.ts # packages/server-utils/src/orchestrion/config.ts # packages/server-utils/src/orchestrion/index.ts

…rion # Conflicts: # packages/server-utils/src/orchestrion/config.ts # packages/server-utils/src/orchestrion/index.ts

…rion # Conflicts: # packages/server-utils/src/orchestrion/index.ts

… orchestrion (#21925) Migrates `node-redis` from the OTel monkey-patch to orchestrion diagnostics-channel injection. Builds on the ioredis migration (#21849). - New `RedisChannel` subscriber in `@sentry/server-utils` produces the same db spans as the OTel `RedisInstrumentation`: single commands, `connect`, and multi/pipeline batches. - Batch spans mirror the native `node-redis:batch` shape. - node-redis ≥5.12 keeps using its own `node-redis:*` diagnostics_channel (unchanged). - When diagnostics-channel injection is opted in, the OTel `RedisInstrumentation` monkey-patch is fully gated off; the composite `Redis` integration stays for the native-channel subscriber/ Note: When we eventually delete the OTel Redis integration, we need to move the native diagnostics-channel subscriber (`subscribeRedisDiagnosticChannels`, for node-redis ≥5.12 / ioredis ≥5.11) into the orchestrion-owned side so it keeps running, then collapse everything into one default `Redis` integration. closes#20765 --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

wip ci check
d05dad8

chargome self-assigned this Jun 30, 2026

chargomeand others added 2 commits June 30, 2026 10:11

cursorBot reviewed Jun 30, 2026
View reviewed changes

Comment threadpackages/node/src/integrations/tracing/redis/index.ts
Comment threadpackages/server-utils/src/integrations/tracing-channel/ioredis.ts Outdated

cursorBot reviewed Jun 30, 2026
View reviewed changes

Comment threadpackages/node/src/integrations/tracing/redis/index.ts
Comment threadpackages/node/src/sdk/experimentalUseDiagnosticsChannelInjection.ts Outdated

cursorBot reviewed Jun 30, 2026
View reviewed changes

chargome marked this pull request as ready for review June 30, 2026 14:20

chargome requested a review from a team as a code owner June 30, 2026 14:20

chargome requested review from JPeer264, andreiborza, isaacs, mydea and nicohrubec and removed request for a team, JPeer264 and mydea June 30, 2026 14:20

cursorBot reviewed Jun 30, 2026
View reviewed changes

Comment threadpackages/node/src/integrations/tracing/redis/index.ts

mydea reviewed Jul 1, 2026
View reviewed changes

Comment threadpackages/server-utils/src/integrations/tracing-channel/ioredis.ts Outdated

sentry conventions
060d43a

sentryBot reviewed Jul 1, 2026
View reviewed changes

Comment threadpackages/server-utils/src/integrations/tracing-channel/ioredis.ts

chargomeand others added 2 commits July 2, 2026 14:56

Merge remote-tracking branch 'origin/develop' into cg/redisio-orchest…
f688a59
…rion

nicohrubec reviewed Jul 2, 2026
View reviewed changes

pr feedback
b755ca1
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

chargome force-pushed the cg/redisio-orchestrion branch from 4509095 to b755ca1Compare July 2, 2026 14:08

nicohrubec approved these changes Jul 2, 2026
View reviewed changes

chargome added 2 commits July 3, 2026 09:39

Merge remote-tracking branch 'origin/develop' into cg/redisio-orchest…
42caf43
…rion # Conflicts: # packages/server-utils/src/orchestrion/config.ts # packages/server-utils/src/orchestrion/index.ts

sentryBot reviewed Jul 3, 2026
View reviewed changes

Comment threadpackages/server-utils/src/integrations/tracing-channel/ioredis.ts

Merge remote-tracking branch 'origin/develop' into cg/redisio-orchest…
c347ffd
…rion # Conflicts: # packages/server-utils/src/orchestrion/index.ts

chargome merged commit aa7a30b into developJul 3, 2026
387 of 389 checks passed

chargome deleted the cg/redisio-orchestrion branch July 3, 2026 09:28

chargome mentioned this pull request Jul 7, 2026
feat(server-utils): Migrate @opentelemetry/instrumentation-redis to orchestrion #21925
Merged

sentry-release-botBot mentioned this pull request Jul 7, 2026
publish: getsentry/sentry-javascript@10.64.0 getsentry/publish#8814
Closed
49 tasks

github-actionsBot mentioned this pull request Jul 7, 2026
Rewrite @opentelemetry/instrumentation-ioredis to orchestrion #20755
Closed

Navigation Menu

Uh oh!

Uh oh!

feat(server-utils): Migrate `@opentelemetry/instrumentation-ioredis` to orchestrion - #21849

feat(server-utils): Migrate `@opentelemetry/instrumentation-ioredis` to orchestrion#21849
chargome merged 12 commits into
developfrom
cg/redisio-orchestrion

chargome commented Jun 29, 2026•
edited
Loading

Uh oh!

chargome commented Jun 30, 2026

Uh oh!

Uh oh!

Uh oh!

chargome commented Jun 30, 2026

Uh oh!

Uh oh!

Uh oh!

chargome commented Jun 30, 2026

Uh oh!

cursorBot left a comment

Uh oh!

cursorBot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nicohrubec left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Uh oh!

Conversation

chargome commented Jun 29, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chargome commented Jun 30, 2026

Uh oh!

Uh oh!

Uh oh!

chargome commented Jun 30, 2026

Uh oh!

Uh oh!

Uh oh!

chargome commented Jun 30, 2026

Uh oh!

cursorBot left a comment

Choose a reason for hiding this comment

Uh oh!

cursorBot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nicohrubec left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

chargome commented Jun 29, 2026•
edited
Loading