feat(node): Only add span listeners for instrumentation when used#15802

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
mydea merged 4 commits into from
Mar 26, 2025
Merged

feat(node): Only add span listeners for instrumentation when used #15802

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3431a27
feat(node): WIP Only add span listeners conditionally
mydea Mar 24, 2025
ee30339
ref add stuff
mydea Mar 25, 2025
d0af51d
fixes
mydea Mar 25, 2025
4f540e5
fix it for ai
mydea Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/node/src/integrations/tracing/connect.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -104,7 +104,7 @@ function addConnectSpanAttributes(span: Span): void {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.connect`,
});

// Also update the name, we don't need to "middleware - " prefix
// Also update the name, we don't need the "middleware - " prefix
const name = attributes['connect.name'];
if (typeof name === 'string') {
span.updateName(name);
Expand Down
44 changes: 25 additions & 19 deletions packages/node/src/integrations/tracing/dataloader.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import {
spanToJSON,
} from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { instrumentWhenWrapped, generateInstrumentOnce } from '../../otel/instrument';

const INTEGRATION_NAME = 'Dataloader';

Expand All@@ -19,31 +19,37 @@ export const instrumentDataloader = generateInstrumentOnce(
);

const _dataloaderIntegration = (() => {
let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

return {
name: INTEGRATION_NAME,
setupOnce() {
instrumentDataloader();
const instrumentation = instrumentDataloader();
instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
},

setup(client) {
client.on('spanStart', span => {
const spanJSON = spanToJSON(span);
if (spanJSON.description?.startsWith('dataloader')) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
}
// This is called either immediately or when the instrumentation is wrapped
instrumentationWrappedCallback?.(() => {
client.on('spanStart', span => {
const spanJSON = spanToJSON(span);
if (spanJSON.description?.startsWith('dataloader')) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
}

// These are all possible dataloader span descriptions
// Still checking for the future versions
// in case they add support for `clear` and `prime`
if (
spanJSON.description === 'dataloader.load' ||
spanJSON.description === 'dataloader.loadMany' ||
spanJSON.description === 'dataloader.batch'
) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
// TODO: We can try adding `key` to the `data` attribute upstream.
// Or alternatively, we can add `requestHook` to the dataloader instrumentation.
}
// These are all possible dataloader span descriptions
// Still checking for the future versions
// in case they add support for `clear` and `prime`
if (
spanJSON.description === 'dataloader.load' ||
spanJSON.description === 'dataloader.loadMany' ||
spanJSON.description === 'dataloader.batch'
) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
// TODO: We can try adding `key` to the `data` attribute upstream.
// Or alternatively, we can add `requestHook` to the dataloader instrumentation.
}
});
});
},
};
Expand Down
29 changes: 17 additions & 12 deletions packages/node/src/integrations/tracing/genericPool.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,38 @@
import { GenericPoolInstrumentation } from '@opentelemetry/instrumentation-generic-pool';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const INTEGRATION_NAME = 'GenericPool';

export const instrumentGenericPool = generateInstrumentOnce(INTEGRATION_NAME, () => new GenericPoolInstrumentation({}));

const _genericPoolIntegration = (() => {
let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

return {
name: INTEGRATION_NAME,
setupOnce() {
instrumentGenericPool();
const instrumentation = instrumentGenericPool();
instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
},

setup(client) {
client.on('spanStart', span => {
const spanJSON = spanToJSON(span);
instrumentationWrappedCallback?.(() =>
client.on('spanStart', span => {
const spanJSON = spanToJSON(span);

const spanDescription = spanJSON.description;
const spanDescription = spanJSON.description;

// typo in emitted span for version <= 0.38.0 of @opentelemetry/instrumentation-generic-pool
const isGenericPoolSpan =
spanDescription === 'generic-pool.aquire' || spanDescription === 'generic-pool.acquire';
// typo in emitted span for version <= 0.38.0 of @opentelemetry/instrumentation-generic-pool
const isGenericPoolSpan =
spanDescription === 'generic-pool.aquire' || spanDescription === 'generic-pool.acquire';

if (isGenericPoolSpan) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.generic_pool');
}
});
if (isGenericPoolSpan) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.generic_pool');
}
}),
);
},
};
}) satisfies IntegrationFn;
Expand Down
25 changes: 15 additions & 10 deletions packages/node/src/integrations/tracing/knex.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { KnexInstrumentation } from '@opentelemetry/instrumentation-knex';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const INTEGRATION_NAME = 'Knex';

Expand All@@ -11,21 +11,26 @@ export const instrumentKnex = generateInstrumentOnce(
);

const _knexIntegration = (() => {
let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

return {
name: INTEGRATION_NAME,
setupOnce() {
instrumentKnex();
const instrumentation = instrumentKnex();
instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
},

setup(client) {
client.on('spanStart', span => {
const { data } = spanToJSON(span);
// knex.version is always set in the span data
// https://github.com/open-telemetry/opentelemetry-js-contrib/blob/0309caeafc44ac9cb13a3345b790b01b76d0497d/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts#L138
if ('knex.version' in data) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
}
});
instrumentationWrappedCallback?.(() =>
client.on('spanStart', span => {
const { data } = spanToJSON(span);
// knex.version is always set in the span data
// https://github.com/open-telemetry/opentelemetry-js-contrib/blob/0309caeafc44ac9cb13a3345b790b01b76d0497d/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts#L138
if ('knex.version' in data) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
}
}),
);
},
};
}) satisfies IntegrationFn;
Expand Down
26 changes: 19 additions & 7 deletions packages/node/src/integrations/tracing/prisma.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,18 @@ function isPrismaV6TracingHelper(helper: unknown): helper is PrismaV6TracingHelp
return !!helper && typeof helper === 'object' && 'dispatchEngineSpans' in helper;
}

function getPrismaTracingHelper(): unknown | undefined {
const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;
const prismaTracingHelper =
prismaInstrumentationObject &&
typeof prismaInstrumentationObject === 'object' &&
'helper' in prismaInstrumentationObject
? prismaInstrumentationObject.helper
: undefined;

return prismaTracingHelper;
}

class SentryPrismaInteropInstrumentation extends EsmInteropPrismaInstrumentation {
public constructor() {
super();
Expand All@@ -30,13 +42,7 @@ class SentryPrismaInteropInstrumentation extends EsmInteropPrismaInstrumentation
// The PrismaIntegration (super class) defines a global variable `global["PRISMA_INSTRUMENTATION"]` when `enable()` is called. This global variable holds a "TracingHelper" which Prisma uses internally to create tracing data. It's their way of not depending on OTEL with their main package. The sucky thing is, prisma broke the interface of the tracing helper with the v6 major update. This means that if you use Prisma 5 with the v6 instrumentation (or vice versa) Prisma just blows up, because tries to call methods on the helper that no longer exist.
// Because we actually want to use the v6 instrumentation and not blow up in Prisma 5 user's faces, what we're doing here is backfilling the v5 method (`createEngineSpan`) with a noop so that no longer crashes when it attempts to call that function.
// We still won't fully emit all the spans, but this could potentially be implemented in the future.
const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;
const prismaTracingHelper =
prismaInstrumentationObject &&
typeof prismaInstrumentationObject === 'object' &&
'helper' in prismaInstrumentationObject
? prismaInstrumentationObject.helper
: undefined;
const prismaTracingHelper = getPrismaTracingHelper();

let emittedWarning = false;

Expand DownExpand Up@@ -119,6 +125,12 @@ export const prismaIntegration = defineIntegration(
instrumentPrisma({ prismaInstrumentation });
},
setup(client) {
// If no tracing helper exists, we skip any work here

@mydeamydeaMar 25, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

this is not perfect as possibly prisma could be set up later than setup(client) is being called, but it was the best I could come up with here 🤔 it seems to work in tests at least!

// this means that prisma is not being used
if (!getPrismaTracingHelper()) {
return;
}

client.on('spanStart', span => {
const spanJSON = spanToJSON(span);
if (spanJSON.description?.startsWith('prisma:')) {
Expand Down
33 changes: 19 additions & 14 deletions packages/node/src/integrations/tracing/tedious.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { TediousInstrumentation } from '@opentelemetry/instrumentation-tedious';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const TEDIUS_INSTRUMENTED_METHODS = new Set([
'callProcedure',
Expand All@@ -17,25 +17,30 @@ const INTEGRATION_NAME = 'Tedious';
export const instrumentTedious = generateInstrumentOnce(INTEGRATION_NAME, () => new TediousInstrumentation({}));

const _tediousIntegration = (() => {
let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

return {
name: INTEGRATION_NAME,
setupOnce() {
instrumentTedious();
const instrumentation = instrumentTedious();
instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
},

setup(client) {
client.on('spanStart', span => {
const { description, data } = spanToJSON(span);
// Tedius integration always set a span name and `db.system` attribute to `mssql`.
if (!description || data['db.system'] !== 'mssql') {
return;
}

const operation = description.split(' ')[0] || '';
if (TEDIUS_INSTRUMENTED_METHODS.has(operation)) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.tedious');
}
});
instrumentationWrappedCallback?.(() =>
client.on('spanStart', span => {
const { description, data } = spanToJSON(span);
// Tedius integration always set a span name and `db.system` attribute to `mssql`.
if (!description || data['db.system'] !== 'mssql') {
return;
}

const operation = description.split(' ')[0] || '';
if (TEDIUS_INSTRUMENTED_METHODS.has(operation)) {
span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.tedious');
}
}),
);
},
};
}) satisfies IntegrationFn;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(node): Only add span listeners for instrumentation when used#15802

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Mar 26, 2025
 Merged


feat(node): Only add span listeners for instrumentation when used
#15802
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3431a27

feat(node): WIP Only add span listeners conditionally


mydea Mar 24, 2025
ee30339

ref add stuff


mydea Mar 25, 2025
d0af51d

fixes


mydea Mar 25, 2025
4f540e5

fix it for ai


mydea Mar 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
packages/node/src/integrations/tracing/connect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,7 +104,7 @@ function addConnectSpanAttributes(span: Span): void {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.connect`,
 });

 // Also update the name, we don't need to "middleware - " prefix
 // Also update the name, we don't need the "middleware - " prefix
 const name = attributes['connect.name'];
 if (typeof name === 'string') {
 span.updateName(name);
Expand Down

44 changes: 25 additions & 19 deletions
packages/node/src/integrations/tracing/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import {
 spanToJSON,
} from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { instrumentWhenWrapped, generateInstrumentOnce } from '../../otel/instrument';

const INTEGRATION_NAME = 'Dataloader';

Expand All@@ -19,31 +19,37 @@ export const instrumentDataloader = generateInstrumentOnce(
);

const _dataloaderIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentDataloader();
 const instrumentation = instrumentDataloader();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }
 // This is called either immediately or when the instrumentation is wrapped
 instrumentationWrappedCallback?.(() => {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }

 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 });
 });
 },
 };
Expand Down

29 changes: 17 additions & 12 deletions
packages/node/src/integrations/tracing/genericPool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,33 +1,38 @@
import { GenericPoolInstrumentation } from '@opentelemetry/instrumentation-generic-pool';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const INTEGRATION_NAME = 'GenericPool';

export const instrumentGenericPool = generateInstrumentOnce(INTEGRATION_NAME, () => new GenericPoolInstrumentation({}));

const _genericPoolIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentGenericPool();
 const instrumentation = instrumentGenericPool();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);

 const spanDescription = spanJSON.description;
const spanDescription = spanJSON.description;

 // typo in emitted span for version <= 0.38.0 of @opentelemetry/instrumentation-generic-pool
 const isGenericPoolSpan =
 spanDescription === 'generic-pool.aquire' || spanDescription === 'generic-pool.acquire';
// typo in emitted span for version <= 0.38.0 of @opentelemetry/instrumentation-generic-pool
const isGenericPoolSpan =
spanDescription === 'generic-pool.aquire' || spanDescription === 'generic-pool.acquire';

 if (isGenericPoolSpan) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.generic_pool');
 }
 });
 if (isGenericPoolSpan) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.generic_pool');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down

25 changes: 15 additions & 10 deletions
packages/node/src/integrations/tracing/knex.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { KnexInstrumentation } from '@opentelemetry/instrumentation-knex';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const INTEGRATION_NAME = 'Knex';

Expand All@@ -11,21 +11,26 @@ export const instrumentKnex = generateInstrumentOnce(
);

const _knexIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentKnex();
 const instrumentation = instrumentKnex();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const { data } = spanToJSON(span);
 // knex.version is always set in the span data
 // https://github.com/open-telemetry/opentelemetry-js-contrib/blob/0309caeafc44ac9cb13a3345b790b01b76d0497d/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts#L138
 if ('knex.version' in data) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
 }
 });
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const { data } = spanToJSON(span);
 // knex.version is always set in the span data
 // https://github.com/open-telemetry/opentelemetry-js-contrib/blob/0309caeafc44ac9cb13a3345b790b01b76d0497d/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts#L138
 if ('knex.version' in data) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down

26 changes: 19 additions & 7 deletions
packages/node/src/integrations/tracing/prisma.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,18 @@ function isPrismaV6TracingHelper(helper: unknown): helper is PrismaV6TracingHelp
 return !!helper && typeof helper === 'object' && 'dispatchEngineSpans' in helper;
}

function getPrismaTracingHelper(): unknown | undefined {
 const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;
 const prismaTracingHelper =
 prismaInstrumentationObject &&
 typeof prismaInstrumentationObject === 'object' &&
 'helper' in prismaInstrumentationObject
 ? prismaInstrumentationObject.helper
 : undefined;

 return prismaTracingHelper;
}

class SentryPrismaInteropInstrumentation extends EsmInteropPrismaInstrumentation {
 public constructor() {
 super();
Expand All@@ -30,13 +42,7 @@ class SentryPrismaInteropInstrumentation extends EsmInteropPrismaInstrumentation
 // The PrismaIntegration (super class) defines a global variable `global["PRISMA_INSTRUMENTATION"]` when `enable()` is called. This global variable holds a "TracingHelper" which Prisma uses internally to create tracing data. It's their way of not depending on OTEL with their main package. The sucky thing is, prisma broke the interface of the tracing helper with the v6 major update. This means that if you use Prisma 5 with the v6 instrumentation (or vice versa) Prisma just blows up, because tries to call methods on the helper that no longer exist.
 // Because we actually want to use the v6 instrumentation and not blow up in Prisma 5 user's faces, what we're doing here is backfilling the v5 method (`createEngineSpan`) with a noop so that no longer crashes when it attempts to call that function.
 // We still won't fully emit all the spans, but this could potentially be implemented in the future.
 const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;
 const prismaTracingHelper =
 prismaInstrumentationObject &&
 typeof prismaInstrumentationObject === 'object' &&
 'helper' in prismaInstrumentationObject
 ? prismaInstrumentationObject.helper
 : undefined;
 const prismaTracingHelper = getPrismaTracingHelper();

 let emittedWarning = false;

Expand DownExpand Up@@ -119,6 +125,12 @@ export const prismaIntegration = defineIntegration(
 instrumentPrisma({ prismaInstrumentation });
 },
 setup(client) {
 // If no tracing helper exists, we skip any work here
@mydeamydeaMar 25, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

this is not perfect as possibly prisma could be set up later than setup(client) is being called, but it was the best I could come up with here 🤔 it seems to work in tests at least!
 // this means that prisma is not being used
 if (!getPrismaTracingHelper()) {
 return;
 }

 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('prisma:')) {
Expand Down

33 changes: 19 additions & 14 deletions
packages/node/src/integrations/tracing/tedious.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { TediousInstrumentation } from '@opentelemetry/instrumentation-tedious';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const TEDIUS_INSTRUMENTED_METHODS = new Set([
 'callProcedure',
Expand All@@ -17,25 +17,30 @@ const INTEGRATION_NAME = 'Tedious';
export const instrumentTedious = generateInstrumentOnce(INTEGRATION_NAME, () => new TediousInstrumentation({}));

const _tediousIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentTedious();
 const instrumentation = instrumentTedious();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const { description, data } = spanToJSON(span);
 // Tedius integration always set a span name and `db.system` attribute to `mssql`.
 if (!description || data['db.system'] !== 'mssql') {
 return;
 }

 const operation = description.split(' ')[0] || '';
 if (TEDIUS_INSTRUMENTED_METHODS.has(operation)) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.tedious');
 }
 });
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const { description, data } = spanToJSON(span);
 // Tedius integration always set a span name and `db.system` attribute to `mssql`.
 if (!description || data['db.system'] !== 'mssql') {
 return;
 }

 const operation = description.split(' ')[0] || '';
 if (TEDIUS_INSTRUMENTED_METHODS.has(operation)) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.tedious');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down
Loading

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

Skip to content
feat(node): Only add span listeners for instrumentation when used#15802

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Mar 26, 2025
 Merged


feat(node): Only add span listeners for instrumentation when used
#15802
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3431a27

feat(node): WIP Only add span listeners conditionally


mydea Mar 24, 2025
ee30339

ref add stuff


mydea Mar 25, 2025
d0af51d

fixes


mydea Mar 25, 2025
4f540e5

fix it for ai


mydea Mar 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
packages/node/src/integrations/tracing/connect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,7 +104,7 @@ function addConnectSpanAttributes(span: Span): void {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.connect`,
 });

 // Also update the name, we don't need to "middleware - " prefix
 // Also update the name, we don't need the "middleware - " prefix
 const name = attributes['connect.name'];
 if (typeof name === 'string') {
 span.updateName(name);
Expand Down

44 changes: 25 additions & 19 deletions
packages/node/src/integrations/tracing/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import {
 spanToJSON,
} from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { instrumentWhenWrapped, generateInstrumentOnce } from '../../otel/instrument';

const INTEGRATION_NAME = 'Dataloader';

Expand All@@ -19,31 +19,37 @@ export const instrumentDataloader = generateInstrumentOnce(
);

const _dataloaderIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentDataloader();
 const instrumentation = instrumentDataloader();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }
 // This is called either immediately or when the instrumentation is wrapped
 instrumentationWrappedCallback?.(() => {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }

 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 });
 });
 },
 };
Expand Down

29 changes: 17 additions & 12 deletions
packages/node/src/integrations/tracing/genericPool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,33 +1,38 @@
import { GenericPoolInstrumentation } from '@opentelemetry/instrumentation-generic-pool';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const INTEGRATION_NAME = 'GenericPool';

export const instrumentGenericPool = generateInstrumentOnce(INTEGRATION_NAME, () => new GenericPoolInstrumentation({}));

const _genericPoolIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentGenericPool();
 const instrumentation = instrumentGenericPool();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);

 const spanDescription = spanJSON.description;
const spanDescription = spanJSON.description;

 // typo in emitted span for version <= 0.38.0 of @opentelemetry/instrumentation-generic-pool
 const isGenericPoolSpan =
 spanDescription === 'generic-pool.aquire' || spanDescription === 'generic-pool.acquire';
// typo in emitted span for version <= 0.38.0 of @opentelemetry/instrumentation-generic-pool
const isGenericPoolSpan =
spanDescription === 'generic-pool.aquire' || spanDescription === 'generic-pool.acquire';

 if (isGenericPoolSpan) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.generic_pool');
 }
 });
 if (isGenericPoolSpan) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.generic_pool');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down

25 changes: 15 additions & 10 deletions
packages/node/src/integrations/tracing/knex.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { KnexInstrumentation } from '@opentelemetry/instrumentation-knex';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const INTEGRATION_NAME = 'Knex';

Expand All@@ -11,21 +11,26 @@ export const instrumentKnex = generateInstrumentOnce(
);

const _knexIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentKnex();
 const instrumentation = instrumentKnex();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const { data } = spanToJSON(span);
 // knex.version is always set in the span data
 // https://github.com/open-telemetry/opentelemetry-js-contrib/blob/0309caeafc44ac9cb13a3345b790b01b76d0497d/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts#L138
 if ('knex.version' in data) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
 }
 });
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const { data } = spanToJSON(span);
 // knex.version is always set in the span data
 // https://github.com/open-telemetry/opentelemetry-js-contrib/blob/0309caeafc44ac9cb13a3345b790b01b76d0497d/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts#L138
 if ('knex.version' in data) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down

26 changes: 19 additions & 7 deletions
packages/node/src/integrations/tracing/prisma.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,18 @@ function isPrismaV6TracingHelper(helper: unknown): helper is PrismaV6TracingHelp
 return !!helper && typeof helper === 'object' && 'dispatchEngineSpans' in helper;
}

function getPrismaTracingHelper(): unknown | undefined {
 const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;
 const prismaTracingHelper =
 prismaInstrumentationObject &&
 typeof prismaInstrumentationObject === 'object' &&
 'helper' in prismaInstrumentationObject
 ? prismaInstrumentationObject.helper
 : undefined;

 return prismaTracingHelper;
}

class SentryPrismaInteropInstrumentation extends EsmInteropPrismaInstrumentation {
 public constructor() {
 super();
Expand All@@ -30,13 +42,7 @@ class SentryPrismaInteropInstrumentation extends EsmInteropPrismaInstrumentation
 // The PrismaIntegration (super class) defines a global variable `global["PRISMA_INSTRUMENTATION"]` when `enable()` is called. This global variable holds a "TracingHelper" which Prisma uses internally to create tracing data. It's their way of not depending on OTEL with their main package. The sucky thing is, prisma broke the interface of the tracing helper with the v6 major update. This means that if you use Prisma 5 with the v6 instrumentation (or vice versa) Prisma just blows up, because tries to call methods on the helper that no longer exist.
 // Because we actually want to use the v6 instrumentation and not blow up in Prisma 5 user's faces, what we're doing here is backfilling the v5 method (`createEngineSpan`) with a noop so that no longer crashes when it attempts to call that function.
 // We still won't fully emit all the spans, but this could potentially be implemented in the future.
 const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;
 const prismaTracingHelper =
 prismaInstrumentationObject &&
 typeof prismaInstrumentationObject === 'object' &&
 'helper' in prismaInstrumentationObject
 ? prismaInstrumentationObject.helper
 : undefined;
 const prismaTracingHelper = getPrismaTracingHelper();

 let emittedWarning = false;

Expand DownExpand Up@@ -119,6 +125,12 @@ export const prismaIntegration = defineIntegration(
 instrumentPrisma({ prismaInstrumentation });
 },
 setup(client) {
 // If no tracing helper exists, we skip any work here
@mydeamydeaMar 25, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

this is not perfect as possibly prisma could be set up later than setup(client) is being called, but it was the best I could come up with here 🤔 it seems to work in tests at least!
 // this means that prisma is not being used
 if (!getPrismaTracingHelper()) {
 return;
 }

 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('prisma:')) {
Expand Down

33 changes: 19 additions & 14 deletions
packages/node/src/integrations/tracing/tedious.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { TediousInstrumentation } from '@opentelemetry/instrumentation-tedious';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const TEDIUS_INSTRUMENTED_METHODS = new Set([
 'callProcedure',
Expand All@@ -17,25 +17,30 @@ const INTEGRATION_NAME = 'Tedious';
export const instrumentTedious = generateInstrumentOnce(INTEGRATION_NAME, () => new TediousInstrumentation({}));

const _tediousIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentTedious();
 const instrumentation = instrumentTedious();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const { description, data } = spanToJSON(span);
 // Tedius integration always set a span name and `db.system` attribute to `mssql`.
 if (!description || data['db.system'] !== 'mssql') {
 return;
 }

 const operation = description.split(' ')[0] || '';
 if (TEDIUS_INSTRUMENTED_METHODS.has(operation)) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.tedious');
 }
 });
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const { description, data } = spanToJSON(span);
 // Tedius integration always set a span name and `db.system` attribute to `mssql`.
 if (!description || data['db.system'] !== 'mssql') {
 return;
 }

 const operation = description.split(' ')[0] || '';
 if (TEDIUS_INSTRUMENTED_METHODS.has(operation)) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.tedious');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down
Loading

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

Skip to content
feat(node): Only add span listeners for instrumentation when used#15802

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Mar 26, 2025
 Merged


feat(node): Only add span listeners for instrumentation when used
#15802
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3431a27

feat(node): WIP Only add span listeners conditionally


mydea Mar 24, 2025
ee30339

ref add stuff


mydea Mar 25, 2025
d0af51d

fixes


mydea Mar 25, 2025
4f540e5

fix it for ai


mydea Mar 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
packages/node/src/integrations/tracing/connect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,7 +104,7 @@ function addConnectSpanAttributes(span: Span): void {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.connect`,
 });

 // Also update the name, we don't need to "middleware - " prefix
 // Also update the name, we don't need the "middleware - " prefix
 const name = attributes['connect.name'];
 if (typeof name === 'string') {
 span.updateName(name);
Expand Down

44 changes: 25 additions & 19 deletions
packages/node/src/integrations/tracing/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import {
 spanToJSON,
} from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { instrumentWhenWrapped, generateInstrumentOnce } from '../../otel/instrument';

const INTEGRATION_NAME = 'Dataloader';

Expand All@@ -19,31 +19,37 @@ export const instrumentDataloader = generateInstrumentOnce(
);

const _dataloaderIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentDataloader();
 const instrumentation = instrumentDataloader();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }
 // This is called either immediately or when the instrumentation is wrapped
 instrumentationWrappedCallback?.(() => {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }

 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 });
 });
 },
 };
Expand Down

29 changes: 17 additions & 12 deletions
packages/node/src/integrations/tracing/genericPool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,33 +1,38 @@
import { GenericPoolInstrumentation } from '@opentelemetry/instrumentation-generic-pool';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const INTEGRATION_NAME = 'GenericPool';

export const instrumentGenericPool = generateInstrumentOnce(INTEGRATION_NAME, () => new GenericPoolInstrumentation({}));

const _genericPoolIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentGenericPool();
 const instrumentation = instrumentGenericPool();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);

 const spanDescription = spanJSON.description;
const spanDescription = spanJSON.description;

 // typo in emitted span for version <= 0.38.0 of @opentelemetry/instrumentation-generic-pool
 const isGenericPoolSpan =
 spanDescription === 'generic-pool.aquire' || spanDescription === 'generic-pool.acquire';
// typo in emitted span for version <= 0.38.0 of @opentelemetry/instrumentation-generic-pool
const isGenericPoolSpan =
spanDescription === 'generic-pool.aquire' || spanDescription === 'generic-pool.acquire';

 if (isGenericPoolSpan) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.generic_pool');
 }
 });
 if (isGenericPoolSpan) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.generic_pool');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down

25 changes: 15 additions & 10 deletions
packages/node/src/integrations/tracing/knex.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { KnexInstrumentation } from '@opentelemetry/instrumentation-knex';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const INTEGRATION_NAME = 'Knex';

Expand All@@ -11,21 +11,26 @@ export const instrumentKnex = generateInstrumentOnce(
);

const _knexIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentKnex();
 const instrumentation = instrumentKnex();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const { data } = spanToJSON(span);
 // knex.version is always set in the span data
 // https://github.com/open-telemetry/opentelemetry-js-contrib/blob/0309caeafc44ac9cb13a3345b790b01b76d0497d/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts#L138
 if ('knex.version' in data) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
 }
 });
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const { data } = spanToJSON(span);
 // knex.version is always set in the span data
 // https://github.com/open-telemetry/opentelemetry-js-contrib/blob/0309caeafc44ac9cb13a3345b790b01b76d0497d/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts#L138
 if ('knex.version' in data) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down

26 changes: 19 additions & 7 deletions
packages/node/src/integrations/tracing/prisma.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,18 @@ function isPrismaV6TracingHelper(helper: unknown): helper is PrismaV6TracingHelp
 return !!helper && typeof helper === 'object' && 'dispatchEngineSpans' in helper;
}

function getPrismaTracingHelper(): unknown | undefined {
 const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;
 const prismaTracingHelper =
 prismaInstrumentationObject &&
 typeof prismaInstrumentationObject === 'object' &&
 'helper' in prismaInstrumentationObject
 ? prismaInstrumentationObject.helper
 : undefined;

 return prismaTracingHelper;
}

class SentryPrismaInteropInstrumentation extends EsmInteropPrismaInstrumentation {
 public constructor() {
 super();
Expand All@@ -30,13 +42,7 @@ class SentryPrismaInteropInstrumentation extends EsmInteropPrismaInstrumentation
 // The PrismaIntegration (super class) defines a global variable `global["PRISMA_INSTRUMENTATION"]` when `enable()` is called. This global variable holds a "TracingHelper" which Prisma uses internally to create tracing data. It's their way of not depending on OTEL with their main package. The sucky thing is, prisma broke the interface of the tracing helper with the v6 major update. This means that if you use Prisma 5 with the v6 instrumentation (or vice versa) Prisma just blows up, because tries to call methods on the helper that no longer exist.
 // Because we actually want to use the v6 instrumentation and not blow up in Prisma 5 user's faces, what we're doing here is backfilling the v5 method (`createEngineSpan`) with a noop so that no longer crashes when it attempts to call that function.
 // We still won't fully emit all the spans, but this could potentially be implemented in the future.
 const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;
 const prismaTracingHelper =
 prismaInstrumentationObject &&
 typeof prismaInstrumentationObject === 'object' &&
 'helper' in prismaInstrumentationObject
 ? prismaInstrumentationObject.helper
 : undefined;
 const prismaTracingHelper = getPrismaTracingHelper();

 let emittedWarning = false;

Expand DownExpand Up@@ -119,6 +125,12 @@ export const prismaIntegration = defineIntegration(
 instrumentPrisma({ prismaInstrumentation });
 },
 setup(client) {
 // If no tracing helper exists, we skip any work here
@mydeamydeaMar 25, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

this is not perfect as possibly prisma could be set up later than setup(client) is being called, but it was the best I could come up with here 🤔 it seems to work in tests at least!
 // this means that prisma is not being used
 if (!getPrismaTracingHelper()) {
 return;
 }

 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('prisma:')) {
Expand Down

33 changes: 19 additions & 14 deletions
packages/node/src/integrations/tracing/tedious.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { TediousInstrumentation } from '@opentelemetry/instrumentation-tedious';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const TEDIUS_INSTRUMENTED_METHODS = new Set([
 'callProcedure',
Expand All@@ -17,25 +17,30 @@ const INTEGRATION_NAME = 'Tedious';
export const instrumentTedious = generateInstrumentOnce(INTEGRATION_NAME, () => new TediousInstrumentation({}));

const _tediousIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentTedious();
 const instrumentation = instrumentTedious();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const { description, data } = spanToJSON(span);
 // Tedius integration always set a span name and `db.system` attribute to `mssql`.
 if (!description || data['db.system'] !== 'mssql') {
 return;
 }

 const operation = description.split(' ')[0] || '';
 if (TEDIUS_INSTRUMENTED_METHODS.has(operation)) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.tedious');
 }
 });
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const { description, data } = spanToJSON(span);
 // Tedius integration always set a span name and `db.system` attribute to `mssql`.
 if (!description || data['db.system'] !== 'mssql') {
 return;
 }

 const operation = description.split(' ')[0] || '';
 if (TEDIUS_INSTRUMENTED_METHODS.has(operation)) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.tedious');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down
Loading

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

Skip to content
feat(node): Only add span listeners for instrumentation when used#15802

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Mar 26, 2025
 Merged


feat(node): Only add span listeners for instrumentation when used
#15802
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3431a27

feat(node): WIP Only add span listeners conditionally


mydea Mar 24, 2025
ee30339

ref add stuff


mydea Mar 25, 2025
d0af51d

fixes


mydea Mar 25, 2025
4f540e5

fix it for ai


mydea Mar 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
packages/node/src/integrations/tracing/connect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,7 +104,7 @@ function addConnectSpanAttributes(span: Span): void {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.connect`,
 });

 // Also update the name, we don't need to "middleware - " prefix
 // Also update the name, we don't need the "middleware - " prefix
 const name = attributes['connect.name'];
 if (typeof name === 'string') {
 span.updateName(name);
Expand Down

44 changes: 25 additions & 19 deletions
packages/node/src/integrations/tracing/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import {
 spanToJSON,
} from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { instrumentWhenWrapped, generateInstrumentOnce } from '../../otel/instrument';

const INTEGRATION_NAME = 'Dataloader';

Expand All@@ -19,31 +19,37 @@ export const instrumentDataloader = generateInstrumentOnce(
);

const _dataloaderIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentDataloader();
 const instrumentation = instrumentDataloader();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }
 // This is called either immediately or when the instrumentation is wrapped
 instrumentationWrappedCallback?.(() => {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }

 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 });
 });
 },
 };
Expand Down

29 changes: 17 additions & 12 deletions
packages/node/src/integrations/tracing/genericPool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,33 +1,38 @@
import { GenericPoolInstrumentation } from '@opentelemetry/instrumentation-generic-pool';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const INTEGRATION_NAME = 'GenericPool';

export const instrumentGenericPool = generateInstrumentOnce(INTEGRATION_NAME, () => new GenericPoolInstrumentation({}));

const _genericPoolIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentGenericPool();
 const instrumentation = instrumentGenericPool();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);

 const spanDescription = spanJSON.description;
const spanDescription = spanJSON.description;

 // typo in emitted span for version <= 0.38.0 of @opentelemetry/instrumentation-generic-pool
 const isGenericPoolSpan =
 spanDescription === 'generic-pool.aquire' || spanDescription === 'generic-pool.acquire';
// typo in emitted span for version <= 0.38.0 of @opentelemetry/instrumentation-generic-pool
const isGenericPoolSpan =
spanDescription === 'generic-pool.aquire' || spanDescription === 'generic-pool.acquire';

 if (isGenericPoolSpan) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.generic_pool');
 }
 });
 if (isGenericPoolSpan) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.generic_pool');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down

25 changes: 15 additions & 10 deletions
packages/node/src/integrations/tracing/knex.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { KnexInstrumentation } from '@opentelemetry/instrumentation-knex';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const INTEGRATION_NAME = 'Knex';

Expand All@@ -11,21 +11,26 @@ export const instrumentKnex = generateInstrumentOnce(
);

const _knexIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentKnex();
 const instrumentation = instrumentKnex();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const { data } = spanToJSON(span);
 // knex.version is always set in the span data
 // https://github.com/open-telemetry/opentelemetry-js-contrib/blob/0309caeafc44ac9cb13a3345b790b01b76d0497d/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts#L138
 if ('knex.version' in data) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
 }
 });
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const { data } = spanToJSON(span);
 // knex.version is always set in the span data
 // https://github.com/open-telemetry/opentelemetry-js-contrib/blob/0309caeafc44ac9cb13a3345b790b01b76d0497d/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts#L138
 if ('knex.version' in data) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down

26 changes: 19 additions & 7 deletions
packages/node/src/integrations/tracing/prisma.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,18 @@ function isPrismaV6TracingHelper(helper: unknown): helper is PrismaV6TracingHelp
 return !!helper && typeof helper === 'object' && 'dispatchEngineSpans' in helper;
}

function getPrismaTracingHelper(): unknown | undefined {
 const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;
 const prismaTracingHelper =
 prismaInstrumentationObject &&
 typeof prismaInstrumentationObject === 'object' &&
 'helper' in prismaInstrumentationObject
 ? prismaInstrumentationObject.helper
 : undefined;

 return prismaTracingHelper;
}

class SentryPrismaInteropInstrumentation extends EsmInteropPrismaInstrumentation {
 public constructor() {
 super();
Expand All@@ -30,13 +42,7 @@ class SentryPrismaInteropInstrumentation extends EsmInteropPrismaInstrumentation
 // The PrismaIntegration (super class) defines a global variable `global["PRISMA_INSTRUMENTATION"]` when `enable()` is called. This global variable holds a "TracingHelper" which Prisma uses internally to create tracing data. It's their way of not depending on OTEL with their main package. The sucky thing is, prisma broke the interface of the tracing helper with the v6 major update. This means that if you use Prisma 5 with the v6 instrumentation (or vice versa) Prisma just blows up, because tries to call methods on the helper that no longer exist.
 // Because we actually want to use the v6 instrumentation and not blow up in Prisma 5 user's faces, what we're doing here is backfilling the v5 method (`createEngineSpan`) with a noop so that no longer crashes when it attempts to call that function.
 // We still won't fully emit all the spans, but this could potentially be implemented in the future.
 const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;
 const prismaTracingHelper =
 prismaInstrumentationObject &&
 typeof prismaInstrumentationObject === 'object' &&
 'helper' in prismaInstrumentationObject
 ? prismaInstrumentationObject.helper
 : undefined;
 const prismaTracingHelper = getPrismaTracingHelper();

 let emittedWarning = false;

Expand DownExpand Up@@ -119,6 +125,12 @@ export const prismaIntegration = defineIntegration(
 instrumentPrisma({ prismaInstrumentation });
 },
 setup(client) {
 // If no tracing helper exists, we skip any work here
@mydeamydeaMar 25, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

this is not perfect as possibly prisma could be set up later than setup(client) is being called, but it was the best I could come up with here 🤔 it seems to work in tests at least!
 // this means that prisma is not being used
 if (!getPrismaTracingHelper()) {
 return;
 }

 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('prisma:')) {
Expand Down

33 changes: 19 additions & 14 deletions
packages/node/src/integrations/tracing/tedious.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { TediousInstrumentation } from '@opentelemetry/instrumentation-tedious';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const TEDIUS_INSTRUMENTED_METHODS = new Set([
 'callProcedure',
Expand All@@ -17,25 +17,30 @@ const INTEGRATION_NAME = 'Tedious';
export const instrumentTedious = generateInstrumentOnce(INTEGRATION_NAME, () => new TediousInstrumentation({}));

const _tediousIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentTedious();
 const instrumentation = instrumentTedious();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const { description, data } = spanToJSON(span);
 // Tedius integration always set a span name and `db.system` attribute to `mssql`.
 if (!description || data['db.system'] !== 'mssql') {
 return;
 }

 const operation = description.split(' ')[0] || '';
 if (TEDIUS_INSTRUMENTED_METHODS.has(operation)) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.tedious');
 }
 });
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const { description, data } = spanToJSON(span);
 // Tedius integration always set a span name and `db.system` attribute to `mssql`.
 if (!description || data['db.system'] !== 'mssql') {
 return;
 }

 const operation = description.split(' ')[0] || '';
 if (TEDIUS_INSTRUMENTED_METHODS.has(operation)) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.tedious');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down
Loading

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

Skip to content
feat(node): Only add span listeners for instrumentation when used#15802

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Mar 26, 2025
 Merged


feat(node): Only add span listeners for instrumentation when used
#15802
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3431a27

feat(node): WIP Only add span listeners conditionally


mydea Mar 24, 2025
ee30339

ref add stuff


mydea Mar 25, 2025
d0af51d

fixes


mydea Mar 25, 2025
4f540e5

fix it for ai


mydea Mar 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
packages/node/src/integrations/tracing/connect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,7 +104,7 @@ function addConnectSpanAttributes(span: Span): void {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.connect`,
 });

 // Also update the name, we don't need to "middleware - " prefix
 // Also update the name, we don't need the "middleware - " prefix
 const name = attributes['connect.name'];
 if (typeof name === 'string') {
 span.updateName(name);
Expand Down

44 changes: 25 additions & 19 deletions
packages/node/src/integrations/tracing/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import {
 spanToJSON,
} from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { instrumentWhenWrapped, generateInstrumentOnce } from '../../otel/instrument';

const INTEGRATION_NAME = 'Dataloader';

Expand All@@ -19,31 +19,37 @@ export const instrumentDataloader = generateInstrumentOnce(
);

const _dataloaderIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentDataloader();
 const instrumentation = instrumentDataloader();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }
 // This is called either immediately or when the instrumentation is wrapped
 instrumentationWrappedCallback?.(() => {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }

 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 });
 });
 },
 };
Expand Down

29 changes: 17 additions & 12 deletions
packages/node/src/integrations/tracing/genericPool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,33 +1,38 @@
import { GenericPoolInstrumentation } from '@opentelemetry/instrumentation-generic-pool';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const INTEGRATION_NAME = 'GenericPool';

export const instrumentGenericPool = generateInstrumentOnce(INTEGRATION_NAME, () => new GenericPoolInstrumentation({}));

const _genericPoolIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentGenericPool();
 const instrumentation = instrumentGenericPool();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);

 const spanDescription = spanJSON.description;
const spanDescription = spanJSON.description;

 // typo in emitted span for version <= 0.38.0 of @opentelemetry/instrumentation-generic-pool
 const isGenericPoolSpan =
 spanDescription === 'generic-pool.aquire' || spanDescription === 'generic-pool.acquire';
// typo in emitted span for version <= 0.38.0 of @opentelemetry/instrumentation-generic-pool
const isGenericPoolSpan =
spanDescription === 'generic-pool.aquire' || spanDescription === 'generic-pool.acquire';

 if (isGenericPoolSpan) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.generic_pool');
 }
 });
 if (isGenericPoolSpan) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.generic_pool');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down

25 changes: 15 additions & 10 deletions
packages/node/src/integrations/tracing/knex.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { KnexInstrumentation } from '@opentelemetry/instrumentation-knex';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const INTEGRATION_NAME = 'Knex';

Expand All@@ -11,21 +11,26 @@ export const instrumentKnex = generateInstrumentOnce(
);

const _knexIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentKnex();
 const instrumentation = instrumentKnex();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const { data } = spanToJSON(span);
 // knex.version is always set in the span data
 // https://github.com/open-telemetry/opentelemetry-js-contrib/blob/0309caeafc44ac9cb13a3345b790b01b76d0497d/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts#L138
 if ('knex.version' in data) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
 }
 });
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const { data } = spanToJSON(span);
 // knex.version is always set in the span data
 // https://github.com/open-telemetry/opentelemetry-js-contrib/blob/0309caeafc44ac9cb13a3345b790b01b76d0497d/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts#L138
 if ('knex.version' in data) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down

26 changes: 19 additions & 7 deletions
packages/node/src/integrations/tracing/prisma.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,18 @@ function isPrismaV6TracingHelper(helper: unknown): helper is PrismaV6TracingHelp
 return !!helper && typeof helper === 'object' && 'dispatchEngineSpans' in helper;
}

function getPrismaTracingHelper(): unknown | undefined {
 const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;
 const prismaTracingHelper =
 prismaInstrumentationObject &&
 typeof prismaInstrumentationObject === 'object' &&
 'helper' in prismaInstrumentationObject
 ? prismaInstrumentationObject.helper
 : undefined;

 return prismaTracingHelper;
}

class SentryPrismaInteropInstrumentation extends EsmInteropPrismaInstrumentation {
 public constructor() {
 super();
Expand All@@ -30,13 +42,7 @@ class SentryPrismaInteropInstrumentation extends EsmInteropPrismaInstrumentation
 // The PrismaIntegration (super class) defines a global variable `global["PRISMA_INSTRUMENTATION"]` when `enable()` is called. This global variable holds a "TracingHelper" which Prisma uses internally to create tracing data. It's their way of not depending on OTEL with their main package. The sucky thing is, prisma broke the interface of the tracing helper with the v6 major update. This means that if you use Prisma 5 with the v6 instrumentation (or vice versa) Prisma just blows up, because tries to call methods on the helper that no longer exist.
 // Because we actually want to use the v6 instrumentation and not blow up in Prisma 5 user's faces, what we're doing here is backfilling the v5 method (`createEngineSpan`) with a noop so that no longer crashes when it attempts to call that function.
 // We still won't fully emit all the spans, but this could potentially be implemented in the future.
 const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;
 const prismaTracingHelper =
 prismaInstrumentationObject &&
 typeof prismaInstrumentationObject === 'object' &&
 'helper' in prismaInstrumentationObject
 ? prismaInstrumentationObject.helper
 : undefined;
 const prismaTracingHelper = getPrismaTracingHelper();

 let emittedWarning = false;

Expand DownExpand Up@@ -119,6 +125,12 @@ export const prismaIntegration = defineIntegration(
 instrumentPrisma({ prismaInstrumentation });
 },
 setup(client) {
 // If no tracing helper exists, we skip any work here
@mydeamydeaMar 25, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

this is not perfect as possibly prisma could be set up later than setup(client) is being called, but it was the best I could come up with here 🤔 it seems to work in tests at least!
 // this means that prisma is not being used
 if (!getPrismaTracingHelper()) {
 return;
 }

 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('prisma:')) {
Expand Down

33 changes: 19 additions & 14 deletions
packages/node/src/integrations/tracing/tedious.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { TediousInstrumentation } from '@opentelemetry/instrumentation-tedious';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const TEDIUS_INSTRUMENTED_METHODS = new Set([
 'callProcedure',
Expand All@@ -17,25 +17,30 @@ const INTEGRATION_NAME = 'Tedious';
export const instrumentTedious = generateInstrumentOnce(INTEGRATION_NAME, () => new TediousInstrumentation({}));

const _tediousIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentTedious();
 const instrumentation = instrumentTedious();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const { description, data } = spanToJSON(span);
 // Tedius integration always set a span name and `db.system` attribute to `mssql`.
 if (!description || data['db.system'] !== 'mssql') {
 return;
 }

 const operation = description.split(' ')[0] || '';
 if (TEDIUS_INSTRUMENTED_METHODS.has(operation)) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.tedious');
 }
 });
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const { description, data } = spanToJSON(span);
 // Tedius integration always set a span name and `db.system` attribute to `mssql`.
 if (!description || data['db.system'] !== 'mssql') {
 return;
 }

 const operation = description.split(' ')[0] || '';
 if (TEDIUS_INSTRUMENTED_METHODS.has(operation)) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.tedious');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down
Loading

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

Skip to content
feat(node): Only add span listeners for instrumentation when used#15802

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Mar 26, 2025
 Merged


feat(node): Only add span listeners for instrumentation when used
#15802
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3431a27

feat(node): WIP Only add span listeners conditionally


mydea Mar 24, 2025
ee30339

ref add stuff


mydea Mar 25, 2025
d0af51d

fixes


mydea Mar 25, 2025
4f540e5

fix it for ai


mydea Mar 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
packages/node/src/integrations/tracing/connect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,7 +104,7 @@ function addConnectSpanAttributes(span: Span): void {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.connect`,
 });

 // Also update the name, we don't need to "middleware - " prefix
 // Also update the name, we don't need the "middleware - " prefix
 const name = attributes['connect.name'];
 if (typeof name === 'string') {
 span.updateName(name);
Expand Down

44 changes: 25 additions & 19 deletions
packages/node/src/integrations/tracing/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import {
 spanToJSON,
} from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { instrumentWhenWrapped, generateInstrumentOnce } from '../../otel/instrument';

const INTEGRATION_NAME = 'Dataloader';

Expand All@@ -19,31 +19,37 @@ export const instrumentDataloader = generateInstrumentOnce(
);

const _dataloaderIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentDataloader();
 const instrumentation = instrumentDataloader();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }
 // This is called either immediately or when the instrumentation is wrapped
 instrumentationWrappedCallback?.(() => {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }

 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 });
 });
 },
 };
Expand Down

29 changes: 17 additions & 12 deletions
packages/node/src/integrations/tracing/genericPool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,33 +1,38 @@
import { GenericPoolInstrumentation } from '@opentelemetry/instrumentation-generic-pool';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const INTEGRATION_NAME = 'GenericPool';

export const instrumentGenericPool = generateInstrumentOnce(INTEGRATION_NAME, () => new GenericPoolInstrumentation({}));

const _genericPoolIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentGenericPool();
 const instrumentation = instrumentGenericPool();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);

 const spanDescription = spanJSON.description;
const spanDescription = spanJSON.description;

 // typo in emitted span for version <= 0.38.0 of @opentelemetry/instrumentation-generic-pool
 const isGenericPoolSpan =
 spanDescription === 'generic-pool.aquire' || spanDescription === 'generic-pool.acquire';
// typo in emitted span for version <= 0.38.0 of @opentelemetry/instrumentation-generic-pool
const isGenericPoolSpan =
spanDescription === 'generic-pool.aquire' || spanDescription === 'generic-pool.acquire';

 if (isGenericPoolSpan) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.generic_pool');
 }
 });
 if (isGenericPoolSpan) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.generic_pool');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down

25 changes: 15 additions & 10 deletions
packages/node/src/integrations/tracing/knex.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { KnexInstrumentation } from '@opentelemetry/instrumentation-knex';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const INTEGRATION_NAME = 'Knex';

Expand All@@ -11,21 +11,26 @@ export const instrumentKnex = generateInstrumentOnce(
);

const _knexIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentKnex();
 const instrumentation = instrumentKnex();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const { data } = spanToJSON(span);
 // knex.version is always set in the span data
 // https://github.com/open-telemetry/opentelemetry-js-contrib/blob/0309caeafc44ac9cb13a3345b790b01b76d0497d/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts#L138
 if ('knex.version' in data) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
 }
 });
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const { data } = spanToJSON(span);
 // knex.version is always set in the span data
 // https://github.com/open-telemetry/opentelemetry-js-contrib/blob/0309caeafc44ac9cb13a3345b790b01b76d0497d/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts#L138
 if ('knex.version' in data) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down

26 changes: 19 additions & 7 deletions
packages/node/src/integrations/tracing/prisma.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,18 @@ function isPrismaV6TracingHelper(helper: unknown): helper is PrismaV6TracingHelp
 return !!helper && typeof helper === 'object' && 'dispatchEngineSpans' in helper;
}

function getPrismaTracingHelper(): unknown | undefined {
 const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;
 const prismaTracingHelper =
 prismaInstrumentationObject &&
 typeof prismaInstrumentationObject === 'object' &&
 'helper' in prismaInstrumentationObject
 ? prismaInstrumentationObject.helper
 : undefined;

 return prismaTracingHelper;
}

class SentryPrismaInteropInstrumentation extends EsmInteropPrismaInstrumentation {
 public constructor() {
 super();
Expand All@@ -30,13 +42,7 @@ class SentryPrismaInteropInstrumentation extends EsmInteropPrismaInstrumentation
 // The PrismaIntegration (super class) defines a global variable `global["PRISMA_INSTRUMENTATION"]` when `enable()` is called. This global variable holds a "TracingHelper" which Prisma uses internally to create tracing data. It's their way of not depending on OTEL with their main package. The sucky thing is, prisma broke the interface of the tracing helper with the v6 major update. This means that if you use Prisma 5 with the v6 instrumentation (or vice versa) Prisma just blows up, because tries to call methods on the helper that no longer exist.
 // Because we actually want to use the v6 instrumentation and not blow up in Prisma 5 user's faces, what we're doing here is backfilling the v5 method (`createEngineSpan`) with a noop so that no longer crashes when it attempts to call that function.
 // We still won't fully emit all the spans, but this could potentially be implemented in the future.
 const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;
 const prismaTracingHelper =
 prismaInstrumentationObject &&
 typeof prismaInstrumentationObject === 'object' &&
 'helper' in prismaInstrumentationObject
 ? prismaInstrumentationObject.helper
 : undefined;
 const prismaTracingHelper = getPrismaTracingHelper();

 let emittedWarning = false;

Expand DownExpand Up@@ -119,6 +125,12 @@ export const prismaIntegration = defineIntegration(
 instrumentPrisma({ prismaInstrumentation });
 },
 setup(client) {
 // If no tracing helper exists, we skip any work here
@mydeamydeaMar 25, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

this is not perfect as possibly prisma could be set up later than setup(client) is being called, but it was the best I could come up with here 🤔 it seems to work in tests at least!
 // this means that prisma is not being used
 if (!getPrismaTracingHelper()) {
 return;
 }

 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('prisma:')) {
Expand Down

33 changes: 19 additions & 14 deletions
packages/node/src/integrations/tracing/tedious.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { TediousInstrumentation } from '@opentelemetry/instrumentation-tedious';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const TEDIUS_INSTRUMENTED_METHODS = new Set([
 'callProcedure',
Expand All@@ -17,25 +17,30 @@ const INTEGRATION_NAME = 'Tedious';
export const instrumentTedious = generateInstrumentOnce(INTEGRATION_NAME, () => new TediousInstrumentation({}));

const _tediousIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentTedious();
 const instrumentation = instrumentTedious();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const { description, data } = spanToJSON(span);
 // Tedius integration always set a span name and `db.system` attribute to `mssql`.
 if (!description || data['db.system'] !== 'mssql') {
 return;
 }

 const operation = description.split(' ')[0] || '';
 if (TEDIUS_INSTRUMENTED_METHODS.has(operation)) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.tedious');
 }
 });
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const { description, data } = spanToJSON(span);
 // Tedius integration always set a span name and `db.system` attribute to `mssql`.
 if (!description || data['db.system'] !== 'mssql') {
 return;
 }

 const operation = description.split(' ')[0] || '';
 if (TEDIUS_INSTRUMENTED_METHODS.has(operation)) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.tedious');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down
Loading

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

Skip to content
feat(node): Only add span listeners for instrumentation when used#15802

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Mar 26, 2025
 Merged


feat(node): Only add span listeners for instrumentation when used
#15802
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
3431a27

feat(node): WIP Only add span listeners conditionally


mydea Mar 24, 2025
ee30339

ref add stuff


mydea Mar 25, 2025
d0af51d

fixes


mydea Mar 25, 2025
4f540e5

fix it for ai


mydea Mar 25, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
packages/node/src/integrations/tracing/connect.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,7 +104,7 @@ function addConnectSpanAttributes(span: Span): void {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.connect`,
 });

 // Also update the name, we don't need to "middleware - " prefix
 // Also update the name, we don't need the "middleware - " prefix
 const name = attributes['connect.name'];
 if (typeof name === 'string') {
 span.updateName(name);
Expand Down

44 changes: 25 additions & 19 deletions
packages/node/src/integrations/tracing/dataloader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ import {
 spanToJSON,
} from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { instrumentWhenWrapped, generateInstrumentOnce } from '../../otel/instrument';

const INTEGRATION_NAME = 'Dataloader';

Expand All@@ -19,31 +19,37 @@ export const instrumentDataloader = generateInstrumentOnce(
);

const _dataloaderIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentDataloader();
 const instrumentation = instrumentDataloader();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }
 // This is called either immediately or when the instrumentation is wrapped
 instrumentationWrappedCallback?.(() => {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('dataloader')) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.dataloader');
 }

 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 // These are all possible dataloader span descriptions
 // Still checking for the future versions
 // in case they add support for `clear` and `prime`
 if (
 spanJSON.description === 'dataloader.load' ||
 spanJSON.description === 'dataloader.loadMany' ||
 spanJSON.description === 'dataloader.batch'
 ) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'cache.get');
 // TODO: We can try adding `key` to the `data` attribute upstream.
 // Or alternatively, we can add `requestHook` to the dataloader instrumentation.
 }
 });
 });
 },
 };
Expand Down

29 changes: 17 additions & 12 deletions
packages/node/src/integrations/tracing/genericPool.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,33 +1,38 @@
import { GenericPoolInstrumentation } from '@opentelemetry/instrumentation-generic-pool';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const INTEGRATION_NAME = 'GenericPool';

export const instrumentGenericPool = generateInstrumentOnce(INTEGRATION_NAME, () => new GenericPoolInstrumentation({}));

const _genericPoolIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentGenericPool();
 const instrumentation = instrumentGenericPool();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);

 const spanDescription = spanJSON.description;
const spanDescription = spanJSON.description;

 // typo in emitted span for version <= 0.38.0 of @opentelemetry/instrumentation-generic-pool
 const isGenericPoolSpan =
 spanDescription === 'generic-pool.aquire' || spanDescription === 'generic-pool.acquire';
// typo in emitted span for version <= 0.38.0 of @opentelemetry/instrumentation-generic-pool
const isGenericPoolSpan =
spanDescription === 'generic-pool.aquire' || spanDescription === 'generic-pool.acquire';

 if (isGenericPoolSpan) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.generic_pool');
 }
 });
 if (isGenericPoolSpan) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.generic_pool');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down

25 changes: 15 additions & 10 deletions
packages/node/src/integrations/tracing/knex.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { KnexInstrumentation } from '@opentelemetry/instrumentation-knex';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const INTEGRATION_NAME = 'Knex';

Expand All@@ -11,21 +11,26 @@ export const instrumentKnex = generateInstrumentOnce(
);

const _knexIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentKnex();
 const instrumentation = instrumentKnex();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const { data } = spanToJSON(span);
 // knex.version is always set in the span data
 // https://github.com/open-telemetry/opentelemetry-js-contrib/blob/0309caeafc44ac9cb13a3345b790b01b76d0497d/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts#L138
 if ('knex.version' in data) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
 }
 });
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const { data } = spanToJSON(span);
 // knex.version is always set in the span data
 // https://github.com/open-telemetry/opentelemetry-js-contrib/blob/0309caeafc44ac9cb13a3345b790b01b76d0497d/plugins/node/opentelemetry-instrumentation-knex/src/instrumentation.ts#L138
 if ('knex.version' in data) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.knex');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down

26 changes: 19 additions & 7 deletions
packages/node/src/integrations/tracing/prisma.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,18 @@ function isPrismaV6TracingHelper(helper: unknown): helper is PrismaV6TracingHelp
 return !!helper && typeof helper === 'object' && 'dispatchEngineSpans' in helper;
}

function getPrismaTracingHelper(): unknown | undefined {
 const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;
 const prismaTracingHelper =
 prismaInstrumentationObject &&
 typeof prismaInstrumentationObject === 'object' &&
 'helper' in prismaInstrumentationObject
 ? prismaInstrumentationObject.helper
 : undefined;

 return prismaTracingHelper;
}

class SentryPrismaInteropInstrumentation extends EsmInteropPrismaInstrumentation {
 public constructor() {
 super();
Expand All@@ -30,13 +42,7 @@ class SentryPrismaInteropInstrumentation extends EsmInteropPrismaInstrumentation
 // The PrismaIntegration (super class) defines a global variable `global["PRISMA_INSTRUMENTATION"]` when `enable()` is called. This global variable holds a "TracingHelper" which Prisma uses internally to create tracing data. It's their way of not depending on OTEL with their main package. The sucky thing is, prisma broke the interface of the tracing helper with the v6 major update. This means that if you use Prisma 5 with the v6 instrumentation (or vice versa) Prisma just blows up, because tries to call methods on the helper that no longer exist.
 // Because we actually want to use the v6 instrumentation and not blow up in Prisma 5 user's faces, what we're doing here is backfilling the v5 method (`createEngineSpan`) with a noop so that no longer crashes when it attempts to call that function.
 // We still won't fully emit all the spans, but this could potentially be implemented in the future.
 const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;
 const prismaTracingHelper =
 prismaInstrumentationObject &&
 typeof prismaInstrumentationObject === 'object' &&
 'helper' in prismaInstrumentationObject
 ? prismaInstrumentationObject.helper
 : undefined;
 const prismaTracingHelper = getPrismaTracingHelper();

 let emittedWarning = false;

Expand DownExpand Up@@ -119,6 +125,12 @@ export const prismaIntegration = defineIntegration(
 instrumentPrisma({ prismaInstrumentation });
 },
 setup(client) {
 // If no tracing helper exists, we skip any work here
@mydeamydeaMar 25, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

this is not perfect as possibly prisma could be set up later than setup(client) is being called, but it was the best I could come up with here 🤔 it seems to work in tests at least!
 // this means that prisma is not being used
 if (!getPrismaTracingHelper()) {
 return;
 }

 client.on('spanStart', span => {
 const spanJSON = spanToJSON(span);
 if (spanJSON.description?.startsWith('prisma:')) {
Expand Down

33 changes: 19 additions & 14 deletions
packages/node/src/integrations/tracing/tedious.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { TediousInstrumentation } from '@opentelemetry/instrumentation-tedious';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, defineIntegration, spanToJSON } from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { generateInstrumentOnce } from '../../otel/instrument';
import { generateInstrumentOnce, instrumentWhenWrapped } from '../../otel/instrument';

const TEDIUS_INSTRUMENTED_METHODS = new Set([
 'callProcedure',
Expand All@@ -17,25 +17,30 @@ const INTEGRATION_NAME = 'Tedious';
export const instrumentTedious = generateInstrumentOnce(INTEGRATION_NAME, () => new TediousInstrumentation({}));

const _tediousIntegration = (() => {
 let instrumentationWrappedCallback: undefined | ((callback: () => void) => void);

 return {
 name: INTEGRATION_NAME,
 setupOnce() {
 instrumentTedious();
 const instrumentation = instrumentTedious();
 instrumentationWrappedCallback = instrumentWhenWrapped(instrumentation);
 },

 setup(client) {
 client.on('spanStart', span => {
 const { description, data } = spanToJSON(span);
 // Tedius integration always set a span name and `db.system` attribute to `mssql`.
 if (!description || data['db.system'] !== 'mssql') {
 return;
 }

 const operation = description.split(' ')[0] || '';
 if (TEDIUS_INSTRUMENTED_METHODS.has(operation)) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.tedious');
 }
 });
 instrumentationWrappedCallback?.(() =>
 client.on('spanStart', span => {
 const { description, data } = spanToJSON(span);
 // Tedius integration always set a span name and `db.system` attribute to `mssql`.
 if (!description || data['db.system'] !== 'mssql') {
 return;
 }

 const operation = description.split(' ')[0] || '';
 if (TEDIUS_INSTRUMENTED_METHODS.has(operation)) {
 span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.tedious');
 }
 }),
 );
 },
 };
}) satisfies IntegrationFn;
Expand Down
Loading