feat(server-utils): Capture and log orchestrion stats#22269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timfish merged 9 commits into from
Jul 15, 2026
Merged

feat(server-utils): Capture and log orchestrion stats #22269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
300820f
feat(server-utils): Capture and log orchestrion stats
timfish Jul 14, 2026
d241716
Fix Deno tests
timfish Jul 14, 2026
b43a3f5
Lint
timfish Jul 14, 2026
9af3066
Merge remote-tracking branch 'upstream/develop' into timfish/feat/orc…
timfish Jul 15, 2026
b4f9ac0
Inject the successful modules at bundle time
timfish Jul 15, 2026
43c2038
Diagnostics hook on all Node versions
timfish Jul 15, 2026
e038103
Bump plugins
timfish Jul 15, 2026
b1cd5ac
Merge remote-tracking branch 'upstream/develop' into timfish/feat/orc…
timfish Jul 15, 2026
e70753f
Fix lock file
timfish Jul 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion dev-packages/deno-integration-tests/suites/orchestrion-mysql/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ Deno.test('@sentry/deno/import: transforms mysql so it publishes the orchestrion
// ...with the real SQL forwarded through the channel context.
assert(line.includes('statement=SELECT 1 AS solution'), `expected forwarded SQL, got: ${line}`);
// The runtime hook set its detection marker at boot.
assert(line.includes('"runtime":true'), `expected runtime marker, got: ${line}`);
assert(line.includes('"runtime":["mysql"]'), `expected runtime marker, got: ${line}`);
});

// Exercises the SDK path end-to-end: `init()` wires `denoMysqlIntegration`
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/deno-integration-tests/suites/orchestrion-postgres/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ Deno.test('@sentry/deno/import: transforms pg so it publishes the orchestrion ch
// ...with the real SQL forwarded through the channel context.
assert(line.includes('statement=SELECT 1 AS solution'), `expected forwarded SQL, got: ${line}`);
// The runtime hook set its detection marker at boot.
assert(line.includes('"runtime":true'), `expected runtime marker, got: ${line}`);
assert(line.includes('"runtime":["pg","pg-pool"]'), `expected runtime marker, got: ${line}`);
});

// Exercises the SDK path end-to-end: `init()` wires `denoPostgresIntegration`
Expand Down
2 changes: 1 addition & 1 deletion packages/bun/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,7 @@
"access": "public"
},
"dependencies": {
"@apm-js-collab/code-transformer-bundler-plugins": "^0.6.0",
"@apm-js-collab/code-transformer-bundler-plugins": "^0.6.1",
"@sentry/core": "10.65.0",
"@sentry/node": "10.65.0",
"@sentry/server-utils": "10.65.0"
Expand Down
9 changes: 9 additions & 0 deletions packages/core/src/utils/worldwide.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,15 @@ export type InternalGlobal = {
_sentryModuleMetadata?: Record<string, any>;
_sentryEsmLoaderHookRegistered?: boolean;
_sentryWrappedDepth?: number;
/**
* Orchestrion bundler and runtime detection.
*/
__SENTRY_ORCHESTRION__?: {
/** Empty array signifies runtime hooked */
runtime?: string[];
/** Empty array signifies bundler plugin ran */
bundler?: string[];
};
} & Carrier;

/** Get's the global object for the current JavaScript runtime */
Expand Down
4 changes: 2 additions & 2 deletions packages/server-utils/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,9 +116,9 @@
"access": "public"
},
"dependencies": {
"@apm-js-collab/code-transformer-bundler-plugins": "^0.6.0",
"@apm-js-collab/code-transformer-bundler-plugins": "^0.6.1",
"@apm-js-collab/code-transformer": "^0.18.0",
"@apm-js-collab/tracing-hooks": "^0.12.0",
"@apm-js-collab/tracing-hooks": "^0.13.0",
"@sentry/conventions": "^0.16.0",
"@sentry/core": "10.65.0"
},
Expand Down
6 changes: 3 additions & 3 deletions packages/server-utils/src/orchestrion/bundler/options.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,16 +13,16 @@ export type PluginOptions = {
* The `@apm-js-collab/code-transformer-bundler-plugins` options shared by every
* orchestrion bundler plugin.
*
* `injectDiagnostics` sets `globalThis.__SENTRY_ORCHESTRION__.bundler = true` at
* `injectDiagnostics` sets `globalThis.__SENTRY_ORCHESTRION__.bundler = ["mysql"]` at

@JPeer264JPeer264Jul 15, 2026

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.

Ah that is smart.

* app boot so the `_experimentalSetupOrchestrion()` detector can confirm the
* bundler path ran (rather than relying on a build-time flag that wouldn't be
* visible to the runtime).
*/
export function orchestrionTransformOptions(options: PluginOptions): Parameters<typeof codeTransformer>[0] {
return {
instrumentations: [...SENTRY_INSTRUMENTATIONS, ...(options.instrumentations || [])],
injectDiagnostics: () => {
return '(globalThis.__SENTRY_ORCHESTRION__=globalThis.__SENTRY_ORCHESTRION__||{}).bundler=true;';
injectDiagnostics: (diag: { transformedModules: string[]; failedModules: string[] }) => {
return `(globalThis.__SENTRY_ORCHESTRION__=globalThis.__SENTRY_ORCHESTRION__||{}).bundler=${JSON.stringify(diag.transformedModules)};`;
},
};
}
51 changes: 24 additions & 27 deletions packages/server-utils/src/orchestrion/detect.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
import { debug } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';

declare global {
// eslint-disable-next-line no-var
var __SENTRY_ORCHESTRION__: { runtime?: boolean; bundler?: boolean } | undefined;
}
import { debug, GLOBAL_OBJ } from '@sentry/core';

/**
* Whether orchestrion has injected the diagnostics channels into this process,
Expand All@@ -16,40 +10,43 @@ declare global {
* will ever publish to those channels.
*/
export function isOrchestrionInjected(): boolean {
const marker = globalThis.__SENTRY_ORCHESTRION__;
return !!(marker?.runtime || marker?.bundler);
return !!GLOBAL_OBJ.__SENTRY_ORCHESTRION__;
Comment thread
cursor[bot] marked this conversation as resolved.
}

/**
* Verifies that the diagnostics channels have been injected either by the
* runtime `--import` hook (or init-time registration), a bundler plugin, or
* both, and warns if not.
* both, and warns if not. When at least one injector is active, logs for each
* mechanism whether it hooked (a defined array, even empty, means it did) and
* which libraries it injected.
*
* Both injectors being active at once is fine: they operate on disjoint module
* sets (a module is either loaded through Node's loader and transformed by the
* runtime hook, or inlined by the bundler and transformed by the plugin), so
* a single module can't be double-wrapped. A hybrid setup, with some deps
* external and runtime-instrumented, others bundled and plugin-instrumented,
* is fine.
*
* Note: intentionally does NOT warn in production, only in debug builds,
* because production warnings are reserved for truly critical issues.
*/
export function detectOrchestrionSetup(): void {
if (!DEBUG_BUILD) return;
const { runtime, bundler } = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ ?? {};

const marker = globalThis.__SENTRY_ORCHESTRION__;
const runtime = !!marker?.runtime;
const bundler = !!marker?.bundler;

DEBUG_BUILD && debug.log(`[orchestrion] detect: runtime=${runtime} bundler=${bundler}`);

if (!isOrchestrionInjected()) {
DEBUG_BUILD &&
debug.warn(
'[Sentry] No diagnostics-channel injection detected. Channel-based integrations ' +
'(mysql, …) will not record spans. Make sure the diagnostics channels are injected ' +
'via the runtime `--import` hook or a bundler plugin before the instrumented modules load.',
);
if (!runtime && !bundler) {

@JPeer264JPeer264Jul 15, 2026

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.

l/m: Also here. We should check for the array length, right?

@timfishtimfishJul 15, 2026

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

If either of these are defined, we will hit the debug logging below with more details for each.

debug.warn(
'[Sentry] No diagnostics-channel injection detected. Channel-based integrations ' +
'will not record spans. Make sure the diagnostics channels are injected ' +
'via the runtime `--import` hook or a bundler plugin before the instrumented modules load.',
);
return;
}

debug.log(
runtime
? `[Sentry] Runtime hook registered, injected libraries=${JSON.stringify(runtime)}`
: '[Sentry] Runtime hook not registered',
);
debug.log(
bundler
? `[Sentry] Bundler plugin ran, injected libraries=${JSON.stringify(bundler)}`
: '[Sentry] Bundler plugin did not run',
Comment thread
timfish marked this conversation as resolved.
);
Comment thread
cursor[bot] marked this conversation as resolved.
}
52 changes: 28 additions & 24 deletions packages/server-utils/src/orchestrion/runtime/register.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
import { debug } from '@sentry/core';
import { debug, GLOBAL_OBJ } from '@sentry/core';
import { createRequire } from 'node:module';
import * as Module from 'node:module';
import { pathToFileURL } from 'node:url';
import { DEBUG_BUILD } from '../../debug-build';
import { SENTRY_INSTRUMENTATIONS } from '../config';
import type { InstrumentationConfig } from '@apm-js-collab/code-transformer';
import type { register } from 'node:module';

type TracingHooksSync = {
initialize: (opts: { instrumentations: InstrumentationConfig[] }) => void;
resolve: Function;
load: Function;
setDiagnosticsHook: (callback: (event: { url: string; moduleName: string; error: Error }) => void) => void;
};

type NodeModule = {
registerHooks?: (options: unknown) => { deregister: () => void };
register?: typeof register;
};

export interface RegisterDiagnosticsChannelInjectionOptions {
/**
Expand All@@ -17,11 +31,6 @@ export interface RegisterDiagnosticsChannelInjectionOptions {
tracingHooksDir?: string;
}

declare global {
// eslint-disable-next-line no-var
var __SENTRY_ORCHESTRION__: { runtime?: boolean; bundler?: boolean } | undefined;
}

/** `Module.registerHooks` only became stable in Node 24.13 / 25.1 and Deno 2.8. */
function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolean {
const parseVersion = (v: string): number[] => v.split('.').map(n => parseInt(n, 10));
Expand All@@ -47,15 +56,9 @@ function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolea
*
* Libraries imported *after* this call publish the `tracingChannel` events that
* the channel-based integrations subscribe to.
*
* Idempotent via `globalThis.__SENTRY_ORCHESTRION__` — a no-op if the runtime
* `--import` hook or a bundler plugin already injected the channels.
*/
export function registerDiagnosticsChannelInjection(options?: RegisterDiagnosticsChannelInjectionOptions): void {
const g = (globalThis.__SENTRY_ORCHESTRION__ ??= {});

// Already injected (runtime --import hook or bundler plugin) — nothing to do.
if (g.runtime) {
if (GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime) {

@JPeer264JPeer264Jul 15, 2026

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.

m: Shouldn't this be the following?

Suggested change
if(GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime){
if(!!GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime.length){

@timfishtimfishJul 15, 2026•
edited
Loading

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

No, an empty array signifies that the the hooks have been setup:

https://github.com/getsentry/sentry-javascript/pull/22269/changes#diff-61b304378c94fe3c1e3d2612639b4dc1199e5d693369321365c546bae700494dR168

@JPeer264JPeer264Jul 15, 2026

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.

Smart

return;
}

Expand DownExpand Up@@ -89,10 +92,7 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic

// `Module.registerHooks` / `Module.register` are newer than the @types/node
// we build against, hence the cast.
const mod = Module as unknown as {
registerHooks?: (hooks: unknown) => void;
register?: (specifier: string, options: unknown) => void;
};
const mod = Module as NodeModule;

// runs both at `--import` time and (synchronously) inside `Sentry.init()`,
// so an unguarded throw would either abort startup or make `init()` throw.
Expand All@@ -105,15 +105,18 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
// We require() the module here so that we can synchronously load it,
// including from a CommonJS Sentry build, without bundlers pulling in.
// All versions in stableSyncHooks support this.
const { initialize, resolve, load } = (
const { initialize, resolve, load, setDiagnosticsHook } = (
requireFromHooksDir
? requireFromHooksDir(`${tracingHooksDir}/hook-sync.mjs`)
: nodeRequire('@apm-js-collab/tracing-hooks/hook-sync.mjs')
) as {
initialize: (opts: { instrumentations: unknown }) => void;
resolve: unknown;
load: unknown;
};
) as TracingHooksSync;

setDiagnosticsHook(event => {
GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(event.moduleName);
});

Comment thread
cursor[bot] marked this conversation as resolved.
initialize({ instrumentations: SENTRY_INSTRUMENTATIONS });
mod.registerHooks({ resolve, load });
DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.registerHooks()');
Expand DownExpand Up@@ -161,5 +164,6 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
return;
}

g.runtime = true;
GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
}
16 changes: 8 additions & 8 deletions yarn.lock
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -404,10 +404,10 @@
dependencies:
json-schema-to-ts "^3.1.1"

"@apm-js-collab/code-transformer-bundler-plugins@^0.6.0":
version "0.6.0"
resolved "https://registry.yarnpkg.com/@apm-js-collab/code-transformer-bundler-plugins/-/code-transformer-bundler-plugins-0.6.0.tgz#ed64bae9e1871366eadc1ef6dabc9ee6ccc53e57"
integrity sha512-Hys7LDskIB/BNrd87GAfYWHRE3mWgcPYonK4W9uxjho4N0JnPKk2YQyOLlqmkyVhj2UzwLRpmbJ4D6uR9O7wyw==
"@apm-js-collab/code-transformer-bundler-plugins@^0.6.1":
version "0.6.1"
resolved "https://registry.yarnpkg.com/@apm-js-collab/code-transformer-bundler-plugins/-/code-transformer-bundler-plugins-0.6.1.tgz#29bf79167411b8607f02db177250b8f7c16d93e1"
integrity sha512-TDvypsLUk/W202Y1JBE6I2enQalWjbYXKnxpELWEZn6GLoIcGFii69ljh948hdAzKZJ/wg0Uwivz72a/szoOBQ==
dependencies:
"@apm-js-collab/code-transformer" "^0.18.0"
es-module-lexer "^2.1.0"
Expand All@@ -426,10 +426,10 @@
semifies "^1.0.0"
source-map "^0.6.0"

"@apm-js-collab/tracing-hooks@^0.12.0":
version "0.12.0"
resolved "https://registry.yarnpkg.com/@apm-js-collab/tracing-hooks/-/tracing-hooks-0.12.0.tgz#b65505d1d075fc8d8f4fa1973c37eaa9a9975b3f"
integrity sha512-U1cDbHOFbeToq5VWNcroBtQpz3hfH39uLkzJ5lorBFVNhHbTNj5MQvP+jODDwxBkG6A/agbQelG15rEoDgnjWg==
"@apm-js-collab/tracing-hooks@^0.13.0":
version "0.13.0"
resolved "https://registry.yarnpkg.com/@apm-js-collab/tracing-hooks/-/tracing-hooks-0.13.0.tgz#20b2f77ec7a0e5dfd9fbf2215b56e2c2b7f41e4b"
integrity sha512-mTvWz9rnQwx1U3h0XPTHaX7bgfkpipLLTQyjlC2cdhQpQEuoLT0AGzoydeoq2NxfEVv6fWOOETcSbb2nptleyw==
dependencies:
"@apm-js-collab/code-transformer" "^0.18.0"
debug "^4.4.1"
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(server-utils): Capture and log orchestrion stats#22269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

timfish
merged 9 commits into

from

Jul 15, 2026
 Merged


feat(server-utils): Capture and log orchestrion stats
#22269
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
300820f

feat(server-utils): Capture and log orchestrion stats


timfish Jul 14, 2026
d241716

Fix Deno tests


timfish Jul 14, 2026
b43a3f5

Lint


timfish Jul 14, 2026
9af3066

Merge remote-tracking branch 'upstream/develop' into timfish/feat/orc…


timfish Jul 15, 2026
b4f9ac0

Inject the successful modules at bundle time


timfish Jul 15, 2026
43c2038

Diagnostics hook on all Node versions


timfish Jul 15, 2026
e038103

Bump plugins


timfish Jul 15, 2026
b1cd5ac

Merge remote-tracking branch 'upstream/develop' into timfish/feat/orc…


timfish Jul 15, 2026
e70753f

Fix lock file


timfish Jul 15, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
dev-packages/deno-integration-tests/suites/orchestrion-mysql/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ Deno.test('@sentry/deno/import: transforms mysql so it publishes the orchestrion
 // ...with the real SQL forwarded through the channel context.
 assert(line.includes('statement=SELECT 1 AS solution'), `expected forwarded SQL, got: ${line}`);
 // The runtime hook set its detection marker at boot.
 assert(line.includes('"runtime":true'), `expected runtime marker, got: ${line}`);
 assert(line.includes('"runtime":["mysql"]'), `expected runtime marker, got: ${line}`);
});

// Exercises the SDK path end-to-end: `init()` wires `denoMysqlIntegration`
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/deno-integration-tests/suites/orchestrion-postgres/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ Deno.test('@sentry/deno/import: transforms pg so it publishes the orchestrion ch
 // ...with the real SQL forwarded through the channel context.
 assert(line.includes('statement=SELECT 1 AS solution'), `expected forwarded SQL, got: ${line}`);
 // The runtime hook set its detection marker at boot.
 assert(line.includes('"runtime":true'), `expected runtime marker, got: ${line}`);
 assert(line.includes('"runtime":["pg","pg-pool"]'), `expected runtime marker, got: ${line}`);
});

// Exercises the SDK path end-to-end: `init()` wires `denoPostgresIntegration`
Expand Down

2 changes: 1 addition & 1 deletion
packages/bun/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,7 @@
 "access": "public"
 },
 "dependencies": {
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.0",
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.1",
 "@sentry/core": "10.65.0",
 "@sentry/node": "10.65.0",
 "@sentry/server-utils": "10.65.0"
Expand Down

9 changes: 9 additions & 0 deletions
packages/core/src/utils/worldwide.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,15 @@ export type InternalGlobal = {
 _sentryModuleMetadata?: Record<string, any>;
 _sentryEsmLoaderHookRegistered?: boolean;
 _sentryWrappedDepth?: number;
 /**
 * Orchestrion bundler and runtime detection.
 */
 __SENTRY_ORCHESTRION__?: {
 /** Empty array signifies runtime hooked */
 runtime?: string[];
 /** Empty array signifies bundler plugin ran */
 bundler?: string[];
 };
} & Carrier;

/** Get's the global object for the current JavaScript runtime */
Expand Down

4 changes: 2 additions & 2 deletions
packages/server-utils/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,9 +116,9 @@
 "access": "public"
 },
 "dependencies": {
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.0",
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.1",
 "@apm-js-collab/code-transformer": "^0.18.0",
 "@apm-js-collab/tracing-hooks": "^0.12.0",
 "@apm-js-collab/tracing-hooks": "^0.13.0",
 "@sentry/conventions": "^0.16.0",
 "@sentry/core": "10.65.0"
 },
Expand Down

6 changes: 3 additions & 3 deletions
packages/server-utils/src/orchestrion/bundler/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,16 +13,16 @@ export type PluginOptions = {
 * The `@apm-js-collab/code-transformer-bundler-plugins` options shared by every
 * orchestrion bundler plugin.
 *
 * `injectDiagnostics` sets `globalThis.__SENTRY_ORCHESTRION__.bundler = true` at
 * `injectDiagnostics` sets `globalThis.__SENTRY_ORCHESTRION__.bundler = ["mysql"]` at
@JPeer264JPeer264Jul 15, 2026

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.

Ah that is smart.
 * app boot so the `_experimentalSetupOrchestrion()` detector can confirm the
 * bundler path ran (rather than relying on a build-time flag that wouldn't be
 * visible to the runtime).
 */
export function orchestrionTransformOptions(options: PluginOptions): Parameters<typeof codeTransformer>[0] {
 return {
 instrumentations: [...SENTRY_INSTRUMENTATIONS, ...(options.instrumentations || [])],
 injectDiagnostics: () => {
 return '(globalThis.__SENTRY_ORCHESTRION__=globalThis.__SENTRY_ORCHESTRION__||{}).bundler=true;';
 injectDiagnostics: (diag: { transformedModules: string[]; failedModules: string[] }) => {
 return `(globalThis.__SENTRY_ORCHESTRION__=globalThis.__SENTRY_ORCHESTRION__||{}).bundler=${JSON.stringify(diag.transformedModules)};`;
 },
 };
}

51 changes: 24 additions & 27 deletions
packages/server-utils/src/orchestrion/detect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
import { debug } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';

declare global {
 // eslint-disable-next-line no-var
 var __SENTRY_ORCHESTRION__: { runtime?: boolean; bundler?: boolean } | undefined;
}
import { debug, GLOBAL_OBJ } from '@sentry/core';

/**
 * Whether orchestrion has injected the diagnostics channels into this process,
Expand All@@ -16,40 +10,43 @@ declare global {
 * will ever publish to those channels.
 */
export function isOrchestrionInjected(): boolean {
 const marker = globalThis.__SENTRY_ORCHESTRION__;
 return !!(marker?.runtime || marker?.bundler);
 return !!GLOBAL_OBJ.__SENTRY_ORCHESTRION__;
Comment thread
cursor[bot] marked this conversation as resolved.

}

/**
 * Verifies that the diagnostics channels have been injected either by the
 * runtime `--import` hook (or init-time registration), a bundler plugin, or
 * both, and warns if not.
 * both, and warns if not. When at least one injector is active, logs for each
 * mechanism whether it hooked (a defined array, even empty, means it did) and
 * which libraries it injected.
 *
 * Both injectors being active at once is fine: they operate on disjoint module
 * sets (a module is either loaded through Node's loader and transformed by the
 * runtime hook, or inlined by the bundler and transformed by the plugin), so
 * a single module can't be double-wrapped. A hybrid setup, with some deps
 * external and runtime-instrumented, others bundled and plugin-instrumented,
 * is fine.
 *
 * Note: intentionally does NOT warn in production, only in debug builds,
 * because production warnings are reserved for truly critical issues.
 */
export function detectOrchestrionSetup(): void {
if (!DEBUG_BUILD) return;
const { runtime, bundler } = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ ?? {};

 const marker = globalThis.__SENTRY_ORCHESTRION__;
 const runtime = !!marker?.runtime;
 const bundler = !!marker?.bundler;

 DEBUG_BUILD && debug.log(`[orchestrion] detect: runtime=${runtime} bundler=${bundler}`);

 if (!isOrchestrionInjected()) {
 DEBUG_BUILD &&
 debug.warn(
 '[Sentry] No diagnostics-channel injection detected. Channel-based integrations ' +
 '(mysql, …) will not record spans. Make sure the diagnostics channels are injected ' +
 'via the runtime `--import` hook or a bundler plugin before the instrumented modules load.',
 );
 if (!runtime && !bundler) {
@JPeer264JPeer264Jul 15, 2026

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.

l/m: Also here. We should check for the array length, right?
@timfishtimfishJul 15, 2026

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

If either of these are defined, we will hit the debug logging below with more details for each.
 debug.warn(
 '[Sentry] No diagnostics-channel injection detected. Channel-based integrations ' +
 'will not record spans. Make sure the diagnostics channels are injected ' +
 'via the runtime `--import` hook or a bundler plugin before the instrumented modules load.',
 );
 return;
 }

 debug.log(
 runtime
 ? `[Sentry] Runtime hook registered, injected libraries=${JSON.stringify(runtime)}`
 : '[Sentry] Runtime hook not registered',
 );
 debug.log(
 bundler
 ? `[Sentry] Bundler plugin ran, injected libraries=${JSON.stringify(bundler)}`
 : '[Sentry] Bundler plugin did not run',
Comment thread
timfish marked this conversation as resolved.

 );
Comment thread
cursor[bot] marked this conversation as resolved.

}

52 changes: 28 additions & 24 deletions
packages/server-utils/src/orchestrion/runtime/register.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
import { debug } from '@sentry/core';
import { debug, GLOBAL_OBJ } from '@sentry/core';
import { createRequire } from 'node:module';
import * as Module from 'node:module';
import { pathToFileURL } from 'node:url';
import { DEBUG_BUILD } from '../../debug-build';
import { SENTRY_INSTRUMENTATIONS } from '../config';
import type { InstrumentationConfig } from '@apm-js-collab/code-transformer';
import type { register } from 'node:module';

type TracingHooksSync = {
 initialize: (opts: { instrumentations: InstrumentationConfig[] }) => void;
 resolve: Function;
 load: Function;
 setDiagnosticsHook: (callback: (event: { url: string; moduleName: string; error: Error }) => void) => void;
};

type NodeModule = {
 registerHooks?: (options: unknown) => { deregister: () => void };
 register?: typeof register;
};

export interface RegisterDiagnosticsChannelInjectionOptions {
 /**
Expand All@@ -17,11 +31,6 @@ export interface RegisterDiagnosticsChannelInjectionOptions {
 tracingHooksDir?: string;
}

declare global {
 // eslint-disable-next-line no-var
 var __SENTRY_ORCHESTRION__: { runtime?: boolean; bundler?: boolean } | undefined;
}

/** `Module.registerHooks` only became stable in Node 24.13 / 25.1 and Deno 2.8. */
function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolean {
 const parseVersion = (v: string): number[] => v.split('.').map(n => parseInt(n, 10));
Expand All@@ -47,15 +56,9 @@ function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolea
 *
 * Libraries imported *after* this call publish the `tracingChannel` events that
 * the channel-based integrations subscribe to.
 *
 * Idempotent via `globalThis.__SENTRY_ORCHESTRION__` — a no-op if the runtime
 * `--import` hook or a bundler plugin already injected the channels.
 */
export function registerDiagnosticsChannelInjection(options?: RegisterDiagnosticsChannelInjectionOptions): void {
 const g = (globalThis.__SENTRY_ORCHESTRION__ ??= {});

 // Already injected (runtime --import hook or bundler plugin) — nothing to do.
 if (g.runtime) {
 if (GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime) {
@JPeer264JPeer264Jul 15, 2026

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.

m: Shouldn't this be the following?

Suggested change

if(GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime){
if(!!GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime.length){
@timfishtimfishJul 15, 2026•

edited

Loading

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

No, an empty array signifies that the the hooks have been setup:
https://github.com/getsentry/sentry-javascript/pull/22269/changes#diff-61b304378c94fe3c1e3d2612639b4dc1199e5d693369321365c546bae700494dR168
@JPeer264JPeer264Jul 15, 2026

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.

Smart
 return;
 }

Expand DownExpand Up@@ -89,10 +92,7 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic

 // `Module.registerHooks` / `Module.register` are newer than the @types/node
 // we build against, hence the cast.
 const mod = Module as unknown as {
 registerHooks?: (hooks: unknown) => void;
 register?: (specifier: string, options: unknown) => void;
 };
 const mod = Module as NodeModule;

 // runs both at `--import` time and (synchronously) inside `Sentry.init()`,
 // so an unguarded throw would either abort startup or make `init()` throw.
Expand All@@ -105,15 +105,18 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 // We require() the module here so that we can synchronously load it,
 // including from a CommonJS Sentry build, without bundlers pulling in.
 // All versions in stableSyncHooks support this.
 const { initialize, resolve, load } = (
 const { initialize, resolve, load, setDiagnosticsHook } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/hook-sync.mjs`)
 : nodeRequire('@apm-js-collab/tracing-hooks/hook-sync.mjs')
 ) as {
 initialize: (opts: { instrumentations: unknown }) => void;
 resolve: unknown;
 load: unknown;
 };
 ) as TracingHooksSync;

 setDiagnosticsHook(event => {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(event.moduleName);
 });

Comment thread
cursor[bot] marked this conversation as resolved.

 initialize({ instrumentations: SENTRY_INSTRUMENTATIONS });
 mod.registerHooks({ resolve, load });
 DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.registerHooks()');
Expand DownExpand Up@@ -161,5 +164,6 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 return;
 }

 g.runtime = true;
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
}

16 changes: 8 additions & 8 deletions
yarn.lock

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -404,10 +404,10 @@
 dependencies:
 json-schema-to-ts "^3.1.1"

"@apm-js-collab/code-transformer-bundler-plugins@^0.6.0":
 version "0.6.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/code-transformer-bundler-plugins/-/code-transformer-bundler-plugins-0.6.0.tgz#ed64bae9e1871366eadc1ef6dabc9ee6ccc53e57"
 integrity sha512-Hys7LDskIB/BNrd87GAfYWHRE3mWgcPYonK4W9uxjho4N0JnPKk2YQyOLlqmkyVhj2UzwLRpmbJ4D6uR9O7wyw==
"@apm-js-collab/code-transformer-bundler-plugins@^0.6.1":
 version "0.6.1"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/code-transformer-bundler-plugins/-/code-transformer-bundler-plugins-0.6.1.tgz#29bf79167411b8607f02db177250b8f7c16d93e1"
 integrity sha512-TDvypsLUk/W202Y1JBE6I2enQalWjbYXKnxpELWEZn6GLoIcGFii69ljh948hdAzKZJ/wg0Uwivz72a/szoOBQ==
 dependencies:
 "@apm-js-collab/code-transformer" "^0.18.0"
 es-module-lexer "^2.1.0"
Expand All@@ -426,10 +426,10 @@
 semifies "^1.0.0"
 source-map "^0.6.0"

"@apm-js-collab/tracing-hooks@^0.12.0":
 version "0.12.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/tracing-hooks/-/tracing-hooks-0.12.0.tgz#b65505d1d075fc8d8f4fa1973c37eaa9a9975b3f"
 integrity sha512-U1cDbHOFbeToq5VWNcroBtQpz3hfH39uLkzJ5lorBFVNhHbTNj5MQvP+jODDwxBkG6A/agbQelG15rEoDgnjWg==
"@apm-js-collab/tracing-hooks@^0.13.0":
 version "0.13.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/tracing-hooks/-/tracing-hooks-0.13.0.tgz#20b2f77ec7a0e5dfd9fbf2215b56e2c2b7f41e4b"
 integrity sha512-mTvWz9rnQwx1U3h0XPTHaX7bgfkpipLLTQyjlC2cdhQpQEuoLT0AGzoydeoq2NxfEVv6fWOOETcSbb2nptleyw==
 dependencies:
 "@apm-js-collab/code-transformer" "^0.18.0"
 debug "^4.4.1"
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(server-utils): Capture and log orchestrion stats#22269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

timfish
merged 9 commits into

from

Jul 15, 2026
 Merged


feat(server-utils): Capture and log orchestrion stats
#22269
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
300820f

feat(server-utils): Capture and log orchestrion stats


timfish Jul 14, 2026
d241716

Fix Deno tests


timfish Jul 14, 2026
b43a3f5

Lint


timfish Jul 14, 2026
9af3066

Merge remote-tracking branch 'upstream/develop' into timfish/feat/orc…


timfish Jul 15, 2026
b4f9ac0

Inject the successful modules at bundle time


timfish Jul 15, 2026
43c2038

Diagnostics hook on all Node versions


timfish Jul 15, 2026
e038103

Bump plugins


timfish Jul 15, 2026
b1cd5ac

Merge remote-tracking branch 'upstream/develop' into timfish/feat/orc…


timfish Jul 15, 2026
e70753f

Fix lock file


timfish Jul 15, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
dev-packages/deno-integration-tests/suites/orchestrion-mysql/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ Deno.test('@sentry/deno/import: transforms mysql so it publishes the orchestrion
 // ...with the real SQL forwarded through the channel context.
 assert(line.includes('statement=SELECT 1 AS solution'), `expected forwarded SQL, got: ${line}`);
 // The runtime hook set its detection marker at boot.
 assert(line.includes('"runtime":true'), `expected runtime marker, got: ${line}`);
 assert(line.includes('"runtime":["mysql"]'), `expected runtime marker, got: ${line}`);
});

// Exercises the SDK path end-to-end: `init()` wires `denoMysqlIntegration`
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/deno-integration-tests/suites/orchestrion-postgres/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ Deno.test('@sentry/deno/import: transforms pg so it publishes the orchestrion ch
 // ...with the real SQL forwarded through the channel context.
 assert(line.includes('statement=SELECT 1 AS solution'), `expected forwarded SQL, got: ${line}`);
 // The runtime hook set its detection marker at boot.
 assert(line.includes('"runtime":true'), `expected runtime marker, got: ${line}`);
 assert(line.includes('"runtime":["pg","pg-pool"]'), `expected runtime marker, got: ${line}`);
});

// Exercises the SDK path end-to-end: `init()` wires `denoPostgresIntegration`
Expand Down

2 changes: 1 addition & 1 deletion
packages/bun/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,7 @@
 "access": "public"
 },
 "dependencies": {
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.0",
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.1",
 "@sentry/core": "10.65.0",
 "@sentry/node": "10.65.0",
 "@sentry/server-utils": "10.65.0"
Expand Down

9 changes: 9 additions & 0 deletions
packages/core/src/utils/worldwide.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,15 @@ export type InternalGlobal = {
 _sentryModuleMetadata?: Record<string, any>;
 _sentryEsmLoaderHookRegistered?: boolean;
 _sentryWrappedDepth?: number;
 /**
 * Orchestrion bundler and runtime detection.
 */
 __SENTRY_ORCHESTRION__?: {
 /** Empty array signifies runtime hooked */
 runtime?: string[];
 /** Empty array signifies bundler plugin ran */
 bundler?: string[];
 };
} & Carrier;

/** Get's the global object for the current JavaScript runtime */
Expand Down

4 changes: 2 additions & 2 deletions
packages/server-utils/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,9 +116,9 @@
 "access": "public"
 },
 "dependencies": {
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.0",
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.1",
 "@apm-js-collab/code-transformer": "^0.18.0",
 "@apm-js-collab/tracing-hooks": "^0.12.0",
 "@apm-js-collab/tracing-hooks": "^0.13.0",
 "@sentry/conventions": "^0.16.0",
 "@sentry/core": "10.65.0"
 },
Expand Down

6 changes: 3 additions & 3 deletions
packages/server-utils/src/orchestrion/bundler/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,16 +13,16 @@ export type PluginOptions = {
 * The `@apm-js-collab/code-transformer-bundler-plugins` options shared by every
 * orchestrion bundler plugin.
 *
 * `injectDiagnostics` sets `globalThis.__SENTRY_ORCHESTRION__.bundler = true` at
 * `injectDiagnostics` sets `globalThis.__SENTRY_ORCHESTRION__.bundler = ["mysql"]` at
@JPeer264JPeer264Jul 15, 2026

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.

Ah that is smart.
 * app boot so the `_experimentalSetupOrchestrion()` detector can confirm the
 * bundler path ran (rather than relying on a build-time flag that wouldn't be
 * visible to the runtime).
 */
export function orchestrionTransformOptions(options: PluginOptions): Parameters<typeof codeTransformer>[0] {
 return {
 instrumentations: [...SENTRY_INSTRUMENTATIONS, ...(options.instrumentations || [])],
 injectDiagnostics: () => {
 return '(globalThis.__SENTRY_ORCHESTRION__=globalThis.__SENTRY_ORCHESTRION__||{}).bundler=true;';
 injectDiagnostics: (diag: { transformedModules: string[]; failedModules: string[] }) => {
 return `(globalThis.__SENTRY_ORCHESTRION__=globalThis.__SENTRY_ORCHESTRION__||{}).bundler=${JSON.stringify(diag.transformedModules)};`;
 },
 };
}

51 changes: 24 additions & 27 deletions
packages/server-utils/src/orchestrion/detect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
import { debug } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';

declare global {
 // eslint-disable-next-line no-var
 var __SENTRY_ORCHESTRION__: { runtime?: boolean; bundler?: boolean } | undefined;
}
import { debug, GLOBAL_OBJ } from '@sentry/core';

/**
 * Whether orchestrion has injected the diagnostics channels into this process,
Expand All@@ -16,40 +10,43 @@ declare global {
 * will ever publish to those channels.
 */
export function isOrchestrionInjected(): boolean {
 const marker = globalThis.__SENTRY_ORCHESTRION__;
 return !!(marker?.runtime || marker?.bundler);
 return !!GLOBAL_OBJ.__SENTRY_ORCHESTRION__;
Comment thread
cursor[bot] marked this conversation as resolved.

}

/**
 * Verifies that the diagnostics channels have been injected either by the
 * runtime `--import` hook (or init-time registration), a bundler plugin, or
 * both, and warns if not.
 * both, and warns if not. When at least one injector is active, logs for each
 * mechanism whether it hooked (a defined array, even empty, means it did) and
 * which libraries it injected.
 *
 * Both injectors being active at once is fine: they operate on disjoint module
 * sets (a module is either loaded through Node's loader and transformed by the
 * runtime hook, or inlined by the bundler and transformed by the plugin), so
 * a single module can't be double-wrapped. A hybrid setup, with some deps
 * external and runtime-instrumented, others bundled and plugin-instrumented,
 * is fine.
 *
 * Note: intentionally does NOT warn in production, only in debug builds,
 * because production warnings are reserved for truly critical issues.
 */
export function detectOrchestrionSetup(): void {
if (!DEBUG_BUILD) return;
const { runtime, bundler } = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ ?? {};

 const marker = globalThis.__SENTRY_ORCHESTRION__;
 const runtime = !!marker?.runtime;
 const bundler = !!marker?.bundler;

 DEBUG_BUILD && debug.log(`[orchestrion] detect: runtime=${runtime} bundler=${bundler}`);

 if (!isOrchestrionInjected()) {
 DEBUG_BUILD &&
 debug.warn(
 '[Sentry] No diagnostics-channel injection detected. Channel-based integrations ' +
 '(mysql, …) will not record spans. Make sure the diagnostics channels are injected ' +
 'via the runtime `--import` hook or a bundler plugin before the instrumented modules load.',
 );
 if (!runtime && !bundler) {
@JPeer264JPeer264Jul 15, 2026

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.

l/m: Also here. We should check for the array length, right?
@timfishtimfishJul 15, 2026

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

If either of these are defined, we will hit the debug logging below with more details for each.
 debug.warn(
 '[Sentry] No diagnostics-channel injection detected. Channel-based integrations ' +
 'will not record spans. Make sure the diagnostics channels are injected ' +
 'via the runtime `--import` hook or a bundler plugin before the instrumented modules load.',
 );
 return;
 }

 debug.log(
 runtime
 ? `[Sentry] Runtime hook registered, injected libraries=${JSON.stringify(runtime)}`
 : '[Sentry] Runtime hook not registered',
 );
 debug.log(
 bundler
 ? `[Sentry] Bundler plugin ran, injected libraries=${JSON.stringify(bundler)}`
 : '[Sentry] Bundler plugin did not run',
Comment thread
timfish marked this conversation as resolved.

 );
Comment thread
cursor[bot] marked this conversation as resolved.

}

52 changes: 28 additions & 24 deletions
packages/server-utils/src/orchestrion/runtime/register.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
import { debug } from '@sentry/core';
import { debug, GLOBAL_OBJ } from '@sentry/core';
import { createRequire } from 'node:module';
import * as Module from 'node:module';
import { pathToFileURL } from 'node:url';
import { DEBUG_BUILD } from '../../debug-build';
import { SENTRY_INSTRUMENTATIONS } from '../config';
import type { InstrumentationConfig } from '@apm-js-collab/code-transformer';
import type { register } from 'node:module';

type TracingHooksSync = {
 initialize: (opts: { instrumentations: InstrumentationConfig[] }) => void;
 resolve: Function;
 load: Function;
 setDiagnosticsHook: (callback: (event: { url: string; moduleName: string; error: Error }) => void) => void;
};

type NodeModule = {
 registerHooks?: (options: unknown) => { deregister: () => void };
 register?: typeof register;
};

export interface RegisterDiagnosticsChannelInjectionOptions {
 /**
Expand All@@ -17,11 +31,6 @@ export interface RegisterDiagnosticsChannelInjectionOptions {
 tracingHooksDir?: string;
}

declare global {
 // eslint-disable-next-line no-var
 var __SENTRY_ORCHESTRION__: { runtime?: boolean; bundler?: boolean } | undefined;
}

/** `Module.registerHooks` only became stable in Node 24.13 / 25.1 and Deno 2.8. */
function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolean {
 const parseVersion = (v: string): number[] => v.split('.').map(n => parseInt(n, 10));
Expand All@@ -47,15 +56,9 @@ function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolea
 *
 * Libraries imported *after* this call publish the `tracingChannel` events that
 * the channel-based integrations subscribe to.
 *
 * Idempotent via `globalThis.__SENTRY_ORCHESTRION__` — a no-op if the runtime
 * `--import` hook or a bundler plugin already injected the channels.
 */
export function registerDiagnosticsChannelInjection(options?: RegisterDiagnosticsChannelInjectionOptions): void {
 const g = (globalThis.__SENTRY_ORCHESTRION__ ??= {});

 // Already injected (runtime --import hook or bundler plugin) — nothing to do.
 if (g.runtime) {
 if (GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime) {
@JPeer264JPeer264Jul 15, 2026

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.

m: Shouldn't this be the following?

Suggested change

if(GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime){
if(!!GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime.length){
@timfishtimfishJul 15, 2026•

edited

Loading

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

No, an empty array signifies that the the hooks have been setup:
https://github.com/getsentry/sentry-javascript/pull/22269/changes#diff-61b304378c94fe3c1e3d2612639b4dc1199e5d693369321365c546bae700494dR168
@JPeer264JPeer264Jul 15, 2026

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.

Smart
 return;
 }

Expand DownExpand Up@@ -89,10 +92,7 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic

 // `Module.registerHooks` / `Module.register` are newer than the @types/node
 // we build against, hence the cast.
 const mod = Module as unknown as {
 registerHooks?: (hooks: unknown) => void;
 register?: (specifier: string, options: unknown) => void;
 };
 const mod = Module as NodeModule;

 // runs both at `--import` time and (synchronously) inside `Sentry.init()`,
 // so an unguarded throw would either abort startup or make `init()` throw.
Expand All@@ -105,15 +105,18 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 // We require() the module here so that we can synchronously load it,
 // including from a CommonJS Sentry build, without bundlers pulling in.
 // All versions in stableSyncHooks support this.
 const { initialize, resolve, load } = (
 const { initialize, resolve, load, setDiagnosticsHook } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/hook-sync.mjs`)
 : nodeRequire('@apm-js-collab/tracing-hooks/hook-sync.mjs')
 ) as {
 initialize: (opts: { instrumentations: unknown }) => void;
 resolve: unknown;
 load: unknown;
 };
 ) as TracingHooksSync;

 setDiagnosticsHook(event => {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(event.moduleName);
 });

Comment thread
cursor[bot] marked this conversation as resolved.

 initialize({ instrumentations: SENTRY_INSTRUMENTATIONS });
 mod.registerHooks({ resolve, load });
 DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.registerHooks()');
Expand DownExpand Up@@ -161,5 +164,6 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 return;
 }

 g.runtime = true;
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
}

16 changes: 8 additions & 8 deletions
yarn.lock

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -404,10 +404,10 @@
 dependencies:
 json-schema-to-ts "^3.1.1"

"@apm-js-collab/code-transformer-bundler-plugins@^0.6.0":
 version "0.6.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/code-transformer-bundler-plugins/-/code-transformer-bundler-plugins-0.6.0.tgz#ed64bae9e1871366eadc1ef6dabc9ee6ccc53e57"
 integrity sha512-Hys7LDskIB/BNrd87GAfYWHRE3mWgcPYonK4W9uxjho4N0JnPKk2YQyOLlqmkyVhj2UzwLRpmbJ4D6uR9O7wyw==
"@apm-js-collab/code-transformer-bundler-plugins@^0.6.1":
 version "0.6.1"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/code-transformer-bundler-plugins/-/code-transformer-bundler-plugins-0.6.1.tgz#29bf79167411b8607f02db177250b8f7c16d93e1"
 integrity sha512-TDvypsLUk/W202Y1JBE6I2enQalWjbYXKnxpELWEZn6GLoIcGFii69ljh948hdAzKZJ/wg0Uwivz72a/szoOBQ==
 dependencies:
 "@apm-js-collab/code-transformer" "^0.18.0"
 es-module-lexer "^2.1.0"
Expand All@@ -426,10 +426,10 @@
 semifies "^1.0.0"
 source-map "^0.6.0"

"@apm-js-collab/tracing-hooks@^0.12.0":
 version "0.12.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/tracing-hooks/-/tracing-hooks-0.12.0.tgz#b65505d1d075fc8d8f4fa1973c37eaa9a9975b3f"
 integrity sha512-U1cDbHOFbeToq5VWNcroBtQpz3hfH39uLkzJ5lorBFVNhHbTNj5MQvP+jODDwxBkG6A/agbQelG15rEoDgnjWg==
"@apm-js-collab/tracing-hooks@^0.13.0":
 version "0.13.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/tracing-hooks/-/tracing-hooks-0.13.0.tgz#20b2f77ec7a0e5dfd9fbf2215b56e2c2b7f41e4b"
 integrity sha512-mTvWz9rnQwx1U3h0XPTHaX7bgfkpipLLTQyjlC2cdhQpQEuoLT0AGzoydeoq2NxfEVv6fWOOETcSbb2nptleyw==
 dependencies:
 "@apm-js-collab/code-transformer" "^0.18.0"
 debug "^4.4.1"
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(server-utils): Capture and log orchestrion stats#22269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

timfish
merged 9 commits into

from

Jul 15, 2026
 Merged


feat(server-utils): Capture and log orchestrion stats
#22269
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
300820f

feat(server-utils): Capture and log orchestrion stats


timfish Jul 14, 2026
d241716

Fix Deno tests


timfish Jul 14, 2026
b43a3f5

Lint


timfish Jul 14, 2026
9af3066

Merge remote-tracking branch 'upstream/develop' into timfish/feat/orc…


timfish Jul 15, 2026
b4f9ac0

Inject the successful modules at bundle time


timfish Jul 15, 2026
43c2038

Diagnostics hook on all Node versions


timfish Jul 15, 2026
e038103

Bump plugins


timfish Jul 15, 2026
b1cd5ac

Merge remote-tracking branch 'upstream/develop' into timfish/feat/orc…


timfish Jul 15, 2026
e70753f

Fix lock file


timfish Jul 15, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
dev-packages/deno-integration-tests/suites/orchestrion-mysql/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ Deno.test('@sentry/deno/import: transforms mysql so it publishes the orchestrion
 // ...with the real SQL forwarded through the channel context.
 assert(line.includes('statement=SELECT 1 AS solution'), `expected forwarded SQL, got: ${line}`);
 // The runtime hook set its detection marker at boot.
 assert(line.includes('"runtime":true'), `expected runtime marker, got: ${line}`);
 assert(line.includes('"runtime":["mysql"]'), `expected runtime marker, got: ${line}`);
});

// Exercises the SDK path end-to-end: `init()` wires `denoMysqlIntegration`
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/deno-integration-tests/suites/orchestrion-postgres/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ Deno.test('@sentry/deno/import: transforms pg so it publishes the orchestrion ch
 // ...with the real SQL forwarded through the channel context.
 assert(line.includes('statement=SELECT 1 AS solution'), `expected forwarded SQL, got: ${line}`);
 // The runtime hook set its detection marker at boot.
 assert(line.includes('"runtime":true'), `expected runtime marker, got: ${line}`);
 assert(line.includes('"runtime":["pg","pg-pool"]'), `expected runtime marker, got: ${line}`);
});

// Exercises the SDK path end-to-end: `init()` wires `denoPostgresIntegration`
Expand Down

2 changes: 1 addition & 1 deletion
packages/bun/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,7 @@
 "access": "public"
 },
 "dependencies": {
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.0",
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.1",
 "@sentry/core": "10.65.0",
 "@sentry/node": "10.65.0",
 "@sentry/server-utils": "10.65.0"
Expand Down

9 changes: 9 additions & 0 deletions
packages/core/src/utils/worldwide.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,15 @@ export type InternalGlobal = {
 _sentryModuleMetadata?: Record<string, any>;
 _sentryEsmLoaderHookRegistered?: boolean;
 _sentryWrappedDepth?: number;
 /**
 * Orchestrion bundler and runtime detection.
 */
 __SENTRY_ORCHESTRION__?: {
 /** Empty array signifies runtime hooked */
 runtime?: string[];
 /** Empty array signifies bundler plugin ran */
 bundler?: string[];
 };
} & Carrier;

/** Get's the global object for the current JavaScript runtime */
Expand Down

4 changes: 2 additions & 2 deletions
packages/server-utils/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,9 +116,9 @@
 "access": "public"
 },
 "dependencies": {
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.0",
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.1",
 "@apm-js-collab/code-transformer": "^0.18.0",
 "@apm-js-collab/tracing-hooks": "^0.12.0",
 "@apm-js-collab/tracing-hooks": "^0.13.0",
 "@sentry/conventions": "^0.16.0",
 "@sentry/core": "10.65.0"
 },
Expand Down

6 changes: 3 additions & 3 deletions
packages/server-utils/src/orchestrion/bundler/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,16 +13,16 @@ export type PluginOptions = {
 * The `@apm-js-collab/code-transformer-bundler-plugins` options shared by every
 * orchestrion bundler plugin.
 *
 * `injectDiagnostics` sets `globalThis.__SENTRY_ORCHESTRION__.bundler = true` at
 * `injectDiagnostics` sets `globalThis.__SENTRY_ORCHESTRION__.bundler = ["mysql"]` at
@JPeer264JPeer264Jul 15, 2026

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.

Ah that is smart.
 * app boot so the `_experimentalSetupOrchestrion()` detector can confirm the
 * bundler path ran (rather than relying on a build-time flag that wouldn't be
 * visible to the runtime).
 */
export function orchestrionTransformOptions(options: PluginOptions): Parameters<typeof codeTransformer>[0] {
 return {
 instrumentations: [...SENTRY_INSTRUMENTATIONS, ...(options.instrumentations || [])],
 injectDiagnostics: () => {
 return '(globalThis.__SENTRY_ORCHESTRION__=globalThis.__SENTRY_ORCHESTRION__||{}).bundler=true;';
 injectDiagnostics: (diag: { transformedModules: string[]; failedModules: string[] }) => {
 return `(globalThis.__SENTRY_ORCHESTRION__=globalThis.__SENTRY_ORCHESTRION__||{}).bundler=${JSON.stringify(diag.transformedModules)};`;
 },
 };
}

51 changes: 24 additions & 27 deletions
packages/server-utils/src/orchestrion/detect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
import { debug } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';

declare global {
 // eslint-disable-next-line no-var
 var __SENTRY_ORCHESTRION__: { runtime?: boolean; bundler?: boolean } | undefined;
}
import { debug, GLOBAL_OBJ } from '@sentry/core';

/**
 * Whether orchestrion has injected the diagnostics channels into this process,
Expand All@@ -16,40 +10,43 @@ declare global {
 * will ever publish to those channels.
 */
export function isOrchestrionInjected(): boolean {
 const marker = globalThis.__SENTRY_ORCHESTRION__;
 return !!(marker?.runtime || marker?.bundler);
 return !!GLOBAL_OBJ.__SENTRY_ORCHESTRION__;
Comment thread
cursor[bot] marked this conversation as resolved.

}

/**
 * Verifies that the diagnostics channels have been injected either by the
 * runtime `--import` hook (or init-time registration), a bundler plugin, or
 * both, and warns if not.
 * both, and warns if not. When at least one injector is active, logs for each
 * mechanism whether it hooked (a defined array, even empty, means it did) and
 * which libraries it injected.
 *
 * Both injectors being active at once is fine: they operate on disjoint module
 * sets (a module is either loaded through Node's loader and transformed by the
 * runtime hook, or inlined by the bundler and transformed by the plugin), so
 * a single module can't be double-wrapped. A hybrid setup, with some deps
 * external and runtime-instrumented, others bundled and plugin-instrumented,
 * is fine.
 *
 * Note: intentionally does NOT warn in production, only in debug builds,
 * because production warnings are reserved for truly critical issues.
 */
export function detectOrchestrionSetup(): void {
if (!DEBUG_BUILD) return;
const { runtime, bundler } = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ ?? {};

 const marker = globalThis.__SENTRY_ORCHESTRION__;
 const runtime = !!marker?.runtime;
 const bundler = !!marker?.bundler;

 DEBUG_BUILD && debug.log(`[orchestrion] detect: runtime=${runtime} bundler=${bundler}`);

 if (!isOrchestrionInjected()) {
 DEBUG_BUILD &&
 debug.warn(
 '[Sentry] No diagnostics-channel injection detected. Channel-based integrations ' +
 '(mysql, …) will not record spans. Make sure the diagnostics channels are injected ' +
 'via the runtime `--import` hook or a bundler plugin before the instrumented modules load.',
 );
 if (!runtime && !bundler) {
@JPeer264JPeer264Jul 15, 2026

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.

l/m: Also here. We should check for the array length, right?
@timfishtimfishJul 15, 2026

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

If either of these are defined, we will hit the debug logging below with more details for each.
 debug.warn(
 '[Sentry] No diagnostics-channel injection detected. Channel-based integrations ' +
 'will not record spans. Make sure the diagnostics channels are injected ' +
 'via the runtime `--import` hook or a bundler plugin before the instrumented modules load.',
 );
 return;
 }

 debug.log(
 runtime
 ? `[Sentry] Runtime hook registered, injected libraries=${JSON.stringify(runtime)}`
 : '[Sentry] Runtime hook not registered',
 );
 debug.log(
 bundler
 ? `[Sentry] Bundler plugin ran, injected libraries=${JSON.stringify(bundler)}`
 : '[Sentry] Bundler plugin did not run',
Comment thread
timfish marked this conversation as resolved.

 );
Comment thread
cursor[bot] marked this conversation as resolved.

}

52 changes: 28 additions & 24 deletions
packages/server-utils/src/orchestrion/runtime/register.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
import { debug } from '@sentry/core';
import { debug, GLOBAL_OBJ } from '@sentry/core';
import { createRequire } from 'node:module';
import * as Module from 'node:module';
import { pathToFileURL } from 'node:url';
import { DEBUG_BUILD } from '../../debug-build';
import { SENTRY_INSTRUMENTATIONS } from '../config';
import type { InstrumentationConfig } from '@apm-js-collab/code-transformer';
import type { register } from 'node:module';

type TracingHooksSync = {
 initialize: (opts: { instrumentations: InstrumentationConfig[] }) => void;
 resolve: Function;
 load: Function;
 setDiagnosticsHook: (callback: (event: { url: string; moduleName: string; error: Error }) => void) => void;
};

type NodeModule = {
 registerHooks?: (options: unknown) => { deregister: () => void };
 register?: typeof register;
};

export interface RegisterDiagnosticsChannelInjectionOptions {
 /**
Expand All@@ -17,11 +31,6 @@ export interface RegisterDiagnosticsChannelInjectionOptions {
 tracingHooksDir?: string;
}

declare global {
 // eslint-disable-next-line no-var
 var __SENTRY_ORCHESTRION__: { runtime?: boolean; bundler?: boolean } | undefined;
}

/** `Module.registerHooks` only became stable in Node 24.13 / 25.1 and Deno 2.8. */
function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolean {
 const parseVersion = (v: string): number[] => v.split('.').map(n => parseInt(n, 10));
Expand All@@ -47,15 +56,9 @@ function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolea
 *
 * Libraries imported *after* this call publish the `tracingChannel` events that
 * the channel-based integrations subscribe to.
 *
 * Idempotent via `globalThis.__SENTRY_ORCHESTRION__` — a no-op if the runtime
 * `--import` hook or a bundler plugin already injected the channels.
 */
export function registerDiagnosticsChannelInjection(options?: RegisterDiagnosticsChannelInjectionOptions): void {
 const g = (globalThis.__SENTRY_ORCHESTRION__ ??= {});

 // Already injected (runtime --import hook or bundler plugin) — nothing to do.
 if (g.runtime) {
 if (GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime) {
@JPeer264JPeer264Jul 15, 2026

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.

m: Shouldn't this be the following?

Suggested change

if(GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime){
if(!!GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime.length){
@timfishtimfishJul 15, 2026•

edited

Loading

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

No, an empty array signifies that the the hooks have been setup:
https://github.com/getsentry/sentry-javascript/pull/22269/changes#diff-61b304378c94fe3c1e3d2612639b4dc1199e5d693369321365c546bae700494dR168
@JPeer264JPeer264Jul 15, 2026

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.

Smart
 return;
 }

Expand DownExpand Up@@ -89,10 +92,7 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic

 // `Module.registerHooks` / `Module.register` are newer than the @types/node
 // we build against, hence the cast.
 const mod = Module as unknown as {
 registerHooks?: (hooks: unknown) => void;
 register?: (specifier: string, options: unknown) => void;
 };
 const mod = Module as NodeModule;

 // runs both at `--import` time and (synchronously) inside `Sentry.init()`,
 // so an unguarded throw would either abort startup or make `init()` throw.
Expand All@@ -105,15 +105,18 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 // We require() the module here so that we can synchronously load it,
 // including from a CommonJS Sentry build, without bundlers pulling in.
 // All versions in stableSyncHooks support this.
 const { initialize, resolve, load } = (
 const { initialize, resolve, load, setDiagnosticsHook } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/hook-sync.mjs`)
 : nodeRequire('@apm-js-collab/tracing-hooks/hook-sync.mjs')
 ) as {
 initialize: (opts: { instrumentations: unknown }) => void;
 resolve: unknown;
 load: unknown;
 };
 ) as TracingHooksSync;

 setDiagnosticsHook(event => {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(event.moduleName);
 });

Comment thread
cursor[bot] marked this conversation as resolved.

 initialize({ instrumentations: SENTRY_INSTRUMENTATIONS });
 mod.registerHooks({ resolve, load });
 DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.registerHooks()');
Expand DownExpand Up@@ -161,5 +164,6 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 return;
 }

 g.runtime = true;
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
}

16 changes: 8 additions & 8 deletions
yarn.lock

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -404,10 +404,10 @@
 dependencies:
 json-schema-to-ts "^3.1.1"

"@apm-js-collab/code-transformer-bundler-plugins@^0.6.0":
 version "0.6.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/code-transformer-bundler-plugins/-/code-transformer-bundler-plugins-0.6.0.tgz#ed64bae9e1871366eadc1ef6dabc9ee6ccc53e57"
 integrity sha512-Hys7LDskIB/BNrd87GAfYWHRE3mWgcPYonK4W9uxjho4N0JnPKk2YQyOLlqmkyVhj2UzwLRpmbJ4D6uR9O7wyw==
"@apm-js-collab/code-transformer-bundler-plugins@^0.6.1":
 version "0.6.1"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/code-transformer-bundler-plugins/-/code-transformer-bundler-plugins-0.6.1.tgz#29bf79167411b8607f02db177250b8f7c16d93e1"
 integrity sha512-TDvypsLUk/W202Y1JBE6I2enQalWjbYXKnxpELWEZn6GLoIcGFii69ljh948hdAzKZJ/wg0Uwivz72a/szoOBQ==
 dependencies:
 "@apm-js-collab/code-transformer" "^0.18.0"
 es-module-lexer "^2.1.0"
Expand All@@ -426,10 +426,10 @@
 semifies "^1.0.0"
 source-map "^0.6.0"

"@apm-js-collab/tracing-hooks@^0.12.0":
 version "0.12.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/tracing-hooks/-/tracing-hooks-0.12.0.tgz#b65505d1d075fc8d8f4fa1973c37eaa9a9975b3f"
 integrity sha512-U1cDbHOFbeToq5VWNcroBtQpz3hfH39uLkzJ5lorBFVNhHbTNj5MQvP+jODDwxBkG6A/agbQelG15rEoDgnjWg==
"@apm-js-collab/tracing-hooks@^0.13.0":
 version "0.13.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/tracing-hooks/-/tracing-hooks-0.13.0.tgz#20b2f77ec7a0e5dfd9fbf2215b56e2c2b7f41e4b"
 integrity sha512-mTvWz9rnQwx1U3h0XPTHaX7bgfkpipLLTQyjlC2cdhQpQEuoLT0AGzoydeoq2NxfEVv6fWOOETcSbb2nptleyw==
 dependencies:
 "@apm-js-collab/code-transformer" "^0.18.0"
 debug "^4.4.1"
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(server-utils): Capture and log orchestrion stats#22269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

timfish
merged 9 commits into

from

Jul 15, 2026
 Merged


feat(server-utils): Capture and log orchestrion stats
#22269
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
300820f

feat(server-utils): Capture and log orchestrion stats


timfish Jul 14, 2026
d241716

Fix Deno tests


timfish Jul 14, 2026
b43a3f5

Lint


timfish Jul 14, 2026
9af3066

Merge remote-tracking branch 'upstream/develop' into timfish/feat/orc…


timfish Jul 15, 2026
b4f9ac0

Inject the successful modules at bundle time


timfish Jul 15, 2026
43c2038

Diagnostics hook on all Node versions


timfish Jul 15, 2026
e038103

Bump plugins


timfish Jul 15, 2026
b1cd5ac

Merge remote-tracking branch 'upstream/develop' into timfish/feat/orc…


timfish Jul 15, 2026
e70753f

Fix lock file


timfish Jul 15, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
dev-packages/deno-integration-tests/suites/orchestrion-mysql/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ Deno.test('@sentry/deno/import: transforms mysql so it publishes the orchestrion
 // ...with the real SQL forwarded through the channel context.
 assert(line.includes('statement=SELECT 1 AS solution'), `expected forwarded SQL, got: ${line}`);
 // The runtime hook set its detection marker at boot.
 assert(line.includes('"runtime":true'), `expected runtime marker, got: ${line}`);
 assert(line.includes('"runtime":["mysql"]'), `expected runtime marker, got: ${line}`);
});

// Exercises the SDK path end-to-end: `init()` wires `denoMysqlIntegration`
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/deno-integration-tests/suites/orchestrion-postgres/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ Deno.test('@sentry/deno/import: transforms pg so it publishes the orchestrion ch
 // ...with the real SQL forwarded through the channel context.
 assert(line.includes('statement=SELECT 1 AS solution'), `expected forwarded SQL, got: ${line}`);
 // The runtime hook set its detection marker at boot.
 assert(line.includes('"runtime":true'), `expected runtime marker, got: ${line}`);
 assert(line.includes('"runtime":["pg","pg-pool"]'), `expected runtime marker, got: ${line}`);
});

// Exercises the SDK path end-to-end: `init()` wires `denoPostgresIntegration`
Expand Down

2 changes: 1 addition & 1 deletion
packages/bun/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,7 @@
 "access": "public"
 },
 "dependencies": {
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.0",
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.1",
 "@sentry/core": "10.65.0",
 "@sentry/node": "10.65.0",
 "@sentry/server-utils": "10.65.0"
Expand Down

9 changes: 9 additions & 0 deletions
packages/core/src/utils/worldwide.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,15 @@ export type InternalGlobal = {
 _sentryModuleMetadata?: Record<string, any>;
 _sentryEsmLoaderHookRegistered?: boolean;
 _sentryWrappedDepth?: number;
 /**
 * Orchestrion bundler and runtime detection.
 */
 __SENTRY_ORCHESTRION__?: {
 /** Empty array signifies runtime hooked */
 runtime?: string[];
 /** Empty array signifies bundler plugin ran */
 bundler?: string[];
 };
} & Carrier;

/** Get's the global object for the current JavaScript runtime */
Expand Down

4 changes: 2 additions & 2 deletions
packages/server-utils/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,9 +116,9 @@
 "access": "public"
 },
 "dependencies": {
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.0",
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.1",
 "@apm-js-collab/code-transformer": "^0.18.0",
 "@apm-js-collab/tracing-hooks": "^0.12.0",
 "@apm-js-collab/tracing-hooks": "^0.13.0",
 "@sentry/conventions": "^0.16.0",
 "@sentry/core": "10.65.0"
 },
Expand Down

6 changes: 3 additions & 3 deletions
packages/server-utils/src/orchestrion/bundler/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,16 +13,16 @@ export type PluginOptions = {
 * The `@apm-js-collab/code-transformer-bundler-plugins` options shared by every
 * orchestrion bundler plugin.
 *
 * `injectDiagnostics` sets `globalThis.__SENTRY_ORCHESTRION__.bundler = true` at
 * `injectDiagnostics` sets `globalThis.__SENTRY_ORCHESTRION__.bundler = ["mysql"]` at
@JPeer264JPeer264Jul 15, 2026

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.

Ah that is smart.
 * app boot so the `_experimentalSetupOrchestrion()` detector can confirm the
 * bundler path ran (rather than relying on a build-time flag that wouldn't be
 * visible to the runtime).
 */
export function orchestrionTransformOptions(options: PluginOptions): Parameters<typeof codeTransformer>[0] {
 return {
 instrumentations: [...SENTRY_INSTRUMENTATIONS, ...(options.instrumentations || [])],
 injectDiagnostics: () => {
 return '(globalThis.__SENTRY_ORCHESTRION__=globalThis.__SENTRY_ORCHESTRION__||{}).bundler=true;';
 injectDiagnostics: (diag: { transformedModules: string[]; failedModules: string[] }) => {
 return `(globalThis.__SENTRY_ORCHESTRION__=globalThis.__SENTRY_ORCHESTRION__||{}).bundler=${JSON.stringify(diag.transformedModules)};`;
 },
 };
}

51 changes: 24 additions & 27 deletions
packages/server-utils/src/orchestrion/detect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
import { debug } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';

declare global {
 // eslint-disable-next-line no-var
 var __SENTRY_ORCHESTRION__: { runtime?: boolean; bundler?: boolean } | undefined;
}
import { debug, GLOBAL_OBJ } from '@sentry/core';

/**
 * Whether orchestrion has injected the diagnostics channels into this process,
Expand All@@ -16,40 +10,43 @@ declare global {
 * will ever publish to those channels.
 */
export function isOrchestrionInjected(): boolean {
 const marker = globalThis.__SENTRY_ORCHESTRION__;
 return !!(marker?.runtime || marker?.bundler);
 return !!GLOBAL_OBJ.__SENTRY_ORCHESTRION__;
Comment thread
cursor[bot] marked this conversation as resolved.

}

/**
 * Verifies that the diagnostics channels have been injected either by the
 * runtime `--import` hook (or init-time registration), a bundler plugin, or
 * both, and warns if not.
 * both, and warns if not. When at least one injector is active, logs for each
 * mechanism whether it hooked (a defined array, even empty, means it did) and
 * which libraries it injected.
 *
 * Both injectors being active at once is fine: they operate on disjoint module
 * sets (a module is either loaded through Node's loader and transformed by the
 * runtime hook, or inlined by the bundler and transformed by the plugin), so
 * a single module can't be double-wrapped. A hybrid setup, with some deps
 * external and runtime-instrumented, others bundled and plugin-instrumented,
 * is fine.
 *
 * Note: intentionally does NOT warn in production, only in debug builds,
 * because production warnings are reserved for truly critical issues.
 */
export function detectOrchestrionSetup(): void {
if (!DEBUG_BUILD) return;
const { runtime, bundler } = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ ?? {};

 const marker = globalThis.__SENTRY_ORCHESTRION__;
 const runtime = !!marker?.runtime;
 const bundler = !!marker?.bundler;

 DEBUG_BUILD && debug.log(`[orchestrion] detect: runtime=${runtime} bundler=${bundler}`);

 if (!isOrchestrionInjected()) {
 DEBUG_BUILD &&
 debug.warn(
 '[Sentry] No diagnostics-channel injection detected. Channel-based integrations ' +
 '(mysql, …) will not record spans. Make sure the diagnostics channels are injected ' +
 'via the runtime `--import` hook or a bundler plugin before the instrumented modules load.',
 );
 if (!runtime && !bundler) {
@JPeer264JPeer264Jul 15, 2026

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.

l/m: Also here. We should check for the array length, right?
@timfishtimfishJul 15, 2026

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

If either of these are defined, we will hit the debug logging below with more details for each.
 debug.warn(
 '[Sentry] No diagnostics-channel injection detected. Channel-based integrations ' +
 'will not record spans. Make sure the diagnostics channels are injected ' +
 'via the runtime `--import` hook or a bundler plugin before the instrumented modules load.',
 );
 return;
 }

 debug.log(
 runtime
 ? `[Sentry] Runtime hook registered, injected libraries=${JSON.stringify(runtime)}`
 : '[Sentry] Runtime hook not registered',
 );
 debug.log(
 bundler
 ? `[Sentry] Bundler plugin ran, injected libraries=${JSON.stringify(bundler)}`
 : '[Sentry] Bundler plugin did not run',
Comment thread
timfish marked this conversation as resolved.

 );
Comment thread
cursor[bot] marked this conversation as resolved.

}

52 changes: 28 additions & 24 deletions
packages/server-utils/src/orchestrion/runtime/register.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
import { debug } from '@sentry/core';
import { debug, GLOBAL_OBJ } from '@sentry/core';
import { createRequire } from 'node:module';
import * as Module from 'node:module';
import { pathToFileURL } from 'node:url';
import { DEBUG_BUILD } from '../../debug-build';
import { SENTRY_INSTRUMENTATIONS } from '../config';
import type { InstrumentationConfig } from '@apm-js-collab/code-transformer';
import type { register } from 'node:module';

type TracingHooksSync = {
 initialize: (opts: { instrumentations: InstrumentationConfig[] }) => void;
 resolve: Function;
 load: Function;
 setDiagnosticsHook: (callback: (event: { url: string; moduleName: string; error: Error }) => void) => void;
};

type NodeModule = {
 registerHooks?: (options: unknown) => { deregister: () => void };
 register?: typeof register;
};

export interface RegisterDiagnosticsChannelInjectionOptions {
 /**
Expand All@@ -17,11 +31,6 @@ export interface RegisterDiagnosticsChannelInjectionOptions {
 tracingHooksDir?: string;
}

declare global {
 // eslint-disable-next-line no-var
 var __SENTRY_ORCHESTRION__: { runtime?: boolean; bundler?: boolean } | undefined;
}

/** `Module.registerHooks` only became stable in Node 24.13 / 25.1 and Deno 2.8. */
function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolean {
 const parseVersion = (v: string): number[] => v.split('.').map(n => parseInt(n, 10));
Expand All@@ -47,15 +56,9 @@ function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolea
 *
 * Libraries imported *after* this call publish the `tracingChannel` events that
 * the channel-based integrations subscribe to.
 *
 * Idempotent via `globalThis.__SENTRY_ORCHESTRION__` — a no-op if the runtime
 * `--import` hook or a bundler plugin already injected the channels.
 */
export function registerDiagnosticsChannelInjection(options?: RegisterDiagnosticsChannelInjectionOptions): void {
 const g = (globalThis.__SENTRY_ORCHESTRION__ ??= {});

 // Already injected (runtime --import hook or bundler plugin) — nothing to do.
 if (g.runtime) {
 if (GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime) {
@JPeer264JPeer264Jul 15, 2026

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.

m: Shouldn't this be the following?

Suggested change

if(GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime){
if(!!GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime.length){
@timfishtimfishJul 15, 2026•

edited

Loading

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

No, an empty array signifies that the the hooks have been setup:
https://github.com/getsentry/sentry-javascript/pull/22269/changes#diff-61b304378c94fe3c1e3d2612639b4dc1199e5d693369321365c546bae700494dR168
@JPeer264JPeer264Jul 15, 2026

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.

Smart
 return;
 }

Expand DownExpand Up@@ -89,10 +92,7 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic

 // `Module.registerHooks` / `Module.register` are newer than the @types/node
 // we build against, hence the cast.
 const mod = Module as unknown as {
 registerHooks?: (hooks: unknown) => void;
 register?: (specifier: string, options: unknown) => void;
 };
 const mod = Module as NodeModule;

 // runs both at `--import` time and (synchronously) inside `Sentry.init()`,
 // so an unguarded throw would either abort startup or make `init()` throw.
Expand All@@ -105,15 +105,18 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 // We require() the module here so that we can synchronously load it,
 // including from a CommonJS Sentry build, without bundlers pulling in.
 // All versions in stableSyncHooks support this.
 const { initialize, resolve, load } = (
 const { initialize, resolve, load, setDiagnosticsHook } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/hook-sync.mjs`)
 : nodeRequire('@apm-js-collab/tracing-hooks/hook-sync.mjs')
 ) as {
 initialize: (opts: { instrumentations: unknown }) => void;
 resolve: unknown;
 load: unknown;
 };
 ) as TracingHooksSync;

 setDiagnosticsHook(event => {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(event.moduleName);
 });

Comment thread
cursor[bot] marked this conversation as resolved.

 initialize({ instrumentations: SENTRY_INSTRUMENTATIONS });
 mod.registerHooks({ resolve, load });
 DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.registerHooks()');
Expand DownExpand Up@@ -161,5 +164,6 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 return;
 }

 g.runtime = true;
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
}

16 changes: 8 additions & 8 deletions
yarn.lock

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -404,10 +404,10 @@
 dependencies:
 json-schema-to-ts "^3.1.1"

"@apm-js-collab/code-transformer-bundler-plugins@^0.6.0":
 version "0.6.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/code-transformer-bundler-plugins/-/code-transformer-bundler-plugins-0.6.0.tgz#ed64bae9e1871366eadc1ef6dabc9ee6ccc53e57"
 integrity sha512-Hys7LDskIB/BNrd87GAfYWHRE3mWgcPYonK4W9uxjho4N0JnPKk2YQyOLlqmkyVhj2UzwLRpmbJ4D6uR9O7wyw==
"@apm-js-collab/code-transformer-bundler-plugins@^0.6.1":
 version "0.6.1"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/code-transformer-bundler-plugins/-/code-transformer-bundler-plugins-0.6.1.tgz#29bf79167411b8607f02db177250b8f7c16d93e1"
 integrity sha512-TDvypsLUk/W202Y1JBE6I2enQalWjbYXKnxpELWEZn6GLoIcGFii69ljh948hdAzKZJ/wg0Uwivz72a/szoOBQ==
 dependencies:
 "@apm-js-collab/code-transformer" "^0.18.0"
 es-module-lexer "^2.1.0"
Expand All@@ -426,10 +426,10 @@
 semifies "^1.0.0"
 source-map "^0.6.0"

"@apm-js-collab/tracing-hooks@^0.12.0":
 version "0.12.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/tracing-hooks/-/tracing-hooks-0.12.0.tgz#b65505d1d075fc8d8f4fa1973c37eaa9a9975b3f"
 integrity sha512-U1cDbHOFbeToq5VWNcroBtQpz3hfH39uLkzJ5lorBFVNhHbTNj5MQvP+jODDwxBkG6A/agbQelG15rEoDgnjWg==
"@apm-js-collab/tracing-hooks@^0.13.0":
 version "0.13.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/tracing-hooks/-/tracing-hooks-0.13.0.tgz#20b2f77ec7a0e5dfd9fbf2215b56e2c2b7f41e4b"
 integrity sha512-mTvWz9rnQwx1U3h0XPTHaX7bgfkpipLLTQyjlC2cdhQpQEuoLT0AGzoydeoq2NxfEVv6fWOOETcSbb2nptleyw==
 dependencies:
 "@apm-js-collab/code-transformer" "^0.18.0"
 debug "^4.4.1"
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(server-utils): Capture and log orchestrion stats#22269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

timfish
merged 9 commits into

from

Jul 15, 2026
 Merged


feat(server-utils): Capture and log orchestrion stats
#22269
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
300820f

feat(server-utils): Capture and log orchestrion stats


timfish Jul 14, 2026
d241716

Fix Deno tests


timfish Jul 14, 2026
b43a3f5

Lint


timfish Jul 14, 2026
9af3066

Merge remote-tracking branch 'upstream/develop' into timfish/feat/orc…


timfish Jul 15, 2026
b4f9ac0

Inject the successful modules at bundle time


timfish Jul 15, 2026
43c2038

Diagnostics hook on all Node versions


timfish Jul 15, 2026
e038103

Bump plugins


timfish Jul 15, 2026
b1cd5ac

Merge remote-tracking branch 'upstream/develop' into timfish/feat/orc…


timfish Jul 15, 2026
e70753f

Fix lock file


timfish Jul 15, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
dev-packages/deno-integration-tests/suites/orchestrion-mysql/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ Deno.test('@sentry/deno/import: transforms mysql so it publishes the orchestrion
 // ...with the real SQL forwarded through the channel context.
 assert(line.includes('statement=SELECT 1 AS solution'), `expected forwarded SQL, got: ${line}`);
 // The runtime hook set its detection marker at boot.
 assert(line.includes('"runtime":true'), `expected runtime marker, got: ${line}`);
 assert(line.includes('"runtime":["mysql"]'), `expected runtime marker, got: ${line}`);
});

// Exercises the SDK path end-to-end: `init()` wires `denoMysqlIntegration`
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/deno-integration-tests/suites/orchestrion-postgres/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ Deno.test('@sentry/deno/import: transforms pg so it publishes the orchestrion ch
 // ...with the real SQL forwarded through the channel context.
 assert(line.includes('statement=SELECT 1 AS solution'), `expected forwarded SQL, got: ${line}`);
 // The runtime hook set its detection marker at boot.
 assert(line.includes('"runtime":true'), `expected runtime marker, got: ${line}`);
 assert(line.includes('"runtime":["pg","pg-pool"]'), `expected runtime marker, got: ${line}`);
});

// Exercises the SDK path end-to-end: `init()` wires `denoPostgresIntegration`
Expand Down

2 changes: 1 addition & 1 deletion
packages/bun/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,7 @@
 "access": "public"
 },
 "dependencies": {
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.0",
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.1",
 "@sentry/core": "10.65.0",
 "@sentry/node": "10.65.0",
 "@sentry/server-utils": "10.65.0"
Expand Down

9 changes: 9 additions & 0 deletions
packages/core/src/utils/worldwide.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,15 @@ export type InternalGlobal = {
 _sentryModuleMetadata?: Record<string, any>;
 _sentryEsmLoaderHookRegistered?: boolean;
 _sentryWrappedDepth?: number;
 /**
 * Orchestrion bundler and runtime detection.
 */
 __SENTRY_ORCHESTRION__?: {
 /** Empty array signifies runtime hooked */
 runtime?: string[];
 /** Empty array signifies bundler plugin ran */
 bundler?: string[];
 };
} & Carrier;

/** Get's the global object for the current JavaScript runtime */
Expand Down

4 changes: 2 additions & 2 deletions
packages/server-utils/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,9 +116,9 @@
 "access": "public"
 },
 "dependencies": {
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.0",
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.1",
 "@apm-js-collab/code-transformer": "^0.18.0",
 "@apm-js-collab/tracing-hooks": "^0.12.0",
 "@apm-js-collab/tracing-hooks": "^0.13.0",
 "@sentry/conventions": "^0.16.0",
 "@sentry/core": "10.65.0"
 },
Expand Down

6 changes: 3 additions & 3 deletions
packages/server-utils/src/orchestrion/bundler/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,16 +13,16 @@ export type PluginOptions = {
 * The `@apm-js-collab/code-transformer-bundler-plugins` options shared by every
 * orchestrion bundler plugin.
 *
 * `injectDiagnostics` sets `globalThis.__SENTRY_ORCHESTRION__.bundler = true` at
 * `injectDiagnostics` sets `globalThis.__SENTRY_ORCHESTRION__.bundler = ["mysql"]` at
@JPeer264JPeer264Jul 15, 2026

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.

Ah that is smart.
 * app boot so the `_experimentalSetupOrchestrion()` detector can confirm the
 * bundler path ran (rather than relying on a build-time flag that wouldn't be
 * visible to the runtime).
 */
export function orchestrionTransformOptions(options: PluginOptions): Parameters<typeof codeTransformer>[0] {
 return {
 instrumentations: [...SENTRY_INSTRUMENTATIONS, ...(options.instrumentations || [])],
 injectDiagnostics: () => {
 return '(globalThis.__SENTRY_ORCHESTRION__=globalThis.__SENTRY_ORCHESTRION__||{}).bundler=true;';
 injectDiagnostics: (diag: { transformedModules: string[]; failedModules: string[] }) => {
 return `(globalThis.__SENTRY_ORCHESTRION__=globalThis.__SENTRY_ORCHESTRION__||{}).bundler=${JSON.stringify(diag.transformedModules)};`;
 },
 };
}

51 changes: 24 additions & 27 deletions
packages/server-utils/src/orchestrion/detect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
import { debug } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';

declare global {
 // eslint-disable-next-line no-var
 var __SENTRY_ORCHESTRION__: { runtime?: boolean; bundler?: boolean } | undefined;
}
import { debug, GLOBAL_OBJ } from '@sentry/core';

/**
 * Whether orchestrion has injected the diagnostics channels into this process,
Expand All@@ -16,40 +10,43 @@ declare global {
 * will ever publish to those channels.
 */
export function isOrchestrionInjected(): boolean {
 const marker = globalThis.__SENTRY_ORCHESTRION__;
 return !!(marker?.runtime || marker?.bundler);
 return !!GLOBAL_OBJ.__SENTRY_ORCHESTRION__;
Comment thread
cursor[bot] marked this conversation as resolved.

}

/**
 * Verifies that the diagnostics channels have been injected either by the
 * runtime `--import` hook (or init-time registration), a bundler plugin, or
 * both, and warns if not.
 * both, and warns if not. When at least one injector is active, logs for each
 * mechanism whether it hooked (a defined array, even empty, means it did) and
 * which libraries it injected.
 *
 * Both injectors being active at once is fine: they operate on disjoint module
 * sets (a module is either loaded through Node's loader and transformed by the
 * runtime hook, or inlined by the bundler and transformed by the plugin), so
 * a single module can't be double-wrapped. A hybrid setup, with some deps
 * external and runtime-instrumented, others bundled and plugin-instrumented,
 * is fine.
 *
 * Note: intentionally does NOT warn in production, only in debug builds,
 * because production warnings are reserved for truly critical issues.
 */
export function detectOrchestrionSetup(): void {
if (!DEBUG_BUILD) return;
const { runtime, bundler } = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ ?? {};

 const marker = globalThis.__SENTRY_ORCHESTRION__;
 const runtime = !!marker?.runtime;
 const bundler = !!marker?.bundler;

 DEBUG_BUILD && debug.log(`[orchestrion] detect: runtime=${runtime} bundler=${bundler}`);

 if (!isOrchestrionInjected()) {
 DEBUG_BUILD &&
 debug.warn(
 '[Sentry] No diagnostics-channel injection detected. Channel-based integrations ' +
 '(mysql, …) will not record spans. Make sure the diagnostics channels are injected ' +
 'via the runtime `--import` hook or a bundler plugin before the instrumented modules load.',
 );
 if (!runtime && !bundler) {
@JPeer264JPeer264Jul 15, 2026

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.

l/m: Also here. We should check for the array length, right?
@timfishtimfishJul 15, 2026

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

If either of these are defined, we will hit the debug logging below with more details for each.
 debug.warn(
 '[Sentry] No diagnostics-channel injection detected. Channel-based integrations ' +
 'will not record spans. Make sure the diagnostics channels are injected ' +
 'via the runtime `--import` hook or a bundler plugin before the instrumented modules load.',
 );
 return;
 }

 debug.log(
 runtime
 ? `[Sentry] Runtime hook registered, injected libraries=${JSON.stringify(runtime)}`
 : '[Sentry] Runtime hook not registered',
 );
 debug.log(
 bundler
 ? `[Sentry] Bundler plugin ran, injected libraries=${JSON.stringify(bundler)}`
 : '[Sentry] Bundler plugin did not run',
Comment thread
timfish marked this conversation as resolved.

 );
Comment thread
cursor[bot] marked this conversation as resolved.

}

52 changes: 28 additions & 24 deletions
packages/server-utils/src/orchestrion/runtime/register.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
import { debug } from '@sentry/core';
import { debug, GLOBAL_OBJ } from '@sentry/core';
import { createRequire } from 'node:module';
import * as Module from 'node:module';
import { pathToFileURL } from 'node:url';
import { DEBUG_BUILD } from '../../debug-build';
import { SENTRY_INSTRUMENTATIONS } from '../config';
import type { InstrumentationConfig } from '@apm-js-collab/code-transformer';
import type { register } from 'node:module';

type TracingHooksSync = {
 initialize: (opts: { instrumentations: InstrumentationConfig[] }) => void;
 resolve: Function;
 load: Function;
 setDiagnosticsHook: (callback: (event: { url: string; moduleName: string; error: Error }) => void) => void;
};

type NodeModule = {
 registerHooks?: (options: unknown) => { deregister: () => void };
 register?: typeof register;
};

export interface RegisterDiagnosticsChannelInjectionOptions {
 /**
Expand All@@ -17,11 +31,6 @@ export interface RegisterDiagnosticsChannelInjectionOptions {
 tracingHooksDir?: string;
}

declare global {
 // eslint-disable-next-line no-var
 var __SENTRY_ORCHESTRION__: { runtime?: boolean; bundler?: boolean } | undefined;
}

/** `Module.registerHooks` only became stable in Node 24.13 / 25.1 and Deno 2.8. */
function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolean {
 const parseVersion = (v: string): number[] => v.split('.').map(n => parseInt(n, 10));
Expand All@@ -47,15 +56,9 @@ function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolea
 *
 * Libraries imported *after* this call publish the `tracingChannel` events that
 * the channel-based integrations subscribe to.
 *
 * Idempotent via `globalThis.__SENTRY_ORCHESTRION__` — a no-op if the runtime
 * `--import` hook or a bundler plugin already injected the channels.
 */
export function registerDiagnosticsChannelInjection(options?: RegisterDiagnosticsChannelInjectionOptions): void {
 const g = (globalThis.__SENTRY_ORCHESTRION__ ??= {});

 // Already injected (runtime --import hook or bundler plugin) — nothing to do.
 if (g.runtime) {
 if (GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime) {
@JPeer264JPeer264Jul 15, 2026

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.

m: Shouldn't this be the following?

Suggested change

if(GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime){
if(!!GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime.length){
@timfishtimfishJul 15, 2026•

edited

Loading

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

No, an empty array signifies that the the hooks have been setup:
https://github.com/getsentry/sentry-javascript/pull/22269/changes#diff-61b304378c94fe3c1e3d2612639b4dc1199e5d693369321365c546bae700494dR168
@JPeer264JPeer264Jul 15, 2026

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.

Smart
 return;
 }

Expand DownExpand Up@@ -89,10 +92,7 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic

 // `Module.registerHooks` / `Module.register` are newer than the @types/node
 // we build against, hence the cast.
 const mod = Module as unknown as {
 registerHooks?: (hooks: unknown) => void;
 register?: (specifier: string, options: unknown) => void;
 };
 const mod = Module as NodeModule;

 // runs both at `--import` time and (synchronously) inside `Sentry.init()`,
 // so an unguarded throw would either abort startup or make `init()` throw.
Expand All@@ -105,15 +105,18 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 // We require() the module here so that we can synchronously load it,
 // including from a CommonJS Sentry build, without bundlers pulling in.
 // All versions in stableSyncHooks support this.
 const { initialize, resolve, load } = (
 const { initialize, resolve, load, setDiagnosticsHook } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/hook-sync.mjs`)
 : nodeRequire('@apm-js-collab/tracing-hooks/hook-sync.mjs')
 ) as {
 initialize: (opts: { instrumentations: unknown }) => void;
 resolve: unknown;
 load: unknown;
 };
 ) as TracingHooksSync;

 setDiagnosticsHook(event => {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(event.moduleName);
 });

Comment thread
cursor[bot] marked this conversation as resolved.

 initialize({ instrumentations: SENTRY_INSTRUMENTATIONS });
 mod.registerHooks({ resolve, load });
 DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.registerHooks()');
Expand DownExpand Up@@ -161,5 +164,6 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 return;
 }

 g.runtime = true;
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
}

16 changes: 8 additions & 8 deletions
yarn.lock

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -404,10 +404,10 @@
 dependencies:
 json-schema-to-ts "^3.1.1"

"@apm-js-collab/code-transformer-bundler-plugins@^0.6.0":
 version "0.6.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/code-transformer-bundler-plugins/-/code-transformer-bundler-plugins-0.6.0.tgz#ed64bae9e1871366eadc1ef6dabc9ee6ccc53e57"
 integrity sha512-Hys7LDskIB/BNrd87GAfYWHRE3mWgcPYonK4W9uxjho4N0JnPKk2YQyOLlqmkyVhj2UzwLRpmbJ4D6uR9O7wyw==
"@apm-js-collab/code-transformer-bundler-plugins@^0.6.1":
 version "0.6.1"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/code-transformer-bundler-plugins/-/code-transformer-bundler-plugins-0.6.1.tgz#29bf79167411b8607f02db177250b8f7c16d93e1"
 integrity sha512-TDvypsLUk/W202Y1JBE6I2enQalWjbYXKnxpELWEZn6GLoIcGFii69ljh948hdAzKZJ/wg0Uwivz72a/szoOBQ==
 dependencies:
 "@apm-js-collab/code-transformer" "^0.18.0"
 es-module-lexer "^2.1.0"
Expand All@@ -426,10 +426,10 @@
 semifies "^1.0.0"
 source-map "^0.6.0"

"@apm-js-collab/tracing-hooks@^0.12.0":
 version "0.12.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/tracing-hooks/-/tracing-hooks-0.12.0.tgz#b65505d1d075fc8d8f4fa1973c37eaa9a9975b3f"
 integrity sha512-U1cDbHOFbeToq5VWNcroBtQpz3hfH39uLkzJ5lorBFVNhHbTNj5MQvP+jODDwxBkG6A/agbQelG15rEoDgnjWg==
"@apm-js-collab/tracing-hooks@^0.13.0":
 version "0.13.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/tracing-hooks/-/tracing-hooks-0.13.0.tgz#20b2f77ec7a0e5dfd9fbf2215b56e2c2b7f41e4b"
 integrity sha512-mTvWz9rnQwx1U3h0XPTHaX7bgfkpipLLTQyjlC2cdhQpQEuoLT0AGzoydeoq2NxfEVv6fWOOETcSbb2nptleyw==
 dependencies:
 "@apm-js-collab/code-transformer" "^0.18.0"
 debug "^4.4.1"
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(server-utils): Capture and log orchestrion stats#22269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

timfish
merged 9 commits into

from

Jul 15, 2026
 Merged


feat(server-utils): Capture and log orchestrion stats
#22269
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
300820f

feat(server-utils): Capture and log orchestrion stats


timfish Jul 14, 2026
d241716

Fix Deno tests


timfish Jul 14, 2026
b43a3f5

Lint


timfish Jul 14, 2026
9af3066

Merge remote-tracking branch 'upstream/develop' into timfish/feat/orc…


timfish Jul 15, 2026
b4f9ac0

Inject the successful modules at bundle time


timfish Jul 15, 2026
43c2038

Diagnostics hook on all Node versions


timfish Jul 15, 2026
e038103

Bump plugins


timfish Jul 15, 2026
b1cd5ac

Merge remote-tracking branch 'upstream/develop' into timfish/feat/orc…


timfish Jul 15, 2026
e70753f

Fix lock file


timfish Jul 15, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
dev-packages/deno-integration-tests/suites/orchestrion-mysql/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ Deno.test('@sentry/deno/import: transforms mysql so it publishes the orchestrion
 // ...with the real SQL forwarded through the channel context.
 assert(line.includes('statement=SELECT 1 AS solution'), `expected forwarded SQL, got: ${line}`);
 // The runtime hook set its detection marker at boot.
 assert(line.includes('"runtime":true'), `expected runtime marker, got: ${line}`);
 assert(line.includes('"runtime":["mysql"]'), `expected runtime marker, got: ${line}`);
});

// Exercises the SDK path end-to-end: `init()` wires `denoMysqlIntegration`
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/deno-integration-tests/suites/orchestrion-postgres/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ Deno.test('@sentry/deno/import: transforms pg so it publishes the orchestrion ch
 // ...with the real SQL forwarded through the channel context.
 assert(line.includes('statement=SELECT 1 AS solution'), `expected forwarded SQL, got: ${line}`);
 // The runtime hook set its detection marker at boot.
 assert(line.includes('"runtime":true'), `expected runtime marker, got: ${line}`);
 assert(line.includes('"runtime":["pg","pg-pool"]'), `expected runtime marker, got: ${line}`);
});

// Exercises the SDK path end-to-end: `init()` wires `denoPostgresIntegration`
Expand Down

2 changes: 1 addition & 1 deletion
packages/bun/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,7 @@
 "access": "public"
 },
 "dependencies": {
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.0",
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.1",
 "@sentry/core": "10.65.0",
 "@sentry/node": "10.65.0",
 "@sentry/server-utils": "10.65.0"
Expand Down

9 changes: 9 additions & 0 deletions
packages/core/src/utils/worldwide.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,15 @@ export type InternalGlobal = {
 _sentryModuleMetadata?: Record<string, any>;
 _sentryEsmLoaderHookRegistered?: boolean;
 _sentryWrappedDepth?: number;
 /**
 * Orchestrion bundler and runtime detection.
 */
 __SENTRY_ORCHESTRION__?: {
 /** Empty array signifies runtime hooked */
 runtime?: string[];
 /** Empty array signifies bundler plugin ran */
 bundler?: string[];
 };
} & Carrier;

/** Get's the global object for the current JavaScript runtime */
Expand Down

4 changes: 2 additions & 2 deletions
packages/server-utils/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,9 +116,9 @@
 "access": "public"
 },
 "dependencies": {
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.0",
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.1",
 "@apm-js-collab/code-transformer": "^0.18.0",
 "@apm-js-collab/tracing-hooks": "^0.12.0",
 "@apm-js-collab/tracing-hooks": "^0.13.0",
 "@sentry/conventions": "^0.16.0",
 "@sentry/core": "10.65.0"
 },
Expand Down

6 changes: 3 additions & 3 deletions
packages/server-utils/src/orchestrion/bundler/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,16 +13,16 @@ export type PluginOptions = {
 * The `@apm-js-collab/code-transformer-bundler-plugins` options shared by every
 * orchestrion bundler plugin.
 *
 * `injectDiagnostics` sets `globalThis.__SENTRY_ORCHESTRION__.bundler = true` at
 * `injectDiagnostics` sets `globalThis.__SENTRY_ORCHESTRION__.bundler = ["mysql"]` at
@JPeer264JPeer264Jul 15, 2026

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.

Ah that is smart.
 * app boot so the `_experimentalSetupOrchestrion()` detector can confirm the
 * bundler path ran (rather than relying on a build-time flag that wouldn't be
 * visible to the runtime).
 */
export function orchestrionTransformOptions(options: PluginOptions): Parameters<typeof codeTransformer>[0] {
 return {
 instrumentations: [...SENTRY_INSTRUMENTATIONS, ...(options.instrumentations || [])],
 injectDiagnostics: () => {
 return '(globalThis.__SENTRY_ORCHESTRION__=globalThis.__SENTRY_ORCHESTRION__||{}).bundler=true;';
 injectDiagnostics: (diag: { transformedModules: string[]; failedModules: string[] }) => {
 return `(globalThis.__SENTRY_ORCHESTRION__=globalThis.__SENTRY_ORCHESTRION__||{}).bundler=${JSON.stringify(diag.transformedModules)};`;
 },
 };
}

51 changes: 24 additions & 27 deletions
packages/server-utils/src/orchestrion/detect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
import { debug } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';

declare global {
 // eslint-disable-next-line no-var
 var __SENTRY_ORCHESTRION__: { runtime?: boolean; bundler?: boolean } | undefined;
}
import { debug, GLOBAL_OBJ } from '@sentry/core';

/**
 * Whether orchestrion has injected the diagnostics channels into this process,
Expand All@@ -16,40 +10,43 @@ declare global {
 * will ever publish to those channels.
 */
export function isOrchestrionInjected(): boolean {
 const marker = globalThis.__SENTRY_ORCHESTRION__;
 return !!(marker?.runtime || marker?.bundler);
 return !!GLOBAL_OBJ.__SENTRY_ORCHESTRION__;
Comment thread
cursor[bot] marked this conversation as resolved.

}

/**
 * Verifies that the diagnostics channels have been injected either by the
 * runtime `--import` hook (or init-time registration), a bundler plugin, or
 * both, and warns if not.
 * both, and warns if not. When at least one injector is active, logs for each
 * mechanism whether it hooked (a defined array, even empty, means it did) and
 * which libraries it injected.
 *
 * Both injectors being active at once is fine: they operate on disjoint module
 * sets (a module is either loaded through Node's loader and transformed by the
 * runtime hook, or inlined by the bundler and transformed by the plugin), so
 * a single module can't be double-wrapped. A hybrid setup, with some deps
 * external and runtime-instrumented, others bundled and plugin-instrumented,
 * is fine.
 *
 * Note: intentionally does NOT warn in production, only in debug builds,
 * because production warnings are reserved for truly critical issues.
 */
export function detectOrchestrionSetup(): void {
if (!DEBUG_BUILD) return;
const { runtime, bundler } = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ ?? {};

 const marker = globalThis.__SENTRY_ORCHESTRION__;
 const runtime = !!marker?.runtime;
 const bundler = !!marker?.bundler;

 DEBUG_BUILD && debug.log(`[orchestrion] detect: runtime=${runtime} bundler=${bundler}`);

 if (!isOrchestrionInjected()) {
 DEBUG_BUILD &&
 debug.warn(
 '[Sentry] No diagnostics-channel injection detected. Channel-based integrations ' +
 '(mysql, …) will not record spans. Make sure the diagnostics channels are injected ' +
 'via the runtime `--import` hook or a bundler plugin before the instrumented modules load.',
 );
 if (!runtime && !bundler) {
@JPeer264JPeer264Jul 15, 2026

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.

l/m: Also here. We should check for the array length, right?
@timfishtimfishJul 15, 2026

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

If either of these are defined, we will hit the debug logging below with more details for each.
 debug.warn(
 '[Sentry] No diagnostics-channel injection detected. Channel-based integrations ' +
 'will not record spans. Make sure the diagnostics channels are injected ' +
 'via the runtime `--import` hook or a bundler plugin before the instrumented modules load.',
 );
 return;
 }

 debug.log(
 runtime
 ? `[Sentry] Runtime hook registered, injected libraries=${JSON.stringify(runtime)}`
 : '[Sentry] Runtime hook not registered',
 );
 debug.log(
 bundler
 ? `[Sentry] Bundler plugin ran, injected libraries=${JSON.stringify(bundler)}`
 : '[Sentry] Bundler plugin did not run',
Comment thread
timfish marked this conversation as resolved.

 );
Comment thread
cursor[bot] marked this conversation as resolved.

}

52 changes: 28 additions & 24 deletions
packages/server-utils/src/orchestrion/runtime/register.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
import { debug } from '@sentry/core';
import { debug, GLOBAL_OBJ } from '@sentry/core';
import { createRequire } from 'node:module';
import * as Module from 'node:module';
import { pathToFileURL } from 'node:url';
import { DEBUG_BUILD } from '../../debug-build';
import { SENTRY_INSTRUMENTATIONS } from '../config';
import type { InstrumentationConfig } from '@apm-js-collab/code-transformer';
import type { register } from 'node:module';

type TracingHooksSync = {
 initialize: (opts: { instrumentations: InstrumentationConfig[] }) => void;
 resolve: Function;
 load: Function;
 setDiagnosticsHook: (callback: (event: { url: string; moduleName: string; error: Error }) => void) => void;
};

type NodeModule = {
 registerHooks?: (options: unknown) => { deregister: () => void };
 register?: typeof register;
};

export interface RegisterDiagnosticsChannelInjectionOptions {
 /**
Expand All@@ -17,11 +31,6 @@ export interface RegisterDiagnosticsChannelInjectionOptions {
 tracingHooksDir?: string;
}

declare global {
 // eslint-disable-next-line no-var
 var __SENTRY_ORCHESTRION__: { runtime?: boolean; bundler?: boolean } | undefined;
}

/** `Module.registerHooks` only became stable in Node 24.13 / 25.1 and Deno 2.8. */
function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolean {
 const parseVersion = (v: string): number[] => v.split('.').map(n => parseInt(n, 10));
Expand All@@ -47,15 +56,9 @@ function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolea
 *
 * Libraries imported *after* this call publish the `tracingChannel` events that
 * the channel-based integrations subscribe to.
 *
 * Idempotent via `globalThis.__SENTRY_ORCHESTRION__` — a no-op if the runtime
 * `--import` hook or a bundler plugin already injected the channels.
 */
export function registerDiagnosticsChannelInjection(options?: RegisterDiagnosticsChannelInjectionOptions): void {
 const g = (globalThis.__SENTRY_ORCHESTRION__ ??= {});

 // Already injected (runtime --import hook or bundler plugin) — nothing to do.
 if (g.runtime) {
 if (GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime) {
@JPeer264JPeer264Jul 15, 2026

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.

m: Shouldn't this be the following?

Suggested change

if(GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime){
if(!!GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime.length){
@timfishtimfishJul 15, 2026•

edited

Loading

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

No, an empty array signifies that the the hooks have been setup:
https://github.com/getsentry/sentry-javascript/pull/22269/changes#diff-61b304378c94fe3c1e3d2612639b4dc1199e5d693369321365c546bae700494dR168
@JPeer264JPeer264Jul 15, 2026

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.

Smart
 return;
 }

Expand DownExpand Up@@ -89,10 +92,7 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic

 // `Module.registerHooks` / `Module.register` are newer than the @types/node
 // we build against, hence the cast.
 const mod = Module as unknown as {
 registerHooks?: (hooks: unknown) => void;
 register?: (specifier: string, options: unknown) => void;
 };
 const mod = Module as NodeModule;

 // runs both at `--import` time and (synchronously) inside `Sentry.init()`,
 // so an unguarded throw would either abort startup or make `init()` throw.
Expand All@@ -105,15 +105,18 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 // We require() the module here so that we can synchronously load it,
 // including from a CommonJS Sentry build, without bundlers pulling in.
 // All versions in stableSyncHooks support this.
 const { initialize, resolve, load } = (
 const { initialize, resolve, load, setDiagnosticsHook } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/hook-sync.mjs`)
 : nodeRequire('@apm-js-collab/tracing-hooks/hook-sync.mjs')
 ) as {
 initialize: (opts: { instrumentations: unknown }) => void;
 resolve: unknown;
 load: unknown;
 };
 ) as TracingHooksSync;

 setDiagnosticsHook(event => {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(event.moduleName);
 });

Comment thread
cursor[bot] marked this conversation as resolved.

 initialize({ instrumentations: SENTRY_INSTRUMENTATIONS });
 mod.registerHooks({ resolve, load });
 DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.registerHooks()');
Expand DownExpand Up@@ -161,5 +164,6 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 return;
 }

 g.runtime = true;
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
}

16 changes: 8 additions & 8 deletions
yarn.lock

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -404,10 +404,10 @@
 dependencies:
 json-schema-to-ts "^3.1.1"

"@apm-js-collab/code-transformer-bundler-plugins@^0.6.0":
 version "0.6.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/code-transformer-bundler-plugins/-/code-transformer-bundler-plugins-0.6.0.tgz#ed64bae9e1871366eadc1ef6dabc9ee6ccc53e57"
 integrity sha512-Hys7LDskIB/BNrd87GAfYWHRE3mWgcPYonK4W9uxjho4N0JnPKk2YQyOLlqmkyVhj2UzwLRpmbJ4D6uR9O7wyw==
"@apm-js-collab/code-transformer-bundler-plugins@^0.6.1":
 version "0.6.1"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/code-transformer-bundler-plugins/-/code-transformer-bundler-plugins-0.6.1.tgz#29bf79167411b8607f02db177250b8f7c16d93e1"
 integrity sha512-TDvypsLUk/W202Y1JBE6I2enQalWjbYXKnxpELWEZn6GLoIcGFii69ljh948hdAzKZJ/wg0Uwivz72a/szoOBQ==
 dependencies:
 "@apm-js-collab/code-transformer" "^0.18.0"
 es-module-lexer "^2.1.0"
Expand All@@ -426,10 +426,10 @@
 semifies "^1.0.0"
 source-map "^0.6.0"

"@apm-js-collab/tracing-hooks@^0.12.0":
 version "0.12.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/tracing-hooks/-/tracing-hooks-0.12.0.tgz#b65505d1d075fc8d8f4fa1973c37eaa9a9975b3f"
 integrity sha512-U1cDbHOFbeToq5VWNcroBtQpz3hfH39uLkzJ5lorBFVNhHbTNj5MQvP+jODDwxBkG6A/agbQelG15rEoDgnjWg==
"@apm-js-collab/tracing-hooks@^0.13.0":
 version "0.13.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/tracing-hooks/-/tracing-hooks-0.13.0.tgz#20b2f77ec7a0e5dfd9fbf2215b56e2c2b7f41e4b"
 integrity sha512-mTvWz9rnQwx1U3h0XPTHaX7bgfkpipLLTQyjlC2cdhQpQEuoLT0AGzoydeoq2NxfEVv6fWOOETcSbb2nptleyw==
 dependencies:
 "@apm-js-collab/code-transformer" "^0.18.0"
 debug "^4.4.1"
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(server-utils): Capture and log orchestrion stats#22269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

timfish
merged 9 commits into

from

Jul 15, 2026
 Merged


feat(server-utils): Capture and log orchestrion stats
#22269
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
300820f

feat(server-utils): Capture and log orchestrion stats


timfish Jul 14, 2026
d241716

Fix Deno tests


timfish Jul 14, 2026
b43a3f5

Lint


timfish Jul 14, 2026
9af3066

Merge remote-tracking branch 'upstream/develop' into timfish/feat/orc…


timfish Jul 15, 2026
b4f9ac0

Inject the successful modules at bundle time


timfish Jul 15, 2026
43c2038

Diagnostics hook on all Node versions


timfish Jul 15, 2026
e038103

Bump plugins


timfish Jul 15, 2026
b1cd5ac

Merge remote-tracking branch 'upstream/develop' into timfish/feat/orc…


timfish Jul 15, 2026
e70753f

Fix lock file


timfish Jul 15, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
dev-packages/deno-integration-tests/suites/orchestrion-mysql/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ Deno.test('@sentry/deno/import: transforms mysql so it publishes the orchestrion
 // ...with the real SQL forwarded through the channel context.
 assert(line.includes('statement=SELECT 1 AS solution'), `expected forwarded SQL, got: ${line}`);
 // The runtime hook set its detection marker at boot.
 assert(line.includes('"runtime":true'), `expected runtime marker, got: ${line}`);
 assert(line.includes('"runtime":["mysql"]'), `expected runtime marker, got: ${line}`);
});

// Exercises the SDK path end-to-end: `init()` wires `denoMysqlIntegration`
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/deno-integration-tests/suites/orchestrion-postgres/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,7 @@ Deno.test('@sentry/deno/import: transforms pg so it publishes the orchestrion ch
 // ...with the real SQL forwarded through the channel context.
 assert(line.includes('statement=SELECT 1 AS solution'), `expected forwarded SQL, got: ${line}`);
 // The runtime hook set its detection marker at boot.
 assert(line.includes('"runtime":true'), `expected runtime marker, got: ${line}`);
 assert(line.includes('"runtime":["pg","pg-pool"]'), `expected runtime marker, got: ${line}`);
});

// Exercises the SDK path end-to-end: `init()` wires `denoPostgresIntegration`
Expand Down

2 changes: 1 addition & 1 deletion
packages/bun/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,7 @@
 "access": "public"
 },
 "dependencies": {
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.0",
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.1",
 "@sentry/core": "10.65.0",
 "@sentry/node": "10.65.0",
 "@sentry/server-utils": "10.65.0"
Expand Down

9 changes: 9 additions & 0 deletions
packages/core/src/utils/worldwide.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,15 @@ export type InternalGlobal = {
 _sentryModuleMetadata?: Record<string, any>;
 _sentryEsmLoaderHookRegistered?: boolean;
 _sentryWrappedDepth?: number;
 /**
 * Orchestrion bundler and runtime detection.
 */
 __SENTRY_ORCHESTRION__?: {
 /** Empty array signifies runtime hooked */
 runtime?: string[];
 /** Empty array signifies bundler plugin ran */
 bundler?: string[];
 };
} & Carrier;

/** Get's the global object for the current JavaScript runtime */
Expand Down

4 changes: 2 additions & 2 deletions
packages/server-utils/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -116,9 +116,9 @@
 "access": "public"
 },
 "dependencies": {
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.0",
 "@apm-js-collab/code-transformer-bundler-plugins": "^0.6.1",
 "@apm-js-collab/code-transformer": "^0.18.0",
 "@apm-js-collab/tracing-hooks": "^0.12.0",
 "@apm-js-collab/tracing-hooks": "^0.13.0",
 "@sentry/conventions": "^0.16.0",
 "@sentry/core": "10.65.0"
 },
Expand Down

6 changes: 3 additions & 3 deletions
packages/server-utils/src/orchestrion/bundler/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,16 +13,16 @@ export type PluginOptions = {
 * The `@apm-js-collab/code-transformer-bundler-plugins` options shared by every
 * orchestrion bundler plugin.
 *
 * `injectDiagnostics` sets `globalThis.__SENTRY_ORCHESTRION__.bundler = true` at
 * `injectDiagnostics` sets `globalThis.__SENTRY_ORCHESTRION__.bundler = ["mysql"]` at
@JPeer264JPeer264Jul 15, 2026

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.

Ah that is smart.
 * app boot so the `_experimentalSetupOrchestrion()` detector can confirm the
 * bundler path ran (rather than relying on a build-time flag that wouldn't be
 * visible to the runtime).
 */
export function orchestrionTransformOptions(options: PluginOptions): Parameters<typeof codeTransformer>[0] {
 return {
 instrumentations: [...SENTRY_INSTRUMENTATIONS, ...(options.instrumentations || [])],
 injectDiagnostics: () => {
 return '(globalThis.__SENTRY_ORCHESTRION__=globalThis.__SENTRY_ORCHESTRION__||{}).bundler=true;';
 injectDiagnostics: (diag: { transformedModules: string[]; failedModules: string[] }) => {
 return `(globalThis.__SENTRY_ORCHESTRION__=globalThis.__SENTRY_ORCHESTRION__||{}).bundler=${JSON.stringify(diag.transformedModules)};`;
 },
 };
}

51 changes: 24 additions & 27 deletions
packages/server-utils/src/orchestrion/detect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
import { debug } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';

declare global {
 // eslint-disable-next-line no-var
 var __SENTRY_ORCHESTRION__: { runtime?: boolean; bundler?: boolean } | undefined;
}
import { debug, GLOBAL_OBJ } from '@sentry/core';

/**
 * Whether orchestrion has injected the diagnostics channels into this process,
Expand All@@ -16,40 +10,43 @@ declare global {
 * will ever publish to those channels.
 */
export function isOrchestrionInjected(): boolean {
 const marker = globalThis.__SENTRY_ORCHESTRION__;
 return !!(marker?.runtime || marker?.bundler);
 return !!GLOBAL_OBJ.__SENTRY_ORCHESTRION__;
Comment thread
cursor[bot] marked this conversation as resolved.

}

/**
 * Verifies that the diagnostics channels have been injected either by the
 * runtime `--import` hook (or init-time registration), a bundler plugin, or
 * both, and warns if not.
 * both, and warns if not. When at least one injector is active, logs for each
 * mechanism whether it hooked (a defined array, even empty, means it did) and
 * which libraries it injected.
 *
 * Both injectors being active at once is fine: they operate on disjoint module
 * sets (a module is either loaded through Node's loader and transformed by the
 * runtime hook, or inlined by the bundler and transformed by the plugin), so
 * a single module can't be double-wrapped. A hybrid setup, with some deps
 * external and runtime-instrumented, others bundled and plugin-instrumented,
 * is fine.
 *
 * Note: intentionally does NOT warn in production, only in debug builds,
 * because production warnings are reserved for truly critical issues.
 */
export function detectOrchestrionSetup(): void {
if (!DEBUG_BUILD) return;
const { runtime, bundler } = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ ?? {};

 const marker = globalThis.__SENTRY_ORCHESTRION__;
 const runtime = !!marker?.runtime;
 const bundler = !!marker?.bundler;

 DEBUG_BUILD && debug.log(`[orchestrion] detect: runtime=${runtime} bundler=${bundler}`);

 if (!isOrchestrionInjected()) {
 DEBUG_BUILD &&
 debug.warn(
 '[Sentry] No diagnostics-channel injection detected. Channel-based integrations ' +
 '(mysql, …) will not record spans. Make sure the diagnostics channels are injected ' +
 'via the runtime `--import` hook or a bundler plugin before the instrumented modules load.',
 );
 if (!runtime && !bundler) {
@JPeer264JPeer264Jul 15, 2026

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.

l/m: Also here. We should check for the array length, right?
@timfishtimfishJul 15, 2026

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

If either of these are defined, we will hit the debug logging below with more details for each.
 debug.warn(
 '[Sentry] No diagnostics-channel injection detected. Channel-based integrations ' +
 'will not record spans. Make sure the diagnostics channels are injected ' +
 'via the runtime `--import` hook or a bundler plugin before the instrumented modules load.',
 );
 return;
 }

 debug.log(
 runtime
 ? `[Sentry] Runtime hook registered, injected libraries=${JSON.stringify(runtime)}`
 : '[Sentry] Runtime hook not registered',
 );
 debug.log(
 bundler
 ? `[Sentry] Bundler plugin ran, injected libraries=${JSON.stringify(bundler)}`
 : '[Sentry] Bundler plugin did not run',
Comment thread
timfish marked this conversation as resolved.

 );
Comment thread
cursor[bot] marked this conversation as resolved.

}

52 changes: 28 additions & 24 deletions
packages/server-utils/src/orchestrion/runtime/register.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
import { debug } from '@sentry/core';
import { debug, GLOBAL_OBJ } from '@sentry/core';
import { createRequire } from 'node:module';
import * as Module from 'node:module';
import { pathToFileURL } from 'node:url';
import { DEBUG_BUILD } from '../../debug-build';
import { SENTRY_INSTRUMENTATIONS } from '../config';
import type { InstrumentationConfig } from '@apm-js-collab/code-transformer';
import type { register } from 'node:module';

type TracingHooksSync = {
 initialize: (opts: { instrumentations: InstrumentationConfig[] }) => void;
 resolve: Function;
 load: Function;
 setDiagnosticsHook: (callback: (event: { url: string; moduleName: string; error: Error }) => void) => void;
};

type NodeModule = {
 registerHooks?: (options: unknown) => { deregister: () => void };
 register?: typeof register;
};

export interface RegisterDiagnosticsChannelInjectionOptions {
 /**
Expand All@@ -17,11 +31,6 @@ export interface RegisterDiagnosticsChannelInjectionOptions {
 tracingHooksDir?: string;
}

declare global {
 // eslint-disable-next-line no-var
 var __SENTRY_ORCHESTRION__: { runtime?: boolean; bundler?: boolean } | undefined;
}

/** `Module.registerHooks` only became stable in Node 24.13 / 25.1 and Deno 2.8. */
function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolean {
 const parseVersion = (v: string): number[] => v.split('.').map(n => parseInt(n, 10));
Expand All@@ -47,15 +56,9 @@ function hasStableSyncModuleHooks(denoVersionString: string | undefined): boolea
 *
 * Libraries imported *after* this call publish the `tracingChannel` events that
 * the channel-based integrations subscribe to.
 *
 * Idempotent via `globalThis.__SENTRY_ORCHESTRION__` — a no-op if the runtime
 * `--import` hook or a bundler plugin already injected the channels.
 */
export function registerDiagnosticsChannelInjection(options?: RegisterDiagnosticsChannelInjectionOptions): void {
 const g = (globalThis.__SENTRY_ORCHESTRION__ ??= {});

 // Already injected (runtime --import hook or bundler plugin) — nothing to do.
 if (g.runtime) {
 if (GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime) {
@JPeer264JPeer264Jul 15, 2026

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.

m: Shouldn't this be the following?

Suggested change

if(GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime){
if(!!GLOBAL_OBJ?.__SENTRY_ORCHESTRION__?.runtime.length){
@timfishtimfishJul 15, 2026•

edited

Loading

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

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

No, an empty array signifies that the the hooks have been setup:
https://github.com/getsentry/sentry-javascript/pull/22269/changes#diff-61b304378c94fe3c1e3d2612639b4dc1199e5d693369321365c546bae700494dR168
@JPeer264JPeer264Jul 15, 2026

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.

Smart
 return;
 }

Expand DownExpand Up@@ -89,10 +92,7 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic

 // `Module.registerHooks` / `Module.register` are newer than the @types/node
 // we build against, hence the cast.
 const mod = Module as unknown as {
 registerHooks?: (hooks: unknown) => void;
 register?: (specifier: string, options: unknown) => void;
 };
 const mod = Module as NodeModule;

 // runs both at `--import` time and (synchronously) inside `Sentry.init()`,
 // so an unguarded throw would either abort startup or make `init()` throw.
Expand All@@ -105,15 +105,18 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 // We require() the module here so that we can synchronously load it,
 // including from a CommonJS Sentry build, without bundlers pulling in.
 // All versions in stableSyncHooks support this.
 const { initialize, resolve, load } = (
 const { initialize, resolve, load, setDiagnosticsHook } = (
 requireFromHooksDir
 ? requireFromHooksDir(`${tracingHooksDir}/hook-sync.mjs`)
 : nodeRequire('@apm-js-collab/tracing-hooks/hook-sync.mjs')
 ) as {
 initialize: (opts: { instrumentations: unknown }) => void;
 resolve: unknown;
 load: unknown;
 };
 ) as TracingHooksSync;

 setDiagnosticsHook(event => {
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime.push(event.moduleName);
 });

Comment thread
cursor[bot] marked this conversation as resolved.

 initialize({ instrumentations: SENTRY_INSTRUMENTATIONS });
 mod.registerHooks({ resolve, load });
 DEBUG_BUILD && debug.log('[orchestrion] registered diagnostics-channel injection via Module.registerHooks()');
Expand DownExpand Up@@ -161,5 +164,6 @@ export function registerDiagnosticsChannelInjection(options?: RegisterDiagnostic
 return;
 }

 g.runtime = true;
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__ = GLOBAL_OBJ.__SENTRY_ORCHESTRION__ || {};
 GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime = GLOBAL_OBJ.__SENTRY_ORCHESTRION__.runtime || [];
}

16 changes: 8 additions & 8 deletions
yarn.lock

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -404,10 +404,10 @@
 dependencies:
 json-schema-to-ts "^3.1.1"

"@apm-js-collab/code-transformer-bundler-plugins@^0.6.0":
 version "0.6.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/code-transformer-bundler-plugins/-/code-transformer-bundler-plugins-0.6.0.tgz#ed64bae9e1871366eadc1ef6dabc9ee6ccc53e57"
 integrity sha512-Hys7LDskIB/BNrd87GAfYWHRE3mWgcPYonK4W9uxjho4N0JnPKk2YQyOLlqmkyVhj2UzwLRpmbJ4D6uR9O7wyw==
"@apm-js-collab/code-transformer-bundler-plugins@^0.6.1":
 version "0.6.1"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/code-transformer-bundler-plugins/-/code-transformer-bundler-plugins-0.6.1.tgz#29bf79167411b8607f02db177250b8f7c16d93e1"
 integrity sha512-TDvypsLUk/W202Y1JBE6I2enQalWjbYXKnxpELWEZn6GLoIcGFii69ljh948hdAzKZJ/wg0Uwivz72a/szoOBQ==
 dependencies:
 "@apm-js-collab/code-transformer" "^0.18.0"
 es-module-lexer "^2.1.0"
Expand All@@ -426,10 +426,10 @@
 semifies "^1.0.0"
 source-map "^0.6.0"

"@apm-js-collab/tracing-hooks@^0.12.0":
 version "0.12.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/tracing-hooks/-/tracing-hooks-0.12.0.tgz#b65505d1d075fc8d8f4fa1973c37eaa9a9975b3f"
 integrity sha512-U1cDbHOFbeToq5VWNcroBtQpz3hfH39uLkzJ5lorBFVNhHbTNj5MQvP+jODDwxBkG6A/agbQelG15rEoDgnjWg==
"@apm-js-collab/tracing-hooks@^0.13.0":
 version "0.13.0"
 resolved "https://registry.yarnpkg.com/@apm-js-collab/tracing-hooks/-/tracing-hooks-0.13.0.tgz#20b2f77ec7a0e5dfd9fbf2215b56e2c2b7f41e4b"
 integrity sha512-mTvWz9rnQwx1U3h0XPTHaX7bgfkpipLLTQyjlC2cdhQpQEuoLT0AGzoydeoq2NxfEVv6fWOOETcSbb2nptleyw==
 dependencies:
 "@apm-js-collab/code-transformer" "^0.18.0"
 debug "^4.4.1"
Expand Down
Loading