Skip to content

feat(node): Rewrite knex instrumentation to orchestrion tracing channels#22237

Open
logaretm wants to merge 2 commits into
developfrom
awad/js-2408-rewrite-opentelemetryinstrumentation-knex-to-orchestrion
Open

feat(node): Rewrite knex instrumentation to orchestrion tracing channels#22237
logaretm wants to merge 2 commits into
developfrom
awad/js-2408-rewrite-opentelemetryinstrumentation-knex-to-orchestrion

Conversation

@logaretm

@logaretm logaretm commented Jul 13, 2026

Copy link
Copy Markdown
Member

Migrates the knex integration off the vendored InstrumentationBase monkey-patch onto a node:diagnostics_channel subscriber whose channels are injected by the orchestrion code transform. The vendored OTel path stays as the fallback when orchestrion isn't injected.

closes #20757

@linear-code

linear-code Bot commented Jul 13, 2026

Copy link
Copy Markdown

JS-2408

@github-actions

github-actions Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size % Change Change
@sentry/browser 27.65 kB - -
@sentry/browser - with treeshaking flags 26.1 kB - -
@sentry/browser (incl. Tracing) 46.42 kB - -
@sentry/browser (incl. Tracing + Span Streaming) 48.21 kB - -
@sentry/browser (incl. Tracing, Profiling) 51.2 kB - -
@sentry/browser (incl. Tracing, Replay) 85.67 kB - -
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 75.31 kB - -
@sentry/browser (incl. Tracing, Replay with Canvas) 90.38 kB - -
@sentry/browser (incl. Tracing, Replay, Feedback) 103.04 kB - -
@sentry/browser (incl. Feedback) 44.83 kB - -
@sentry/browser (incl. sendFeedback) 32.45 kB - -
@sentry/browser (incl. FeedbackAsync) 37.58 kB - -
@sentry/browser (incl. Metrics) 28.74 kB - -
@sentry/browser (incl. Logs) 28.98 kB - -
@sentry/browser (incl. Metrics & Logs) 29.67 kB - -
@sentry/react 29.45 kB - -
@sentry/react (incl. Tracing) 48.68 kB - -
@sentry/vue 33.08 kB - -
@sentry/vue (incl. Tracing) 48.4 kB - -
@sentry/svelte 27.67 kB - -
CDN Bundle 30.05 kB - -
CDN Bundle (incl. Tracing) 48.41 kB - -
CDN Bundle (incl. Logs, Metrics) 31.64 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) 49.71 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) 70.87 kB - -
CDN Bundle (incl. Tracing, Replay) 85.9 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) 87.21 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) 91.7 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) 92.97 kB - -
CDN Bundle - uncompressed 89.58 kB - -
CDN Bundle (incl. Tracing) - uncompressed 146.33 kB - -
CDN Bundle (incl. Logs, Metrics) - uncompressed 94.29 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed 150.31 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) - uncompressed 219.02 kB - -
CDN Bundle (incl. Tracing, Replay) - uncompressed 265.54 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) - uncompressed 269.5 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 279.24 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed 283.19 kB - -
@sentry/nextjs (client) 51.22 kB - -
@sentry/sveltekit (client) 46.86 kB - -
@sentry/core/server 78.51 kB - -
@sentry/core/browser 64.86 kB - -
@sentry/node-core 62.79 kB +0.01% +1 B 🔺
@sentry/node 125.19 kB +0.01% +1 B 🔺
@sentry/node (incl. diagnostics channel injection) 140.18 kB +0.15% +202 B 🔺
@sentry/node/import (ESM hook with diagnostics-channel injection) 69.96 kB - -
@sentry/node/light 50.8 kB +0.01% +1 B 🔺
@sentry/node - without tracing 74.17 kB +0.01% +1 B 🔺
@sentry/aws-serverless 83.39 kB -0.01% -3 B 🔽
@sentry/cloudflare (withSentry) - minified 181.79 kB - -
@sentry/cloudflare (withSentry) 449.98 kB - -

View base workflow run

@logaretm logaretm force-pushed the awad/js-2408-rewrite-opentelemetryinstrumentation-knex-to-orchestrion branch 3 times, most recently from fea4e2e to f04f9e0 Compare July 13, 2026 20:46
@logaretm logaretm marked this pull request as ready for review July 13, 2026 20:53
@logaretm logaretm requested review from a team as code owners July 13, 2026 20:53
@logaretm logaretm requested review from andreiborza, isaacs and mydea and removed request for a team July 13, 2026 20:53
Comment thread packages/server-utils/src/integrations/tracing-channel/knex.ts
@logaretm logaretm force-pushed the awad/js-2408-rewrite-opentelemetryinstrumentation-knex-to-orchestrion branch from f04f9e0 to 189751c Compare July 13, 2026 21:34

@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 2 potential issues.

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 189751c. Configure here.

Comment thread packages/node/src/integrations/tracing/knex/index.ts
Comment thread packages/server-utils/src/integrations/tracing-channel/knex.ts
// Prefer the diagnostics-channel subscriber when orchestrion injected its channels; otherwise
// fall back to the vendored OTel instrumentation. `isOrchestrionInjected()` is only reliable by
// `setupOnce` (the runtime injection runs during `Sentry.init()`, after integrations are built).
if (isOrchestrionInjected()) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

is this needed, I think other integrations (at least the ones I migrated) did not use this pattern?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yep, because this is not a default integration so it wouldn't be swapped in by the existing mechanism we have.

It is similar to the one in #20749 and NestJS

@logaretm logaretm force-pushed the awad/js-2408-rewrite-opentelemetryinstrumentation-knex-to-orchestrion branch from 189751c to 204a03a Compare July 14, 2026 15:23
logaretm added 2 commits July 14, 2026 13:35
Migrate the knex integration off the vendored `InstrumentationBase`
monkey-patch onto a `node:diagnostics_channel` subscriber whose channels
are injected by the orchestrion code transform. The OTel path stays as the
fallback when orchestrion isn't injected.

knex is opt-in (not a default performance integration), so the `@sentry/node`
factory picks the path itself in `setupOnce` via `isOrchestrionInjected()`
rather than the central `channelIntegrations` swap.

`Runner.query` produces the span; `Client.queryBuilder`/`schemaBuilder`/`raw`
are wrapped for bookkeeping so the span active at builder-creation time is
reused as the parent when the query runs later.

Fixes #20757
Add an opt-in `denoKnexIntegration` that reuses the shared knex channel
subscriber from `@sentry/server-utils` and installs Deno's AsyncLocalStorage
context strategy, mirroring the other Deno DB integrations. Exported but kept
out of the default set, matching knex being opt-in on Node.
@logaretm logaretm force-pushed the awad/js-2408-rewrite-opentelemetryinstrumentation-knex-to-orchestrion branch from 9caa486 to 0fe09bf Compare July 14, 2026 17:37
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.

Rewrite @opentelemetry/instrumentation-knex to orchestrion

2 participants