@sentry/node 10.63.0 → 10.65.0

package/build/cjs/integrations/tracing/prisma/index.js

@@ -1,8 +1,8 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
-const api = require('@opentelemetry/api');
 const core = require('@sentry/core');
 const nodeCore = require('@sentry/node-core');
+const debugBuild = require('../../../debug-build.js');
 const instrumentation = require('./vendored/instrumentation.js');
 
 const INTEGRATION_NAME = "Prisma";
@@ -14,6 +14,44 @@ function getPrismaTracingHelper() {
   const prismaTracingHelper = prismaInstrumentationObject && typeof prismaInstrumentationObject === "object" && "helper" in prismaInstrumentationObject ? prismaInstrumentationObject.helper : void 0;
   return prismaTracingHelper;
 }
+const MAX_TRACKED_PRISMA_SPANS = 1e3;
+const prismaSpanRegistry = new core.LRUMap(MAX_TRACKED_PRISMA_SPANS);
+const pendingEngineSpans = [];
+function registerPrismaSpan(id, span) {
+  prismaSpanRegistry.set(id, span);
+}
+function createResolvedEngineSpans() {
+  let createdSpan = true;
+  while (createdSpan) {
+    createdSpan = false;
+    for (let i = pendingEngineSpans.length - 1; i >= 0; i--) {
+      const engineSpan = pendingEngineSpans[i];
+      const parentSpan = prismaSpanRegistry.get(engineSpan.parent_span_id);
+      if (!parentSpan) {
+        continue;
+      }
+      const span = core.startInactiveSpan({
+        name: engineSpan.name,
+        attributes: engineSpan.attributes,
+        kind: engineSpan.kind === "client" ? core.SPAN_KIND.CLIENT : core.SPAN_KIND.INTERNAL,
+        startTime: engineSpan.start_time,
+        parentSpan
+      });
+      registerPrismaSpan(engineSpan.span_id, span);
+      if (engineSpan.links) {
+        span.addLinks(
+          engineSpan.links.flatMap((link) => {
+            const linkedSpan = prismaSpanRegistry.get(link.span_id);
+            return linkedSpan ? [{ context: linkedSpan.spanContext() }] : [];
+          })
+        );
+      }
+      span.end(engineSpan.end_time);
+      pendingEngineSpans.splice(i, 1);
+      createdSpan = true;
+    }
+  }
+}
 class SentryPrismaInteropInstrumentation extends instrumentation.PrismaInstrumentation {
   constructor(options) {
     super(options?.instrumentationConfig);
@@ -23,58 +61,12 @@ class SentryPrismaInteropInstrumentation extends instrumentation.PrismaInstrumen
     const prismaTracingHelper = getPrismaTracingHelper();
     if (isPrismaV6TracingHelper(prismaTracingHelper)) {
       prismaTracingHelper.createEngineSpan = (engineSpanEvent) => {
-        const tracer = api.trace.getTracer("prismaV5Compatibility");
-        const initialIdGenerator = tracer._idGenerator;
-        if (!initialIdGenerator) {
-          core.consoleSandbox(() => {
-            console.warn(
-              "[Sentry] Could not find _idGenerator on tracer, skipping Prisma v5 compatibility - some Prisma spans may be missing!"
-            );
-          });
-          return;
-        }
-        try {
-          engineSpanEvent.spans.forEach((engineSpan) => {
-            const kind = engineSpan.kind === "client" ? api.SpanKind.CLIENT : api.SpanKind.INTERNAL;
-            const parentSpanId = engineSpan.parent_span_id;
-            const spanId = engineSpan.span_id;
-            const traceId = engineSpan.trace_id;
-            const links = engineSpan.links?.map((link) => {
-              return {
-                context: {
-                  traceId: link.trace_id,
-                  spanId: link.span_id,
-                  traceFlags: api.TraceFlags.SAMPLED
-                }
-              };
-            });
-            const ctx = api.trace.setSpanContext(api.context.active(), {
-              traceId,
-              spanId: parentSpanId,
-              traceFlags: api.TraceFlags.SAMPLED
-            });
-            api.context.with(ctx, () => {
-              const temporaryIdGenerator = {
-                generateTraceId: () => {
-                  return traceId;
-                },
-                generateSpanId: () => {
-                  return spanId;
-                }
-              };
-              tracer._idGenerator = temporaryIdGenerator;
-              const span = tracer.startSpan(engineSpan.name, {
-                kind,
-                links,
-                startTime: engineSpan.start_time,
-                attributes: engineSpan.attributes
-              });
-              span.end(engineSpan.end_time);
-              tracer._idGenerator = initialIdGenerator;
-            });
-          });
-        } finally {
-          tracer._idGenerator = initialIdGenerator;
+        pendingEngineSpans.push(...engineSpanEvent.spans);
+        createResolvedEngineSpans();
+        const overflow = pendingEngineSpans.length - MAX_TRACKED_PRISMA_SPANS;
+        if (overflow > 0) {
+          debugBuild.DEBUG_BUILD && core.debug.log(`[Prisma] Dropping ${overflow} unresolved v5 engine span(s) whose parent was never registered.`);
+          pendingEngineSpans.splice(0, overflow);
         }
       };
     }
@@ -97,6 +89,9 @@ const prismaIntegration = core.defineIntegration((options) => {
         const spanJSON = core.spanToJSON(span);
         if (spanJSON.description?.startsWith("prisma:")) {
           span.setAttribute(core.SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, "auto.db.otel.prisma");
+          if (spanJSON.description.startsWith("prisma:client:")) {
+            registerPrismaSpan(span.spanContext().spanId, span);
+          }
         }
         if ((spanJSON.description === "prisma:engine:db_query" || spanJSON.description === "prisma:client:db_query") && spanJSON.data["db.query.text"]) {
           span.updateName(spanJSON.data["db.query.text"]);

package/build/cjs/integrations/tracing/prisma/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../../../../src/integrations/tracing/prisma/index.ts"],"sourcesContent":["import type { Link, Tracer } from '@opentelemetry/api';\nimport { context, SpanKind, trace, TraceFlags } from '@opentelemetry/api';\nimport type { Instrumentation } from '@opentelemetry/instrumentation';\nimport type { IdGenerator } from '@opentelemetry/sdk-trace-base';\nimport { consoleSandbox, defineIntegration, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, spanToJSON } from '@sentry/core';\nimport { generateInstrumentOnce } from '@sentry/node-core';\nimport { PrismaInstrumentation } from './vendored/instrumentation';\nimport type { PrismaV5TracingHelper } from './vendored/v5-tracing-helper';\nimport type { PrismaV6TracingHelper } from './vendored/v6-tracing-helper';\n\nconst INTEGRATION_NAME = 'Prisma' as const;\n\ntype CompatibilityLayerTraceHelper = PrismaV5TracingHelper & PrismaV6TracingHelper;\n\n// Vendored in from @prisma/instrumentation v5:\ntype V5EngineSpanEvent = {\n  span: boolean;\n  spans: V5EngineSpan[];\n};\n\ntype V5EngineSpanKind = 'client' | 'internal';\n\ntype V5EngineSpan = {\n  span: boolean;\n  name: string;\n  trace_id: string;\n  span_id: string;\n  parent_span_id: string;\n  start_time: [number, number];\n  end_time: [number, number];\n  attributes?: Record<string, string>;\n  links?: { trace_id: string; span_id: string }[];\n  kind: V5EngineSpanKind;\n};\n\nfunction isPrismaV6TracingHelper(helper: unknown): helper is PrismaV6TracingHelper {\n  return !!helper && typeof helper === 'object' && 'dispatchEngineSpans' in helper;\n}\n\nfunction getPrismaTracingHelper(): unknown | undefined {\n  const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;\n  const prismaTracingHelper =\n    prismaInstrumentationObject &&\n    typeof prismaInstrumentationObject === 'object' &&\n    'helper' in prismaInstrumentationObject\n      ? prismaInstrumentationObject.helper\n      : undefined;\n\n  return prismaTracingHelper;\n}\n\ntype TracerWithIdGenerator = Tracer & {\n  _idGenerator?: IdGenerator;\n};\n\ninterface PrismaOptions {\n  /**\n   * @deprecated This is no longer used, v5 works out of the box.\n   */\n  prismaInstrumentation?: Instrumentation;\n  /**\n   * Configuration passed through to the {@link PrismaInstrumentation} constructor.\n   */\n  instrumentationConfig?: ConstructorParameters<typeof PrismaInstrumentation>[0];\n}\n\nclass SentryPrismaInteropInstrumentation extends PrismaInstrumentation {\n  public constructor(options?: PrismaOptions) {\n    super(options?.instrumentationConfig);\n  }\n\n  public enable(): void {\n    super.enable();\n\n    // 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.\n    // 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.\n    const prismaTracingHelper = getPrismaTracingHelper();\n\n    if (isPrismaV6TracingHelper(prismaTracingHelper)) {\n      // Inspired & adjusted from https://github.com/prisma/prisma/tree/5.22.0/packages/instrumentation\n      (prismaTracingHelper as CompatibilityLayerTraceHelper).createEngineSpan = (\n        engineSpanEvent: V5EngineSpanEvent,\n      ) => {\n        const tracer = trace.getTracer('prismaV5Compatibility') as TracerWithIdGenerator;\n\n        // Prisma v5 relies on being able to create spans with a specific span & trace ID\n        // this is no longer possible in OTEL v2, there is no public API to do this anymore\n        // So in order to kind of hack this possibility, we rely on the internal `_idGenerator` property\n        // This is used to generate the random IDs, and we overwrite this temporarily to generate static IDs\n        // This is flawed and may not work, e.g. if the code is bundled and the private property is renamed\n        // in such cases, these spans will not be captured and some Prisma spans will be missing\n        const initialIdGenerator = tracer._idGenerator;\n\n        if (!initialIdGenerator) {\n          consoleSandbox(() => {\n            // eslint-disable-next-line no-console\n            console.warn(\n              '[Sentry] Could not find _idGenerator on tracer, skipping Prisma v5 compatibility - some Prisma spans may be missing!',\n            );\n          });\n\n          return;\n        }\n\n        try {\n          engineSpanEvent.spans.forEach(engineSpan => {\n            const kind = engineSpan.kind === 'client' ? SpanKind.CLIENT : SpanKind.INTERNAL;\n\n            const parentSpanId = engineSpan.parent_span_id;\n            const spanId = engineSpan.span_id;\n            const traceId = engineSpan.trace_id;\n\n            const links: Link[] | undefined = engineSpan.links?.map(link => {\n              return {\n                context: {\n                  traceId: link.trace_id,\n                  spanId: link.span_id,\n                  traceFlags: TraceFlags.SAMPLED,\n                },\n              };\n            });\n\n            const ctx = trace.setSpanContext(context.active(), {\n              traceId,\n              spanId: parentSpanId,\n              traceFlags: TraceFlags.SAMPLED,\n            });\n\n            context.with(ctx, () => {\n              const temporaryIdGenerator: IdGenerator = {\n                generateTraceId: () => {\n                  return traceId;\n                },\n                generateSpanId: () => {\n                  return spanId;\n                },\n              };\n\n              tracer._idGenerator = temporaryIdGenerator;\n\n              const span = tracer.startSpan(engineSpan.name, {\n                kind,\n                links,\n                startTime: engineSpan.start_time,\n                attributes: engineSpan.attributes,\n              });\n\n              span.end(engineSpan.end_time);\n\n              tracer._idGenerator = initialIdGenerator;\n            });\n          });\n        } finally {\n          // Ensure we always restore this at the end, even if something errors\n          tracer._idGenerator = initialIdGenerator;\n        }\n      };\n    }\n  }\n}\n\nexport const instrumentPrisma = generateInstrumentOnce<PrismaOptions>(INTEGRATION_NAME, options => {\n  return new SentryPrismaInteropInstrumentation(options);\n});\n\n/**\n * Adds Sentry tracing instrumentation for the [prisma](https://www.npmjs.com/package/prisma) library.\n * For more information, see the [`prismaIntegration` documentation](https://docs.sentry.io/platforms/javascript/guides/node/configuration/integrations/prisma/).\n *\n * NOTE: This integration works out of the box with Prisma v6, and v7.\n * On Prisma versions prior to v6, add `previewFeatures = [\"tracing\"]` to the client generator block of your Prisma schema:\n *\n *    ```\n *    generator client {\n *      provider = \"prisma-client-js\"\n *      previewFeatures = [\"tracing\"]\n *    }\n *    ```\n */\nexport const prismaIntegration = defineIntegration((options?: PrismaOptions) => {\n  return {\n    name: INTEGRATION_NAME,\n    setupOnce() {\n      instrumentPrisma(options);\n    },\n    setup(client) {\n      // If no tracing helper exists, we skip any work here\n      // this means that prisma is not being used\n      if (!getPrismaTracingHelper()) {\n        return;\n      }\n\n      // Prisma v5 engine spans are created via the `createEngineSpan` path above, which bypasses the\n      // tracing helper, so this hook applies origin, the db_query rename, and the db.system backfill to\n      // them. v6/v7 spans already get these from the helper; the guards are idempotent, so it's a no-op there.\n      client.on('spanStart', span => {\n        const spanJSON = spanToJSON(span);\n        if (spanJSON.description?.startsWith('prisma:')) {\n          span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.prisma');\n        }\n\n        // Make sure we use the query text as the span name, for ex. SELECT * FROM \"User\" WHERE \"id\" = $1.\n        // v5/v6 emit `prisma:engine:db_query`; v7 inlined the engine and emits `prisma:client:db_query`.\n        if (\n          (spanJSON.description === 'prisma:engine:db_query' || spanJSON.description === 'prisma:client:db_query') &&\n          spanJSON.data['db.query.text']\n        ) {\n          span.updateName(spanJSON.data['db.query.text'] as string);\n        }\n\n        // In Prisma v5.22+, the `db.system` attribute is automatically set\n        // On older versions, this is missing, so we add it here\n        if (spanJSON.description === 'prisma:engine:db_query' && !spanJSON.data['db.system']) {\n          span.setAttribute('db.system', 'prisma');\n        }\n      });\n    },\n  };\n});\n"],"names":["PrismaInstrumentation","trace","consoleSandbox","SpanKind","TraceFlags","context","generateInstrumentOnce","defineIntegration","spanToJSON","SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN"],"mappings":";;;;;;;AAUA,MAAM,gBAAA,GAAmB,QAAA;AAyBzB,SAAS,wBAAwB,MAAA,EAAkD;AACjF,EAAA,OAAO,CAAC,CAAC,MAAA,IAAU,OAAO,MAAA,KAAW,YAAY,qBAAA,IAAyB,MAAA;AAC5E;AAEA,SAAS,sBAAA,GAA8C;AACrD,EAAA,MAAM,8BAA+B,UAAA,CAAuC,sBAAA;AAC5E,EAAA,MAAM,mBAAA,GACJ,+BACA,OAAO,2BAAA,KAAgC,YACvC,QAAA,IAAY,2BAAA,GACR,4BAA4B,MAAA,GAC5B,MAAA;AAEN,EAAA,OAAO,mBAAA;AACT;AAiBA,MAAM,2CAA2CA,qCAAA,CAAsB;AAAA,EAC9D,YAAY,OAAA,EAAyB;AAC1C,IAAA,KAAA,CAAM,SAAS,qBAAqB,CAAA;AAAA,EACtC;AAAA,EAEO,MAAA,GAAe;AACpB,IAAA,KAAA,CAAM,MAAA,EAAO;AAIb,IAAA,MAAM,sBAAsB,sBAAA,EAAuB;AAEnD,IAAA,IAAI,uBAAA,CAAwB,mBAAmB,CAAA,EAAG;AAEhD,MAAC,mBAAA,CAAsD,gBAAA,GAAmB,CACxE,eAAA,KACG;AACH,QAAA,MAAM,MAAA,GAASC,SAAA,CAAM,SAAA,CAAU,uBAAuB,CAAA;AAQtD,QAAA,MAAM,qBAAqB,MAAA,CAAO,YAAA;AAElC,QAAA,IAAI,CAAC,kBAAA,EAAoB;AACvB,UAAAC,mBAAA,CAAe,MAAM;AAEnB,YAAA,OAAA,CAAQ,IAAA;AAAA,cACN;AAAA,aACF;AAAA,UACF,CAAC,CAAA;AAED,UAAA;AAAA,QACF;AAEA,QAAA,IAAI;AACF,UAAA,eAAA,CAAgB,KAAA,CAAM,QAAQ,CAAA,UAAA,KAAc;AAC1C,YAAA,MAAM,OAAO,UAAA,CAAW,IAAA,KAAS,QAAA,GAAWC,YAAA,CAAS,SAASA,YAAA,CAAS,QAAA;AAEvE,YAAA,MAAM,eAAe,UAAA,CAAW,cAAA;AAChC,YAAA,MAAM,SAAS,UAAA,CAAW,OAAA;AAC1B,YAAA,MAAM,UAAU,UAAA,CAAW,QAAA;AAE3B,YAAA,MAAM,KAAA,GAA4B,UAAA,CAAW,KAAA,EAAO,GAAA,CAAI,CAAA,IAAA,KAAQ;AAC9D,cAAA,OAAO;AAAA,gBACL,OAAA,EAAS;AAAA,kBACP,SAAS,IAAA,CAAK,QAAA;AAAA,kBACd,QAAQ,IAAA,CAAK,OAAA;AAAA,kBACb,YAAYC,cAAA,CAAW;AAAA;AACzB,eACF;AAAA,YACF,CAAC,CAAA;AAED,YAAA,MAAM,GAAA,GAAMH,SAAA,CAAM,cAAA,CAAeI,WAAA,CAAQ,QAAO,EAAG;AAAA,cACjD,OAAA;AAAA,cACA,MAAA,EAAQ,YAAA;AAAA,cACR,YAAYD,cAAA,CAAW;AAAA,aACxB,CAAA;AAED,YAAAC,WAAA,CAAQ,IAAA,CAAK,KAAK,MAAM;AACtB,cAAA,MAAM,oBAAA,GAAoC;AAAA,gBACxC,iBAAiB,MAAM;AACrB,kBAAA,OAAO,OAAA;AAAA,gBACT,CAAA;AAAA,gBACA,gBAAgB,MAAM;AACpB,kBAAA,OAAO,MAAA;AAAA,gBACT;AAAA,eACF;AAEA,cAAA,MAAA,CAAO,YAAA,GAAe,oBAAA;AAEtB,cAAA,MAAM,IAAA,GAAO,MAAA,CAAO,SAAA,CAAU,UAAA,CAAW,IAAA,EAAM;AAAA,gBAC7C,IAAA;AAAA,gBACA,KAAA;AAAA,gBACA,WAAW,UAAA,CAAW,UAAA;AAAA,gBACtB,YAAY,UAAA,CAAW;AAAA,eACxB,CAAA;AAED,cAAA,IAAA,CAAK,GAAA,CAAI,WAAW,QAAQ,CAAA;AAE5B,cAAA,MAAA,CAAO,YAAA,GAAe,kBAAA;AAAA,YACxB,CAAC,CAAA;AAAA,UACH,CAAC,CAAA;AAAA,QACH,CAAA,SAAE;AAEA,UAAA,MAAA,CAAO,YAAA,GAAe,kBAAA;AAAA,QACxB;AAAA,MACF,CAAA;AAAA,IACF;AAAA,EACF;AACF;AAEO,MAAM,gBAAA,GAAmBC,+BAAA,CAAsC,gBAAA,EAAkB,CAAA,OAAA,KAAW;AACjG,EAAA,OAAO,IAAI,mCAAmC,OAAO,CAAA;AACvD,CAAC;AAgBM,MAAM,iBAAA,GAAoBC,sBAAA,CAAkB,CAAC,OAAA,KAA4B;AAC9E,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,gBAAA;AAAA,IACN,SAAA,GAAY;AACV,MAAA,gBAAA,CAAiB,OAAO,CAAA;AAAA,IAC1B,CAAA;AAAA,IACA,MAAM,MAAA,EAAQ;AAGZ,MAAA,IAAI,CAAC,wBAAuB,EAAG;AAC7B,QAAA;AAAA,MACF;AAKA,MAAA,MAAA,CAAO,EAAA,CAAG,aAAa,CAAA,IAAA,KAAQ;AAC7B,QAAA,MAAM,QAAA,GAAWC,gBAAW,IAAI,CAAA;AAChC,QAAA,IAAI,QAAA,CAAS,WAAA,EAAa,UAAA,CAAW,SAAS,CAAA,EAAG;AAC/C,UAAA,IAAA,CAAK,YAAA,CAAaC,uCAAkC,qBAAqB,CAAA;AAAA,QAC3E;AAIA,QAAA,IAAA,CACG,QAAA,CAAS,gBAAgB,wBAAA,IAA4B,QAAA,CAAS,gBAAgB,wBAAA,KAC/E,QAAA,CAAS,IAAA,CAAK,eAAe,CAAA,EAC7B;AACA,UAAA,IAAA,CAAK,UAAA,CAAW,QAAA,CAAS,IAAA,CAAK,eAAe,CAAW,CAAA;AAAA,QAC1D;AAIA,QAAA,IAAI,SAAS,WAAA,KAAgB,wBAAA,IAA4B,CAAC,QAAA,CAAS,IAAA,CAAK,WAAW,CAAA,EAAG;AACpF,UAAA,IAAA,CAAK,YAAA,CAAa,aAAa,QAAQ,CAAA;AAAA,QACzC;AAAA,MACF,CAAC,CAAA;AAAA,IACH;AAAA,GACF;AACF,CAAC;;;;;"}
+{"version":3,"file":"index.js","sources":["../../../../../src/integrations/tracing/prisma/index.ts"],"sourcesContent":["import type { Instrumentation } from '@opentelemetry/instrumentation';\nimport type { Span } from '@sentry/core';\nimport {\n  debug,\n  defineIntegration,\n  LRUMap,\n  SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,\n  SPAN_KIND,\n  spanToJSON,\n  startInactiveSpan,\n} from '@sentry/core';\nimport { generateInstrumentOnce } from '@sentry/node-core';\nimport { DEBUG_BUILD } from '../../../debug-build';\nimport { PrismaInstrumentation } from './vendored/instrumentation';\nimport type { PrismaV5TracingHelper } from './vendored/v5-tracing-helper';\nimport type { PrismaV6TracingHelper } from './vendored/v6-tracing-helper';\n\nconst INTEGRATION_NAME = 'Prisma' as const;\n\ntype CompatibilityLayerTraceHelper = PrismaV5TracingHelper & PrismaV6TracingHelper;\n\n// Vendored in from @prisma/instrumentation v5:\ntype V5EngineSpanEvent = {\n  span: boolean;\n  spans: V5EngineSpan[];\n};\n\ntype V5EngineSpanKind = 'client' | 'internal';\n\ntype V5EngineSpan = {\n  span: boolean;\n  name: string;\n  trace_id: string;\n  span_id: string;\n  parent_span_id: string;\n  start_time: [number, number];\n  end_time: [number, number];\n  attributes?: Record<string, string>;\n  links?: { trace_id: string; span_id: string }[];\n  kind: V5EngineSpanKind;\n};\n\nfunction isPrismaV6TracingHelper(helper: unknown): helper is PrismaV6TracingHelper {\n  return !!helper && typeof helper === 'object' && 'dispatchEngineSpans' in helper;\n}\n\nfunction getPrismaTracingHelper(): unknown | undefined {\n  const prismaInstrumentationObject = (globalThis as Record<string, unknown>).PRISMA_INSTRUMENTATION;\n  const prismaTracingHelper =\n    prismaInstrumentationObject &&\n    typeof prismaInstrumentationObject === 'object' &&\n    'helper' in prismaInstrumentationObject\n      ? prismaInstrumentationObject.helper\n      : undefined;\n\n  return prismaTracingHelper;\n}\n\n// Prisma v5 dispatches engine spans (`prisma:engine:*`, which carry the SQL `db.statement`) one batch\n// at a time, out of order, and detached from the active span, naming their parent only by id: a span\n// references either a client span (by the Sentry span id Prisma learned via `getTraceParent`) or a\n// sibling engine span (by the engine's own id), and a batch may not contain the parent it references.\n// By the time the engine reports them the client span may already have ended, so `getActiveSpan()`\n// can't be used to find it. `prismaSpanRegistry` maps span ids to their Sentry span, and an engine\n// span whose parent isn't registered yet waits in `pendingEngineSpans` until a later batch registers it.\nconst MAX_TRACKED_PRISMA_SPANS = 1000;\nconst prismaSpanRegistry = new LRUMap<string, Span>(MAX_TRACKED_PRISMA_SPANS);\nconst pendingEngineSpans: V5EngineSpan[] = [];\n\n/** Register a span so v5 engine spans can later resolve it as a parent by the id Prisma reports it under. */\nfunction registerPrismaSpan(id: string, span: Span): void {\n  prismaSpanRegistry.set(id, span);\n}\n\n/**\n * Create every pending v5 engine span whose parent is now registered, repeating until no further span\n * resolves (so a child queued before its parent is created once the parent arrives in a later batch).\n * Each span is created under its resolved parent and registered by its engine id so its own children\n * can find it; origin, the `prisma:engine:db_query` to SQL rename, and the `db.system` backfill are\n * applied by the `spanStart` hook, exactly as for v6/v7 engine spans.\n */\nfunction createResolvedEngineSpans(): void {\n  // Terminates: `createdSpan` is only set true right after a `splice`, so every pass that keeps the\n  // loop going strictly shrinks the finite `pendingEngineSpans`; a pass that resolves nothing exits.\n  let createdSpan = true;\n  while (createdSpan) {\n    createdSpan = false;\n    for (let i = pendingEngineSpans.length - 1; i >= 0; i--) {\n      const engineSpan = pendingEngineSpans[i]!;\n      const parentSpan = prismaSpanRegistry.get(engineSpan.parent_span_id);\n      if (!parentSpan) {\n        continue;\n      }\n\n      const span = startInactiveSpan({\n        name: engineSpan.name,\n        attributes: engineSpan.attributes,\n        kind: engineSpan.kind === 'client' ? SPAN_KIND.CLIENT : SPAN_KIND.INTERNAL,\n        startTime: engineSpan.start_time,\n        parentSpan,\n      });\n      registerPrismaSpan(engineSpan.span_id, span);\n\n      // Engine links reference other engine spans by their engine id; re-point them at the Sentry spans\n      // we minted (mirroring v6/v7's `dispatchEngineSpan`). Links must be added before the span ends,\n      // since the SentryTracerProvider seals spans on end. Links to spans we haven't created are dropped.\n      if (engineSpan.links) {\n        span.addLinks(\n          engineSpan.links.flatMap(link => {\n            const linkedSpan = prismaSpanRegistry.get(link.span_id);\n            return linkedSpan ? [{ context: linkedSpan.spanContext() }] : [];\n          }),\n        );\n      }\n\n      span.end(engineSpan.end_time);\n\n      pendingEngineSpans.splice(i, 1);\n      createdSpan = true;\n    }\n  }\n}\n\ninterface PrismaOptions {\n  /**\n   * @deprecated This is no longer used, v5 works out of the box.\n   */\n  prismaInstrumentation?: Instrumentation;\n  /**\n   * Configuration passed through to the {@link PrismaInstrumentation} constructor.\n   */\n  instrumentationConfig?: ConstructorParameters<typeof PrismaInstrumentation>[0];\n}\n\nclass SentryPrismaInteropInstrumentation extends PrismaInstrumentation {\n  public constructor(options?: PrismaOptions) {\n    super(options?.instrumentationConfig);\n  }\n\n  public enable(): void {\n    super.enable();\n\n    // 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.\n    // Because we actually want to use the v6/v7 instrumentation and not blow up in Prisma 5 users' faces, we backfill the v5-only `createEngineSpan` method so v5 engine spans are minted through Sentry's span APIs instead of crashing.\n    const prismaTracingHelper = getPrismaTracingHelper();\n\n    if (isPrismaV6TracingHelper(prismaTracingHelper)) {\n      (prismaTracingHelper as CompatibilityLayerTraceHelper).createEngineSpan = (\n        engineSpanEvent: V5EngineSpanEvent,\n      ) => {\n        pendingEngineSpans.push(...engineSpanEvent.spans);\n\n        // Resolve before capping so a span is only ever dropped after a full resolution attempt, never\n        // before it had a chance to find its parent. What remains are orphans whose parent was never\n        // registered (e.g. evicted from the registry under sustained load); cap that backlog so it can't\n        // grow without bound.\n        createResolvedEngineSpans();\n\n        const overflow = pendingEngineSpans.length - MAX_TRACKED_PRISMA_SPANS;\n        if (overflow > 0) {\n          DEBUG_BUILD &&\n            debug.log(`[Prisma] Dropping ${overflow} unresolved v5 engine span(s) whose parent was never registered.`);\n          pendingEngineSpans.splice(0, overflow);\n        }\n      };\n    }\n  }\n}\n\nexport const instrumentPrisma = generateInstrumentOnce<PrismaOptions>(INTEGRATION_NAME, options => {\n  return new SentryPrismaInteropInstrumentation(options);\n});\n\n/**\n * Adds Sentry tracing instrumentation for the [prisma](https://www.npmjs.com/package/prisma) library.\n * For more information, see the [`prismaIntegration` documentation](https://docs.sentry.io/platforms/javascript/guides/node/configuration/integrations/prisma/).\n *\n * NOTE: This integration works out of the box with Prisma v6, and v7.\n * On Prisma versions prior to v6, add `previewFeatures = [\"tracing\"]` to the client generator block of your Prisma schema:\n *\n *    ```\n *    generator client {\n *      provider = \"prisma-client-js\"\n *      previewFeatures = [\"tracing\"]\n *    }\n *    ```\n */\nexport const prismaIntegration = defineIntegration((options?: PrismaOptions) => {\n  return {\n    name: INTEGRATION_NAME,\n    setupOnce() {\n      instrumentPrisma(options);\n    },\n    setup(client) {\n      // If no tracing helper exists, we skip any work here\n      // this means that prisma is not being used\n      if (!getPrismaTracingHelper()) {\n        return;\n      }\n\n      // Prisma v5 engine spans are created via the `createEngineSpan` path above, which bypasses the\n      // tracing helper, so this hook applies origin, the db_query rename, and the db.system backfill to\n      // them. v6/v7 spans already get these from the helper; the guards are idempotent, so it's a no-op there.\n      client.on('spanStart', span => {\n        const spanJSON = spanToJSON(span);\n        if (spanJSON.description?.startsWith('prisma:')) {\n          span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, 'auto.db.otel.prisma');\n\n          // Register client spans so a v5 engine span (dispatched later, detached) can resolve one as a\n          // parent by the Sentry span id Prisma reported via `getTraceParent` (see\n          // `createResolvedEngineSpans`). Only client spans are referenced this way; engine spans\n          // reference their parent by the engine's own id and are registered in `createResolvedEngineSpans`,\n          // so registering them here too would just leave entries that are never looked up.\n          if (spanJSON.description.startsWith('prisma:client:')) {\n            registerPrismaSpan(span.spanContext().spanId, span);\n          }\n        }\n\n        // Make sure we use the query text as the span name, for ex. SELECT * FROM \"User\" WHERE \"id\" = $1.\n        // v5/v6 emit `prisma:engine:db_query`; v7 inlined the engine and emits `prisma:client:db_query`.\n        if (\n          (spanJSON.description === 'prisma:engine:db_query' || spanJSON.description === 'prisma:client:db_query') &&\n          spanJSON.data['db.query.text']\n        ) {\n          span.updateName(spanJSON.data['db.query.text'] as string);\n        }\n\n        // In Prisma v5.22+, the `db.system` attribute is automatically set\n        // On older versions, this is missing, so we add it here\n        if (spanJSON.description === 'prisma:engine:db_query' && !spanJSON.data['db.system']) {\n          span.setAttribute('db.system', 'prisma');\n        }\n      });\n    },\n  };\n});\n"],"names":["LRUMap","startInactiveSpan","SPAN_KIND","PrismaInstrumentation","DEBUG_BUILD","debug","generateInstrumentOnce","defineIntegration","spanToJSON","SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN"],"mappings":";;;;;;;AAiBA,MAAM,gBAAA,GAAmB,QAAA;AAyBzB,SAAS,wBAAwB,MAAA,EAAkD;AACjF,EAAA,OAAO,CAAC,CAAC,MAAA,IAAU,OAAO,MAAA,KAAW,YAAY,qBAAA,IAAyB,MAAA;AAC5E;AAEA,SAAS,sBAAA,GAA8C;AACrD,EAAA,MAAM,8BAA+B,UAAA,CAAuC,sBAAA;AAC5E,EAAA,MAAM,mBAAA,GACJ,+BACA,OAAO,2BAAA,KAAgC,YACvC,QAAA,IAAY,2BAAA,GACR,4BAA4B,MAAA,GAC5B,MAAA;AAEN,EAAA,OAAO,mBAAA;AACT;AASA,MAAM,wBAAA,GAA2B,GAAA;AACjC,MAAM,kBAAA,GAAqB,IAAIA,WAAA,CAAqB,wBAAwB,CAAA;AAC5E,MAAM,qBAAqC,EAAC;AAG5C,SAAS,kBAAA,CAAmB,IAAY,IAAA,EAAkB;AACxD,EAAA,kBAAA,CAAmB,GAAA,CAAI,IAAI,IAAI,CAAA;AACjC;AASA,SAAS,yBAAA,GAAkC;AAGzC,EAAA,IAAI,WAAA,GAAc,IAAA;AAClB,EAAA,OAAO,WAAA,EAAa;AAClB,IAAA,WAAA,GAAc,KAAA;AACd,IAAA,KAAA,IAAS,IAAI,kBAAA,CAAmB,MAAA,GAAS,CAAA,EAAG,CAAA,IAAK,GAAG,CAAA,EAAA,EAAK;AACvD,MAAA,MAAM,UAAA,GAAa,mBAAmB,CAAC,CAAA;AACvC,MAAA,MAAM,UAAA,GAAa,kBAAA,CAAmB,GAAA,CAAI,UAAA,CAAW,cAAc,CAAA;AACnE,MAAA,IAAI,CAAC,UAAA,EAAY;AACf,QAAA;AAAA,MACF;AAEA,MAAA,MAAM,OAAOC,sBAAA,CAAkB;AAAA,QAC7B,MAAM,UAAA,CAAW,IAAA;AAAA,QACjB,YAAY,UAAA,CAAW,UAAA;AAAA,QACvB,MAAM,UAAA,CAAW,IAAA,KAAS,QAAA,GAAWC,cAAA,CAAU,SAASA,cAAA,CAAU,QAAA;AAAA,QAClE,WAAW,UAAA,CAAW,UAAA;AAAA,QACtB;AAAA,OACD,CAAA;AACD,MAAA,kBAAA,CAAmB,UAAA,CAAW,SAAS,IAAI,CAAA;AAK3C,MAAA,IAAI,WAAW,KAAA,EAAO;AACpB,QAAA,IAAA,CAAK,QAAA;AAAA,UACH,UAAA,CAAW,KAAA,CAAM,OAAA,CAAQ,CAAA,IAAA,KAAQ;AAC/B,YAAA,MAAM,UAAA,GAAa,kBAAA,CAAmB,GAAA,CAAI,IAAA,CAAK,OAAO,CAAA;AACtD,YAAA,OAAO,UAAA,GAAa,CAAC,EAAE,OAAA,EAAS,WAAW,WAAA,EAAY,EAAG,CAAA,GAAI,EAAC;AAAA,UACjE,CAAC;AAAA,SACH;AAAA,MACF;AAEA,MAAA,IAAA,CAAK,GAAA,CAAI,WAAW,QAAQ,CAAA;AAE5B,MAAA,kBAAA,CAAmB,MAAA,CAAO,GAAG,CAAC,CAAA;AAC9B,MAAA,WAAA,GAAc,IAAA;AAAA,IAChB;AAAA,EACF;AACF;AAaA,MAAM,2CAA2CC,qCAAA,CAAsB;AAAA,EAC9D,YAAY,OAAA,EAAyB;AAC1C,IAAA,KAAA,CAAM,SAAS,qBAAqB,CAAA;AAAA,EACtC;AAAA,EAEO,MAAA,GAAe;AACpB,IAAA,KAAA,CAAM,MAAA,EAAO;AAIb,IAAA,MAAM,sBAAsB,sBAAA,EAAuB;AAEnD,IAAA,IAAI,uBAAA,CAAwB,mBAAmB,CAAA,EAAG;AAChD,MAAC,mBAAA,CAAsD,gBAAA,GAAmB,CACxE,eAAA,KACG;AACH,QAAA,kBAAA,CAAmB,IAAA,CAAK,GAAG,eAAA,CAAgB,KAAK,CAAA;AAMhD,QAAA,yBAAA,EAA0B;AAE1B,QAAA,MAAM,QAAA,GAAW,mBAAmB,MAAA,GAAS,wBAAA;AAC7C,QAAA,IAAI,WAAW,CAAA,EAAG;AAChB,UAAAC,sBAAA,IACEC,UAAA,CAAM,GAAA,CAAI,CAAA,kBAAA,EAAqB,QAAQ,CAAA,gEAAA,CAAkE,CAAA;AAC3G,UAAA,kBAAA,CAAmB,MAAA,CAAO,GAAG,QAAQ,CAAA;AAAA,QACvC;AAAA,MACF,CAAA;AAAA,IACF;AAAA,EACF;AACF;AAEO,MAAM,gBAAA,GAAmBC,+BAAA,CAAsC,gBAAA,EAAkB,CAAA,OAAA,KAAW;AACjG,EAAA,OAAO,IAAI,mCAAmC,OAAO,CAAA;AACvD,CAAC;AAgBM,MAAM,iBAAA,GAAoBC,sBAAA,CAAkB,CAAC,OAAA,KAA4B;AAC9E,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,gBAAA;AAAA,IACN,SAAA,GAAY;AACV,MAAA,gBAAA,CAAiB,OAAO,CAAA;AAAA,IAC1B,CAAA;AAAA,IACA,MAAM,MAAA,EAAQ;AAGZ,MAAA,IAAI,CAAC,wBAAuB,EAAG;AAC7B,QAAA;AAAA,MACF;AAKA,MAAA,MAAA,CAAO,EAAA,CAAG,aAAa,CAAA,IAAA,KAAQ;AAC7B,QAAA,MAAM,QAAA,GAAWC,gBAAW,IAAI,CAAA;AAChC,QAAA,IAAI,QAAA,CAAS,WAAA,EAAa,UAAA,CAAW,SAAS,CAAA,EAAG;AAC/C,UAAA,IAAA,CAAK,YAAA,CAAaC,uCAAkC,qBAAqB,CAAA;AAOzE,UAAA,IAAI,QAAA,CAAS,WAAA,CAAY,UAAA,CAAW,gBAAgB,CAAA,EAAG;AACrD,YAAA,kBAAA,CAAmB,IAAA,CAAK,WAAA,EAAY,CAAE,MAAA,EAAQ,IAAI,CAAA;AAAA,UACpD;AAAA,QACF;AAIA,QAAA,IAAA,CACG,QAAA,CAAS,gBAAgB,wBAAA,IAA4B,QAAA,CAAS,gBAAgB,wBAAA,KAC/E,QAAA,CAAS,IAAA,CAAK,eAAe,CAAA,EAC7B;AACA,UAAA,IAAA,CAAK,UAAA,CAAW,QAAA,CAAS,IAAA,CAAK,eAAe,CAAW,CAAA;AAAA,QAC1D;AAIA,QAAA,IAAI,SAAS,WAAA,KAAgB,wBAAA,IAA4B,CAAC,QAAA,CAAS,IAAA,CAAK,WAAW,CAAA,EAAG;AACpF,UAAA,IAAA,CAAK,YAAA,CAAa,aAAa,QAAQ,CAAA;AAAA,QACzC;AAAA,MACF,CAAC,CAAA;AAAA,IACH;AAAA,GACF;AACF,CAAC;;;;;"}

package/build/cjs/integrations/tracing/redis/cache.js

@@ -0,0 +1,41 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+const core = require('@sentry/core');
+const redisCache = require('../../../utils/redisCache.js');
+
+exports._redisOptions = {};
+function setRedisOptions(options) {
+  exports._redisOptions = options;
+}
+const cacheResponseHook = (span, redisCommand, cmdArgs, response) => {
+  const safeKey = redisCache.getCacheKeySafely(redisCommand, cmdArgs);
+  const cacheOperation = redisCache.getCacheOperation(redisCommand);
+  if (!safeKey || !cacheOperation || !exports._redisOptions.cachePrefixes || !redisCache.shouldConsiderForCache(redisCommand, safeKey, exports._redisOptions.cachePrefixes)) {
+    return;
+  }
+  const spanData = core.spanToJSON(span).data;
+  const networkPeerAddress = spanData["net.peer.name"] ?? spanData["server.address"];
+  const networkPeerPort = spanData["net.peer.port"] ?? spanData["server.port"];
+  if (networkPeerPort && networkPeerAddress) {
+    span.setAttributes({ "network.peer.address": networkPeerAddress, "network.peer.port": networkPeerPort });
+  }
+  const cacheItemSize = redisCache.calculateCacheItemSize(response);
+  if (cacheItemSize) {
+    span.setAttribute(core.SEMANTIC_ATTRIBUTE_CACHE_ITEM_SIZE, cacheItemSize);
+  }
+  if (redisCache.isInCommands(redisCache.GET_COMMANDS, redisCommand) && cacheItemSize !== void 0) {
+    span.setAttribute(core.SEMANTIC_ATTRIBUTE_CACHE_HIT, cacheItemSize > 0);
+  }
+  span.setAttributes({
+    [core.SEMANTIC_ATTRIBUTE_SENTRY_OP]: cacheOperation,
+    [core.SEMANTIC_ATTRIBUTE_CACHE_KEY]: safeKey
+  });
+  const spanDescription = safeKey.join(", ");
+  span.updateName(
+    exports._redisOptions.maxCacheKeyLength ? core.truncate(spanDescription, exports._redisOptions.maxCacheKeyLength) : spanDescription
+  );
+};
+
+exports.cacheResponseHook = cacheResponseHook;
+exports.setRedisOptions = setRedisOptions;
+//# sourceMappingURL=cache.js.map

package/build/cjs/integrations/tracing/redis/cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.js","sources":["../../../../../src/integrations/tracing/redis/cache.ts"],"sourcesContent":["import type { Span } from '@sentry/core';\nimport {\n  SEMANTIC_ATTRIBUTE_CACHE_HIT,\n  SEMANTIC_ATTRIBUTE_CACHE_ITEM_SIZE,\n  SEMANTIC_ATTRIBUTE_CACHE_KEY,\n  SEMANTIC_ATTRIBUTE_SENTRY_OP,\n  spanToJSON,\n  truncate,\n} from '@sentry/core';\nimport type { IORedisCommandArgs } from '../../../utils/redisCache';\nimport {\n  calculateCacheItemSize,\n  GET_COMMANDS,\n  getCacheKeySafely,\n  getCacheOperation,\n  isInCommands,\n  shouldConsiderForCache,\n} from '../../../utils/redisCache';\nimport type { IORedisResponseCustomAttributeFunction } from './vendored/types';\n\n// This module deliberately does NOT import the vendored OTel `IORedisInstrumentation`/\n// `RedisInstrumentation`, so the orchestrion opt-in can pull `cacheResponseHook`\n// without dragging the OTel redis instrumentation into its module graph.\n\nexport interface RedisOptions {\n  /**\n   * Define cache prefixes for cache keys that should be captured as a cache span.\n   *\n   * Setting this to, for example, `['user:']` will capture cache keys that start with `user:`.\n   */\n  cachePrefixes?: string[];\n  /**\n   * Maximum length of the cache key added to the span description. If the key exceeds this length, it will be truncated.\n   *\n   * Passing `0` will use the full cache key without truncation.\n   *\n   * By default, the full cache key is used.\n   */\n  maxCacheKeyLength?: number;\n}\n\n/* Only exported for testing purposes */\nexport let _redisOptions: RedisOptions = {};\n\n/** Set the options consumed by {@link cacheResponseHook}. */\nexport function setRedisOptions(options: RedisOptions): void {\n  _redisOptions = options;\n}\n\n/* Only exported for testing purposes */\nexport const cacheResponseHook: IORedisResponseCustomAttributeFunction = (\n  span: Span,\n  redisCommand: string,\n  cmdArgs: IORedisCommandArgs,\n  response: unknown,\n) => {\n  const safeKey = getCacheKeySafely(redisCommand, cmdArgs);\n  const cacheOperation = getCacheOperation(redisCommand);\n\n  if (\n    !safeKey ||\n    !cacheOperation ||\n    !_redisOptions.cachePrefixes ||\n    !shouldConsiderForCache(redisCommand, safeKey, _redisOptions.cachePrefixes)\n  ) {\n    // not relevant for cache\n    return;\n  }\n\n  // otel/ioredis seems to be using the old standard, as there was a change to those params: https://github.com/open-telemetry/opentelemetry-specification/issues/3199\n  // We are using params based on the docs: https://opentelemetry.io/docs/specs/semconv/attributes-registry/network/\n  // Fall back to stable semconv attributes (server.address/server.port) when\n  // old-semconv ones are absent, eg OTEL_SEMCONV_STABILITY_OPT_IN=database\n  // set for node-redis v4/v5.\n  const spanData = spanToJSON(span).data;\n  const networkPeerAddress = spanData['net.peer.name'] ?? spanData['server.address'];\n  const networkPeerPort = spanData['net.peer.port'] ?? spanData['server.port'];\n  if (networkPeerPort && networkPeerAddress) {\n    span.setAttributes({ 'network.peer.address': networkPeerAddress, 'network.peer.port': networkPeerPort });\n  }\n\n  const cacheItemSize = calculateCacheItemSize(response);\n\n  if (cacheItemSize) {\n    span.setAttribute(SEMANTIC_ATTRIBUTE_CACHE_ITEM_SIZE, cacheItemSize);\n  }\n\n  if (isInCommands(GET_COMMANDS, redisCommand) && cacheItemSize !== undefined) {\n    span.setAttribute(SEMANTIC_ATTRIBUTE_CACHE_HIT, cacheItemSize > 0);\n  }\n\n  span.setAttributes({\n    [SEMANTIC_ATTRIBUTE_SENTRY_OP]: cacheOperation,\n    [SEMANTIC_ATTRIBUTE_CACHE_KEY]: safeKey,\n  });\n\n  // todo: change to string[] once EAP supports it\n  const spanDescription = safeKey.join(', ');\n\n  span.updateName(\n    _redisOptions.maxCacheKeyLength ? truncate(spanDescription, _redisOptions.maxCacheKeyLength) : spanDescription,\n  );\n};\n"],"names":["_redisOptions","getCacheKeySafely","getCacheOperation","shouldConsiderForCache","spanToJSON","calculateCacheItemSize","SEMANTIC_ATTRIBUTE_CACHE_ITEM_SIZE","isInCommands","GET_COMMANDS","SEMANTIC_ATTRIBUTE_CACHE_HIT","SEMANTIC_ATTRIBUTE_SENTRY_OP","SEMANTIC_ATTRIBUTE_CACHE_KEY","truncate"],"mappings":";;;;;AA0CWA,wBAA8B;AAGlC,SAAS,gBAAgB,OAAA,EAA6B;AAC3D,EAAAA,qBAAA,GAAgB,OAAA;AAClB;AAGO,MAAM,iBAAA,GAA4D,CACvE,IAAA,EACA,YAAA,EACA,SACA,QAAA,KACG;AACH,EAAA,MAAM,OAAA,GAAUC,4BAAA,CAAkB,YAAA,EAAc,OAAO,CAAA;AACvD,EAAA,MAAM,cAAA,GAAiBC,6BAAkB,YAAY,CAAA;AAErD,EAAA,IACE,CAAC,OAAA,IACD,CAAC,cAAA,IACD,CAACF,qBAAA,CAAc,aAAA,IACf,CAACG,iCAAA,CAAuB,YAAA,EAAc,OAAA,EAASH,qBAAA,CAAc,aAAa,CAAA,EAC1E;AAEA,IAAA;AAAA,EACF;AAOA,EAAA,MAAM,QAAA,GAAWI,eAAA,CAAW,IAAI,CAAA,CAAE,IAAA;AAClC,EAAA,MAAM,kBAAA,GAAqB,QAAA,CAAS,eAAe,CAAA,IAAK,SAAS,gBAAgB,CAAA;AACjF,EAAA,MAAM,eAAA,GAAkB,QAAA,CAAS,eAAe,CAAA,IAAK,SAAS,aAAa,CAAA;AAC3E,EAAA,IAAI,mBAAmB,kBAAA,EAAoB;AACzC,IAAA,IAAA,CAAK,cAAc,EAAE,sBAAA,EAAwB,kBAAA,EAAoB,mBAAA,EAAqB,iBAAiB,CAAA;AAAA,EACzG;AAEA,EAAA,MAAM,aAAA,GAAgBC,kCAAuB,QAAQ,CAAA;AAErD,EAAA,IAAI,aAAA,EAAe;AACjB,IAAA,IAAA,CAAK,YAAA,CAAaC,yCAAoC,aAAa,CAAA;AAAA,EACrE;AAEA,EAAA,IAAIC,uBAAA,CAAaC,uBAAA,EAAc,YAAY,CAAA,IAAK,kBAAkB,MAAA,EAAW;AAC3E,IAAA,IAAA,CAAK,YAAA,CAAaC,iCAAA,EAA8B,aAAA,GAAgB,CAAC,CAAA;AAAA,EACnE;AAEA,EAAA,IAAA,CAAK,aAAA,CAAc;AAAA,IACjB,CAACC,iCAA4B,GAAG,cAAA;AAAA,IAChC,CAACC,iCAA4B,GAAG;AAAA,GACjC,CAAA;AAGD,EAAA,MAAM,eAAA,GAAkB,OAAA,CAAQ,IAAA,CAAK,IAAI,CAAA;AAEzC,EAAA,IAAA,CAAK,UAAA;AAAA,IACHX,sBAAc,iBAAA,GAAoBY,aAAA,CAAS,eAAA,EAAiBZ,qBAAA,CAAc,iBAAiB,CAAA,GAAI;AAAA,GACjG;AACF;;;;;"}

package/build/cjs/integrations/tracing/redis/index.js

@@ -4,74 +4,47 @@ const core = require('@sentry/core');
 const dc = require('node:diagnostics_channel');
 const serverUtils = require('@sentry/server-utils');
 const nodeCore = require('@sentry/node-core');
-const redisCache = require('../../../utils/redisCache.js');
+const diagnosticsChannelInjection = require('../../../sdk/diagnosticsChannelInjection.js');
+const cache = require('./cache.js');
 const ioredisInstrumentation = require('./vendored/ioredis-instrumentation.js');
 const redisInstrumentation = require('./vendored/redis-instrumentation.js');
 
 const INTEGRATION_NAME = "Redis";
-exports._redisOptions = {};
-const cacheResponseHook = (span, redisCommand, cmdArgs, response) => {
-  const safeKey = redisCache.getCacheKeySafely(redisCommand, cmdArgs);
-  const cacheOperation = redisCache.getCacheOperation(redisCommand);
-  if (!safeKey || !cacheOperation || !exports._redisOptions.cachePrefixes || !redisCache.shouldConsiderForCache(redisCommand, safeKey, exports._redisOptions.cachePrefixes)) {
-    return;
-  }
-  const spanData = core.spanToJSON(span).data;
-  const networkPeerAddress = spanData["net.peer.name"] ?? spanData["server.address"];
-  const networkPeerPort = spanData["net.peer.port"] ?? spanData["server.port"];
-  if (networkPeerPort && networkPeerAddress) {
-    span.setAttributes({ "network.peer.address": networkPeerAddress, "network.peer.port": networkPeerPort });
-  }
-  const cacheItemSize = redisCache.calculateCacheItemSize(response);
-  if (cacheItemSize) {
-    span.setAttribute(core.SEMANTIC_ATTRIBUTE_CACHE_ITEM_SIZE, cacheItemSize);
-  }
-  if (redisCache.isInCommands(redisCache.GET_COMMANDS, redisCommand) && cacheItemSize !== void 0) {
-    span.setAttribute(core.SEMANTIC_ATTRIBUTE_CACHE_HIT, cacheItemSize > 0);
-  }
-  span.setAttributes({
-    [core.SEMANTIC_ATTRIBUTE_SENTRY_OP]: cacheOperation,
-    [core.SEMANTIC_ATTRIBUTE_CACHE_KEY]: safeKey
-  });
-  const spanDescription = safeKey.join(", ");
-  span.updateName(
-    exports._redisOptions.maxCacheKeyLength ? core.truncate(spanDescription, exports._redisOptions.maxCacheKeyLength) : spanDescription
-  );
-};
 const instrumentIORedis = nodeCore.generateInstrumentOnce(`${INTEGRATION_NAME}.IORedis`, () => {
   return new ioredisInstrumentation.IORedisInstrumentation({
-    responseHook: cacheResponseHook
+    responseHook: cache.cacheResponseHook
   });
 });
 const instrumentRedisModule = nodeCore.generateInstrumentOnce(`${INTEGRATION_NAME}.Redis`, () => {
   return new redisInstrumentation.RedisInstrumentation({
-    responseHook: cacheResponseHook
+    responseHook: cache.cacheResponseHook
   });
 });
 const instrumentRedis = Object.assign(
   () => {
-    instrumentIORedis();
-    instrumentRedisModule();
-    if (dc.tracingChannel) {
-      core.waitForTracingChannelBinding(() => {
-        serverUtils.subscribeRedisDiagnosticChannels(dc.tracingChannel, cacheResponseHook);
-      });
+    if (!diagnosticsChannelInjection.isDiagnosticsChannelInjectionEnabled() || !dc.tracingChannel) {
+      instrumentIORedis();
+      instrumentRedisModule();
     }
   },
   { id: INTEGRATION_NAME }
 );
 const _redisIntegration = ((options = {}) => {
-  return {
+  return core.extendIntegration(serverUtils.redisIntegration({ responseHook: cache.cacheResponseHook }), {
     name: INTEGRATION_NAME,
     setupOnce() {
-      exports._redisOptions = options;
+      cache.setRedisOptions(options);
       instrumentRedis();
     }
-  };
+  });
 });
 const redisIntegration = core.defineIntegration(_redisIntegration);
 
-exports.cacheResponseHook = cacheResponseHook;
+Object.defineProperty(exports, "_redisOptions", {
+  enumerable: true,
+  get: () => cache._redisOptions
+});
+exports.cacheResponseHook = cache.cacheResponseHook;
 exports.instrumentRedis = instrumentRedis;
 exports.redisIntegration = redisIntegration;
 //# sourceMappingURL=index.js.map

package/build/cjs/integrations/tracing/redis/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../../../../src/integrations/tracing/redis/index.ts"],"sourcesContent":["import type { IntegrationFn, Span } from '@sentry/core';\nimport {\n  defineIntegration,\n  SEMANTIC_ATTRIBUTE_CACHE_HIT,\n  SEMANTIC_ATTRIBUTE_CACHE_ITEM_SIZE,\n  SEMANTIC_ATTRIBUTE_CACHE_KEY,\n  SEMANTIC_ATTRIBUTE_SENTRY_OP,\n  spanToJSON,\n  truncate,\n  waitForTracingChannelBinding,\n} from '@sentry/core';\nimport * as dc from 'node:diagnostics_channel';\nimport { subscribeRedisDiagnosticChannels, type RedisTracingChannelFactory } from '@sentry/server-utils';\nimport { generateInstrumentOnce } from '@sentry/node-core';\nimport type { IORedisCommandArgs } from '../../../utils/redisCache';\nimport {\n  calculateCacheItemSize,\n  GET_COMMANDS,\n  getCacheKeySafely,\n  getCacheOperation,\n  isInCommands,\n  shouldConsiderForCache,\n} from '../../../utils/redisCache';\nimport type { IORedisResponseCustomAttributeFunction } from './vendored/types';\nimport { IORedisInstrumentation } from './vendored/ioredis-instrumentation';\nimport { RedisInstrumentation } from './vendored/redis-instrumentation';\n\ninterface RedisOptions {\n  /**\n   * Define cache prefixes for cache keys that should be captured as a cache span.\n   *\n   * Setting this to, for example, `['user:']` will capture cache keys that start with `user:`.\n   */\n  cachePrefixes?: string[];\n  /**\n   * Maximum length of the cache key added to the span description. If the key exceeds this length, it will be truncated.\n   *\n   * Passing `0` will use the full cache key without truncation.\n   *\n   * By default, the full cache key is used.\n   */\n  maxCacheKeyLength?: number;\n}\n\nconst INTEGRATION_NAME = 'Redis' as const;\n\n/* Only exported for testing purposes */\nexport let _redisOptions: RedisOptions = {};\n\n/* Only exported for testing purposes */\nexport const cacheResponseHook: IORedisResponseCustomAttributeFunction = (\n  span: Span,\n  redisCommand: string,\n  cmdArgs: IORedisCommandArgs,\n  response: unknown,\n) => {\n  const safeKey = getCacheKeySafely(redisCommand, cmdArgs);\n  const cacheOperation = getCacheOperation(redisCommand);\n\n  if (\n    !safeKey ||\n    !cacheOperation ||\n    !_redisOptions.cachePrefixes ||\n    !shouldConsiderForCache(redisCommand, safeKey, _redisOptions.cachePrefixes)\n  ) {\n    // not relevant for cache\n    return;\n  }\n\n  // otel/ioredis seems to be using the old standard, as there was a change to those params: https://github.com/open-telemetry/opentelemetry-specification/issues/3199\n  // We are using params based on the docs: https://opentelemetry.io/docs/specs/semconv/attributes-registry/network/\n  // Fall back to stable semconv attributes (server.address/server.port) when\n  // old-semconv ones are absent, eg OTEL_SEMCONV_STABILITY_OPT_IN=database\n  // set for node-redis v4/v5.\n  const spanData = spanToJSON(span).data;\n  const networkPeerAddress = spanData['net.peer.name'] ?? spanData['server.address'];\n  const networkPeerPort = spanData['net.peer.port'] ?? spanData['server.port'];\n  if (networkPeerPort && networkPeerAddress) {\n    span.setAttributes({ 'network.peer.address': networkPeerAddress, 'network.peer.port': networkPeerPort });\n  }\n\n  const cacheItemSize = calculateCacheItemSize(response);\n\n  if (cacheItemSize) {\n    span.setAttribute(SEMANTIC_ATTRIBUTE_CACHE_ITEM_SIZE, cacheItemSize);\n  }\n\n  if (isInCommands(GET_COMMANDS, redisCommand) && cacheItemSize !== undefined) {\n    span.setAttribute(SEMANTIC_ATTRIBUTE_CACHE_HIT, cacheItemSize > 0);\n  }\n\n  span.setAttributes({\n    [SEMANTIC_ATTRIBUTE_SENTRY_OP]: cacheOperation,\n    [SEMANTIC_ATTRIBUTE_CACHE_KEY]: safeKey,\n  });\n\n  // todo: change to string[] once EAP supports it\n  const spanDescription = safeKey.join(', ');\n\n  span.updateName(\n    _redisOptions.maxCacheKeyLength ? truncate(spanDescription, _redisOptions.maxCacheKeyLength) : spanDescription,\n  );\n};\n\nconst instrumentIORedis = generateInstrumentOnce(`${INTEGRATION_NAME}.IORedis`, () => {\n  return new IORedisInstrumentation({\n    responseHook: cacheResponseHook,\n  });\n});\n\nconst instrumentRedisModule = generateInstrumentOnce(`${INTEGRATION_NAME}.Redis`, () => {\n  return new RedisInstrumentation({\n    responseHook: cacheResponseHook,\n  });\n});\n\n/**\n * To be able to preload all Redis OTel instrumentations with just one ID\n * (\"Redis\"), all the instrumentations are generated in this one function\n */\nexport const instrumentRedis = Object.assign(\n  (): void => {\n    instrumentIORedis();\n    instrumentRedisModule();\n    // node-redis >= 5.12.0 and ioredis >= 5.11.0 publish via diagnostics_channel.\n    // `bindTracingChannelToSpan` (inside the subscriber) makes the span the active\n    // OTel context via `bindStore`, which needs the Sentry OTel context manager to\n    // be registered — `initOpenTelemetry()` does that after integration `setupOnce`,\n    // so defer to the next tick.\n    // Check this here to ensure this does not fail at runtime for Node <= 18.18.0\n    if (dc.tracingChannel) {\n      waitForTracingChannelBinding(() => {\n        subscribeRedisDiagnosticChannels(dc.tracingChannel as RedisTracingChannelFactory, cacheResponseHook);\n      });\n    }\n\n    // todo: implement them gradually\n    // new LegacyRedisInstrumentation({}),\n  },\n  { id: INTEGRATION_NAME },\n);\n\nconst _redisIntegration = ((options: RedisOptions = {}) => {\n  return {\n    name: INTEGRATION_NAME,\n    setupOnce() {\n      _redisOptions = options;\n      instrumentRedis();\n    },\n  };\n}) satisfies IntegrationFn;\n\n/**\n * Adds Sentry tracing instrumentation for the [redis](https://www.npmjs.com/package/redis) and\n * [ioredis](https://www.npmjs.com/package/ioredis) libraries.\n *\n * For more information, see the [`redisIntegration` documentation](https://docs.sentry.io/platforms/javascript/guides/node/configuration/integrations/redis/).\n *\n * @example\n * ```javascript\n * const Sentry = require('@sentry/node');\n *\n * Sentry.init({\n *  integrations: [Sentry.redisIntegration()],\n * });\n * ```\n */\nexport const redisIntegration = defineIntegration(_redisIntegration);\n"],"names":["_redisOptions","getCacheKeySafely","getCacheOperation","shouldConsiderForCache","spanToJSON","calculateCacheItemSize","SEMANTIC_ATTRIBUTE_CACHE_ITEM_SIZE","isInCommands","GET_COMMANDS","SEMANTIC_ATTRIBUTE_CACHE_HIT","SEMANTIC_ATTRIBUTE_SENTRY_OP","SEMANTIC_ATTRIBUTE_CACHE_KEY","truncate","generateInstrumentOnce","IORedisInstrumentation","RedisInstrumentation","waitForTracingChannelBinding","subscribeRedisDiagnosticChannels","defineIntegration"],"mappings":";;;;;;;;;;AA4CA,MAAM,gBAAA,GAAmB,OAAA;AAGdA,wBAA8B;AAGlC,MAAM,iBAAA,GAA4D,CACvE,IAAA,EACA,YAAA,EACA,SACA,QAAA,KACG;AACH,EAAA,MAAM,OAAA,GAAUC,4BAAA,CAAkB,YAAA,EAAc,OAAO,CAAA;AACvD,EAAA,MAAM,cAAA,GAAiBC,6BAAkB,YAAY,CAAA;AAErD,EAAA,IACE,CAAC,OAAA,IACD,CAAC,cAAA,IACD,CAACF,qBAAA,CAAc,aAAA,IACf,CAACG,iCAAA,CAAuB,YAAA,EAAc,OAAA,EAASH,qBAAA,CAAc,aAAa,CAAA,EAC1E;AAEA,IAAA;AAAA,EACF;AAOA,EAAA,MAAM,QAAA,GAAWI,eAAA,CAAW,IAAI,CAAA,CAAE,IAAA;AAClC,EAAA,MAAM,kBAAA,GAAqB,QAAA,CAAS,eAAe,CAAA,IAAK,SAAS,gBAAgB,CAAA;AACjF,EAAA,MAAM,eAAA,GAAkB,QAAA,CAAS,eAAe,CAAA,IAAK,SAAS,aAAa,CAAA;AAC3E,EAAA,IAAI,mBAAmB,kBAAA,EAAoB;AACzC,IAAA,IAAA,CAAK,cAAc,EAAE,sBAAA,EAAwB,kBAAA,EAAoB,mBAAA,EAAqB,iBAAiB,CAAA;AAAA,EACzG;AAEA,EAAA,MAAM,aAAA,GAAgBC,kCAAuB,QAAQ,CAAA;AAErD,EAAA,IAAI,aAAA,EAAe;AACjB,IAAA,IAAA,CAAK,YAAA,CAAaC,yCAAoC,aAAa,CAAA;AAAA,EACrE;AAEA,EAAA,IAAIC,uBAAA,CAAaC,uBAAA,EAAc,YAAY,CAAA,IAAK,kBAAkB,MAAA,EAAW;AAC3E,IAAA,IAAA,CAAK,YAAA,CAAaC,iCAAA,EAA8B,aAAA,GAAgB,CAAC,CAAA;AAAA,EACnE;AAEA,EAAA,IAAA,CAAK,aAAA,CAAc;AAAA,IACjB,CAACC,iCAA4B,GAAG,cAAA;AAAA,IAChC,CAACC,iCAA4B,GAAG;AAAA,GACjC,CAAA;AAGD,EAAA,MAAM,eAAA,GAAkB,OAAA,CAAQ,IAAA,CAAK,IAAI,CAAA;AAEzC,EAAA,IAAA,CAAK,UAAA;AAAA,IACHX,sBAAc,iBAAA,GAAoBY,aAAA,CAAS,eAAA,EAAiBZ,qBAAA,CAAc,iBAAiB,CAAA,GAAI;AAAA,GACjG;AACF;AAEA,MAAM,iBAAA,GAAoBa,+BAAA,CAAuB,CAAA,EAAG,gBAAgB,YAAY,MAAM;AACpF,EAAA,OAAO,IAAIC,6CAAA,CAAuB;AAAA,IAChC,YAAA,EAAc;AAAA,GACf,CAAA;AACH,CAAC,CAAA;AAED,MAAM,qBAAA,GAAwBD,+BAAA,CAAuB,CAAA,EAAG,gBAAgB,UAAU,MAAM;AACtF,EAAA,OAAO,IAAIE,yCAAA,CAAqB;AAAA,IAC9B,YAAA,EAAc;AAAA,GACf,CAAA;AACH,CAAC,CAAA;AAMM,MAAM,kBAAkB,MAAA,CAAO,MAAA;AAAA,EACpC,MAAY;AACV,IAAA,iBAAA,EAAkB;AAClB,IAAA,qBAAA,EAAsB;AAOtB,IAAA,IAAI,GAAG,cAAA,EAAgB;AACrB,MAAAC,iCAAA,CAA6B,MAAM;AACjC,QAAAC,4CAAA,CAAiC,EAAA,CAAG,gBAA8C,iBAAiB,CAAA;AAAA,MACrG,CAAC,CAAA;AAAA,IACH;AAAA,EAIF,CAAA;AAAA,EACA,EAAE,IAAI,gBAAA;AACR;AAEA,MAAM,iBAAA,IAAqB,CAAC,OAAA,GAAwB,EAAC,KAAM;AACzD,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,gBAAA;AAAA,IACN,SAAA,GAAY;AACV,MAAAjB,qBAAA,GAAgB,OAAA;AAChB,MAAA,eAAA,EAAgB;AAAA,IAClB;AAAA,GACF;AACF,CAAA,CAAA;AAiBO,MAAM,gBAAA,GAAmBkB,uBAAkB,iBAAiB;;;;;;"}
+{"version":3,"file":"index.js","sources":["../../../../../src/integrations/tracing/redis/index.ts"],"sourcesContent":["import type { IntegrationFn } from '@sentry/core';\nimport { defineIntegration, extendIntegration } from '@sentry/core';\nimport * as dc from 'node:diagnostics_channel';\nimport { redisIntegration as redisChannelIntegration } from '@sentry/server-utils';\nimport { generateInstrumentOnce } from '@sentry/node-core';\nimport { isDiagnosticsChannelInjectionEnabled } from '../../../sdk/diagnosticsChannelInjection';\nimport { cacheResponseHook, type RedisOptions, setRedisOptions } from './cache';\nimport { IORedisInstrumentation } from './vendored/ioredis-instrumentation';\nimport { RedisInstrumentation } from './vendored/redis-instrumentation';\n\n// `cacheResponseHook`/`_redisOptions` live in `./cache` (which has no OTel\n// instrumentation imports) so the orchestrion opt-in can pull the hook without\n// dragging the OTel redis instrumentation in. Re-exported here for tests.\nexport { _redisOptions, cacheResponseHook } from './cache';\n\nconst INTEGRATION_NAME = 'Redis' as const;\n\nconst instrumentIORedis = generateInstrumentOnce(`${INTEGRATION_NAME}.IORedis`, () => {\n  return new IORedisInstrumentation({\n    responseHook: cacheResponseHook,\n  });\n});\n\nconst instrumentRedisModule = generateInstrumentOnce(`${INTEGRATION_NAME}.Redis`, () => {\n  return new RedisInstrumentation({\n    responseHook: cacheResponseHook,\n  });\n});\n\n/**\n * To be able to preload all Redis OTel instrumentations with just one ID\n * (\"Redis\"), all the instrumentations are generated in this one function\n */\nexport const instrumentRedis = Object.assign(\n  (): void => {\n    // When diagnostics-channel injection is opted in, orchestrion fully owns the older\n    // ioredis (`<5.11.0`) and redis/node-redis (`<5.12.0`) ranges — commands, connect, and\n    // batches — so skip both OTel monkey-patches to avoid double instrumentation. On Node\n    // without `tracingChannel` (<18.19) orchestrion can't run, so keep the OTel patches there.\n    if (!isDiagnosticsChannelInjectionEnabled() || !dc.tracingChannel) {\n      instrumentIORedis();\n      instrumentRedisModule();\n    }\n\n    // todo: implement them gradually\n    // new LegacyRedisInstrumentation({}),\n  },\n  { id: INTEGRATION_NAME },\n);\n\nconst _redisIntegration = ((options: RedisOptions = {}) => {\n  // The diagnostics_channel subscription (node-redis >= 5.12.0, ioredis >= 5.11.0) lives in\n  // server-utils so it is shared across server runtimes; we extend it here to also run the vendored\n  // OTel patchers for older client versions. `cacheResponseHook` reads options set in the extension's\n  // `setupOnce` below, but it only runs at command time, by which point those options are set.\n  return extendIntegration(redisChannelIntegration({ responseHook: cacheResponseHook }), {\n    name: INTEGRATION_NAME,\n    setupOnce() {\n      setRedisOptions(options);\n      instrumentRedis();\n    },\n  });\n}) satisfies IntegrationFn;\n\n/**\n * Adds Sentry tracing instrumentation for the [redis](https://www.npmjs.com/package/redis) and\n * [ioredis](https://www.npmjs.com/package/ioredis) libraries.\n *\n * For more information, see the [`redisIntegration` documentation](https://docs.sentry.io/platforms/javascript/guides/node/configuration/integrations/redis/).\n *\n * @example\n * ```javascript\n * const Sentry = require('@sentry/node');\n *\n * Sentry.init({\n *  integrations: [Sentry.redisIntegration()],\n * });\n * ```\n */\nexport const redisIntegration = defineIntegration(_redisIntegration);\n"],"names":["generateInstrumentOnce","IORedisInstrumentation","cacheResponseHook","RedisInstrumentation","isDiagnosticsChannelInjectionEnabled","extendIntegration","redisChannelIntegration","setRedisOptions","defineIntegration"],"mappings":";;;;;;;;;;;AAeA,MAAM,gBAAA,GAAmB,OAAA;AAEzB,MAAM,iBAAA,GAAoBA,+BAAA,CAAuB,CAAA,EAAG,gBAAgB,YAAY,MAAM;AACpF,EAAA,OAAO,IAAIC,6CAAA,CAAuB;AAAA,IAChC,YAAA,EAAcC;AAAA,GACf,CAAA;AACH,CAAC,CAAA;AAED,MAAM,qBAAA,GAAwBF,+BAAA,CAAuB,CAAA,EAAG,gBAAgB,UAAU,MAAM;AACtF,EAAA,OAAO,IAAIG,yCAAA,CAAqB;AAAA,IAC9B,YAAA,EAAcD;AAAA,GACf,CAAA;AACH,CAAC,CAAA;AAMM,MAAM,kBAAkB,MAAA,CAAO,MAAA;AAAA,EACpC,MAAY;AAKV,IAAA,IAAI,CAACE,gEAAA,EAAqC,IAAK,CAAC,GAAG,cAAA,EAAgB;AACjE,MAAA,iBAAA,EAAkB;AAClB,MAAA,qBAAA,EAAsB;AAAA,IACxB;AAAA,EAIF,CAAA;AAAA,EACA,EAAE,IAAI,gBAAA;AACR;AAEA,MAAM,iBAAA,IAAqB,CAAC,OAAA,GAAwB,EAAC,KAAM;AAKzD,EAAA,OAAOC,uBAAkBC,4BAAA,CAAwB,EAAE,YAAA,EAAcJ,uBAAA,EAAmB,CAAA,EAAG;AAAA,IACrF,IAAA,EAAM,gBAAA;AAAA,IACN,SAAA,GAAY;AACV,MAAAK,qBAAA,CAAgB,OAAO,CAAA;AACvB,MAAA,eAAA,EAAgB;AAAA,IAClB;AAAA,GACD,CAAA;AACH,CAAA,CAAA;AAiBO,MAAM,gBAAA,GAAmBC,uBAAkB,iBAAiB;;;;;;;;;;"}

package/build/cjs/integrations/tracing/redis/vendored/ioredis-instrumentation.js

@@ -2,7 +2,8 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
 const instrumentation = require('@opentelemetry/instrumentation');
 const core = require('@sentry/core');
-const redisCommon = require('./redis-common.js');
+const attributes = require('@sentry/conventions/attributes');
+const serverUtils = require('@sentry/server-utils');
 const semconv = require('./semconv.js');
 
 const PACKAGE_NAME = "@sentry/instrumentation-ioredis";
@@ -53,15 +54,19 @@ class IORedisInstrumentation extends instrumentation.InstrumentationBase {
           return original.apply(this, args);
         }
         const { host, port } = this.options;
-        const attributes = {
-          [semconv.ATTR_DB_SYSTEM]: semconv.DB_SYSTEM_VALUE_REDIS,
-          [semconv.ATTR_DB_STATEMENT]: redisCommon.defaultDbStatementSerializer(cmd.name, cmd.args),
+        const attributes$1 = {
+          // oxlint-disable-next-line typescript/no-deprecated
+          [attributes.DB_SYSTEM]: semconv.DB_SYSTEM_VALUE_REDIS,
+          // oxlint-disable-next-line typescript/no-deprecated
+          [attributes.DB_STATEMENT]: serverUtils.defaultDbStatementSerializer(cmd.name, cmd.args),
           [semconv.ATTR_DB_CONNECTION_STRING]: `redis://${host}:${port}`,
-          [semconv.ATTR_NET_PEER_NAME]: host,
-          [semconv.ATTR_NET_PEER_PORT]: port,
+          // oxlint-disable-next-line typescript/no-deprecated
+          [attributes.NET_PEER_NAME]: host,
+          // oxlint-disable-next-line typescript/no-deprecated
+          [attributes.NET_PEER_PORT]: port,
           [core.SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN
         };
-        const span = core.startInactiveSpan({ name: cmd.name, kind: core.SPAN_KIND.CLIENT, attributes });
+        const span = core.startInactiveSpan({ name: cmd.name, kind: core.SPAN_KIND.CLIENT, attributes: attributes$1 });
         try {
           const result = original.apply(this, args);
           const origResolve = cmd.resolve;
@@ -90,15 +95,19 @@ class IORedisInstrumentation extends instrumentation.InstrumentationBase {
           return original.apply(this, args);
         }
         const { host, port } = this.options;
-        const attributes = {
-          [semconv.ATTR_DB_SYSTEM]: semconv.DB_SYSTEM_VALUE_REDIS,
-          [semconv.ATTR_DB_STATEMENT]: "connect",
+        const attributes$1 = {
+          // oxlint-disable-next-line typescript/no-deprecated
+          [attributes.DB_SYSTEM]: semconv.DB_SYSTEM_VALUE_REDIS,
+          // oxlint-disable-next-line typescript/no-deprecated
+          [attributes.DB_STATEMENT]: "connect",
           [semconv.ATTR_DB_CONNECTION_STRING]: `redis://${host}:${port}`,
-          [semconv.ATTR_NET_PEER_NAME]: host,
-          [semconv.ATTR_NET_PEER_PORT]: port,
+          // oxlint-disable-next-line typescript/no-deprecated
+          [attributes.NET_PEER_NAME]: host,
+          // oxlint-disable-next-line typescript/no-deprecated
+          [attributes.NET_PEER_PORT]: port,
           [core.SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN
         };
-        const span = core.startInactiveSpan({ name: "connect", kind: core.SPAN_KIND.CLIENT, attributes });
+        const span = core.startInactiveSpan({ name: "connect", kind: core.SPAN_KIND.CLIENT, attributes: attributes$1 });
         try {
           const result = original.apply(this, args);
           if (result instanceof Promise) {

package/build/cjs/integrations/tracing/redis/vendored/ioredis-instrumentation.js.map

@@ -1 +1 @@
-{"version":3,"file":"ioredis-instrumentation.js","sources":["../../../../../../src/integrations/tracing/redis/vendored/ioredis-instrumentation.ts"],"sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n * SPDX-License-Identifier: Apache-2.0\n *\n * NOTICE from the Sentry authors:\n * - Vendored from: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/instrumentation-ioredis-v0.62.0/packages/instrumentation-ioredis\n * - Upstream version: @opentelemetry/instrumentation-ioredis@0.62.0\n * - Minor TypeScript adjustments for this repository's compiler settings\n * - Refactored to use Sentry's span APIs instead of OpenTelemetry tracing APIs\n */\n\nimport { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';\nimport type { Span, SpanAttributes } from '@sentry/core';\nimport {\n  getActiveSpan,\n  SDK_VERSION,\n  SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,\n  SPAN_KIND,\n  SPAN_STATUS_ERROR,\n  startInactiveSpan,\n} from '@sentry/core';\nimport { defaultDbStatementSerializer } from './redis-common';\nimport {\n  ATTR_DB_CONNECTION_STRING,\n  ATTR_DB_STATEMENT,\n  ATTR_DB_SYSTEM,\n  ATTR_NET_PEER_NAME,\n  ATTR_NET_PEER_PORT,\n  DB_SYSTEM_VALUE_REDIS,\n} from './semconv';\nimport type { IORedisInstrumentationConfig } from './types';\n\nconst PACKAGE_NAME = '@sentry/instrumentation-ioredis';\nconst ORIGIN = 'auto.db.otel.redis';\n\n// ioredis >= 5.11.0 publishes via diagnostics_channel, which Sentry subscribes\n// to separately, so this monkey-patching instrumentation only covers < 5.11.0.\nconst SUPPORTED_VERSIONS = ['>=2.0.0 <5.11.0'];\n\n// The raw imported `ioredis` module is either the CommonJS export or an ESM\n// namespace wrapping it on `.default`. Typed shallowly since it is only used\n// internally to reach the `Redis` prototype that holds the methods we patch.\ntype IORedisModule = {\n  default?: { prototype: RedisPrototype };\n  prototype: RedisPrototype;\n  [Symbol.toStringTag]?: string;\n};\n\ninterface RedisPrototype {\n  sendCommand: (...args: unknown[]) => unknown;\n  connect: (...args: unknown[]) => unknown;\n}\n\n// The `this` of the patched methods is a Redis client instance exposing its\n// connection options.\ninterface RedisClient {\n  options: { host?: string; port?: number };\n}\n\n// The in-flight command object ioredis passes to `sendCommand`. We swap its\n// `resolve`/`reject` so the span ends when the command settles.\ninterface RedisCommand {\n  name: string;\n  args: Array<string | Buffer>;\n  resolve: (result: unknown) => void;\n  reject: (err: Error) => void;\n}\n\nfunction endSpan(span: Span, err: Error | null | undefined): void {\n  if (err) {\n    span.setStatus({ code: SPAN_STATUS_ERROR, message: err.message });\n  }\n  span.end();\n}\n\nexport class IORedisInstrumentation extends InstrumentationBase<IORedisInstrumentationConfig> {\n  public constructor(config: IORedisInstrumentationConfig = {}) {\n    super(PACKAGE_NAME, SDK_VERSION, config);\n  }\n\n  protected init(): InstrumentationNodeModuleDefinition[] {\n    return [\n      new InstrumentationNodeModuleDefinition(\n        'ioredis',\n        SUPPORTED_VERSIONS,\n        (module: IORedisModule) => {\n          const moduleExports = module[Symbol.toStringTag] === 'Module' && module.default ? module.default : module;\n          if (isWrapped(moduleExports.prototype.sendCommand)) {\n            this._unwrap(moduleExports.prototype, 'sendCommand');\n          }\n          this._wrap(moduleExports.prototype, 'sendCommand', this._patchSendCommand());\n          if (isWrapped(moduleExports.prototype.connect)) {\n            this._unwrap(moduleExports.prototype, 'connect');\n          }\n          this._wrap(moduleExports.prototype, 'connect', this._patchConnection());\n          return module;\n        },\n        (module: IORedisModule | undefined) => {\n          if (module === undefined) return;\n          const moduleExports = module[Symbol.toStringTag] === 'Module' && module.default ? module.default : module;\n          this._unwrap(moduleExports.prototype, 'sendCommand');\n          this._unwrap(moduleExports.prototype, 'connect');\n        },\n      ),\n    ];\n  }\n\n  private _patchSendCommand() {\n    const instrumentation = this;\n    return (original: (...args: unknown[]) => unknown) => {\n      return function (this: RedisClient, ...args: unknown[]): unknown {\n        const cmd = args[0] as RedisCommand | undefined;\n        // ioredis only creates a span when there is an active parent span\n        // (the upstream `requireParentSpan` default, which Sentry never overrides).\n        if (args.length < 1 || typeof cmd !== 'object' || !getActiveSpan()) {\n          return original.apply(this, args);\n        }\n\n        const { host, port } = this.options;\n        const attributes: SpanAttributes = {\n          [ATTR_DB_SYSTEM]: DB_SYSTEM_VALUE_REDIS,\n          [ATTR_DB_STATEMENT]: defaultDbStatementSerializer(cmd.name, cmd.args),\n          [ATTR_DB_CONNECTION_STRING]: `redis://${host}:${port}`,\n          [ATTR_NET_PEER_NAME]: host,\n          [ATTR_NET_PEER_PORT]: port,\n          [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,\n        };\n\n        const span = startInactiveSpan({ name: cmd.name, kind: SPAN_KIND.CLIENT, attributes });\n\n        try {\n          const result = original.apply(this, args);\n          const origResolve = cmd.resolve;\n          cmd.resolve = function (response: unknown): void {\n            instrumentation._callResponseHook(span, cmd, response);\n            endSpan(span, null);\n            origResolve(response);\n          };\n          const origReject = cmd.reject;\n          cmd.reject = function (err: Error): void {\n            endSpan(span, err);\n            origReject(err);\n          };\n          return result;\n        } catch (error) {\n          endSpan(span, error as Error);\n          throw error;\n        }\n      };\n    };\n  }\n\n  private _patchConnection() {\n    return (original: (...args: unknown[]) => unknown) => {\n      return function (this: RedisClient, ...args: unknown[]): unknown {\n        if (!getActiveSpan()) {\n          return original.apply(this, args);\n        }\n\n        const { host, port } = this.options;\n        const attributes: SpanAttributes = {\n          [ATTR_DB_SYSTEM]: DB_SYSTEM_VALUE_REDIS,\n          [ATTR_DB_STATEMENT]: 'connect',\n          [ATTR_DB_CONNECTION_STRING]: `redis://${host}:${port}`,\n          [ATTR_NET_PEER_NAME]: host,\n          [ATTR_NET_PEER_PORT]: port,\n          [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,\n        };\n\n        const span = startInactiveSpan({ name: 'connect', kind: SPAN_KIND.CLIENT, attributes });\n\n        try {\n          const result = original.apply(this, args) as Promise<unknown> | undefined;\n          if (result instanceof Promise) {\n            return result.then(\n              (value: unknown) => {\n                endSpan(span, null);\n                return value;\n              },\n              (error: Error) => {\n                endSpan(span, error);\n                return Promise.reject(error);\n              },\n            );\n          }\n          endSpan(span, null);\n          return result;\n        } catch (error) {\n          endSpan(span, error as Error);\n          throw error;\n        }\n      };\n    };\n  }\n\n  private _callResponseHook(span: Span, cmd: RedisCommand, response: unknown): void {\n    const { responseHook } = this.getConfig();\n    if (!responseHook) {\n      return;\n    }\n    try {\n      responseHook(span, cmd.name, cmd.args, response);\n    } catch {\n      // ignore errors thrown from the user-provided response hook\n    }\n  }\n}\n"],"names":["SPAN_STATUS_ERROR","InstrumentationBase","SDK_VERSION","InstrumentationNodeModuleDefinition","isWrapped","getActiveSpan","ATTR_DB_SYSTEM","DB_SYSTEM_VALUE_REDIS","ATTR_DB_STATEMENT","defaultDbStatementSerializer","ATTR_DB_CONNECTION_STRING","ATTR_NET_PEER_NAME","ATTR_NET_PEER_PORT","SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN","startInactiveSpan","SPAN_KIND"],"mappings":";;;;;;;AAgCA,MAAM,YAAA,GAAe,iCAAA;AACrB,MAAM,MAAA,GAAS,oBAAA;AAIf,MAAM,kBAAA,GAAqB,CAAC,iBAAiB,CAAA;AA+B7C,SAAS,OAAA,CAAQ,MAAY,GAAA,EAAqC;AAChE,EAAA,IAAI,GAAA,EAAK;AACP,IAAA,IAAA,CAAK,UAAU,EAAE,IAAA,EAAMA,wBAAmB,OAAA,EAAS,GAAA,CAAI,SAAS,CAAA;AAAA,EAClE;AACA,EAAA,IAAA,CAAK,GAAA,EAAI;AACX;AAEO,MAAM,+BAA+BC,mCAAA,CAAkD;AAAA,EACrF,WAAA,CAAY,MAAA,GAAuC,EAAC,EAAG;AAC5D,IAAA,KAAA,CAAM,YAAA,EAAcC,kBAAa,MAAM,CAAA;AAAA,EACzC;AAAA,EAEU,IAAA,GAA8C;AACtD,IAAA,OAAO;AAAA,MACL,IAAIC,mDAAA;AAAA,QACF,SAAA;AAAA,QACA,kBAAA;AAAA,QACA,CAAC,MAAA,KAA0B;AACzB,UAAA,MAAM,aAAA,GAAgB,OAAO,MAAA,CAAO,WAAW,MAAM,QAAA,IAAY,MAAA,CAAO,OAAA,GAAU,MAAA,CAAO,OAAA,GAAU,MAAA;AACnG,UAAA,IAAIC,yBAAA,CAAU,aAAA,CAAc,SAAA,CAAU,WAAW,CAAA,EAAG;AAClD,YAAA,IAAA,CAAK,OAAA,CAAQ,aAAA,CAAc,SAAA,EAAW,aAAa,CAAA;AAAA,UACrD;AACA,UAAA,IAAA,CAAK,MAAM,aAAA,CAAc,SAAA,EAAW,aAAA,EAAe,IAAA,CAAK,mBAAmB,CAAA;AAC3E,UAAA,IAAIA,yBAAA,CAAU,aAAA,CAAc,SAAA,CAAU,OAAO,CAAA,EAAG;AAC9C,YAAA,IAAA,CAAK,OAAA,CAAQ,aAAA,CAAc,SAAA,EAAW,SAAS,CAAA;AAAA,UACjD;AACA,UAAA,IAAA,CAAK,MAAM,aAAA,CAAc,SAAA,EAAW,SAAA,EAAW,IAAA,CAAK,kBAAkB,CAAA;AACtE,UAAA,OAAO,MAAA;AAAA,QACT,CAAA;AAAA,QACA,CAAC,MAAA,KAAsC;AACrC,UAAA,IAAI,WAAW,MAAA,EAAW;AAC1B,UAAA,MAAM,aAAA,GAAgB,OAAO,MAAA,CAAO,WAAW,MAAM,QAAA,IAAY,MAAA,CAAO,OAAA,GAAU,MAAA,CAAO,OAAA,GAAU,MAAA;AACnG,UAAA,IAAA,CAAK,OAAA,CAAQ,aAAA,CAAc,SAAA,EAAW,aAAa,CAAA;AACnD,UAAA,IAAA,CAAK,OAAA,CAAQ,aAAA,CAAc,SAAA,EAAW,SAAS,CAAA;AAAA,QACjD;AAAA;AACF,KACF;AAAA,EACF;AAAA,EAEQ,iBAAA,GAAoB;AAC1B,IAAA,MAAM,eAAA,GAAkB,IAAA;AACxB,IAAA,OAAO,CAAC,QAAA,KAA8C;AACpD,MAAA,OAAO,YAAgC,IAAA,EAA0B;AAC/D,QAAA,MAAM,GAAA,GAAM,KAAK,CAAC,CAAA;AAGlB,QAAA,IAAI,IAAA,CAAK,SAAS,CAAA,IAAK,OAAO,QAAQ,QAAA,IAAY,CAACC,oBAAc,EAAG;AAClE,UAAA,OAAO,QAAA,CAAS,KAAA,CAAM,IAAA,EAAM,IAAI,CAAA;AAAA,QAClC;AAEA,QAAA,MAAM,EAAE,IAAA,EAAM,IAAA,EAAK,GAAI,IAAA,CAAK,OAAA;AAC5B,QAAA,MAAM,UAAA,GAA6B;AAAA,UACjC,CAACC,sBAAc,GAAGC,6BAAA;AAAA,UAClB,CAACC,yBAAiB,GAAGC,yCAA6B,GAAA,CAAI,IAAA,EAAM,IAAI,IAAI,CAAA;AAAA,UACpE,CAACC,iCAAyB,GAAG,CAAA,QAAA,EAAW,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA,UACpD,CAACC,0BAAkB,GAAG,IAAA;AAAA,UACtB,CAACC,0BAAkB,GAAG,IAAA;AAAA,UACtB,CAACC,qCAAgC,GAAG;AAAA,SACtC;AAEA,QAAA,MAAM,IAAA,GAAOC,sBAAA,CAAkB,EAAE,IAAA,EAAM,GAAA,CAAI,MAAM,IAAA,EAAMC,cAAA,CAAU,MAAA,EAAQ,UAAA,EAAY,CAAA;AAErF,QAAA,IAAI;AACF,UAAA,MAAM,MAAA,GAAS,QAAA,CAAS,KAAA,CAAM,IAAA,EAAM,IAAI,CAAA;AACxC,UAAA,MAAM,cAAc,GAAA,CAAI,OAAA;AACxB,UAAA,GAAA,CAAI,OAAA,GAAU,SAAU,QAAA,EAAyB;AAC/C,YAAA,eAAA,CAAgB,iBAAA,CAAkB,IAAA,EAAM,GAAA,EAAK,QAAQ,CAAA;AACrD,YAAA,OAAA,CAAQ,MAAM,IAAI,CAAA;AAClB,YAAA,WAAA,CAAY,QAAQ,CAAA;AAAA,UACtB,CAAA;AACA,UAAA,MAAM,aAAa,GAAA,CAAI,MAAA;AACvB,UAAA,GAAA,CAAI,MAAA,GAAS,SAAU,GAAA,EAAkB;AACvC,YAAA,OAAA,CAAQ,MAAM,GAAG,CAAA;AACjB,YAAA,UAAA,CAAW,GAAG,CAAA;AAAA,UAChB,CAAA;AACA,UAAA,OAAO,MAAA;AAAA,QACT,SAAS,KAAA,EAAO;AACd,UAAA,OAAA,CAAQ,MAAM,KAAc,CAAA;AAC5B,UAAA,MAAM,KAAA;AAAA,QACR;AAAA,MACF,CAAA;AAAA,IACF,CAAA;AAAA,EACF;AAAA,EAEQ,gBAAA,GAAmB;AACzB,IAAA,OAAO,CAAC,QAAA,KAA8C;AACpD,MAAA,OAAO,YAAgC,IAAA,EAA0B;AAC/D,QAAA,IAAI,CAACV,oBAAc,EAAG;AACpB,UAAA,OAAO,QAAA,CAAS,KAAA,CAAM,IAAA,EAAM,IAAI,CAAA;AAAA,QAClC;AAEA,QAAA,MAAM,EAAE,IAAA,EAAM,IAAA,EAAK,GAAI,IAAA,CAAK,OAAA;AAC5B,QAAA,MAAM,UAAA,GAA6B;AAAA,UACjC,CAACC,sBAAc,GAAGC,6BAAA;AAAA,UAClB,CAACC,yBAAiB,GAAG,SAAA;AAAA,UACrB,CAACE,iCAAyB,GAAG,CAAA,QAAA,EAAW,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA,UACpD,CAACC,0BAAkB,GAAG,IAAA;AAAA,UACtB,CAACC,0BAAkB,GAAG,IAAA;AAAA,UACtB,CAACC,qCAAgC,GAAG;AAAA,SACtC;AAEA,QAAA,MAAM,IAAA,GAAOC,uBAAkB,EAAE,IAAA,EAAM,WAAW,IAAA,EAAMC,cAAA,CAAU,MAAA,EAAQ,UAAA,EAAY,CAAA;AAEtF,QAAA,IAAI;AACF,UAAA,MAAM,MAAA,GAAS,QAAA,CAAS,KAAA,CAAM,IAAA,EAAM,IAAI,CAAA;AACxC,UAAA,IAAI,kBAAkB,OAAA,EAAS;AAC7B,YAAA,OAAO,MAAA,CAAO,IAAA;AAAA,cACZ,CAAC,KAAA,KAAmB;AAClB,gBAAA,OAAA,CAAQ,MAAM,IAAI,CAAA;AAClB,gBAAA,OAAO,KAAA;AAAA,cACT,CAAA;AAAA,cACA,CAAC,KAAA,KAAiB;AAChB,gBAAA,OAAA,CAAQ,MAAM,KAAK,CAAA;AACnB,gBAAA,OAAO,OAAA,CAAQ,OAAO,KAAK,CAAA;AAAA,cAC7B;AAAA,aACF;AAAA,UACF;AACA,UAAA,OAAA,CAAQ,MAAM,IAAI,CAAA;AAClB,UAAA,OAAO,MAAA;AAAA,QACT,SAAS,KAAA,EAAO;AACd,UAAA,OAAA,CAAQ,MAAM,KAAc,CAAA;AAC5B,UAAA,MAAM,KAAA;AAAA,QACR;AAAA,MACF,CAAA;AAAA,IACF,CAAA;AAAA,EACF;AAAA,EAEQ,iBAAA,CAAkB,IAAA,EAAY,GAAA,EAAmB,QAAA,EAAyB;AAChF,IAAA,MAAM,EAAE,YAAA,EAAa,GAAI,IAAA,CAAK,SAAA,EAAU;AACxC,IAAA,IAAI,CAAC,YAAA,EAAc;AACjB,MAAA;AAAA,IACF;AACA,IAAA,IAAI;AACF,MAAA,YAAA,CAAa,IAAA,EAAM,GAAA,CAAI,IAAA,EAAM,GAAA,CAAI,MAAM,QAAQ,CAAA;AAAA,IACjD,CAAA,CAAA,MAAQ;AAAA,IAER;AAAA,EACF;AACF;;;;"}
+{"version":3,"file":"ioredis-instrumentation.js","sources":["../../../../../../src/integrations/tracing/redis/vendored/ioredis-instrumentation.ts"],"sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n * SPDX-License-Identifier: Apache-2.0\n *\n * NOTICE from the Sentry authors:\n * - Vendored from: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/instrumentation-ioredis-v0.62.0/packages/instrumentation-ioredis\n * - Upstream version: @opentelemetry/instrumentation-ioredis@0.62.0\n * - Minor TypeScript adjustments for this repository's compiler settings\n * - Refactored to use Sentry's span APIs instead of OpenTelemetry tracing APIs\n */\n\nimport { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';\nimport type { Span, SpanAttributes } from '@sentry/core';\nimport {\n  getActiveSpan,\n  SDK_VERSION,\n  SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,\n  SPAN_KIND,\n  SPAN_STATUS_ERROR,\n  startInactiveSpan,\n} from '@sentry/core';\nimport { DB_STATEMENT, DB_SYSTEM, NET_PEER_NAME, NET_PEER_PORT } from '@sentry/conventions/attributes';\nimport { defaultDbStatementSerializer } from '@sentry/server-utils';\nimport { ATTR_DB_CONNECTION_STRING, DB_SYSTEM_VALUE_REDIS } from './semconv';\nimport type { IORedisInstrumentationConfig } from './types';\n\nconst PACKAGE_NAME = '@sentry/instrumentation-ioredis';\nconst ORIGIN = 'auto.db.otel.redis';\n\n// ioredis >= 5.11.0 publishes via diagnostics_channel, which Sentry subscribes\n// to separately, so this monkey-patching instrumentation only covers < 5.11.0.\nconst SUPPORTED_VERSIONS = ['>=2.0.0 <5.11.0'];\n\n// The raw imported `ioredis` module is either the CommonJS export or an ESM\n// namespace wrapping it on `.default`. Typed shallowly since it is only used\n// internally to reach the `Redis` prototype that holds the methods we patch.\ntype IORedisModule = {\n  default?: { prototype: RedisPrototype };\n  prototype: RedisPrototype;\n  [Symbol.toStringTag]?: string;\n};\n\ninterface RedisPrototype {\n  sendCommand: (...args: unknown[]) => unknown;\n  connect: (...args: unknown[]) => unknown;\n}\n\n// The `this` of the patched methods is a Redis client instance exposing its\n// connection options.\ninterface RedisClient {\n  options: { host?: string; port?: number };\n}\n\n// The in-flight command object ioredis passes to `sendCommand`. We swap its\n// `resolve`/`reject` so the span ends when the command settles.\ninterface RedisCommand {\n  name: string;\n  args: Array<string | Buffer>;\n  resolve: (result: unknown) => void;\n  reject: (err: Error) => void;\n}\n\nfunction endSpan(span: Span, err: Error | null | undefined): void {\n  if (err) {\n    span.setStatus({ code: SPAN_STATUS_ERROR, message: err.message });\n  }\n  span.end();\n}\n\nexport class IORedisInstrumentation extends InstrumentationBase<IORedisInstrumentationConfig> {\n  public constructor(config: IORedisInstrumentationConfig = {}) {\n    super(PACKAGE_NAME, SDK_VERSION, config);\n  }\n\n  protected init(): InstrumentationNodeModuleDefinition[] {\n    return [\n      new InstrumentationNodeModuleDefinition(\n        'ioredis',\n        SUPPORTED_VERSIONS,\n        (module: IORedisModule) => {\n          const moduleExports = module[Symbol.toStringTag] === 'Module' && module.default ? module.default : module;\n          if (isWrapped(moduleExports.prototype.sendCommand)) {\n            this._unwrap(moduleExports.prototype, 'sendCommand');\n          }\n          this._wrap(moduleExports.prototype, 'sendCommand', this._patchSendCommand());\n          if (isWrapped(moduleExports.prototype.connect)) {\n            this._unwrap(moduleExports.prototype, 'connect');\n          }\n          this._wrap(moduleExports.prototype, 'connect', this._patchConnection());\n          return module;\n        },\n        (module: IORedisModule | undefined) => {\n          if (module === undefined) return;\n          const moduleExports = module[Symbol.toStringTag] === 'Module' && module.default ? module.default : module;\n          this._unwrap(moduleExports.prototype, 'sendCommand');\n          this._unwrap(moduleExports.prototype, 'connect');\n        },\n      ),\n    ];\n  }\n\n  private _patchSendCommand() {\n    const instrumentation = this;\n    return (original: (...args: unknown[]) => unknown) => {\n      return function (this: RedisClient, ...args: unknown[]): unknown {\n        const cmd = args[0] as RedisCommand | undefined;\n        // ioredis only creates a span when there is an active parent span\n        // (the upstream `requireParentSpan` default, which Sentry never overrides).\n        if (args.length < 1 || typeof cmd !== 'object' || !getActiveSpan()) {\n          return original.apply(this, args);\n        }\n\n        const { host, port } = this.options;\n        const attributes: SpanAttributes = {\n          // oxlint-disable-next-line typescript/no-deprecated\n          [DB_SYSTEM]: DB_SYSTEM_VALUE_REDIS,\n          // oxlint-disable-next-line typescript/no-deprecated\n          [DB_STATEMENT]: defaultDbStatementSerializer(cmd.name, cmd.args),\n          [ATTR_DB_CONNECTION_STRING]: `redis://${host}:${port}`,\n          // oxlint-disable-next-line typescript/no-deprecated\n          [NET_PEER_NAME]: host,\n          // oxlint-disable-next-line typescript/no-deprecated\n          [NET_PEER_PORT]: port,\n          [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,\n        };\n\n        const span = startInactiveSpan({ name: cmd.name, kind: SPAN_KIND.CLIENT, attributes });\n\n        try {\n          const result = original.apply(this, args);\n          const origResolve = cmd.resolve;\n          cmd.resolve = function (response: unknown): void {\n            instrumentation._callResponseHook(span, cmd, response);\n            endSpan(span, null);\n            origResolve(response);\n          };\n          const origReject = cmd.reject;\n          cmd.reject = function (err: Error): void {\n            endSpan(span, err);\n            origReject(err);\n          };\n          return result;\n        } catch (error) {\n          endSpan(span, error as Error);\n          throw error;\n        }\n      };\n    };\n  }\n\n  private _patchConnection() {\n    return (original: (...args: unknown[]) => unknown) => {\n      return function (this: RedisClient, ...args: unknown[]): unknown {\n        if (!getActiveSpan()) {\n          return original.apply(this, args);\n        }\n\n        const { host, port } = this.options;\n        const attributes: SpanAttributes = {\n          // oxlint-disable-next-line typescript/no-deprecated\n          [DB_SYSTEM]: DB_SYSTEM_VALUE_REDIS,\n          // oxlint-disable-next-line typescript/no-deprecated\n          [DB_STATEMENT]: 'connect',\n          [ATTR_DB_CONNECTION_STRING]: `redis://${host}:${port}`,\n          // oxlint-disable-next-line typescript/no-deprecated\n          [NET_PEER_NAME]: host,\n          // oxlint-disable-next-line typescript/no-deprecated\n          [NET_PEER_PORT]: port,\n          [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,\n        };\n\n        const span = startInactiveSpan({ name: 'connect', kind: SPAN_KIND.CLIENT, attributes });\n\n        try {\n          const result = original.apply(this, args) as Promise<unknown> | undefined;\n          if (result instanceof Promise) {\n            return result.then(\n              (value: unknown) => {\n                endSpan(span, null);\n                return value;\n              },\n              (error: Error) => {\n                endSpan(span, error);\n                return Promise.reject(error);\n              },\n            );\n          }\n          endSpan(span, null);\n          return result;\n        } catch (error) {\n          endSpan(span, error as Error);\n          throw error;\n        }\n      };\n    };\n  }\n\n  private _callResponseHook(span: Span, cmd: RedisCommand, response: unknown): void {\n    const { responseHook } = this.getConfig();\n    if (!responseHook) {\n      return;\n    }\n    try {\n      responseHook(span, cmd.name, cmd.args, response);\n    } catch {\n      // ignore errors thrown from the user-provided response hook\n    }\n  }\n}\n"],"names":["SPAN_STATUS_ERROR","InstrumentationBase","SDK_VERSION","InstrumentationNodeModuleDefinition","isWrapped","getActiveSpan","attributes","DB_SYSTEM","DB_SYSTEM_VALUE_REDIS","DB_STATEMENT","defaultDbStatementSerializer","ATTR_DB_CONNECTION_STRING","NET_PEER_NAME","NET_PEER_PORT","SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN","startInactiveSpan","SPAN_KIND"],"mappings":";;;;;;;;AA0BA,MAAM,YAAA,GAAe,iCAAA;AACrB,MAAM,MAAA,GAAS,oBAAA;AAIf,MAAM,kBAAA,GAAqB,CAAC,iBAAiB,CAAA;AA+B7C,SAAS,OAAA,CAAQ,MAAY,GAAA,EAAqC;AAChE,EAAA,IAAI,GAAA,EAAK;AACP,IAAA,IAAA,CAAK,UAAU,EAAE,IAAA,EAAMA,wBAAmB,OAAA,EAAS,GAAA,CAAI,SAAS,CAAA;AAAA,EAClE;AACA,EAAA,IAAA,CAAK,GAAA,EAAI;AACX;AAEO,MAAM,+BAA+BC,mCAAA,CAAkD;AAAA,EACrF,WAAA,CAAY,MAAA,GAAuC,EAAC,EAAG;AAC5D,IAAA,KAAA,CAAM,YAAA,EAAcC,kBAAa,MAAM,CAAA;AAAA,EACzC;AAAA,EAEU,IAAA,GAA8C;AACtD,IAAA,OAAO;AAAA,MACL,IAAIC,mDAAA;AAAA,QACF,SAAA;AAAA,QACA,kBAAA;AAAA,QACA,CAAC,MAAA,KAA0B;AACzB,UAAA,MAAM,aAAA,GAAgB,OAAO,MAAA,CAAO,WAAW,MAAM,QAAA,IAAY,MAAA,CAAO,OAAA,GAAU,MAAA,CAAO,OAAA,GAAU,MAAA;AACnG,UAAA,IAAIC,yBAAA,CAAU,aAAA,CAAc,SAAA,CAAU,WAAW,CAAA,EAAG;AAClD,YAAA,IAAA,CAAK,OAAA,CAAQ,aAAA,CAAc,SAAA,EAAW,aAAa,CAAA;AAAA,UACrD;AACA,UAAA,IAAA,CAAK,MAAM,aAAA,CAAc,SAAA,EAAW,aAAA,EAAe,IAAA,CAAK,mBAAmB,CAAA;AAC3E,UAAA,IAAIA,yBAAA,CAAU,aAAA,CAAc,SAAA,CAAU,OAAO,CAAA,EAAG;AAC9C,YAAA,IAAA,CAAK,OAAA,CAAQ,aAAA,CAAc,SAAA,EAAW,SAAS,CAAA;AAAA,UACjD;AACA,UAAA,IAAA,CAAK,MAAM,aAAA,CAAc,SAAA,EAAW,SAAA,EAAW,IAAA,CAAK,kBAAkB,CAAA;AACtE,UAAA,OAAO,MAAA;AAAA,QACT,CAAA;AAAA,QACA,CAAC,MAAA,KAAsC;AACrC,UAAA,IAAI,WAAW,MAAA,EAAW;AAC1B,UAAA,MAAM,aAAA,GAAgB,OAAO,MAAA,CAAO,WAAW,MAAM,QAAA,IAAY,MAAA,CAAO,OAAA,GAAU,MAAA,CAAO,OAAA,GAAU,MAAA;AACnG,UAAA,IAAA,CAAK,OAAA,CAAQ,aAAA,CAAc,SAAA,EAAW,aAAa,CAAA;AACnD,UAAA,IAAA,CAAK,OAAA,CAAQ,aAAA,CAAc,SAAA,EAAW,SAAS,CAAA;AAAA,QACjD;AAAA;AACF,KACF;AAAA,EACF;AAAA,EAEQ,iBAAA,GAAoB;AAC1B,IAAA,MAAM,eAAA,GAAkB,IAAA;AACxB,IAAA,OAAO,CAAC,QAAA,KAA8C;AACpD,MAAA,OAAO,YAAgC,IAAA,EAA0B;AAC/D,QAAA,MAAM,GAAA,GAAM,KAAK,CAAC,CAAA;AAGlB,QAAA,IAAI,IAAA,CAAK,SAAS,CAAA,IAAK,OAAO,QAAQ,QAAA,IAAY,CAACC,oBAAc,EAAG;AAClE,UAAA,OAAO,QAAA,CAAS,KAAA,CAAM,IAAA,EAAM,IAAI,CAAA;AAAA,QAClC;AAEA,QAAA,MAAM,EAAE,IAAA,EAAM,IAAA,EAAK,GAAI,IAAA,CAAK,OAAA;AAC5B,QAAA,MAAMC,YAAA,GAA6B;AAAA;AAAA,UAEjC,CAACC,oBAAS,GAAGC,6BAAA;AAAA;AAAA,UAEb,CAACC,uBAAY,GAAGC,yCAA6B,GAAA,CAAI,IAAA,EAAM,IAAI,IAAI,CAAA;AAAA,UAC/D,CAACC,iCAAyB,GAAG,CAAA,QAAA,EAAW,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA;AAAA,UAEpD,CAACC,wBAAa,GAAG,IAAA;AAAA;AAAA,UAEjB,CAACC,wBAAa,GAAG,IAAA;AAAA,UACjB,CAACC,qCAAgC,GAAG;AAAA,SACtC;AAEA,QAAA,MAAM,IAAA,GAAOC,sBAAA,CAAkB,EAAE,IAAA,EAAM,GAAA,CAAI,MAAM,IAAA,EAAMC,cAAA,CAAU,MAAA,cAAQV,YAAA,EAAY,CAAA;AAErF,QAAA,IAAI;AACF,UAAA,MAAM,MAAA,GAAS,QAAA,CAAS,KAAA,CAAM,IAAA,EAAM,IAAI,CAAA;AACxC,UAAA,MAAM,cAAc,GAAA,CAAI,OAAA;AACxB,UAAA,GAAA,CAAI,OAAA,GAAU,SAAU,QAAA,EAAyB;AAC/C,YAAA,eAAA,CAAgB,iBAAA,CAAkB,IAAA,EAAM,GAAA,EAAK,QAAQ,CAAA;AACrD,YAAA,OAAA,CAAQ,MAAM,IAAI,CAAA;AAClB,YAAA,WAAA,CAAY,QAAQ,CAAA;AAAA,UACtB,CAAA;AACA,UAAA,MAAM,aAAa,GAAA,CAAI,MAAA;AACvB,UAAA,GAAA,CAAI,MAAA,GAAS,SAAU,GAAA,EAAkB;AACvC,YAAA,OAAA,CAAQ,MAAM,GAAG,CAAA;AACjB,YAAA,UAAA,CAAW,GAAG,CAAA;AAAA,UAChB,CAAA;AACA,UAAA,OAAO,MAAA;AAAA,QACT,SAAS,KAAA,EAAO;AACd,UAAA,OAAA,CAAQ,MAAM,KAAc,CAAA;AAC5B,UAAA,MAAM,KAAA;AAAA,QACR;AAAA,MACF,CAAA;AAAA,IACF,CAAA;AAAA,EACF;AAAA,EAEQ,gBAAA,GAAmB;AACzB,IAAA,OAAO,CAAC,QAAA,KAA8C;AACpD,MAAA,OAAO,YAAgC,IAAA,EAA0B;AAC/D,QAAA,IAAI,CAACD,oBAAc,EAAG;AACpB,UAAA,OAAO,QAAA,CAAS,KAAA,CAAM,IAAA,EAAM,IAAI,CAAA;AAAA,QAClC;AAEA,QAAA,MAAM,EAAE,IAAA,EAAM,IAAA,EAAK,GAAI,IAAA,CAAK,OAAA;AAC5B,QAAA,MAAMC,YAAA,GAA6B;AAAA;AAAA,UAEjC,CAACC,oBAAS,GAAGC,6BAAA;AAAA;AAAA,UAEb,CAACC,uBAAY,GAAG,SAAA;AAAA,UAChB,CAACE,iCAAyB,GAAG,CAAA,QAAA,EAAW,IAAI,IAAI,IAAI,CAAA,CAAA;AAAA;AAAA,UAEpD,CAACC,wBAAa,GAAG,IAAA;AAAA;AAAA,UAEjB,CAACC,wBAAa,GAAG,IAAA;AAAA,UACjB,CAACC,qCAAgC,GAAG;AAAA,SACtC;AAEA,QAAA,MAAM,IAAA,GAAOC,uBAAkB,EAAE,IAAA,EAAM,WAAW,IAAA,EAAMC,cAAA,CAAU,MAAA,cAAQV,YAAA,EAAY,CAAA;AAEtF,QAAA,IAAI;AACF,UAAA,MAAM,MAAA,GAAS,QAAA,CAAS,KAAA,CAAM,IAAA,EAAM,IAAI,CAAA;AACxC,UAAA,IAAI,kBAAkB,OAAA,EAAS;AAC7B,YAAA,OAAO,MAAA,CAAO,IAAA;AAAA,cACZ,CAAC,KAAA,KAAmB;AAClB,gBAAA,OAAA,CAAQ,MAAM,IAAI,CAAA;AAClB,gBAAA,OAAO,KAAA;AAAA,cACT,CAAA;AAAA,cACA,CAAC,KAAA,KAAiB;AAChB,gBAAA,OAAA,CAAQ,MAAM,KAAK,CAAA;AACnB,gBAAA,OAAO,OAAA,CAAQ,OAAO,KAAK,CAAA;AAAA,cAC7B;AAAA,aACF;AAAA,UACF;AACA,UAAA,OAAA,CAAQ,MAAM,IAAI,CAAA;AAClB,UAAA,OAAO,MAAA;AAAA,QACT,SAAS,KAAA,EAAO;AACd,UAAA,OAAA,CAAQ,MAAM,KAAc,CAAA;AAC5B,UAAA,MAAM,KAAA;AAAA,QACR;AAAA,MACF,CAAA;AAAA,IACF,CAAA;AAAA,EACF;AAAA,EAEQ,iBAAA,CAAkB,IAAA,EAAY,GAAA,EAAmB,QAAA,EAAyB;AAChF,IAAA,MAAM,EAAE,YAAA,EAAa,GAAI,IAAA,CAAK,SAAA,EAAU;AACxC,IAAA,IAAI,CAAC,YAAA,EAAc;AACjB,MAAA;AAAA,IACF;AACA,IAAA,IAAI;AACF,MAAA,YAAA,CAAa,IAAA,EAAM,GAAA,CAAI,IAAA,EAAM,GAAA,CAAI,MAAM,QAAQ,CAAA;AAAA,IACjD,CAAA,CAAA,MAAQ;AAAA,IAER;AAAA,EACF;AACF;;;;"}

package/build/cjs/integrations/tracing/redis/vendored/redis-instrumentation.js

@@ -2,9 +2,10 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
 const instrumentation = require('@opentelemetry/instrumentation');
 const core = require('@sentry/core');
+const attributes = require('@sentry/conventions/attributes');
+const serverUtils = require('@sentry/server-utils');
 const debugBuild = require('../../../../debug-build.js');
 const InstrumentationNodeModuleFile = require('../../InstrumentationNodeModuleFile.js');
-const redisCommon = require('./redis-common.js');
 const semconv = require('./semconv.js');
 
 const PACKAGE_NAME = "@sentry/instrumentation-redis";
@@ -43,9 +44,12 @@ function removeCredentialsFromDBConnectionStringAttribute(url) {
 }
 function getClientAttributes(options) {
   return {
-    [semconv.ATTR_DB_SYSTEM]: semconv.DB_SYSTEM_VALUE_REDIS,
-    [semconv.ATTR_NET_PEER_NAME]: options?.socket?.host,
-    [semconv.ATTR_NET_PEER_PORT]: options?.socket?.port,
+    // oxlint-disable-next-line typescript/no-deprecated
+    [attributes.DB_SYSTEM]: semconv.DB_SYSTEM_VALUE_REDIS,
+    // oxlint-disable-next-line typescript/no-deprecated
+    [attributes.NET_PEER_NAME]: options?.socket?.host,
+    // oxlint-disable-next-line typescript/no-deprecated
+    [attributes.NET_PEER_PORT]: options?.socket?.port,
     [semconv.ATTR_DB_CONNECTION_STRING]: removeCredentialsFromDBConnectionStringAttribute(options?.url),
     [core.SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN
   };
@@ -80,22 +84,24 @@ const _RedisInstrumentationV2_V3 = class _RedisInstrumentationV2_V3 extends inst
         if (arguments.length !== 1 || typeof cmd !== "object") {
           return original.apply(this, arguments);
         }
-        const attributes = {
-          [semconv.ATTR_DB_SYSTEM]: semconv.DB_SYSTEM_VALUE_REDIS,
-          [semconv.ATTR_DB_STATEMENT]: redisCommon.defaultDbStatementSerializer(cmd.command, cmd.args),
+        const attributes$1 = {
+          // oxlint-disable-next-line typescript/no-deprecated
+          [attributes.DB_SYSTEM]: semconv.DB_SYSTEM_VALUE_REDIS,
+          // oxlint-disable-next-line typescript/no-deprecated
+          [attributes.DB_STATEMENT]: serverUtils.defaultDbStatementSerializer(cmd.command, cmd.args),
           [core.SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN
         };
         if (this.connection_options) {
-          attributes[semconv.ATTR_NET_PEER_NAME] = this.connection_options.host;
-          attributes[semconv.ATTR_NET_PEER_PORT] = this.connection_options.port;
+          attributes$1[attributes.NET_PEER_NAME] = this.connection_options.host;
+          attributes$1[attributes.NET_PEER_PORT] = this.connection_options.port;
         }
         if (this.address) {
-          attributes[semconv.ATTR_DB_CONNECTION_STRING] = `redis://${this.address}`;
+          attributes$1[semconv.ATTR_DB_CONNECTION_STRING] = `redis://${this.address}`;
         }
         const span = core.startInactiveSpan({
           name: `${_RedisInstrumentationV2_V3.COMPONENT}-${cmd.command}`,
           kind: core.SPAN_KIND.CLIENT,
-          attributes
+          attributes: attributes$1
         });
         const originalCallback = arguments[0].callback;
         if (originalCallback) {
@@ -332,15 +338,15 @@ const _RedisInstrumentationV4_V5 = class _RedisInstrumentationV4_V5 extends inst
     const clientOptions = origThis.options || origThis[MULTI_COMMAND_OPTIONS];
     const commandName = redisCommandArguments[0];
     const commandArgs = redisCommandArguments.slice(1);
-    const attributes = getClientAttributes(clientOptions);
-    const dbStatement = redisCommon.defaultDbStatementSerializer(commandName, commandArgs);
+    const attributes$1 = getClientAttributes(clientOptions);
+    const dbStatement = serverUtils.defaultDbStatementSerializer(commandName, commandArgs);
     if (dbStatement != null) {
-      attributes[semconv.ATTR_DB_STATEMENT] = dbStatement;
+      attributes$1[attributes.DB_STATEMENT] = dbStatement;
     }
     const span = core.startInactiveSpan({
       name: `${_RedisInstrumentationV4_V5.COMPONENT}-${commandName}`,
       kind: core.SPAN_KIND.CLIENT,
-      attributes
+      attributes: attributes$1
     });
     const res = core.withActiveSpan(span, () => origFunction.apply(origThis, origArguments));
     if (res instanceof Promise) {