fix(server-utils): Ensure all orchestrion instrumentation lazy registers#22387

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

Closed
mydea wants to merge 2 commits into from
Closed

fix(server-utils): Ensure all orchestrion instrumentation lazy registers #22387

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93dba1a
fix(server-utils): Ensure all orchestrion instrumentation lazy registers
mydea Jul 20, 2026
0a548ed
fix lint
mydea Jul 22, 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
19 changes: 12 additions & 7 deletions packages/node/src/integrations/tracing/dataloader/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,19 +9,24 @@ const INTEGRATION_NAME = 'Dataloader' as const;
export const instrumentDataloader = generateInstrumentOnce(INTEGRATION_NAME, () => new DataloaderInstrumentation());

const _dataloaderIntegration = (() => {
// Decide in setup/setupOnce, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
// after the integrations array has already been built, so `isOrchestrionInjected()` is only
// reliable by `setup`. When the diagnostics channels are injected (runtime hook or bundler
// plugin), subscribe to them (the channel integration needs the client to register its
// injection listener); otherwise fall back to the vendored OTel instrumentation.

return {
name: INTEGRATION_NAME,
setupOnce() {
// Decide here, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
// after the integrations array has already been built, so `isOrchestrionInjected()` is only
// reliable by `setupOnce`. When the diagnostics channels are injected (runtime hook or bundler
// plugin), subscribe to them; otherwise fall back to the vendored OTel instrumentation.
if (isOrchestrionInjected()) {
dataloaderChannelIntegration().setupOnce?.();
} else {
if (!isOrchestrionInjected()) {
instrumentDataloader();
}
},
setup(client) {
if (isOrchestrionInjected()) {
dataloaderChannelIntegration().setup?.(client);
}
},
};
}) satisfies IntegrationFn;

Expand Down
18 changes: 12 additions & 6 deletions packages/node/src/integrations/tracing/knex/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,18 +9,24 @@ const INTEGRATION_NAME = 'Knex' as const;
export const instrumentKnex = generateInstrumentOnce(INTEGRATION_NAME, () => new KnexInstrumentation());

const _knexIntegration = (() => {
// Decide in setup/setupOnce, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
// after the integrations array has already been built, so `isOrchestrionInjected()` is only
// reliable by `setup`. When the diagnostics channels are injected (runtime hook or bundler
// plugin), subscribe to them (the channel integration needs the client to register its
// injection listener); otherwise fall back to the vendored OTel instrumentation.

return {
name: INTEGRATION_NAME,
setupOnce() {
// Prefer the diagnostics-channel subscriber when orchestrion injected its channels; otherwise
// fall back to the vendored OTel instrumentation. `isOrchestrionInjected()` is only reliable by
// `setupOnce` (the runtime injection runs during `Sentry.init()`, after integrations are built).
if (isOrchestrionInjected()) {
knexChannelIntegration().setupOnce?.();
} else {
if (!isOrchestrionInjected()) {
instrumentKnex();
}
},
setup(client) {
if (isOrchestrionInjected()) {
knexChannelIntegration().setup?.(client);
}
},
};
}) satisfies IntegrationFn;

Expand Down
37 changes: 12 additions & 25 deletions packages/server-utils/src/integrations/tracing-channel/amqplib.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,13 @@ import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn, Span, SpanAttributes } from '@sentry/core';
import {
continueTrace,
debug,
defineIntegration,
getTraceData,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_KIND,
SPAN_STATUS_ERROR,
startInactiveSpan,
timestampInSeconds,
waitForTracingChannelBinding,
} from '@sentry/core';
// eslint-disable-next-line typescript/no-deprecated -- NET_PEER_* emitted alongside SERVER_* for backwards compatibility (TODO(v11): remove)
import {
Expand All@@ -27,9 +25,10 @@ import {
SERVER_PORT,
URL_FULL,
} from '@sentry/conventions/attributes';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { amqplibModuleNames } from '../../orchestrion/config/amqplib';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Amqplib' integration is omitted from the default set.
Expand DownExpand Up@@ -156,32 +155,20 @@ interface AmqpConnectContext {

const NOOP = (): void => {};

// Guards against subscribing to the amqplib channels more than once in a process. Core dedupes
// `setupOnce` by integration *name*, which is not enough here: the Deno SDK wraps this integration
// under a different name (`DenoAmqplib`) via `extendIntegration`, so adding both would otherwise run
// the subscribe logic twice and emit duplicate spans for every operation.
let subscribed = false;
function instrumentAmqplib(): void {
subscribeConnect();
subscribePublish();
subscribeConfirmPublish();
subscribeConsume();
subscribeDispatch();
subscribeSettle();
}

const _amqplibChannelIntegration = (() => {
return {
name: INTEGRATION_NAME,
setupOnce() {
// `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
if (!diagnosticsChannel.tracingChannel || subscribed) {
return;
}
subscribed = true;

DEBUG_BUILD && debug.log('[orchestrion:amqplib] subscribing to amqplib tracing channels');

waitForTracingChannelBinding(() => {
subscribeConnect();
subscribePublish();
subscribeConfirmPublish();
subscribeConsume();
subscribeDispatch();
subscribeSettle();
});
setup(client) {
invokeOrchestrionInstrumentation(client, amqplibModuleNames, instrumentAmqplib, []);
},
};
}) satisfies IntegrationFn;
Expand Down
54 changes: 22 additions & 32 deletions packages/server-utils/src/integrations/tracing-channel/anthropic.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@ import {
_INTERNAL_shouldSkipAiProviderWrapping,
addAnthropicRequestAttributes,
addAnthropicResponseAttributes,
debug,
defineIntegration,
extractAnthropicRequestAttributes,
GEN_AI_REQUEST_MODEL_ATTRIBUTE,
Expand All@@ -14,11 +13,11 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
shouldEnableTruncation,
startInactiveSpan,
waitForTracingChannelBinding,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { anthropicAiModuleNames } from '../../orchestrion/config/anthropic-ai';

// Same name as the OTel integration by design: when enabled, the OTel 'Anthropic_AI'
// integration is dropped from the default set (see the Node opt-in loader).
Expand DownExpand Up@@ -47,39 +46,30 @@ interface AnthropicChannelContext {
result?: unknown;
}

let subscribed = false;
function instrumentAnthropic(options: AnthropicAiOptions): void {
for (const { channel, operation, methodPath, stream } of INSTRUMENTED_CHANNELS) {
bindTracingChannelToSpan(
diagnosticsChannel.tracingChannel<AnthropicChannelContext>(channel),
data => createGenAiSpan(data, operation, methodPath, options),
{
beforeSpanEnd: (span, data) => {
addAnthropicResponseAttributes(
span,
data.result as AnthropicAiResponse,
resolveAIRecordingOptions(options).recordOutputs,
);
},
deferSpanEnd: ({ span, data }) => wrapStreamResult(span, data, stream, options),
},
);
}
}

const _anthropicChannelIntegration = ((options: AnthropicAiOptions = {}) => {
return {
name: INTEGRATION_NAME,
setupOnce() {
// tracingChannel is unavailable before Node 18.19 and prevent double-subscribe
if (!diagnosticsChannel.tracingChannel || subscribed) {
return;
}
subscribed = true;

// `bindTracingChannelToSpan` needs the async-context binding that `initOpenTelemetry()` registers
// after `setupOnce` runs, so wait for it before subscribing.
waitForTracingChannelBinding(() => {
for (const { channel, operation, methodPath, stream } of INSTRUMENTED_CHANNELS) {
DEBUG_BUILD && debug.log(`[orchestrion:anthropic] subscribing to channel "${channel}"`);
bindTracingChannelToSpan(
diagnosticsChannel.tracingChannel<AnthropicChannelContext>(channel),
data => createGenAiSpan(data, operation, methodPath, options),
{
beforeSpanEnd: (span, data) => {
addAnthropicResponseAttributes(
span,
data.result as AnthropicAiResponse,
resolveAIRecordingOptions(options).recordOutputs,
);
},
deferSpanEnd: ({ span, data }) => wrapStreamResult(span, data, stream, options),
},
);
}
});
setup(client) {
invokeOrchestrionInstrumentation(client, anthropicAiModuleNames, instrumentAnthropic, [options]);
},
};
}) satisfies IntegrationFn;
Expand Down
34 changes: 13 additions & 21 deletions packages/server-utils/src/integrations/tracing-channel/dataloader.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn, Span, StartSpanOptions } from '@sentry/core';
import {
debug,
defineIntegration,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_KIND,
startInactiveSpan,
startSpan,
waitForTracingChannelBinding,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import type { ChannelName } from '../../orchestrion/channels';
import { CHANNELS } from '../../orchestrion/channels';
import type { TracingChannelPayloadWithSpan } from '../../tracing-channel';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { dataloaderModuleNames } from '../../orchestrion/config/dataloader';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Dataloader' integration is omitted from the default set.
const INTEGRATION_NAME = 'Dataloader' as const;

const MODULE_NAME = 'dataloader';
Expand DownExpand Up@@ -78,25 +75,20 @@ function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Oper
};
}

function instrumentDataloader(): void {
subscribeConstruct();
subscribeLoad();
subscribeSimpleOperation(CHANNELS.DATALOADER_LOAD_MANY, 'loadMany');
subscribeSimpleOperation(CHANNELS.DATALOADER_PRIME, 'prime');
subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR, 'clear');
subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR_ALL, 'clearAll');
}

const _dataloaderChannelIntegration = (() => {
return {
name: INTEGRATION_NAME,
setupOnce() {
// `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
if (!diagnosticsChannel.tracingChannel) {
return;
}

DEBUG_BUILD && debug.log('[orchestrion:dataloader] subscribing to dataloader tracing channels');

waitForTracingChannelBinding(() => {
subscribeConstruct();
subscribeLoad();
subscribeSimpleOperation(CHANNELS.DATALOADER_LOAD_MANY, 'loadMany');
subscribeSimpleOperation(CHANNELS.DATALOADER_PRIME, 'prime');
subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR, 'clear');
subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR_ALL, 'clearAll');
});
setup(client) {
invokeOrchestrionInstrumentation(client, dataloaderModuleNames, instrumentDataloader, []);
},
};
}) satisfies IntegrationFn;
Expand Down
16 changes: 5 additions & 11 deletions packages/server-utils/src/integrations/tracing-channel/express/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import { defineIntegration, waitForTracingChannelBinding } from '@sentry/core';
import { defineIntegration } from '@sentry/core';
import type { ExpressIntegrationOptions } from './types';
import { instrumentExpress } from './instrumentation';
import { expressModuleNames } from '../../../orchestrion/config/express';
import { invokeOrchestrionInstrumentation } from '../../../orchestrion/instrumentation';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Express' integration is omitted from the default set.
Expand All@@ -11,15 +12,8 @@ const INTEGRATION_NAME = 'Express' as const;
const _expressChannelIntegration = ((options: ExpressIntegrationOptions = {}) => {
return {
name: INTEGRATION_NAME,
setupOnce() {
// `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
if (!diagnosticsChannel.tracingChannel) {
return;
}

waitForTracingChannelBinding(() => {
instrumentExpress(options, diagnosticsChannel.tracingChannel);
});
setup(client) {
invokeOrchestrionInstrumentation(client, expressModuleNames, instrumentExpress, [options]);
},
};
}) satisfies IntegrationFn;
Expand Down
14 changes: 3 additions & 11 deletions packages/server-utils/src/integrations/tracing-channel/express/instrumentation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type * as diagnosticsChannel from 'node:diagnostics_channel';
import * as diagnosticsChannel from 'node:diagnostics_channel';
import { HTTP_ROUTE } from '@sentry/conventions/attributes';
import type { Span } from '@sentry/core';
import {
Expand DownExpand Up@@ -45,16 +45,8 @@ const ATTR_EXPRESS_TYPE = 'express.type';

const NOOP = (): void => {};

let _isInstrumented = false;

export function instrumentExpress(
options: ExpressIntegrationOptions,
tracingChannel: typeof diagnosticsChannel.tracingChannel,
): void {
if (_isInstrumented) {
return;
}
_isInstrumented = true;
export function instrumentExpress(options: ExpressIntegrationOptions): void {
const tracingChannel = diagnosticsChannel.tracingChannel;

// Record each layer's registered path *pattern* as it is registered, so the
// matched route can be reconstructed with its parameters intact at request
Expand Down
18 changes: 5 additions & 13 deletions packages/server-utils/src/integrations/tracing-channel/generic-pool.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import {
defineIntegration,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
startInactiveSpan,
waitForTracingChannelBinding,
} from '@sentry/core';
import { defineIntegration, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startInactiveSpan } from '@sentry/core';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { genericPoolModuleNames } from '../../orchestrion/config/generic-pool';

// Same name as the OTel integration by design — when enabled, the OTel
// 'GenericPool' integration is omitted from the default set.
Expand All@@ -20,13 +17,8 @@ interface GenericPoolAcquireContext {
const _genericPoolChannelIntegration = (() => {
return {
name: INTEGRATION_NAME,
setupOnce() {
// `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
if (!diagnosticsChannel.tracingChannel) {
return;
}

waitForTracingChannelBinding(() => instrumentGenericPool());
setup(client) {
invokeOrchestrionInstrumentation(client, genericPoolModuleNames, instrumentGenericPool, []);
},
};
}) satisfies IntegrationFn;
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
fix(server-utils): Ensure all orchestrion instrumentation lazy registers#22387

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

 Closed

mydea
wants to merge
2
commits into

from

 Closed


fix(server-utils): Ensure all orchestrion instrumentation lazy registers
#22387
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
93dba1a

fix(server-utils): Ensure all orchestrion instrumentation lazy registers


mydea Jul 20, 2026
0a548ed

fix lint


mydea Jul 22, 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


19 changes: 12 additions & 7 deletions
packages/node/src/integrations/tracing/dataloader/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,19 +9,24 @@ const INTEGRATION_NAME = 'Dataloader' as const;
export const instrumentDataloader = generateInstrumentOnce(INTEGRATION_NAME, () => new DataloaderInstrumentation());

const _dataloaderIntegration = (() => {
 // Decide in setup/setupOnce, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setup`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them (the channel integration needs the client to register its
 // injection listener); otherwise fall back to the vendored OTel instrumentation.

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // Decide here, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setupOnce`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them; otherwise fall back to the vendored OTel instrumentation.
 if (isOrchestrionInjected()) {
 dataloaderChannelIntegration().setupOnce?.();
 } else {
 if (!isOrchestrionInjected()) {
 instrumentDataloader();
 }
 },
 setup(client) {
 if (isOrchestrionInjected()) {
 dataloaderChannelIntegration().setup?.(client);
 }
 },
 };
}) satisfies IntegrationFn;

Expand Down

18 changes: 12 additions & 6 deletions
packages/node/src/integrations/tracing/knex/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,18 +9,24 @@ const INTEGRATION_NAME = 'Knex' as const;
export const instrumentKnex = generateInstrumentOnce(INTEGRATION_NAME, () => new KnexInstrumentation());

const _knexIntegration = (() => {
 // Decide in setup/setupOnce, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setup`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them (the channel integration needs the client to register its
 // injection listener); otherwise fall back to the vendored OTel instrumentation.

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // Prefer the diagnostics-channel subscriber when orchestrion injected its channels; otherwise
 // fall back to the vendored OTel instrumentation. `isOrchestrionInjected()` is only reliable by
 // `setupOnce` (the runtime injection runs during `Sentry.init()`, after integrations are built).
 if (isOrchestrionInjected()) {
 knexChannelIntegration().setupOnce?.();
 } else {
 if (!isOrchestrionInjected()) {
 instrumentKnex();
 }
 },
 setup(client) {
 if (isOrchestrionInjected()) {
 knexChannelIntegration().setup?.(client);
 }
 },
 };
}) satisfies IntegrationFn;

Expand Down

37 changes: 12 additions & 25 deletions
packages/server-utils/src/integrations/tracing-channel/amqplib.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,13 @@ import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn, Span, SpanAttributes } from '@sentry/core';
import {
 continueTrace,
 debug,
 defineIntegration,
 getTraceData,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SPAN_KIND,
 SPAN_STATUS_ERROR,
 startInactiveSpan,
 timestampInSeconds,
 waitForTracingChannelBinding,
} from '@sentry/core';
// eslint-disable-next-line typescript/no-deprecated -- NET_PEER_* emitted alongside SERVER_* for backwards compatibility (TODO(v11): remove)
import {
Expand All@@ -27,9 +25,10 @@ import {
 SERVER_PORT,
 URL_FULL,
} from '@sentry/conventions/attributes';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { amqplibModuleNames } from '../../orchestrion/config/amqplib';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Amqplib' integration is omitted from the default set.
Expand DownExpand Up@@ -156,32 +155,20 @@ interface AmqpConnectContext {

const NOOP = (): void => {};

// Guards against subscribing to the amqplib channels more than once in a process. Core dedupes
// `setupOnce` by integration *name*, which is not enough here: the Deno SDK wraps this integration
// under a different name (`DenoAmqplib`) via `extendIntegration`, so adding both would otherwise run
// the subscribe logic twice and emit duplicate spans for every operation.
let subscribed = false;
function instrumentAmqplib(): void {
 subscribeConnect();
 subscribePublish();
 subscribeConfirmPublish();
 subscribeConsume();
 subscribeDispatch();
 subscribeSettle();
}

const _amqplibChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel || subscribed) {
 return;
 }
 subscribed = true;

 DEBUG_BUILD && debug.log('[orchestrion:amqplib] subscribing to amqplib tracing channels');

 waitForTracingChannelBinding(() => {
 subscribeConnect();
 subscribePublish();
 subscribeConfirmPublish();
 subscribeConsume();
 subscribeDispatch();
 subscribeSettle();
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, amqplibModuleNames, instrumentAmqplib, []);
 },
 };
}) satisfies IntegrationFn;
Expand Down

54 changes: 22 additions & 32 deletions
packages/server-utils/src/integrations/tracing-channel/anthropic.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@ import {
 _INTERNAL_shouldSkipAiProviderWrapping,
 addAnthropicRequestAttributes,
 addAnthropicResponseAttributes,
 debug,
 defineIntegration,
 extractAnthropicRequestAttributes,
 GEN_AI_REQUEST_MODEL_ATTRIBUTE,
Expand All@@ -14,11 +13,11 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 shouldEnableTruncation,
 startInactiveSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { anthropicAiModuleNames } from '../../orchestrion/config/anthropic-ai';

// Same name as the OTel integration by design: when enabled, the OTel 'Anthropic_AI'
// integration is dropped from the default set (see the Node opt-in loader).
Expand DownExpand Up@@ -47,39 +46,30 @@ interface AnthropicChannelContext {
 result?: unknown;
}

let subscribed = false;
function instrumentAnthropic(options: AnthropicAiOptions): void {
 for (const { channel, operation, methodPath, stream } of INSTRUMENTED_CHANNELS) {
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<AnthropicChannelContext>(channel),
 data => createGenAiSpan(data, operation, methodPath, options),
 {
 beforeSpanEnd: (span, data) => {
 addAnthropicResponseAttributes(
 span,
 data.result as AnthropicAiResponse,
 resolveAIRecordingOptions(options).recordOutputs,
 );
 },
 deferSpanEnd: ({ span, data }) => wrapStreamResult(span, data, stream, options),
 },
 );
 }
}

const _anthropicChannelIntegration = ((options: AnthropicAiOptions = {}) => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // tracingChannel is unavailable before Node 18.19 and prevent double-subscribe
 if (!diagnosticsChannel.tracingChannel || subscribed) {
 return;
 }
 subscribed = true;

 // `bindTracingChannelToSpan` needs the async-context binding that `initOpenTelemetry()` registers
 // after `setupOnce` runs, so wait for it before subscribing.
 waitForTracingChannelBinding(() => {
 for (const { channel, operation, methodPath, stream } of INSTRUMENTED_CHANNELS) {
 DEBUG_BUILD && debug.log(`[orchestrion:anthropic] subscribing to channel "${channel}"`);
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<AnthropicChannelContext>(channel),
 data => createGenAiSpan(data, operation, methodPath, options),
 {
 beforeSpanEnd: (span, data) => {
 addAnthropicResponseAttributes(
 span,
 data.result as AnthropicAiResponse,
 resolveAIRecordingOptions(options).recordOutputs,
 );
 },
 deferSpanEnd: ({ span, data }) => wrapStreamResult(span, data, stream, options),
 },
 );
 }
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, anthropicAiModuleNames, instrumentAnthropic, [options]);
 },
 };
}) satisfies IntegrationFn;
Expand Down

34 changes: 13 additions & 21 deletions
packages/server-utils/src/integrations/tracing-channel/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn, Span, StartSpanOptions } from '@sentry/core';
import {
 debug,
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SPAN_KIND,
 startInactiveSpan,
 startSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import type { ChannelName } from '../../orchestrion/channels';
import { CHANNELS } from '../../orchestrion/channels';
import type { TracingChannelPayloadWithSpan } from '../../tracing-channel';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { dataloaderModuleNames } from '../../orchestrion/config/dataloader';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Dataloader' integration is omitted from the default set.
const INTEGRATION_NAME = 'Dataloader' as const;

const MODULE_NAME = 'dataloader';
Expand DownExpand Up@@ -78,25 +75,20 @@ function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Oper
 };
}

function instrumentDataloader(): void {
 subscribeConstruct();
 subscribeLoad();
 subscribeSimpleOperation(CHANNELS.DATALOADER_LOAD_MANY, 'loadMany');
 subscribeSimpleOperation(CHANNELS.DATALOADER_PRIME, 'prime');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR, 'clear');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR_ALL, 'clearAll');
}

const _dataloaderChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 DEBUG_BUILD && debug.log('[orchestrion:dataloader] subscribing to dataloader tracing channels');

 waitForTracingChannelBinding(() => {
 subscribeConstruct();
 subscribeLoad();
 subscribeSimpleOperation(CHANNELS.DATALOADER_LOAD_MANY, 'loadMany');
 subscribeSimpleOperation(CHANNELS.DATALOADER_PRIME, 'prime');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR, 'clear');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR_ALL, 'clearAll');
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, dataloaderModuleNames, instrumentDataloader, []);
 },
 };
}) satisfies IntegrationFn;
Expand Down

16 changes: 5 additions & 11 deletions
packages/server-utils/src/integrations/tracing-channel/express/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import { defineIntegration, waitForTracingChannelBinding } from '@sentry/core';
import { defineIntegration } from '@sentry/core';
import type { ExpressIntegrationOptions } from './types';
import { instrumentExpress } from './instrumentation';
import { expressModuleNames } from '../../../orchestrion/config/express';
import { invokeOrchestrionInstrumentation } from '../../../orchestrion/instrumentation';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Express' integration is omitted from the default set.
Expand All@@ -11,15 +12,8 @@ const INTEGRATION_NAME = 'Express' as const;
const _expressChannelIntegration = ((options: ExpressIntegrationOptions = {}) => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 waitForTracingChannelBinding(() => {
 instrumentExpress(options, diagnosticsChannel.tracingChannel);
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, expressModuleNames, instrumentExpress, [options]);
 },
 };
}) satisfies IntegrationFn;
Expand Down

14 changes: 3 additions & 11 deletions
packages/server-utils/src/integrations/tracing-channel/express/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type * as diagnosticsChannel from 'node:diagnostics_channel';
import * as diagnosticsChannel from 'node:diagnostics_channel';
import { HTTP_ROUTE } from '@sentry/conventions/attributes';
import type { Span } from '@sentry/core';
import {
Expand DownExpand Up@@ -45,16 +45,8 @@ const ATTR_EXPRESS_TYPE = 'express.type';

const NOOP = (): void => {};

let _isInstrumented = false;

export function instrumentExpress(
 options: ExpressIntegrationOptions,
 tracingChannel: typeof diagnosticsChannel.tracingChannel,
): void {
 if (_isInstrumented) {
 return;
 }
 _isInstrumented = true;
export function instrumentExpress(options: ExpressIntegrationOptions): void {
 const tracingChannel = diagnosticsChannel.tracingChannel;

 // Record each layer's registered path *pattern* as it is registered, so the
 // matched route can be reconstructed with its parameters intact at request
Expand Down

18 changes: 5 additions & 13 deletions
packages/server-utils/src/integrations/tracing-channel/generic-pool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import {
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 startInactiveSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { defineIntegration, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startInactiveSpan } from '@sentry/core';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { genericPoolModuleNames } from '../../orchestrion/config/generic-pool';

// Same name as the OTel integration by design — when enabled, the OTel
// 'GenericPool' integration is omitted from the default set.
Expand All@@ -20,13 +17,8 @@ interface GenericPoolAcquireContext {
const _genericPoolChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 waitForTracingChannelBinding(() => instrumentGenericPool());
 setup(client) {
 invokeOrchestrionInstrumentation(client, genericPoolModuleNames, instrumentGenericPool, []);
 },
 };
}) satisfies IntegrationFn;
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
fix(server-utils): Ensure all orchestrion instrumentation lazy registers#22387

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

 Closed

mydea
wants to merge
2
commits into

from

 Closed


fix(server-utils): Ensure all orchestrion instrumentation lazy registers
#22387
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
93dba1a

fix(server-utils): Ensure all orchestrion instrumentation lazy registers


mydea Jul 20, 2026
0a548ed

fix lint


mydea Jul 22, 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


19 changes: 12 additions & 7 deletions
packages/node/src/integrations/tracing/dataloader/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,19 +9,24 @@ const INTEGRATION_NAME = 'Dataloader' as const;
export const instrumentDataloader = generateInstrumentOnce(INTEGRATION_NAME, () => new DataloaderInstrumentation());

const _dataloaderIntegration = (() => {
 // Decide in setup/setupOnce, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setup`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them (the channel integration needs the client to register its
 // injection listener); otherwise fall back to the vendored OTel instrumentation.

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // Decide here, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setupOnce`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them; otherwise fall back to the vendored OTel instrumentation.
 if (isOrchestrionInjected()) {
 dataloaderChannelIntegration().setupOnce?.();
 } else {
 if (!isOrchestrionInjected()) {
 instrumentDataloader();
 }
 },
 setup(client) {
 if (isOrchestrionInjected()) {
 dataloaderChannelIntegration().setup?.(client);
 }
 },
 };
}) satisfies IntegrationFn;

Expand Down

18 changes: 12 additions & 6 deletions
packages/node/src/integrations/tracing/knex/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,18 +9,24 @@ const INTEGRATION_NAME = 'Knex' as const;
export const instrumentKnex = generateInstrumentOnce(INTEGRATION_NAME, () => new KnexInstrumentation());

const _knexIntegration = (() => {
 // Decide in setup/setupOnce, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setup`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them (the channel integration needs the client to register its
 // injection listener); otherwise fall back to the vendored OTel instrumentation.

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // Prefer the diagnostics-channel subscriber when orchestrion injected its channels; otherwise
 // fall back to the vendored OTel instrumentation. `isOrchestrionInjected()` is only reliable by
 // `setupOnce` (the runtime injection runs during `Sentry.init()`, after integrations are built).
 if (isOrchestrionInjected()) {
 knexChannelIntegration().setupOnce?.();
 } else {
 if (!isOrchestrionInjected()) {
 instrumentKnex();
 }
 },
 setup(client) {
 if (isOrchestrionInjected()) {
 knexChannelIntegration().setup?.(client);
 }
 },
 };
}) satisfies IntegrationFn;

Expand Down

37 changes: 12 additions & 25 deletions
packages/server-utils/src/integrations/tracing-channel/amqplib.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,13 @@ import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn, Span, SpanAttributes } from '@sentry/core';
import {
 continueTrace,
 debug,
 defineIntegration,
 getTraceData,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SPAN_KIND,
 SPAN_STATUS_ERROR,
 startInactiveSpan,
 timestampInSeconds,
 waitForTracingChannelBinding,
} from '@sentry/core';
// eslint-disable-next-line typescript/no-deprecated -- NET_PEER_* emitted alongside SERVER_* for backwards compatibility (TODO(v11): remove)
import {
Expand All@@ -27,9 +25,10 @@ import {
 SERVER_PORT,
 URL_FULL,
} from '@sentry/conventions/attributes';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { amqplibModuleNames } from '../../orchestrion/config/amqplib';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Amqplib' integration is omitted from the default set.
Expand DownExpand Up@@ -156,32 +155,20 @@ interface AmqpConnectContext {

const NOOP = (): void => {};

// Guards against subscribing to the amqplib channels more than once in a process. Core dedupes
// `setupOnce` by integration *name*, which is not enough here: the Deno SDK wraps this integration
// under a different name (`DenoAmqplib`) via `extendIntegration`, so adding both would otherwise run
// the subscribe logic twice and emit duplicate spans for every operation.
let subscribed = false;
function instrumentAmqplib(): void {
 subscribeConnect();
 subscribePublish();
 subscribeConfirmPublish();
 subscribeConsume();
 subscribeDispatch();
 subscribeSettle();
}

const _amqplibChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel || subscribed) {
 return;
 }
 subscribed = true;

 DEBUG_BUILD && debug.log('[orchestrion:amqplib] subscribing to amqplib tracing channels');

 waitForTracingChannelBinding(() => {
 subscribeConnect();
 subscribePublish();
 subscribeConfirmPublish();
 subscribeConsume();
 subscribeDispatch();
 subscribeSettle();
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, amqplibModuleNames, instrumentAmqplib, []);
 },
 };
}) satisfies IntegrationFn;
Expand Down

54 changes: 22 additions & 32 deletions
packages/server-utils/src/integrations/tracing-channel/anthropic.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@ import {
 _INTERNAL_shouldSkipAiProviderWrapping,
 addAnthropicRequestAttributes,
 addAnthropicResponseAttributes,
 debug,
 defineIntegration,
 extractAnthropicRequestAttributes,
 GEN_AI_REQUEST_MODEL_ATTRIBUTE,
Expand All@@ -14,11 +13,11 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 shouldEnableTruncation,
 startInactiveSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { anthropicAiModuleNames } from '../../orchestrion/config/anthropic-ai';

// Same name as the OTel integration by design: when enabled, the OTel 'Anthropic_AI'
// integration is dropped from the default set (see the Node opt-in loader).
Expand DownExpand Up@@ -47,39 +46,30 @@ interface AnthropicChannelContext {
 result?: unknown;
}

let subscribed = false;
function instrumentAnthropic(options: AnthropicAiOptions): void {
 for (const { channel, operation, methodPath, stream } of INSTRUMENTED_CHANNELS) {
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<AnthropicChannelContext>(channel),
 data => createGenAiSpan(data, operation, methodPath, options),
 {
 beforeSpanEnd: (span, data) => {
 addAnthropicResponseAttributes(
 span,
 data.result as AnthropicAiResponse,
 resolveAIRecordingOptions(options).recordOutputs,
 );
 },
 deferSpanEnd: ({ span, data }) => wrapStreamResult(span, data, stream, options),
 },
 );
 }
}

const _anthropicChannelIntegration = ((options: AnthropicAiOptions = {}) => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // tracingChannel is unavailable before Node 18.19 and prevent double-subscribe
 if (!diagnosticsChannel.tracingChannel || subscribed) {
 return;
 }
 subscribed = true;

 // `bindTracingChannelToSpan` needs the async-context binding that `initOpenTelemetry()` registers
 // after `setupOnce` runs, so wait for it before subscribing.
 waitForTracingChannelBinding(() => {
 for (const { channel, operation, methodPath, stream } of INSTRUMENTED_CHANNELS) {
 DEBUG_BUILD && debug.log(`[orchestrion:anthropic] subscribing to channel "${channel}"`);
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<AnthropicChannelContext>(channel),
 data => createGenAiSpan(data, operation, methodPath, options),
 {
 beforeSpanEnd: (span, data) => {
 addAnthropicResponseAttributes(
 span,
 data.result as AnthropicAiResponse,
 resolveAIRecordingOptions(options).recordOutputs,
 );
 },
 deferSpanEnd: ({ span, data }) => wrapStreamResult(span, data, stream, options),
 },
 );
 }
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, anthropicAiModuleNames, instrumentAnthropic, [options]);
 },
 };
}) satisfies IntegrationFn;
Expand Down

34 changes: 13 additions & 21 deletions
packages/server-utils/src/integrations/tracing-channel/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn, Span, StartSpanOptions } from '@sentry/core';
import {
 debug,
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SPAN_KIND,
 startInactiveSpan,
 startSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import type { ChannelName } from '../../orchestrion/channels';
import { CHANNELS } from '../../orchestrion/channels';
import type { TracingChannelPayloadWithSpan } from '../../tracing-channel';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { dataloaderModuleNames } from '../../orchestrion/config/dataloader';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Dataloader' integration is omitted from the default set.
const INTEGRATION_NAME = 'Dataloader' as const;

const MODULE_NAME = 'dataloader';
Expand DownExpand Up@@ -78,25 +75,20 @@ function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Oper
 };
}

function instrumentDataloader(): void {
 subscribeConstruct();
 subscribeLoad();
 subscribeSimpleOperation(CHANNELS.DATALOADER_LOAD_MANY, 'loadMany');
 subscribeSimpleOperation(CHANNELS.DATALOADER_PRIME, 'prime');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR, 'clear');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR_ALL, 'clearAll');
}

const _dataloaderChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 DEBUG_BUILD && debug.log('[orchestrion:dataloader] subscribing to dataloader tracing channels');

 waitForTracingChannelBinding(() => {
 subscribeConstruct();
 subscribeLoad();
 subscribeSimpleOperation(CHANNELS.DATALOADER_LOAD_MANY, 'loadMany');
 subscribeSimpleOperation(CHANNELS.DATALOADER_PRIME, 'prime');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR, 'clear');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR_ALL, 'clearAll');
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, dataloaderModuleNames, instrumentDataloader, []);
 },
 };
}) satisfies IntegrationFn;
Expand Down

16 changes: 5 additions & 11 deletions
packages/server-utils/src/integrations/tracing-channel/express/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import { defineIntegration, waitForTracingChannelBinding } from '@sentry/core';
import { defineIntegration } from '@sentry/core';
import type { ExpressIntegrationOptions } from './types';
import { instrumentExpress } from './instrumentation';
import { expressModuleNames } from '../../../orchestrion/config/express';
import { invokeOrchestrionInstrumentation } from '../../../orchestrion/instrumentation';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Express' integration is omitted from the default set.
Expand All@@ -11,15 +12,8 @@ const INTEGRATION_NAME = 'Express' as const;
const _expressChannelIntegration = ((options: ExpressIntegrationOptions = {}) => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 waitForTracingChannelBinding(() => {
 instrumentExpress(options, diagnosticsChannel.tracingChannel);
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, expressModuleNames, instrumentExpress, [options]);
 },
 };
}) satisfies IntegrationFn;
Expand Down

14 changes: 3 additions & 11 deletions
packages/server-utils/src/integrations/tracing-channel/express/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type * as diagnosticsChannel from 'node:diagnostics_channel';
import * as diagnosticsChannel from 'node:diagnostics_channel';
import { HTTP_ROUTE } from '@sentry/conventions/attributes';
import type { Span } from '@sentry/core';
import {
Expand DownExpand Up@@ -45,16 +45,8 @@ const ATTR_EXPRESS_TYPE = 'express.type';

const NOOP = (): void => {};

let _isInstrumented = false;

export function instrumentExpress(
 options: ExpressIntegrationOptions,
 tracingChannel: typeof diagnosticsChannel.tracingChannel,
): void {
 if (_isInstrumented) {
 return;
 }
 _isInstrumented = true;
export function instrumentExpress(options: ExpressIntegrationOptions): void {
 const tracingChannel = diagnosticsChannel.tracingChannel;

 // Record each layer's registered path *pattern* as it is registered, so the
 // matched route can be reconstructed with its parameters intact at request
Expand Down

18 changes: 5 additions & 13 deletions
packages/server-utils/src/integrations/tracing-channel/generic-pool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import {
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 startInactiveSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { defineIntegration, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startInactiveSpan } from '@sentry/core';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { genericPoolModuleNames } from '../../orchestrion/config/generic-pool';

// Same name as the OTel integration by design — when enabled, the OTel
// 'GenericPool' integration is omitted from the default set.
Expand All@@ -20,13 +17,8 @@ interface GenericPoolAcquireContext {
const _genericPoolChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 waitForTracingChannelBinding(() => instrumentGenericPool());
 setup(client) {
 invokeOrchestrionInstrumentation(client, genericPoolModuleNames, instrumentGenericPool, []);
 },
 };
}) satisfies IntegrationFn;
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
fix(server-utils): Ensure all orchestrion instrumentation lazy registers#22387

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

 Closed

mydea
wants to merge
2
commits into

from

 Closed


fix(server-utils): Ensure all orchestrion instrumentation lazy registers
#22387
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
93dba1a

fix(server-utils): Ensure all orchestrion instrumentation lazy registers


mydea Jul 20, 2026
0a548ed

fix lint


mydea Jul 22, 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


19 changes: 12 additions & 7 deletions
packages/node/src/integrations/tracing/dataloader/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,19 +9,24 @@ const INTEGRATION_NAME = 'Dataloader' as const;
export const instrumentDataloader = generateInstrumentOnce(INTEGRATION_NAME, () => new DataloaderInstrumentation());

const _dataloaderIntegration = (() => {
 // Decide in setup/setupOnce, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setup`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them (the channel integration needs the client to register its
 // injection listener); otherwise fall back to the vendored OTel instrumentation.

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // Decide here, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setupOnce`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them; otherwise fall back to the vendored OTel instrumentation.
 if (isOrchestrionInjected()) {
 dataloaderChannelIntegration().setupOnce?.();
 } else {
 if (!isOrchestrionInjected()) {
 instrumentDataloader();
 }
 },
 setup(client) {
 if (isOrchestrionInjected()) {
 dataloaderChannelIntegration().setup?.(client);
 }
 },
 };
}) satisfies IntegrationFn;

Expand Down

18 changes: 12 additions & 6 deletions
packages/node/src/integrations/tracing/knex/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,18 +9,24 @@ const INTEGRATION_NAME = 'Knex' as const;
export const instrumentKnex = generateInstrumentOnce(INTEGRATION_NAME, () => new KnexInstrumentation());

const _knexIntegration = (() => {
 // Decide in setup/setupOnce, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setup`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them (the channel integration needs the client to register its
 // injection listener); otherwise fall back to the vendored OTel instrumentation.

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // Prefer the diagnostics-channel subscriber when orchestrion injected its channels; otherwise
 // fall back to the vendored OTel instrumentation. `isOrchestrionInjected()` is only reliable by
 // `setupOnce` (the runtime injection runs during `Sentry.init()`, after integrations are built).
 if (isOrchestrionInjected()) {
 knexChannelIntegration().setupOnce?.();
 } else {
 if (!isOrchestrionInjected()) {
 instrumentKnex();
 }
 },
 setup(client) {
 if (isOrchestrionInjected()) {
 knexChannelIntegration().setup?.(client);
 }
 },
 };
}) satisfies IntegrationFn;

Expand Down

37 changes: 12 additions & 25 deletions
packages/server-utils/src/integrations/tracing-channel/amqplib.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,13 @@ import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn, Span, SpanAttributes } from '@sentry/core';
import {
 continueTrace,
 debug,
 defineIntegration,
 getTraceData,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SPAN_KIND,
 SPAN_STATUS_ERROR,
 startInactiveSpan,
 timestampInSeconds,
 waitForTracingChannelBinding,
} from '@sentry/core';
// eslint-disable-next-line typescript/no-deprecated -- NET_PEER_* emitted alongside SERVER_* for backwards compatibility (TODO(v11): remove)
import {
Expand All@@ -27,9 +25,10 @@ import {
 SERVER_PORT,
 URL_FULL,
} from '@sentry/conventions/attributes';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { amqplibModuleNames } from '../../orchestrion/config/amqplib';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Amqplib' integration is omitted from the default set.
Expand DownExpand Up@@ -156,32 +155,20 @@ interface AmqpConnectContext {

const NOOP = (): void => {};

// Guards against subscribing to the amqplib channels more than once in a process. Core dedupes
// `setupOnce` by integration *name*, which is not enough here: the Deno SDK wraps this integration
// under a different name (`DenoAmqplib`) via `extendIntegration`, so adding both would otherwise run
// the subscribe logic twice and emit duplicate spans for every operation.
let subscribed = false;
function instrumentAmqplib(): void {
 subscribeConnect();
 subscribePublish();
 subscribeConfirmPublish();
 subscribeConsume();
 subscribeDispatch();
 subscribeSettle();
}

const _amqplibChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel || subscribed) {
 return;
 }
 subscribed = true;

 DEBUG_BUILD && debug.log('[orchestrion:amqplib] subscribing to amqplib tracing channels');

 waitForTracingChannelBinding(() => {
 subscribeConnect();
 subscribePublish();
 subscribeConfirmPublish();
 subscribeConsume();
 subscribeDispatch();
 subscribeSettle();
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, amqplibModuleNames, instrumentAmqplib, []);
 },
 };
}) satisfies IntegrationFn;
Expand Down

54 changes: 22 additions & 32 deletions
packages/server-utils/src/integrations/tracing-channel/anthropic.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@ import {
 _INTERNAL_shouldSkipAiProviderWrapping,
 addAnthropicRequestAttributes,
 addAnthropicResponseAttributes,
 debug,
 defineIntegration,
 extractAnthropicRequestAttributes,
 GEN_AI_REQUEST_MODEL_ATTRIBUTE,
Expand All@@ -14,11 +13,11 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 shouldEnableTruncation,
 startInactiveSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { anthropicAiModuleNames } from '../../orchestrion/config/anthropic-ai';

// Same name as the OTel integration by design: when enabled, the OTel 'Anthropic_AI'
// integration is dropped from the default set (see the Node opt-in loader).
Expand DownExpand Up@@ -47,39 +46,30 @@ interface AnthropicChannelContext {
 result?: unknown;
}

let subscribed = false;
function instrumentAnthropic(options: AnthropicAiOptions): void {
 for (const { channel, operation, methodPath, stream } of INSTRUMENTED_CHANNELS) {
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<AnthropicChannelContext>(channel),
 data => createGenAiSpan(data, operation, methodPath, options),
 {
 beforeSpanEnd: (span, data) => {
 addAnthropicResponseAttributes(
 span,
 data.result as AnthropicAiResponse,
 resolveAIRecordingOptions(options).recordOutputs,
 );
 },
 deferSpanEnd: ({ span, data }) => wrapStreamResult(span, data, stream, options),
 },
 );
 }
}

const _anthropicChannelIntegration = ((options: AnthropicAiOptions = {}) => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // tracingChannel is unavailable before Node 18.19 and prevent double-subscribe
 if (!diagnosticsChannel.tracingChannel || subscribed) {
 return;
 }
 subscribed = true;

 // `bindTracingChannelToSpan` needs the async-context binding that `initOpenTelemetry()` registers
 // after `setupOnce` runs, so wait for it before subscribing.
 waitForTracingChannelBinding(() => {
 for (const { channel, operation, methodPath, stream } of INSTRUMENTED_CHANNELS) {
 DEBUG_BUILD && debug.log(`[orchestrion:anthropic] subscribing to channel "${channel}"`);
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<AnthropicChannelContext>(channel),
 data => createGenAiSpan(data, operation, methodPath, options),
 {
 beforeSpanEnd: (span, data) => {
 addAnthropicResponseAttributes(
 span,
 data.result as AnthropicAiResponse,
 resolveAIRecordingOptions(options).recordOutputs,
 );
 },
 deferSpanEnd: ({ span, data }) => wrapStreamResult(span, data, stream, options),
 },
 );
 }
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, anthropicAiModuleNames, instrumentAnthropic, [options]);
 },
 };
}) satisfies IntegrationFn;
Expand Down

34 changes: 13 additions & 21 deletions
packages/server-utils/src/integrations/tracing-channel/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn, Span, StartSpanOptions } from '@sentry/core';
import {
 debug,
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SPAN_KIND,
 startInactiveSpan,
 startSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import type { ChannelName } from '../../orchestrion/channels';
import { CHANNELS } from '../../orchestrion/channels';
import type { TracingChannelPayloadWithSpan } from '../../tracing-channel';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { dataloaderModuleNames } from '../../orchestrion/config/dataloader';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Dataloader' integration is omitted from the default set.
const INTEGRATION_NAME = 'Dataloader' as const;

const MODULE_NAME = 'dataloader';
Expand DownExpand Up@@ -78,25 +75,20 @@ function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Oper
 };
}

function instrumentDataloader(): void {
 subscribeConstruct();
 subscribeLoad();
 subscribeSimpleOperation(CHANNELS.DATALOADER_LOAD_MANY, 'loadMany');
 subscribeSimpleOperation(CHANNELS.DATALOADER_PRIME, 'prime');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR, 'clear');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR_ALL, 'clearAll');
}

const _dataloaderChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 DEBUG_BUILD && debug.log('[orchestrion:dataloader] subscribing to dataloader tracing channels');

 waitForTracingChannelBinding(() => {
 subscribeConstruct();
 subscribeLoad();
 subscribeSimpleOperation(CHANNELS.DATALOADER_LOAD_MANY, 'loadMany');
 subscribeSimpleOperation(CHANNELS.DATALOADER_PRIME, 'prime');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR, 'clear');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR_ALL, 'clearAll');
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, dataloaderModuleNames, instrumentDataloader, []);
 },
 };
}) satisfies IntegrationFn;
Expand Down

16 changes: 5 additions & 11 deletions
packages/server-utils/src/integrations/tracing-channel/express/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import { defineIntegration, waitForTracingChannelBinding } from '@sentry/core';
import { defineIntegration } from '@sentry/core';
import type { ExpressIntegrationOptions } from './types';
import { instrumentExpress } from './instrumentation';
import { expressModuleNames } from '../../../orchestrion/config/express';
import { invokeOrchestrionInstrumentation } from '../../../orchestrion/instrumentation';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Express' integration is omitted from the default set.
Expand All@@ -11,15 +12,8 @@ const INTEGRATION_NAME = 'Express' as const;
const _expressChannelIntegration = ((options: ExpressIntegrationOptions = {}) => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 waitForTracingChannelBinding(() => {
 instrumentExpress(options, diagnosticsChannel.tracingChannel);
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, expressModuleNames, instrumentExpress, [options]);
 },
 };
}) satisfies IntegrationFn;
Expand Down

14 changes: 3 additions & 11 deletions
packages/server-utils/src/integrations/tracing-channel/express/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type * as diagnosticsChannel from 'node:diagnostics_channel';
import * as diagnosticsChannel from 'node:diagnostics_channel';
import { HTTP_ROUTE } from '@sentry/conventions/attributes';
import type { Span } from '@sentry/core';
import {
Expand DownExpand Up@@ -45,16 +45,8 @@ const ATTR_EXPRESS_TYPE = 'express.type';

const NOOP = (): void => {};

let _isInstrumented = false;

export function instrumentExpress(
 options: ExpressIntegrationOptions,
 tracingChannel: typeof diagnosticsChannel.tracingChannel,
): void {
 if (_isInstrumented) {
 return;
 }
 _isInstrumented = true;
export function instrumentExpress(options: ExpressIntegrationOptions): void {
 const tracingChannel = diagnosticsChannel.tracingChannel;

 // Record each layer's registered path *pattern* as it is registered, so the
 // matched route can be reconstructed with its parameters intact at request
Expand Down

18 changes: 5 additions & 13 deletions
packages/server-utils/src/integrations/tracing-channel/generic-pool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import {
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 startInactiveSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { defineIntegration, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startInactiveSpan } from '@sentry/core';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { genericPoolModuleNames } from '../../orchestrion/config/generic-pool';

// Same name as the OTel integration by design — when enabled, the OTel
// 'GenericPool' integration is omitted from the default set.
Expand All@@ -20,13 +17,8 @@ interface GenericPoolAcquireContext {
const _genericPoolChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 waitForTracingChannelBinding(() => instrumentGenericPool());
 setup(client) {
 invokeOrchestrionInstrumentation(client, genericPoolModuleNames, instrumentGenericPool, []);
 },
 };
}) satisfies IntegrationFn;
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
fix(server-utils): Ensure all orchestrion instrumentation lazy registers#22387

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

 Closed

mydea
wants to merge
2
commits into

from

 Closed


fix(server-utils): Ensure all orchestrion instrumentation lazy registers
#22387
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
93dba1a

fix(server-utils): Ensure all orchestrion instrumentation lazy registers


mydea Jul 20, 2026
0a548ed

fix lint


mydea Jul 22, 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


19 changes: 12 additions & 7 deletions
packages/node/src/integrations/tracing/dataloader/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,19 +9,24 @@ const INTEGRATION_NAME = 'Dataloader' as const;
export const instrumentDataloader = generateInstrumentOnce(INTEGRATION_NAME, () => new DataloaderInstrumentation());

const _dataloaderIntegration = (() => {
 // Decide in setup/setupOnce, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setup`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them (the channel integration needs the client to register its
 // injection listener); otherwise fall back to the vendored OTel instrumentation.

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // Decide here, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setupOnce`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them; otherwise fall back to the vendored OTel instrumentation.
 if (isOrchestrionInjected()) {
 dataloaderChannelIntegration().setupOnce?.();
 } else {
 if (!isOrchestrionInjected()) {
 instrumentDataloader();
 }
 },
 setup(client) {
 if (isOrchestrionInjected()) {
 dataloaderChannelIntegration().setup?.(client);
 }
 },
 };
}) satisfies IntegrationFn;

Expand Down

18 changes: 12 additions & 6 deletions
packages/node/src/integrations/tracing/knex/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,18 +9,24 @@ const INTEGRATION_NAME = 'Knex' as const;
export const instrumentKnex = generateInstrumentOnce(INTEGRATION_NAME, () => new KnexInstrumentation());

const _knexIntegration = (() => {
 // Decide in setup/setupOnce, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setup`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them (the channel integration needs the client to register its
 // injection listener); otherwise fall back to the vendored OTel instrumentation.

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // Prefer the diagnostics-channel subscriber when orchestrion injected its channels; otherwise
 // fall back to the vendored OTel instrumentation. `isOrchestrionInjected()` is only reliable by
 // `setupOnce` (the runtime injection runs during `Sentry.init()`, after integrations are built).
 if (isOrchestrionInjected()) {
 knexChannelIntegration().setupOnce?.();
 } else {
 if (!isOrchestrionInjected()) {
 instrumentKnex();
 }
 },
 setup(client) {
 if (isOrchestrionInjected()) {
 knexChannelIntegration().setup?.(client);
 }
 },
 };
}) satisfies IntegrationFn;

Expand Down

37 changes: 12 additions & 25 deletions
packages/server-utils/src/integrations/tracing-channel/amqplib.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,13 @@ import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn, Span, SpanAttributes } from '@sentry/core';
import {
 continueTrace,
 debug,
 defineIntegration,
 getTraceData,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SPAN_KIND,
 SPAN_STATUS_ERROR,
 startInactiveSpan,
 timestampInSeconds,
 waitForTracingChannelBinding,
} from '@sentry/core';
// eslint-disable-next-line typescript/no-deprecated -- NET_PEER_* emitted alongside SERVER_* for backwards compatibility (TODO(v11): remove)
import {
Expand All@@ -27,9 +25,10 @@ import {
 SERVER_PORT,
 URL_FULL,
} from '@sentry/conventions/attributes';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { amqplibModuleNames } from '../../orchestrion/config/amqplib';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Amqplib' integration is omitted from the default set.
Expand DownExpand Up@@ -156,32 +155,20 @@ interface AmqpConnectContext {

const NOOP = (): void => {};

// Guards against subscribing to the amqplib channels more than once in a process. Core dedupes
// `setupOnce` by integration *name*, which is not enough here: the Deno SDK wraps this integration
// under a different name (`DenoAmqplib`) via `extendIntegration`, so adding both would otherwise run
// the subscribe logic twice and emit duplicate spans for every operation.
let subscribed = false;
function instrumentAmqplib(): void {
 subscribeConnect();
 subscribePublish();
 subscribeConfirmPublish();
 subscribeConsume();
 subscribeDispatch();
 subscribeSettle();
}

const _amqplibChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel || subscribed) {
 return;
 }
 subscribed = true;

 DEBUG_BUILD && debug.log('[orchestrion:amqplib] subscribing to amqplib tracing channels');

 waitForTracingChannelBinding(() => {
 subscribeConnect();
 subscribePublish();
 subscribeConfirmPublish();
 subscribeConsume();
 subscribeDispatch();
 subscribeSettle();
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, amqplibModuleNames, instrumentAmqplib, []);
 },
 };
}) satisfies IntegrationFn;
Expand Down

54 changes: 22 additions & 32 deletions
packages/server-utils/src/integrations/tracing-channel/anthropic.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@ import {
 _INTERNAL_shouldSkipAiProviderWrapping,
 addAnthropicRequestAttributes,
 addAnthropicResponseAttributes,
 debug,
 defineIntegration,
 extractAnthropicRequestAttributes,
 GEN_AI_REQUEST_MODEL_ATTRIBUTE,
Expand All@@ -14,11 +13,11 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 shouldEnableTruncation,
 startInactiveSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { anthropicAiModuleNames } from '../../orchestrion/config/anthropic-ai';

// Same name as the OTel integration by design: when enabled, the OTel 'Anthropic_AI'
// integration is dropped from the default set (see the Node opt-in loader).
Expand DownExpand Up@@ -47,39 +46,30 @@ interface AnthropicChannelContext {
 result?: unknown;
}

let subscribed = false;
function instrumentAnthropic(options: AnthropicAiOptions): void {
 for (const { channel, operation, methodPath, stream } of INSTRUMENTED_CHANNELS) {
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<AnthropicChannelContext>(channel),
 data => createGenAiSpan(data, operation, methodPath, options),
 {
 beforeSpanEnd: (span, data) => {
 addAnthropicResponseAttributes(
 span,
 data.result as AnthropicAiResponse,
 resolveAIRecordingOptions(options).recordOutputs,
 );
 },
 deferSpanEnd: ({ span, data }) => wrapStreamResult(span, data, stream, options),
 },
 );
 }
}

const _anthropicChannelIntegration = ((options: AnthropicAiOptions = {}) => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // tracingChannel is unavailable before Node 18.19 and prevent double-subscribe
 if (!diagnosticsChannel.tracingChannel || subscribed) {
 return;
 }
 subscribed = true;

 // `bindTracingChannelToSpan` needs the async-context binding that `initOpenTelemetry()` registers
 // after `setupOnce` runs, so wait for it before subscribing.
 waitForTracingChannelBinding(() => {
 for (const { channel, operation, methodPath, stream } of INSTRUMENTED_CHANNELS) {
 DEBUG_BUILD && debug.log(`[orchestrion:anthropic] subscribing to channel "${channel}"`);
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<AnthropicChannelContext>(channel),
 data => createGenAiSpan(data, operation, methodPath, options),
 {
 beforeSpanEnd: (span, data) => {
 addAnthropicResponseAttributes(
 span,
 data.result as AnthropicAiResponse,
 resolveAIRecordingOptions(options).recordOutputs,
 );
 },
 deferSpanEnd: ({ span, data }) => wrapStreamResult(span, data, stream, options),
 },
 );
 }
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, anthropicAiModuleNames, instrumentAnthropic, [options]);
 },
 };
}) satisfies IntegrationFn;
Expand Down

34 changes: 13 additions & 21 deletions
packages/server-utils/src/integrations/tracing-channel/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn, Span, StartSpanOptions } from '@sentry/core';
import {
 debug,
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SPAN_KIND,
 startInactiveSpan,
 startSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import type { ChannelName } from '../../orchestrion/channels';
import { CHANNELS } from '../../orchestrion/channels';
import type { TracingChannelPayloadWithSpan } from '../../tracing-channel';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { dataloaderModuleNames } from '../../orchestrion/config/dataloader';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Dataloader' integration is omitted from the default set.
const INTEGRATION_NAME = 'Dataloader' as const;

const MODULE_NAME = 'dataloader';
Expand DownExpand Up@@ -78,25 +75,20 @@ function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Oper
 };
}

function instrumentDataloader(): void {
 subscribeConstruct();
 subscribeLoad();
 subscribeSimpleOperation(CHANNELS.DATALOADER_LOAD_MANY, 'loadMany');
 subscribeSimpleOperation(CHANNELS.DATALOADER_PRIME, 'prime');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR, 'clear');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR_ALL, 'clearAll');
}

const _dataloaderChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 DEBUG_BUILD && debug.log('[orchestrion:dataloader] subscribing to dataloader tracing channels');

 waitForTracingChannelBinding(() => {
 subscribeConstruct();
 subscribeLoad();
 subscribeSimpleOperation(CHANNELS.DATALOADER_LOAD_MANY, 'loadMany');
 subscribeSimpleOperation(CHANNELS.DATALOADER_PRIME, 'prime');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR, 'clear');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR_ALL, 'clearAll');
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, dataloaderModuleNames, instrumentDataloader, []);
 },
 };
}) satisfies IntegrationFn;
Expand Down

16 changes: 5 additions & 11 deletions
packages/server-utils/src/integrations/tracing-channel/express/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import { defineIntegration, waitForTracingChannelBinding } from '@sentry/core';
import { defineIntegration } from '@sentry/core';
import type { ExpressIntegrationOptions } from './types';
import { instrumentExpress } from './instrumentation';
import { expressModuleNames } from '../../../orchestrion/config/express';
import { invokeOrchestrionInstrumentation } from '../../../orchestrion/instrumentation';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Express' integration is omitted from the default set.
Expand All@@ -11,15 +12,8 @@ const INTEGRATION_NAME = 'Express' as const;
const _expressChannelIntegration = ((options: ExpressIntegrationOptions = {}) => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 waitForTracingChannelBinding(() => {
 instrumentExpress(options, diagnosticsChannel.tracingChannel);
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, expressModuleNames, instrumentExpress, [options]);
 },
 };
}) satisfies IntegrationFn;
Expand Down

14 changes: 3 additions & 11 deletions
packages/server-utils/src/integrations/tracing-channel/express/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type * as diagnosticsChannel from 'node:diagnostics_channel';
import * as diagnosticsChannel from 'node:diagnostics_channel';
import { HTTP_ROUTE } from '@sentry/conventions/attributes';
import type { Span } from '@sentry/core';
import {
Expand DownExpand Up@@ -45,16 +45,8 @@ const ATTR_EXPRESS_TYPE = 'express.type';

const NOOP = (): void => {};

let _isInstrumented = false;

export function instrumentExpress(
 options: ExpressIntegrationOptions,
 tracingChannel: typeof diagnosticsChannel.tracingChannel,
): void {
 if (_isInstrumented) {
 return;
 }
 _isInstrumented = true;
export function instrumentExpress(options: ExpressIntegrationOptions): void {
 const tracingChannel = diagnosticsChannel.tracingChannel;

 // Record each layer's registered path *pattern* as it is registered, so the
 // matched route can be reconstructed with its parameters intact at request
Expand Down

18 changes: 5 additions & 13 deletions
packages/server-utils/src/integrations/tracing-channel/generic-pool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import {
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 startInactiveSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { defineIntegration, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startInactiveSpan } from '@sentry/core';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { genericPoolModuleNames } from '../../orchestrion/config/generic-pool';

// Same name as the OTel integration by design — when enabled, the OTel
// 'GenericPool' integration is omitted from the default set.
Expand All@@ -20,13 +17,8 @@ interface GenericPoolAcquireContext {
const _genericPoolChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 waitForTracingChannelBinding(() => instrumentGenericPool());
 setup(client) {
 invokeOrchestrionInstrumentation(client, genericPoolModuleNames, instrumentGenericPool, []);
 },
 };
}) satisfies IntegrationFn;
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
fix(server-utils): Ensure all orchestrion instrumentation lazy registers#22387

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

 Closed

mydea
wants to merge
2
commits into

from

 Closed


fix(server-utils): Ensure all orchestrion instrumentation lazy registers
#22387
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
93dba1a

fix(server-utils): Ensure all orchestrion instrumentation lazy registers


mydea Jul 20, 2026
0a548ed

fix lint


mydea Jul 22, 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


19 changes: 12 additions & 7 deletions
packages/node/src/integrations/tracing/dataloader/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,19 +9,24 @@ const INTEGRATION_NAME = 'Dataloader' as const;
export const instrumentDataloader = generateInstrumentOnce(INTEGRATION_NAME, () => new DataloaderInstrumentation());

const _dataloaderIntegration = (() => {
 // Decide in setup/setupOnce, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setup`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them (the channel integration needs the client to register its
 // injection listener); otherwise fall back to the vendored OTel instrumentation.

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // Decide here, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setupOnce`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them; otherwise fall back to the vendored OTel instrumentation.
 if (isOrchestrionInjected()) {
 dataloaderChannelIntegration().setupOnce?.();
 } else {
 if (!isOrchestrionInjected()) {
 instrumentDataloader();
 }
 },
 setup(client) {
 if (isOrchestrionInjected()) {
 dataloaderChannelIntegration().setup?.(client);
 }
 },
 };
}) satisfies IntegrationFn;

Expand Down

18 changes: 12 additions & 6 deletions
packages/node/src/integrations/tracing/knex/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,18 +9,24 @@ const INTEGRATION_NAME = 'Knex' as const;
export const instrumentKnex = generateInstrumentOnce(INTEGRATION_NAME, () => new KnexInstrumentation());

const _knexIntegration = (() => {
 // Decide in setup/setupOnce, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setup`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them (the channel integration needs the client to register its
 // injection listener); otherwise fall back to the vendored OTel instrumentation.

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // Prefer the diagnostics-channel subscriber when orchestrion injected its channels; otherwise
 // fall back to the vendored OTel instrumentation. `isOrchestrionInjected()` is only reliable by
 // `setupOnce` (the runtime injection runs during `Sentry.init()`, after integrations are built).
 if (isOrchestrionInjected()) {
 knexChannelIntegration().setupOnce?.();
 } else {
 if (!isOrchestrionInjected()) {
 instrumentKnex();
 }
 },
 setup(client) {
 if (isOrchestrionInjected()) {
 knexChannelIntegration().setup?.(client);
 }
 },
 };
}) satisfies IntegrationFn;

Expand Down

37 changes: 12 additions & 25 deletions
packages/server-utils/src/integrations/tracing-channel/amqplib.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,13 @@ import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn, Span, SpanAttributes } from '@sentry/core';
import {
 continueTrace,
 debug,
 defineIntegration,
 getTraceData,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SPAN_KIND,
 SPAN_STATUS_ERROR,
 startInactiveSpan,
 timestampInSeconds,
 waitForTracingChannelBinding,
} from '@sentry/core';
// eslint-disable-next-line typescript/no-deprecated -- NET_PEER_* emitted alongside SERVER_* for backwards compatibility (TODO(v11): remove)
import {
Expand All@@ -27,9 +25,10 @@ import {
 SERVER_PORT,
 URL_FULL,
} from '@sentry/conventions/attributes';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { amqplibModuleNames } from '../../orchestrion/config/amqplib';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Amqplib' integration is omitted from the default set.
Expand DownExpand Up@@ -156,32 +155,20 @@ interface AmqpConnectContext {

const NOOP = (): void => {};

// Guards against subscribing to the amqplib channels more than once in a process. Core dedupes
// `setupOnce` by integration *name*, which is not enough here: the Deno SDK wraps this integration
// under a different name (`DenoAmqplib`) via `extendIntegration`, so adding both would otherwise run
// the subscribe logic twice and emit duplicate spans for every operation.
let subscribed = false;
function instrumentAmqplib(): void {
 subscribeConnect();
 subscribePublish();
 subscribeConfirmPublish();
 subscribeConsume();
 subscribeDispatch();
 subscribeSettle();
}

const _amqplibChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel || subscribed) {
 return;
 }
 subscribed = true;

 DEBUG_BUILD && debug.log('[orchestrion:amqplib] subscribing to amqplib tracing channels');

 waitForTracingChannelBinding(() => {
 subscribeConnect();
 subscribePublish();
 subscribeConfirmPublish();
 subscribeConsume();
 subscribeDispatch();
 subscribeSettle();
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, amqplibModuleNames, instrumentAmqplib, []);
 },
 };
}) satisfies IntegrationFn;
Expand Down

54 changes: 22 additions & 32 deletions
packages/server-utils/src/integrations/tracing-channel/anthropic.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@ import {
 _INTERNAL_shouldSkipAiProviderWrapping,
 addAnthropicRequestAttributes,
 addAnthropicResponseAttributes,
 debug,
 defineIntegration,
 extractAnthropicRequestAttributes,
 GEN_AI_REQUEST_MODEL_ATTRIBUTE,
Expand All@@ -14,11 +13,11 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 shouldEnableTruncation,
 startInactiveSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { anthropicAiModuleNames } from '../../orchestrion/config/anthropic-ai';

// Same name as the OTel integration by design: when enabled, the OTel 'Anthropic_AI'
// integration is dropped from the default set (see the Node opt-in loader).
Expand DownExpand Up@@ -47,39 +46,30 @@ interface AnthropicChannelContext {
 result?: unknown;
}

let subscribed = false;
function instrumentAnthropic(options: AnthropicAiOptions): void {
 for (const { channel, operation, methodPath, stream } of INSTRUMENTED_CHANNELS) {
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<AnthropicChannelContext>(channel),
 data => createGenAiSpan(data, operation, methodPath, options),
 {
 beforeSpanEnd: (span, data) => {
 addAnthropicResponseAttributes(
 span,
 data.result as AnthropicAiResponse,
 resolveAIRecordingOptions(options).recordOutputs,
 );
 },
 deferSpanEnd: ({ span, data }) => wrapStreamResult(span, data, stream, options),
 },
 );
 }
}

const _anthropicChannelIntegration = ((options: AnthropicAiOptions = {}) => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // tracingChannel is unavailable before Node 18.19 and prevent double-subscribe
 if (!diagnosticsChannel.tracingChannel || subscribed) {
 return;
 }
 subscribed = true;

 // `bindTracingChannelToSpan` needs the async-context binding that `initOpenTelemetry()` registers
 // after `setupOnce` runs, so wait for it before subscribing.
 waitForTracingChannelBinding(() => {
 for (const { channel, operation, methodPath, stream } of INSTRUMENTED_CHANNELS) {
 DEBUG_BUILD && debug.log(`[orchestrion:anthropic] subscribing to channel "${channel}"`);
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<AnthropicChannelContext>(channel),
 data => createGenAiSpan(data, operation, methodPath, options),
 {
 beforeSpanEnd: (span, data) => {
 addAnthropicResponseAttributes(
 span,
 data.result as AnthropicAiResponse,
 resolveAIRecordingOptions(options).recordOutputs,
 );
 },
 deferSpanEnd: ({ span, data }) => wrapStreamResult(span, data, stream, options),
 },
 );
 }
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, anthropicAiModuleNames, instrumentAnthropic, [options]);
 },
 };
}) satisfies IntegrationFn;
Expand Down

34 changes: 13 additions & 21 deletions
packages/server-utils/src/integrations/tracing-channel/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn, Span, StartSpanOptions } from '@sentry/core';
import {
 debug,
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SPAN_KIND,
 startInactiveSpan,
 startSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import type { ChannelName } from '../../orchestrion/channels';
import { CHANNELS } from '../../orchestrion/channels';
import type { TracingChannelPayloadWithSpan } from '../../tracing-channel';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { dataloaderModuleNames } from '../../orchestrion/config/dataloader';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Dataloader' integration is omitted from the default set.
const INTEGRATION_NAME = 'Dataloader' as const;

const MODULE_NAME = 'dataloader';
Expand DownExpand Up@@ -78,25 +75,20 @@ function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Oper
 };
}

function instrumentDataloader(): void {
 subscribeConstruct();
 subscribeLoad();
 subscribeSimpleOperation(CHANNELS.DATALOADER_LOAD_MANY, 'loadMany');
 subscribeSimpleOperation(CHANNELS.DATALOADER_PRIME, 'prime');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR, 'clear');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR_ALL, 'clearAll');
}

const _dataloaderChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 DEBUG_BUILD && debug.log('[orchestrion:dataloader] subscribing to dataloader tracing channels');

 waitForTracingChannelBinding(() => {
 subscribeConstruct();
 subscribeLoad();
 subscribeSimpleOperation(CHANNELS.DATALOADER_LOAD_MANY, 'loadMany');
 subscribeSimpleOperation(CHANNELS.DATALOADER_PRIME, 'prime');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR, 'clear');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR_ALL, 'clearAll');
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, dataloaderModuleNames, instrumentDataloader, []);
 },
 };
}) satisfies IntegrationFn;
Expand Down

16 changes: 5 additions & 11 deletions
packages/server-utils/src/integrations/tracing-channel/express/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import { defineIntegration, waitForTracingChannelBinding } from '@sentry/core';
import { defineIntegration } from '@sentry/core';
import type { ExpressIntegrationOptions } from './types';
import { instrumentExpress } from './instrumentation';
import { expressModuleNames } from '../../../orchestrion/config/express';
import { invokeOrchestrionInstrumentation } from '../../../orchestrion/instrumentation';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Express' integration is omitted from the default set.
Expand All@@ -11,15 +12,8 @@ const INTEGRATION_NAME = 'Express' as const;
const _expressChannelIntegration = ((options: ExpressIntegrationOptions = {}) => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 waitForTracingChannelBinding(() => {
 instrumentExpress(options, diagnosticsChannel.tracingChannel);
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, expressModuleNames, instrumentExpress, [options]);
 },
 };
}) satisfies IntegrationFn;
Expand Down

14 changes: 3 additions & 11 deletions
packages/server-utils/src/integrations/tracing-channel/express/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type * as diagnosticsChannel from 'node:diagnostics_channel';
import * as diagnosticsChannel from 'node:diagnostics_channel';
import { HTTP_ROUTE } from '@sentry/conventions/attributes';
import type { Span } from '@sentry/core';
import {
Expand DownExpand Up@@ -45,16 +45,8 @@ const ATTR_EXPRESS_TYPE = 'express.type';

const NOOP = (): void => {};

let _isInstrumented = false;

export function instrumentExpress(
 options: ExpressIntegrationOptions,
 tracingChannel: typeof diagnosticsChannel.tracingChannel,
): void {
 if (_isInstrumented) {
 return;
 }
 _isInstrumented = true;
export function instrumentExpress(options: ExpressIntegrationOptions): void {
 const tracingChannel = diagnosticsChannel.tracingChannel;

 // Record each layer's registered path *pattern* as it is registered, so the
 // matched route can be reconstructed with its parameters intact at request
Expand Down

18 changes: 5 additions & 13 deletions
packages/server-utils/src/integrations/tracing-channel/generic-pool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import {
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 startInactiveSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { defineIntegration, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startInactiveSpan } from '@sentry/core';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { genericPoolModuleNames } from '../../orchestrion/config/generic-pool';

// Same name as the OTel integration by design — when enabled, the OTel
// 'GenericPool' integration is omitted from the default set.
Expand All@@ -20,13 +17,8 @@ interface GenericPoolAcquireContext {
const _genericPoolChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 waitForTracingChannelBinding(() => instrumentGenericPool());
 setup(client) {
 invokeOrchestrionInstrumentation(client, genericPoolModuleNames, instrumentGenericPool, []);
 },
 };
}) satisfies IntegrationFn;
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
fix(server-utils): Ensure all orchestrion instrumentation lazy registers#22387

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

 Closed

mydea
wants to merge
2
commits into

from

 Closed


fix(server-utils): Ensure all orchestrion instrumentation lazy registers
#22387
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
93dba1a

fix(server-utils): Ensure all orchestrion instrumentation lazy registers


mydea Jul 20, 2026
0a548ed

fix lint


mydea Jul 22, 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


19 changes: 12 additions & 7 deletions
packages/node/src/integrations/tracing/dataloader/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,19 +9,24 @@ const INTEGRATION_NAME = 'Dataloader' as const;
export const instrumentDataloader = generateInstrumentOnce(INTEGRATION_NAME, () => new DataloaderInstrumentation());

const _dataloaderIntegration = (() => {
 // Decide in setup/setupOnce, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setup`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them (the channel integration needs the client to register its
 // injection listener); otherwise fall back to the vendored OTel instrumentation.

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // Decide here, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setupOnce`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them; otherwise fall back to the vendored OTel instrumentation.
 if (isOrchestrionInjected()) {
 dataloaderChannelIntegration().setupOnce?.();
 } else {
 if (!isOrchestrionInjected()) {
 instrumentDataloader();
 }
 },
 setup(client) {
 if (isOrchestrionInjected()) {
 dataloaderChannelIntegration().setup?.(client);
 }
 },
 };
}) satisfies IntegrationFn;

Expand Down

18 changes: 12 additions & 6 deletions
packages/node/src/integrations/tracing/knex/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,18 +9,24 @@ const INTEGRATION_NAME = 'Knex' as const;
export const instrumentKnex = generateInstrumentOnce(INTEGRATION_NAME, () => new KnexInstrumentation());

const _knexIntegration = (() => {
 // Decide in setup/setupOnce, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setup`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them (the channel integration needs the client to register its
 // injection listener); otherwise fall back to the vendored OTel instrumentation.

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // Prefer the diagnostics-channel subscriber when orchestrion injected its channels; otherwise
 // fall back to the vendored OTel instrumentation. `isOrchestrionInjected()` is only reliable by
 // `setupOnce` (the runtime injection runs during `Sentry.init()`, after integrations are built).
 if (isOrchestrionInjected()) {
 knexChannelIntegration().setupOnce?.();
 } else {
 if (!isOrchestrionInjected()) {
 instrumentKnex();
 }
 },
 setup(client) {
 if (isOrchestrionInjected()) {
 knexChannelIntegration().setup?.(client);
 }
 },
 };
}) satisfies IntegrationFn;

Expand Down

37 changes: 12 additions & 25 deletions
packages/server-utils/src/integrations/tracing-channel/amqplib.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,13 @@ import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn, Span, SpanAttributes } from '@sentry/core';
import {
 continueTrace,
 debug,
 defineIntegration,
 getTraceData,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SPAN_KIND,
 SPAN_STATUS_ERROR,
 startInactiveSpan,
 timestampInSeconds,
 waitForTracingChannelBinding,
} from '@sentry/core';
// eslint-disable-next-line typescript/no-deprecated -- NET_PEER_* emitted alongside SERVER_* for backwards compatibility (TODO(v11): remove)
import {
Expand All@@ -27,9 +25,10 @@ import {
 SERVER_PORT,
 URL_FULL,
} from '@sentry/conventions/attributes';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { amqplibModuleNames } from '../../orchestrion/config/amqplib';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Amqplib' integration is omitted from the default set.
Expand DownExpand Up@@ -156,32 +155,20 @@ interface AmqpConnectContext {

const NOOP = (): void => {};

// Guards against subscribing to the amqplib channels more than once in a process. Core dedupes
// `setupOnce` by integration *name*, which is not enough here: the Deno SDK wraps this integration
// under a different name (`DenoAmqplib`) via `extendIntegration`, so adding both would otherwise run
// the subscribe logic twice and emit duplicate spans for every operation.
let subscribed = false;
function instrumentAmqplib(): void {
 subscribeConnect();
 subscribePublish();
 subscribeConfirmPublish();
 subscribeConsume();
 subscribeDispatch();
 subscribeSettle();
}

const _amqplibChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel || subscribed) {
 return;
 }
 subscribed = true;

 DEBUG_BUILD && debug.log('[orchestrion:amqplib] subscribing to amqplib tracing channels');

 waitForTracingChannelBinding(() => {
 subscribeConnect();
 subscribePublish();
 subscribeConfirmPublish();
 subscribeConsume();
 subscribeDispatch();
 subscribeSettle();
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, amqplibModuleNames, instrumentAmqplib, []);
 },
 };
}) satisfies IntegrationFn;
Expand Down

54 changes: 22 additions & 32 deletions
packages/server-utils/src/integrations/tracing-channel/anthropic.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@ import {
 _INTERNAL_shouldSkipAiProviderWrapping,
 addAnthropicRequestAttributes,
 addAnthropicResponseAttributes,
 debug,
 defineIntegration,
 extractAnthropicRequestAttributes,
 GEN_AI_REQUEST_MODEL_ATTRIBUTE,
Expand All@@ -14,11 +13,11 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 shouldEnableTruncation,
 startInactiveSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { anthropicAiModuleNames } from '../../orchestrion/config/anthropic-ai';

// Same name as the OTel integration by design: when enabled, the OTel 'Anthropic_AI'
// integration is dropped from the default set (see the Node opt-in loader).
Expand DownExpand Up@@ -47,39 +46,30 @@ interface AnthropicChannelContext {
 result?: unknown;
}

let subscribed = false;
function instrumentAnthropic(options: AnthropicAiOptions): void {
 for (const { channel, operation, methodPath, stream } of INSTRUMENTED_CHANNELS) {
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<AnthropicChannelContext>(channel),
 data => createGenAiSpan(data, operation, methodPath, options),
 {
 beforeSpanEnd: (span, data) => {
 addAnthropicResponseAttributes(
 span,
 data.result as AnthropicAiResponse,
 resolveAIRecordingOptions(options).recordOutputs,
 );
 },
 deferSpanEnd: ({ span, data }) => wrapStreamResult(span, data, stream, options),
 },
 );
 }
}

const _anthropicChannelIntegration = ((options: AnthropicAiOptions = {}) => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // tracingChannel is unavailable before Node 18.19 and prevent double-subscribe
 if (!diagnosticsChannel.tracingChannel || subscribed) {
 return;
 }
 subscribed = true;

 // `bindTracingChannelToSpan` needs the async-context binding that `initOpenTelemetry()` registers
 // after `setupOnce` runs, so wait for it before subscribing.
 waitForTracingChannelBinding(() => {
 for (const { channel, operation, methodPath, stream } of INSTRUMENTED_CHANNELS) {
 DEBUG_BUILD && debug.log(`[orchestrion:anthropic] subscribing to channel "${channel}"`);
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<AnthropicChannelContext>(channel),
 data => createGenAiSpan(data, operation, methodPath, options),
 {
 beforeSpanEnd: (span, data) => {
 addAnthropicResponseAttributes(
 span,
 data.result as AnthropicAiResponse,
 resolveAIRecordingOptions(options).recordOutputs,
 );
 },
 deferSpanEnd: ({ span, data }) => wrapStreamResult(span, data, stream, options),
 },
 );
 }
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, anthropicAiModuleNames, instrumentAnthropic, [options]);
 },
 };
}) satisfies IntegrationFn;
Expand Down

34 changes: 13 additions & 21 deletions
packages/server-utils/src/integrations/tracing-channel/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn, Span, StartSpanOptions } from '@sentry/core';
import {
 debug,
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SPAN_KIND,
 startInactiveSpan,
 startSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import type { ChannelName } from '../../orchestrion/channels';
import { CHANNELS } from '../../orchestrion/channels';
import type { TracingChannelPayloadWithSpan } from '../../tracing-channel';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { dataloaderModuleNames } from '../../orchestrion/config/dataloader';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Dataloader' integration is omitted from the default set.
const INTEGRATION_NAME = 'Dataloader' as const;

const MODULE_NAME = 'dataloader';
Expand DownExpand Up@@ -78,25 +75,20 @@ function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Oper
 };
}

function instrumentDataloader(): void {
 subscribeConstruct();
 subscribeLoad();
 subscribeSimpleOperation(CHANNELS.DATALOADER_LOAD_MANY, 'loadMany');
 subscribeSimpleOperation(CHANNELS.DATALOADER_PRIME, 'prime');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR, 'clear');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR_ALL, 'clearAll');
}

const _dataloaderChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 DEBUG_BUILD && debug.log('[orchestrion:dataloader] subscribing to dataloader tracing channels');

 waitForTracingChannelBinding(() => {
 subscribeConstruct();
 subscribeLoad();
 subscribeSimpleOperation(CHANNELS.DATALOADER_LOAD_MANY, 'loadMany');
 subscribeSimpleOperation(CHANNELS.DATALOADER_PRIME, 'prime');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR, 'clear');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR_ALL, 'clearAll');
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, dataloaderModuleNames, instrumentDataloader, []);
 },
 };
}) satisfies IntegrationFn;
Expand Down

16 changes: 5 additions & 11 deletions
packages/server-utils/src/integrations/tracing-channel/express/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import { defineIntegration, waitForTracingChannelBinding } from '@sentry/core';
import { defineIntegration } from '@sentry/core';
import type { ExpressIntegrationOptions } from './types';
import { instrumentExpress } from './instrumentation';
import { expressModuleNames } from '../../../orchestrion/config/express';
import { invokeOrchestrionInstrumentation } from '../../../orchestrion/instrumentation';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Express' integration is omitted from the default set.
Expand All@@ -11,15 +12,8 @@ const INTEGRATION_NAME = 'Express' as const;
const _expressChannelIntegration = ((options: ExpressIntegrationOptions = {}) => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 waitForTracingChannelBinding(() => {
 instrumentExpress(options, diagnosticsChannel.tracingChannel);
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, expressModuleNames, instrumentExpress, [options]);
 },
 };
}) satisfies IntegrationFn;
Expand Down

14 changes: 3 additions & 11 deletions
packages/server-utils/src/integrations/tracing-channel/express/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type * as diagnosticsChannel from 'node:diagnostics_channel';
import * as diagnosticsChannel from 'node:diagnostics_channel';
import { HTTP_ROUTE } from '@sentry/conventions/attributes';
import type { Span } from '@sentry/core';
import {
Expand DownExpand Up@@ -45,16 +45,8 @@ const ATTR_EXPRESS_TYPE = 'express.type';

const NOOP = (): void => {};

let _isInstrumented = false;

export function instrumentExpress(
 options: ExpressIntegrationOptions,
 tracingChannel: typeof diagnosticsChannel.tracingChannel,
): void {
 if (_isInstrumented) {
 return;
 }
 _isInstrumented = true;
export function instrumentExpress(options: ExpressIntegrationOptions): void {
 const tracingChannel = diagnosticsChannel.tracingChannel;

 // Record each layer's registered path *pattern* as it is registered, so the
 // matched route can be reconstructed with its parameters intact at request
Expand Down

18 changes: 5 additions & 13 deletions
packages/server-utils/src/integrations/tracing-channel/generic-pool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import {
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 startInactiveSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { defineIntegration, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startInactiveSpan } from '@sentry/core';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { genericPoolModuleNames } from '../../orchestrion/config/generic-pool';

// Same name as the OTel integration by design — when enabled, the OTel
// 'GenericPool' integration is omitted from the default set.
Expand All@@ -20,13 +17,8 @@ interface GenericPoolAcquireContext {
const _genericPoolChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 waitForTracingChannelBinding(() => instrumentGenericPool());
 setup(client) {
 invokeOrchestrionInstrumentation(client, genericPoolModuleNames, instrumentGenericPool, []);
 },
 };
}) satisfies IntegrationFn;
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
fix(server-utils): Ensure all orchestrion instrumentation lazy registers#22387

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

 Closed

mydea
wants to merge
2
commits into

from

 Closed


fix(server-utils): Ensure all orchestrion instrumentation lazy registers
#22387
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
93dba1a

fix(server-utils): Ensure all orchestrion instrumentation lazy registers


mydea Jul 20, 2026
0a548ed

fix lint


mydea Jul 22, 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


19 changes: 12 additions & 7 deletions
packages/node/src/integrations/tracing/dataloader/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,19 +9,24 @@ const INTEGRATION_NAME = 'Dataloader' as const;
export const instrumentDataloader = generateInstrumentOnce(INTEGRATION_NAME, () => new DataloaderInstrumentation());

const _dataloaderIntegration = (() => {
 // Decide in setup/setupOnce, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setup`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them (the channel integration needs the client to register its
 // injection listener); otherwise fall back to the vendored OTel instrumentation.

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // Decide here, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setupOnce`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them; otherwise fall back to the vendored OTel instrumentation.
 if (isOrchestrionInjected()) {
 dataloaderChannelIntegration().setupOnce?.();
 } else {
 if (!isOrchestrionInjected()) {
 instrumentDataloader();
 }
 },
 setup(client) {
 if (isOrchestrionInjected()) {
 dataloaderChannelIntegration().setup?.(client);
 }
 },
 };
}) satisfies IntegrationFn;

Expand Down

18 changes: 12 additions & 6 deletions
packages/node/src/integrations/tracing/knex/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,18 +9,24 @@ const INTEGRATION_NAME = 'Knex' as const;
export const instrumentKnex = generateInstrumentOnce(INTEGRATION_NAME, () => new KnexInstrumentation());

const _knexIntegration = (() => {
 // Decide in setup/setupOnce, not in the factory: the runtime channel injection runs inside `Sentry.init()`,
 // after the integrations array has already been built, so `isOrchestrionInjected()` is only
 // reliable by `setup`. When the diagnostics channels are injected (runtime hook or bundler
 // plugin), subscribe to them (the channel integration needs the client to register its
 // injection listener); otherwise fall back to the vendored OTel instrumentation.

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // Prefer the diagnostics-channel subscriber when orchestrion injected its channels; otherwise
 // fall back to the vendored OTel instrumentation. `isOrchestrionInjected()` is only reliable by
 // `setupOnce` (the runtime injection runs during `Sentry.init()`, after integrations are built).
 if (isOrchestrionInjected()) {
 knexChannelIntegration().setupOnce?.();
 } else {
 if (!isOrchestrionInjected()) {
 instrumentKnex();
 }
 },
 setup(client) {
 if (isOrchestrionInjected()) {
 knexChannelIntegration().setup?.(client);
 }
 },
 };
}) satisfies IntegrationFn;

Expand Down

37 changes: 12 additions & 25 deletions
packages/server-utils/src/integrations/tracing-channel/amqplib.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,13 @@ import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn, Span, SpanAttributes } from '@sentry/core';
import {
 continueTrace,
 debug,
 defineIntegration,
 getTraceData,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SPAN_KIND,
 SPAN_STATUS_ERROR,
 startInactiveSpan,
 timestampInSeconds,
 waitForTracingChannelBinding,
} from '@sentry/core';
// eslint-disable-next-line typescript/no-deprecated -- NET_PEER_* emitted alongside SERVER_* for backwards compatibility (TODO(v11): remove)
import {
Expand All@@ -27,9 +25,10 @@ import {
 SERVER_PORT,
 URL_FULL,
} from '@sentry/conventions/attributes';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { amqplibModuleNames } from '../../orchestrion/config/amqplib';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Amqplib' integration is omitted from the default set.
Expand DownExpand Up@@ -156,32 +155,20 @@ interface AmqpConnectContext {

const NOOP = (): void => {};

// Guards against subscribing to the amqplib channels more than once in a process. Core dedupes
// `setupOnce` by integration *name*, which is not enough here: the Deno SDK wraps this integration
// under a different name (`DenoAmqplib`) via `extendIntegration`, so adding both would otherwise run
// the subscribe logic twice and emit duplicate spans for every operation.
let subscribed = false;
function instrumentAmqplib(): void {
 subscribeConnect();
 subscribePublish();
 subscribeConfirmPublish();
 subscribeConsume();
 subscribeDispatch();
 subscribeSettle();
}

const _amqplibChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel || subscribed) {
 return;
 }
 subscribed = true;

 DEBUG_BUILD && debug.log('[orchestrion:amqplib] subscribing to amqplib tracing channels');

 waitForTracingChannelBinding(() => {
 subscribeConnect();
 subscribePublish();
 subscribeConfirmPublish();
 subscribeConsume();
 subscribeDispatch();
 subscribeSettle();
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, amqplibModuleNames, instrumentAmqplib, []);
 },
 };
}) satisfies IntegrationFn;
Expand Down

54 changes: 22 additions & 32 deletions
packages/server-utils/src/integrations/tracing-channel/anthropic.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,6 @@ import {
 _INTERNAL_shouldSkipAiProviderWrapping,
 addAnthropicRequestAttributes,
 addAnthropicResponseAttributes,
 debug,
 defineIntegration,
 extractAnthropicRequestAttributes,
 GEN_AI_REQUEST_MODEL_ATTRIBUTE,
Expand All@@ -14,11 +13,11 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 shouldEnableTruncation,
 startInactiveSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { anthropicAiModuleNames } from '../../orchestrion/config/anthropic-ai';

// Same name as the OTel integration by design: when enabled, the OTel 'Anthropic_AI'
// integration is dropped from the default set (see the Node opt-in loader).
Expand DownExpand Up@@ -47,39 +46,30 @@ interface AnthropicChannelContext {
 result?: unknown;
}

let subscribed = false;
function instrumentAnthropic(options: AnthropicAiOptions): void {
 for (const { channel, operation, methodPath, stream } of INSTRUMENTED_CHANNELS) {
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<AnthropicChannelContext>(channel),
 data => createGenAiSpan(data, operation, methodPath, options),
 {
 beforeSpanEnd: (span, data) => {
 addAnthropicResponseAttributes(
 span,
 data.result as AnthropicAiResponse,
 resolveAIRecordingOptions(options).recordOutputs,
 );
 },
 deferSpanEnd: ({ span, data }) => wrapStreamResult(span, data, stream, options),
 },
 );
 }
}

const _anthropicChannelIntegration = ((options: AnthropicAiOptions = {}) => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // tracingChannel is unavailable before Node 18.19 and prevent double-subscribe
 if (!diagnosticsChannel.tracingChannel || subscribed) {
 return;
 }
 subscribed = true;

 // `bindTracingChannelToSpan` needs the async-context binding that `initOpenTelemetry()` registers
 // after `setupOnce` runs, so wait for it before subscribing.
 waitForTracingChannelBinding(() => {
 for (const { channel, operation, methodPath, stream } of INSTRUMENTED_CHANNELS) {
 DEBUG_BUILD && debug.log(`[orchestrion:anthropic] subscribing to channel "${channel}"`);
 bindTracingChannelToSpan(
 diagnosticsChannel.tracingChannel<AnthropicChannelContext>(channel),
 data => createGenAiSpan(data, operation, methodPath, options),
 {
 beforeSpanEnd: (span, data) => {
 addAnthropicResponseAttributes(
 span,
 data.result as AnthropicAiResponse,
 resolveAIRecordingOptions(options).recordOutputs,
 );
 },
 deferSpanEnd: ({ span, data }) => wrapStreamResult(span, data, stream, options),
 },
 );
 }
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, anthropicAiModuleNames, instrumentAnthropic, [options]);
 },
 };
}) satisfies IntegrationFn;
Expand Down

34 changes: 13 additions & 21 deletions
packages/server-utils/src/integrations/tracing-channel/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn, Span, StartSpanOptions } from '@sentry/core';
import {
 debug,
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SPAN_KIND,
 startInactiveSpan,
 startSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import type { ChannelName } from '../../orchestrion/channels';
import { CHANNELS } from '../../orchestrion/channels';
import type { TracingChannelPayloadWithSpan } from '../../tracing-channel';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { dataloaderModuleNames } from '../../orchestrion/config/dataloader';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Dataloader' integration is omitted from the default set.
const INTEGRATION_NAME = 'Dataloader' as const;

const MODULE_NAME = 'dataloader';
Expand DownExpand Up@@ -78,25 +75,20 @@ function makeSpanOptions(loader: DataLoaderInstance | undefined, operation: Oper
 };
}

function instrumentDataloader(): void {
 subscribeConstruct();
 subscribeLoad();
 subscribeSimpleOperation(CHANNELS.DATALOADER_LOAD_MANY, 'loadMany');
 subscribeSimpleOperation(CHANNELS.DATALOADER_PRIME, 'prime');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR, 'clear');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR_ALL, 'clearAll');
}

const _dataloaderChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 DEBUG_BUILD && debug.log('[orchestrion:dataloader] subscribing to dataloader tracing channels');

 waitForTracingChannelBinding(() => {
 subscribeConstruct();
 subscribeLoad();
 subscribeSimpleOperation(CHANNELS.DATALOADER_LOAD_MANY, 'loadMany');
 subscribeSimpleOperation(CHANNELS.DATALOADER_PRIME, 'prime');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR, 'clear');
 subscribeSimpleOperation(CHANNELS.DATALOADER_CLEAR_ALL, 'clearAll');
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, dataloaderModuleNames, instrumentDataloader, []);
 },
 };
}) satisfies IntegrationFn;
Expand Down

16 changes: 5 additions & 11 deletions
packages/server-utils/src/integrations/tracing-channel/express/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import { defineIntegration, waitForTracingChannelBinding } from '@sentry/core';
import { defineIntegration } from '@sentry/core';
import type { ExpressIntegrationOptions } from './types';
import { instrumentExpress } from './instrumentation';
import { expressModuleNames } from '../../../orchestrion/config/express';
import { invokeOrchestrionInstrumentation } from '../../../orchestrion/instrumentation';

// NOTE: this uses the same name as the OTel integration by design.
// When enabled, the OTel 'Express' integration is omitted from the default set.
Expand All@@ -11,15 +12,8 @@ const INTEGRATION_NAME = 'Express' as const;
const _expressChannelIntegration = ((options: ExpressIntegrationOptions = {}) => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 waitForTracingChannelBinding(() => {
 instrumentExpress(options, diagnosticsChannel.tracingChannel);
 });
 setup(client) {
 invokeOrchestrionInstrumentation(client, expressModuleNames, instrumentExpress, [options]);
 },
 };
}) satisfies IntegrationFn;
Expand Down

14 changes: 3 additions & 11 deletions
packages/server-utils/src/integrations/tracing-channel/express/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import type * as diagnosticsChannel from 'node:diagnostics_channel';
import * as diagnosticsChannel from 'node:diagnostics_channel';
import { HTTP_ROUTE } from '@sentry/conventions/attributes';
import type { Span } from '@sentry/core';
import {
Expand DownExpand Up@@ -45,16 +45,8 @@ const ATTR_EXPRESS_TYPE = 'express.type';

const NOOP = (): void => {};

let _isInstrumented = false;

export function instrumentExpress(
 options: ExpressIntegrationOptions,
 tracingChannel: typeof diagnosticsChannel.tracingChannel,
): void {
 if (_isInstrumented) {
 return;
 }
 _isInstrumented = true;
export function instrumentExpress(options: ExpressIntegrationOptions): void {
 const tracingChannel = diagnosticsChannel.tracingChannel;

 // Record each layer's registered path *pattern* as it is registered, so the
 // matched route can be reconstructed with its parameters intact at request
Expand Down

18 changes: 5 additions & 13 deletions
packages/server-utils/src/integrations/tracing-channel/generic-pool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
import * as diagnosticsChannel from 'node:diagnostics_channel';
import type { IntegrationFn } from '@sentry/core';
import {
 defineIntegration,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 startInactiveSpan,
 waitForTracingChannelBinding,
} from '@sentry/core';
import { defineIntegration, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startInactiveSpan } from '@sentry/core';
import { CHANNELS } from '../../orchestrion/channels';
import { bindTracingChannelToSpan } from '../../tracing-channel';
import { invokeOrchestrionInstrumentation } from '../../orchestrion/instrumentation';
import { genericPoolModuleNames } from '../../orchestrion/config/generic-pool';

// Same name as the OTel integration by design — when enabled, the OTel
// 'GenericPool' integration is omitted from the default set.
Expand All@@ -20,13 +17,8 @@ interface GenericPoolAcquireContext {
const _genericPoolChannelIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.
 if (!diagnosticsChannel.tracingChannel) {
 return;
 }

 waitForTracingChannelBinding(() => instrumentGenericPool());
 setup(client) {
 invokeOrchestrionInstrumentation(client, genericPoolModuleNames, instrumentGenericPool, []);
 },
 };
}) satisfies IntegrationFn;
Expand Down
Loading