@depup/sentry__server-utils 10.67.0-depup.0

package/build/esm/integrations/tracing-channel/kafkajs/semconv.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"semconv.js","sources":["../../../../../src/integrations/tracing-channel/kafkajs/semconv.ts"],"sourcesContent":["/*\n * Unstable OTel semantic-convention keys/values without a `@sentry/conventions` constant, inlined to\n * keep this integration free of `@opentelemetry/*` deps. Values are byte-identical to the vendored OTel\n * instrumentation (`@sentry/node`'s `integrations/tracing/kafka/vendored/semconv.ts`) for span parity.\n */\n\nexport const ATTR_MESSAGING_DESTINATION_PARTITION_ID = 'messaging.destination.partition.id' as const;\nexport const ATTR_MESSAGING_KAFKA_MESSAGE_KEY = 'messaging.kafka.message.key' as const;\nexport const ATTR_MESSAGING_KAFKA_MESSAGE_TOMBSTONE = 'messaging.kafka.message.tombstone' as const;\nexport const ATTR_MESSAGING_KAFKA_OFFSET = 'messaging.kafka.offset' as const;\nexport const MESSAGING_OPERATION_TYPE_VALUE_PROCESS = 'process' as const;\nexport const MESSAGING_OPERATION_TYPE_VALUE_RECEIVE = 'receive' as const;\nexport const MESSAGING_OPERATION_TYPE_VALUE_SEND = 'send' as const;\nexport const MESSAGING_SYSTEM_VALUE_KAFKA = 'kafka' as const;\n\n// `_OTHER` is OTel's fallback bucket when no more specific `error.type` is known.\nexport const ERROR_TYPE_VALUE_OTHER = '_OTHER' as const;\n"],"names":[],"mappings":"AAMO,MAAM,uCAAA,GAA0C;AAChD,MAAM,gCAAA,GAAmC;AACzC,MAAM,sCAAA,GAAyC;AAC/C,MAAM,2BAAA,GAA8B;AACpC,MAAM,sCAAA,GAAyC;AAC/C,MAAM,sCAAA,GAAyC;AAC/C,MAAM,mCAAA,GAAsC;AAC5C,MAAM,4BAAA,GAA+B;AAGrC,MAAM,sBAAA,GAAyB;;;;"}

package/build/esm/integrations/tracing-channel/kafkajs/spans.js

@@ -0,0 +1,112 @@
+import { ERROR_TYPE, MESSAGING_OPERATION_TYPE, MESSAGING_OPERATION_NAME, MESSAGING_DESTINATION_NAME, MESSAGING_SYSTEM } from '@sentry/conventions/attributes';
+import { SPAN_STATUS_ERROR, startInactiveSpan, SPAN_KIND, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, getTraceData, propagationContextFromHeaders } from '@sentry/core';
+import { ERROR_TYPE_VALUE_OTHER, MESSAGING_OPERATION_TYPE_VALUE_SEND, MESSAGING_SYSTEM_VALUE_KAFKA, ATTR_MESSAGING_DESTINATION_PARTITION_ID, ATTR_MESSAGING_KAFKA_MESSAGE_TOMBSTONE, ATTR_MESSAGING_KAFKA_MESSAGE_KEY, ATTR_MESSAGING_KAFKA_OFFSET, MESSAGING_OPERATION_TYPE_VALUE_RECEIVE } from './semconv.js';
+
+const PRODUCER_ORIGIN = "auto.kafkajs.orchestrion.producer";
+const CONSUMER_ORIGIN = "auto.kafkajs.orchestrion.consumer";
+const TRACE_FLAG_SAMPLED = 1;
+const TRACE_FLAG_NONE = 0;
+function getHeaderAsString(headers, key) {
+  const value = headers?.[key];
+  if (value == null) {
+    return void 0;
+  }
+  return Array.isArray(value) ? value[0]?.toString() : value.toString();
+}
+function getLinksFromHeaders(headers) {
+  const sentryTrace = getHeaderAsString(headers, "sentry-trace");
+  if (!sentryTrace) {
+    return void 0;
+  }
+  const { traceId, parentSpanId, sampled } = propagationContextFromHeaders(
+    sentryTrace,
+    getHeaderAsString(headers, "baggage")
+  );
+  if (!parentSpanId) {
+    return void 0;
+  }
+  return [
+    {
+      context: {
+        traceId,
+        spanId: parentSpanId,
+        isRemote: true,
+        traceFlags: sampled ? TRACE_FLAG_SAMPLED : TRACE_FLAG_NONE
+      }
+    }
+  ];
+}
+function startConsumerSpan({ topic, message, operationType, links, attributes }) {
+  const operationName = operationType === MESSAGING_OPERATION_TYPE_VALUE_RECEIVE ? "poll" : operationType;
+  return startInactiveSpan({
+    name: `${operationName} ${topic}`,
+    // todo(v11): Use https://getsentry.github.io/sentry-conventions/ops/#messaging
+    op: "message",
+    kind: operationType === MESSAGING_OPERATION_TYPE_VALUE_RECEIVE ? SPAN_KIND.CLIENT : SPAN_KIND.CONSUMER,
+    links,
+    attributes: {
+      ...attributes,
+      [MESSAGING_SYSTEM]: MESSAGING_SYSTEM_VALUE_KAFKA,
+      [MESSAGING_DESTINATION_NAME]: topic,
+      [MESSAGING_OPERATION_TYPE]: operationType,
+      [MESSAGING_OPERATION_NAME]: operationName,
+      [ATTR_MESSAGING_KAFKA_MESSAGE_KEY]: message?.key ? String(message.key) : void 0,
+      [ATTR_MESSAGING_KAFKA_MESSAGE_TOMBSTONE]: message?.key && message.value === null ? true : void 0,
+      [ATTR_MESSAGING_KAFKA_OFFSET]: message?.offset,
+      // Mirror the upstream behavior of only tagging per-message processing spans (not the batch
+      // receiving span, which carries no message) with the auto origin.
+      ...message ? { [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: CONSUMER_ORIGIN } : {}
+    }
+  });
+}
+function startProducerSpan(topic, message) {
+  const span = startInactiveSpan({
+    name: `send ${topic}`,
+    op: "message",
+    kind: SPAN_KIND.PRODUCER,
+    attributes: {
+      [MESSAGING_SYSTEM]: MESSAGING_SYSTEM_VALUE_KAFKA,
+      [MESSAGING_DESTINATION_NAME]: topic,
+      [ATTR_MESSAGING_KAFKA_MESSAGE_KEY]: message.key ? String(message.key) : void 0,
+      [ATTR_MESSAGING_KAFKA_MESSAGE_TOMBSTONE]: message.key && message.value === null ? true : void 0,
+      [ATTR_MESSAGING_DESTINATION_PARTITION_ID]: message.partition !== void 0 ? String(message.partition) : void 0,
+      [MESSAGING_OPERATION_NAME]: "send",
+      [MESSAGING_OPERATION_TYPE]: MESSAGING_OPERATION_TYPE_VALUE_SEND,
+      [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: PRODUCER_ORIGIN
+    }
+  });
+  message.headers = message.headers ?? {};
+  const traceData = getTraceData({ span });
+  if (traceData["sentry-trace"]) {
+    message.headers["sentry-trace"] = traceData["sentry-trace"];
+  }
+  if (traceData.baggage) {
+    message.headers["baggage"] = traceData.baggage;
+  }
+  return span;
+}
+function applyErrorToSpans(spans, reason) {
+  let errorMessage;
+  let errorType = ERROR_TYPE_VALUE_OTHER;
+  if (typeof reason === "string" || reason === void 0) {
+    errorMessage = reason;
+  } else if (typeof reason === "object" && reason !== null && Object.prototype.hasOwnProperty.call(reason, "message")) {
+    errorMessage = reason.message;
+    errorType = reason.constructor.name;
+  }
+  spans.forEach((span) => {
+    span.setAttribute(ERROR_TYPE, errorType);
+    span.setStatus({ code: SPAN_STATUS_ERROR, message: errorMessage });
+  });
+}
+function endSpansOnPromise(spans, promise) {
+  return Promise.resolve(promise).catch((reason) => {
+    applyErrorToSpans(spans, reason);
+    throw reason;
+  }).finally(() => {
+    spans.forEach((span) => span.end());
+  });
+}
+
+export { applyErrorToSpans, endSpansOnPromise, getHeaderAsString, getLinksFromHeaders, startConsumerSpan, startProducerSpan };
+//# sourceMappingURL=spans.js.map

package/build/esm/integrations/tracing-channel/kafkajs/spans.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spans.js","sources":["../../../../../src/integrations/tracing-channel/kafkajs/spans.ts"],"sourcesContent":["/*\n * Copyright The OpenTelemetry Authors, Aspecto\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/15ef7506553f631ea4181391e0c5725a56f0d082/packages/instrumentation-kafkajs\n * - Upstream version: @opentelemetry/instrumentation-kafkajs@0.27.0\n * - Span builders migrated to the `@sentry/core` span API. Kept byte-identical in span name/attributes\n *   for parity with the OTel integration this replaces; only the origin changes to\n *   `auto.kafkajs.orchestrion.*` to mark the injection path.\n */\n\nimport {\n  ERROR_TYPE,\n  MESSAGING_DESTINATION_NAME,\n  MESSAGING_OPERATION_NAME,\n  MESSAGING_OPERATION_TYPE,\n  MESSAGING_SYSTEM,\n} from '@sentry/conventions/attributes';\nimport type { Span, SpanAttributes, SpanLink } from '@sentry/core';\nimport {\n  getTraceData,\n  propagationContextFromHeaders,\n  SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,\n  SPAN_KIND,\n  SPAN_STATUS_ERROR,\n  startInactiveSpan,\n} from '@sentry/core';\nimport type { KafkaMessage, Message } from './types';\nimport {\n  ATTR_MESSAGING_DESTINATION_PARTITION_ID,\n  ATTR_MESSAGING_KAFKA_MESSAGE_KEY,\n  ATTR_MESSAGING_KAFKA_MESSAGE_TOMBSTONE,\n  ATTR_MESSAGING_KAFKA_OFFSET,\n  ERROR_TYPE_VALUE_OTHER,\n  MESSAGING_OPERATION_TYPE_VALUE_RECEIVE,\n  MESSAGING_OPERATION_TYPE_VALUE_SEND,\n  MESSAGING_SYSTEM_VALUE_KAFKA,\n} from './semconv';\n\nconst PRODUCER_ORIGIN = 'auto.kafkajs.orchestrion.producer';\nconst CONSUMER_ORIGIN = 'auto.kafkajs.orchestrion.consumer';\n\n// `@opentelemetry/api` `TraceFlags`, inlined to avoid an OTel dep: SAMPLED = 0x1, NONE = 0x0.\nconst TRACE_FLAG_SAMPLED = 1;\nconst TRACE_FLAG_NONE = 0;\n\ninterface ConsumerSpanOptions {\n  topic: string;\n  message: KafkaMessage | undefined;\n  operationType: string;\n  attributes: SpanAttributes;\n  links?: SpanLink[];\n}\n\n/**\n * Reads a header value off a kafkajs message as a string. kafkajs delivers headers as `Buffer`s (or\n * arrays of them), so we normalize to a string before handing them to Sentry's trace helpers.\n */\nexport function getHeaderAsString(headers: KafkaMessage['headers'], key: string): string | undefined {\n  const value = headers?.[key];\n  if (value == null) {\n    return undefined;\n  }\n  return Array.isArray(value) ? value[0]?.toString() : value.toString();\n}\n\n/**\n * Builds a span link to the producer span carried in the message headers, mirroring the upstream\n * behavior of linking each batch-processed message to its originating producer span.\n */\nexport function getLinksFromHeaders(headers: KafkaMessage['headers']): SpanLink[] | undefined {\n  const sentryTrace = getHeaderAsString(headers, 'sentry-trace');\n  if (!sentryTrace) {\n    return undefined;\n  }\n\n  const { traceId, parentSpanId, sampled } = propagationContextFromHeaders(\n    sentryTrace,\n    getHeaderAsString(headers, 'baggage'),\n  );\n  if (!parentSpanId) {\n    return undefined;\n  }\n\n  return [\n    {\n      context: {\n        traceId,\n        spanId: parentSpanId,\n        isRemote: true,\n        traceFlags: sampled ? TRACE_FLAG_SAMPLED : TRACE_FLAG_NONE,\n      },\n    },\n  ];\n}\n\n/** Starts an inactive consumer (process/receive) span carrying the kafkajs messaging attributes. */\nexport function startConsumerSpan({ topic, message, operationType, links, attributes }: ConsumerSpanOptions): Span {\n  // The batch \"receive\" span is named `poll`; per-message spans use the operation type verbatim.\n  const operationName = operationType === MESSAGING_OPERATION_TYPE_VALUE_RECEIVE ? 'poll' : operationType;\n\n  return startInactiveSpan({\n    name: `${operationName} ${topic}`,\n    // todo(v11): Use https://getsentry.github.io/sentry-conventions/ops/#messaging\n    op: 'message',\n    kind: operationType === MESSAGING_OPERATION_TYPE_VALUE_RECEIVE ? SPAN_KIND.CLIENT : SPAN_KIND.CONSUMER,\n    links,\n    attributes: {\n      ...attributes,\n      [MESSAGING_SYSTEM]: MESSAGING_SYSTEM_VALUE_KAFKA,\n      [MESSAGING_DESTINATION_NAME]: topic,\n      [MESSAGING_OPERATION_TYPE]: operationType,\n      [MESSAGING_OPERATION_NAME]: operationName,\n      [ATTR_MESSAGING_KAFKA_MESSAGE_KEY]: message?.key ? String(message.key) : undefined,\n      [ATTR_MESSAGING_KAFKA_MESSAGE_TOMBSTONE]: message?.key && message.value === null ? true : undefined,\n      [ATTR_MESSAGING_KAFKA_OFFSET]: message?.offset as string | undefined,\n      // Mirror the upstream behavior of only tagging per-message processing spans (not the batch\n      // receiving span, which carries no message) with the auto origin.\n      ...(message ? { [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: CONSUMER_ORIGIN } : {}),\n    },\n  });\n}\n\n/** Starts an inactive producer span and propagates its trace into the message headers. */\nexport function startProducerSpan(topic: string, message: Message): Span {\n  const span = startInactiveSpan({\n    name: `send ${topic}`,\n    op: 'message',\n    kind: SPAN_KIND.PRODUCER,\n    attributes: {\n      [MESSAGING_SYSTEM]: MESSAGING_SYSTEM_VALUE_KAFKA,\n      [MESSAGING_DESTINATION_NAME]: topic,\n      [ATTR_MESSAGING_KAFKA_MESSAGE_KEY]: message.key ? String(message.key) : undefined,\n      [ATTR_MESSAGING_KAFKA_MESSAGE_TOMBSTONE]: message.key && message.value === null ? true : undefined,\n      [ATTR_MESSAGING_DESTINATION_PARTITION_ID]:\n        message.partition !== undefined ? String(message.partition) : undefined,\n      [MESSAGING_OPERATION_NAME]: 'send',\n      [MESSAGING_OPERATION_TYPE]: MESSAGING_OPERATION_TYPE_VALUE_SEND,\n      [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: PRODUCER_ORIGIN,\n    },\n  });\n\n  // Propagate the producer span's trace to consumers via the message headers.\n  message.headers = message.headers ?? {};\n  const traceData = getTraceData({ span });\n  if (traceData['sentry-trace']) {\n    message.headers['sentry-trace'] = traceData['sentry-trace'];\n  }\n  if (traceData.baggage) {\n    message.headers['baggage'] = traceData.baggage;\n  }\n\n  return span;\n}\n\n/**\n * Marks all `spans` with the error status and `error.type` derived from a settle-time `reason`,\n * WITHOUT ending them. Mirrors the vendored `endSpansOnPromise` catch block. The producer path (which\n * receives discrete `error`/`asyncEnd` channel events) applies the error on `error` and ends on\n * `asyncEnd`; the consumer path folds this into `endSpansOnPromise`.\n */\nexport function applyErrorToSpans(spans: Span[], reason: unknown): void {\n  let errorMessage: string | undefined;\n  let errorType: string = ERROR_TYPE_VALUE_OTHER;\n  if (typeof reason === 'string' || reason === undefined) {\n    errorMessage = reason;\n  } else if (typeof reason === 'object' && reason !== null && Object.prototype.hasOwnProperty.call(reason, 'message')) {\n    errorMessage = (reason as { message?: string }).message;\n    errorType = (reason as { constructor: { name: string } }).constructor.name;\n  }\n\n  spans.forEach(span => {\n    span.setAttribute(ERROR_TYPE, errorType);\n    span.setStatus({ code: SPAN_STATUS_ERROR, message: errorMessage });\n  });\n}\n\n/**\n * Resolves once `promise` settles, applying the error status to all `spans` on failure and ending\n * them regardless. Used by the consumer path, which invokes the user callback directly (and so holds a\n * real promise). Verbatim from the vendored `endSpansOnPromise`.\n */\nexport function endSpansOnPromise<T>(spans: Span[], promise: Promise<T>): Promise<T> {\n  return Promise.resolve(promise)\n    .catch(reason => {\n      applyErrorToSpans(spans, reason);\n      throw reason;\n    })\n    .finally(() => {\n      spans.forEach(span => span.end());\n    });\n}\n"],"names":[],"mappings":";;;;AAwCA,MAAM,eAAA,GAAkB,mCAAA;AACxB,MAAM,eAAA,GAAkB,mCAAA;AAGxB,MAAM,kBAAA,GAAqB,CAAA;AAC3B,MAAM,eAAA,GAAkB,CAAA;AAcjB,SAAS,iBAAA,CAAkB,SAAkC,GAAA,EAAiC;AACnG,EAAA,MAAM,KAAA,GAAQ,UAAU,GAAG,CAAA;AAC3B,EAAA,IAAI,SAAS,IAAA,EAAM;AACjB,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,OAAO,KAAA,CAAM,OAAA,CAAQ,KAAK,CAAA,GAAI,KAAA,CAAM,CAAC,CAAA,EAAG,QAAA,EAAS,GAAI,KAAA,CAAM,QAAA,EAAS;AACtE;AAMO,SAAS,oBAAoB,OAAA,EAA0D;AAC5F,EAAA,MAAM,WAAA,GAAc,iBAAA,CAAkB,OAAA,EAAS,cAAc,CAAA;AAC7D,EAAA,IAAI,CAAC,WAAA,EAAa;AAChB,IAAA,OAAO,MAAA;AAAA,EACT;AAEA,EAAA,MAAM,EAAE,OAAA,EAAS,YAAA,EAAc,OAAA,EAAQ,GAAI,6BAAA;AAAA,IACzC,WAAA;AAAA,IACA,iBAAA,CAAkB,SAAS,SAAS;AAAA,GACtC;AACA,EAAA,IAAI,CAAC,YAAA,EAAc;AACjB,IAAA,OAAO,MAAA;AAAA,EACT;AAEA,EAAA,OAAO;AAAA,IACL;AAAA,MACE,OAAA,EAAS;AAAA,QACP,OAAA;AAAA,QACA,MAAA,EAAQ,YAAA;AAAA,QACR,QAAA,EAAU,IAAA;AAAA,QACV,UAAA,EAAY,UAAU,kBAAA,GAAqB;AAAA;AAC7C;AACF,GACF;AACF;AAGO,SAAS,kBAAkB,EAAE,KAAA,EAAO,SAAS,aAAA,EAAe,KAAA,EAAO,YAAW,EAA8B;AAEjH,EAAA,MAAM,aAAA,GAAgB,aAAA,KAAkB,sCAAA,GAAyC,MAAA,GAAS,aAAA;AAE1F,EAAA,OAAO,iBAAA,CAAkB;AAAA,IACvB,IAAA,EAAM,CAAA,EAAG,aAAa,CAAA,CAAA,EAAI,KAAK,CAAA,CAAA;AAAA;AAAA,IAE/B,EAAA,EAAI,SAAA;AAAA,IACJ,IAAA,EAAM,aAAA,KAAkB,sCAAA,GAAyC,SAAA,CAAU,SAAS,SAAA,CAAU,QAAA;AAAA,IAC9F,KAAA;AAAA,IACA,UAAA,EAAY;AAAA,MACV,GAAG,UAAA;AAAA,MACH,CAAC,gBAAgB,GAAG,4BAAA;AAAA,MACpB,CAAC,0BAA0B,GAAG,KAAA;AAAA,MAC9B,CAAC,wBAAwB,GAAG,aAAA;AAAA,MAC5B,CAAC,wBAAwB,GAAG,aAAA;AAAA,MAC5B,CAAC,gCAAgC,GAAG,OAAA,EAAS,MAAM,MAAA,CAAO,OAAA,CAAQ,GAAG,CAAA,GAAI,MAAA;AAAA,MACzE,CAAC,sCAAsC,GAAG,OAAA,EAAS,OAAO,OAAA,CAAQ,KAAA,KAAU,OAAO,IAAA,GAAO,MAAA;AAAA,MAC1F,CAAC,2BAA2B,GAAG,OAAA,EAAS,MAAA;AAAA;AAAA;AAAA,MAGxC,GAAI,UAAU,EAAE,CAAC,gCAAgC,GAAG,eAAA,KAAoB;AAAC;AAC3E,GACD,CAAA;AACH;AAGO,SAAS,iBAAA,CAAkB,OAAe,OAAA,EAAwB;AACvE,EAAA,MAAM,OAAO,iBAAA,CAAkB;AAAA,IAC7B,IAAA,EAAM,QAAQ,KAAK,CAAA,CAAA;AAAA,IACnB,EAAA,EAAI,SAAA;AAAA,IACJ,MAAM,SAAA,CAAU,QAAA;AAAA,IAChB,UAAA,EAAY;AAAA,MACV,CAAC,gBAAgB,GAAG,4BAAA;AAAA,MACpB,CAAC,0BAA0B,GAAG,KAAA;AAAA,MAC9B,CAAC,gCAAgC,GAAG,OAAA,CAAQ,MAAM,MAAA,CAAO,OAAA,CAAQ,GAAG,CAAA,GAAI,MAAA;AAAA,MACxE,CAAC,sCAAsC,GAAG,OAAA,CAAQ,OAAO,OAAA,CAAQ,KAAA,KAAU,OAAO,IAAA,GAAO,MAAA;AAAA,MACzF,CAAC,uCAAuC,GACtC,OAAA,CAAQ,cAAc,MAAA,GAAY,MAAA,CAAO,OAAA,CAAQ,SAAS,CAAA,GAAI,MAAA;AAAA,MAChE,CAAC,wBAAwB,GAAG,MAAA;AAAA,MAC5B,CAAC,wBAAwB,GAAG,mCAAA;AAAA,MAC5B,CAAC,gCAAgC,GAAG;AAAA;AACtC,GACD,CAAA;AAGD,EAAA,OAAA,CAAQ,OAAA,GAAU,OAAA,CAAQ,OAAA,IAAW,EAAC;AACtC,EAAA,MAAM,SAAA,GAAY,YAAA,CAAa,EAAE,IAAA,EAAM,CAAA;AACvC,EAAA,IAAI,SAAA,CAAU,cAAc,CAAA,EAAG;AAC7B,IAAA,OAAA,CAAQ,OAAA,CAAQ,cAAc,CAAA,GAAI,SAAA,CAAU,cAAc,CAAA;AAAA,EAC5D;AACA,EAAA,IAAI,UAAU,OAAA,EAAS;AACrB,IAAA,OAAA,CAAQ,OAAA,CAAQ,SAAS,CAAA,GAAI,SAAA,CAAU,OAAA;AAAA,EACzC;AAEA,EAAA,OAAO,IAAA;AACT;AAQO,SAAS,iBAAA,CAAkB,OAAe,MAAA,EAAuB;AACtE,EAAA,IAAI,YAAA;AACJ,EAAA,IAAI,SAAA,GAAoB,sBAAA;AACxB,EAAA,IAAI,OAAO,MAAA,KAAW,QAAA,IAAY,MAAA,KAAW,MAAA,EAAW;AACtD,IAAA,YAAA,GAAe,MAAA;AAAA,EACjB,CAAA,MAAA,IAAW,OAAO,MAAA,KAAW,QAAA,IAAY,MAAA,KAAW,IAAA,IAAQ,MAAA,CAAO,SAAA,CAAU,cAAA,CAAe,IAAA,CAAK,MAAA,EAAQ,SAAS,CAAA,EAAG;AACnH,IAAA,YAAA,GAAgB,MAAA,CAAgC,OAAA;AAChD,IAAA,SAAA,GAAa,OAA6C,WAAA,CAAY,IAAA;AAAA,EACxE;AAEA,EAAA,KAAA,CAAM,QAAQ,CAAA,IAAA,KAAQ;AACpB,IAAA,IAAA,CAAK,YAAA,CAAa,YAAY,SAAS,CAAA;AACvC,IAAA,IAAA,CAAK,UAAU,EAAE,IAAA,EAAM,iBAAA,EAAmB,OAAA,EAAS,cAAc,CAAA;AAAA,EACnE,CAAC,CAAA;AACH;AAOO,SAAS,iBAAA,CAAqB,OAAe,OAAA,EAAiC;AACnF,EAAA,OAAO,OAAA,CAAQ,OAAA,CAAQ,OAAO,CAAA,CAC3B,MAAM,CAAA,MAAA,KAAU;AACf,IAAA,iBAAA,CAAkB,OAAO,MAAM,CAAA;AAC/B,IAAA,MAAM,MAAA;AAAA,EACR,CAAC,CAAA,CACA,OAAA,CAAQ,MAAM;AACb,IAAA,KAAA,CAAM,OAAA,CAAQ,CAAA,IAAA,KAAQ,IAAA,CAAK,GAAA,EAAK,CAAA;AAAA,EAClC,CAAC,CAAA;AACL;;;;"}

package/build/esm/integrations/tracing-channel/knex.js

@@ -0,0 +1,186 @@
+import * as diagnosticsChannel from 'node:diagnostics_channel';
+import { defineIntegration, debug, waitForTracingChannelBinding, getActiveSpan, SPAN_STATUS_ERROR, truncate, startInactiveSpan, SPAN_KIND, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
+import { DB_STATEMENT, NET_TRANSPORT, NET_PEER_PORT, NET_PEER_NAME, DB_USER, DB_SYSTEM, DB_NAME, DB_OPERATION } from '@sentry/conventions/attributes';
+import { DEBUG_BUILD } from '../../debug-build.js';
+import { CHANNELS } from '../../orchestrion/channels.js';
+import { bindTracingChannelToSpan } from '../../tracing-channel.js';
+
+const INTEGRATION_NAME = "Knex";
+const ORIGIN = "auto.db.orchestrion.knex";
+const MAX_QUERY_LENGTH = 1021;
+const ATTR_DB_SQL_TABLE = "db.sql.table";
+const DB_SYSTEM_SQLITE = "sqlite";
+const DB_SYSTEM_POSTGRESQL = "postgresql";
+const parentSpanSymbol = /* @__PURE__ */ Symbol("sentry.orchestrion.knex.parent-span");
+const _knexChannelIntegration = (() => {
+  return {
+    name: INTEGRATION_NAME,
+    setupOnce() {
+      if (!diagnosticsChannel.tracingChannel) {
+        return;
+      }
+      DEBUG_BUILD && debug.log(`[orchestrion:knex] subscribing to channel "${CHANNELS.KNEX_QUERY}"`);
+      waitForTracingChannelBinding(() => {
+        subscribeBuilder(CHANNELS.KNEX_QUERY_BUILDER);
+        subscribeBuilder(CHANNELS.KNEX_SCHEMA_BUILDER);
+        subscribeBuilder(CHANNELS.KNEX_RAW);
+        subscribeQuery();
+      });
+    }
+  };
+});
+function subscribeBuilder(channelName) {
+  diagnosticsChannel.tracingChannel(channelName).end.subscribe((message) => {
+    const builder = message.result;
+    if (!builder || typeof builder !== "object" || parentSpanSymbol in builder) {
+      return;
+    }
+    const activeSpan = getActiveSpan();
+    if (!activeSpan) {
+      return;
+    }
+    Object.defineProperty(builder, parentSpanSymbol, { value: activeSpan });
+  });
+}
+function subscribeQuery() {
+  bindTracingChannelToSpan(
+    diagnosticsChannel.tracingChannel(CHANNELS.KNEX_QUERY),
+    (data) => {
+      const runner = data.self;
+      const builder = runner?.builder;
+      const parentSpan = builder?.[parentSpanSymbol] ?? getActiveSpan();
+      if (!parentSpan) {
+        return void 0;
+      }
+      const query = data.arguments[0];
+      const client = runner?.client;
+      const connection = client?.config?.connection;
+      const connectionString = connection?.connectionString;
+      const table = extractTableName(builder);
+      const operation = query?.method;
+      const name = connection?.filename || connection?.database || extractDatabaseFromConnectionString(connectionString);
+      const attributes = {
+        [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,
+        "knex.version": data.moduleVersion,
+        [DB_SYSTEM]: mapSystem(client?.driverName),
+        [ATTR_DB_SQL_TABLE]: table,
+        [DB_OPERATION]: operation,
+        [DB_USER]: connection?.user,
+        [DB_NAME]: name,
+        [NET_PEER_NAME]: connection?.host ?? extractHostFromConnectionString(connectionString),
+        [NET_PEER_PORT]: connection?.port ?? extractPortFromConnectionString(connectionString),
+        [NET_TRANSPORT]: connection?.filename === ":memory:" ? "inproc" : void 0,
+        [DB_STATEMENT]: query?.sql != null ? truncate(query.sql, MAX_QUERY_LENGTH) : void 0
+      };
+      return startInactiveSpan({
+        name: getName(name, operation, table) ?? "knex.query",
+        kind: SPAN_KIND.CLIENT,
+        op: "db",
+        parentSpan,
+        attributes
+      });
+    },
+    {
+      beforeSpanEnd(span, data) {
+        if ("error" in data) {
+          const message = cleanErrorMessage(data);
+          if (message !== void 0) {
+            span.setStatus({ code: SPAN_STATUS_ERROR, message });
+          }
+        }
+      }
+    }
+  );
+}
+function cleanErrorMessage(data) {
+  const error = data.error;
+  if (!error || typeof error !== "object" || typeof error.message !== "string") {
+    return void 0;
+  }
+  const rawMessage = error.message;
+  const query = data.arguments[0];
+  if (!query?.sql) {
+    return rawMessage;
+  }
+  try {
+    const formatter = getFormatter(data.self);
+    const fullQuery = formatter(query.sql, query.bindings || []);
+    return rawMessage.replace(`${fullQuery} - `, "");
+  } catch {
+    return rawMessage;
+  }
+}
+function getFormatter(runner) {
+  if (runner) {
+    const client = runner.client;
+    if (client) {
+      if (client._formatQuery) {
+        return client._formatQuery.bind(client);
+      } else if (client.SqlString) {
+        return client.SqlString.format.bind(client.SqlString);
+      }
+    }
+    if (runner.builder?.toString) {
+      return runner.builder.toString.bind(runner.builder);
+    }
+  }
+  return () => "<noop formatter>";
+}
+function mapSystem(driverName) {
+  if (driverName === "sqlite3") {
+    return DB_SYSTEM_SQLITE;
+  }
+  if (driverName === "pg") {
+    return DB_SYSTEM_POSTGRESQL;
+  }
+  return driverName;
+}
+function getName(db, operation, table) {
+  if (operation && db) {
+    return table ? `${operation} ${db}.${table}` : `${operation} ${db}`;
+  }
+  return db;
+}
+function extractTableName(builder) {
+  const table = builder?._single?.table;
+  if (table && typeof table === "object") {
+    return extractTableName(table);
+  }
+  return typeof table === "string" ? table : void 0;
+}
+function extractDatabaseFromConnectionString(connectionString) {
+  if (!connectionString) {
+    return void 0;
+  }
+  try {
+    const db = new URL(connectionString).pathname?.replace(/^\//, "");
+    return db || void 0;
+  } catch {
+    return void 0;
+  }
+}
+function extractHostFromConnectionString(connectionString) {
+  if (!connectionString) {
+    return void 0;
+  }
+  try {
+    return new URL(connectionString).hostname || void 0;
+  } catch {
+    return void 0;
+  }
+}
+function extractPortFromConnectionString(connectionString) {
+  if (!connectionString) {
+    return void 0;
+  }
+  try {
+    const port = new URL(connectionString).port;
+    return port ? parseInt(port, 10) : void 0;
+  } catch {
+    return void 0;
+  }
+}
+const knexChannelIntegration = defineIntegration(_knexChannelIntegration);
+
+export { knexChannelIntegration };
+//# sourceMappingURL=knex.js.map

package/build/esm/integrations/tracing-channel/knex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"knex.js","sources":["../../../../src/integrations/tracing-channel/knex.ts"],"sourcesContent":["// The `@sentry/conventions` db/net attribute keys are deprecated (superseded by newer semconv), but we\n// emit them deliberately to preserve parity with what `@opentelemetry/instrumentation-knex` produced.\n/* oxlint-disable typescript/no-deprecated */\n\nimport * as diagnosticsChannel from 'node:diagnostics_channel';\nimport type { IntegrationFn, Span, SpanAttributes } from '@sentry/core';\nimport {\n  debug,\n  defineIntegration,\n  getActiveSpan,\n  SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,\n  SPAN_KIND,\n  SPAN_STATUS_ERROR,\n  startInactiveSpan,\n  truncate,\n  waitForTracingChannelBinding,\n} from '@sentry/core';\nimport {\n  DB_NAME,\n  DB_OPERATION,\n  DB_STATEMENT,\n  DB_SYSTEM,\n  DB_USER,\n  NET_PEER_NAME,\n  NET_PEER_PORT,\n  NET_TRANSPORT,\n} from '@sentry/conventions/attributes';\nimport { DEBUG_BUILD } from '../../debug-build';\nimport { CHANNELS } from '../../orchestrion/channels';\nimport { bindTracingChannelToSpan } from '../../tracing-channel';\n\n// NOTE: this uses the same name as the OTel integration by design. `@sentry/node`'s `knexIntegration`\n// picks this subscriber over the vendored OTel path when orchestrion injection is active.\nconst INTEGRATION_NAME = 'Knex' as const;\nconst ORIGIN = 'auto.db.orchestrion.knex';\n\n// Max length of the query text captured in `db.statement`; \"...\" is appended when truncated, so the\n// truncated statement caps at 1024 chars (1 KiB), matching `@opentelemetry/instrumentation-knex`.\nconst MAX_QUERY_LENGTH = 1021;\n\n// `db.sql.table` is deprecated and not exported by `@sentry/conventions`, so keep it local. Matches\n// what `@opentelemetry/instrumentation-knex` emitted.\nconst ATTR_DB_SQL_TABLE = 'db.sql.table';\n\nconst DB_SYSTEM_SQLITE = 'sqlite';\nconst DB_SYSTEM_POSTGRESQL = 'postgresql';\n\n// The span active when a builder is created, reused as the parent when the query runs later (the query\n// often executes in a different async context than the builder was created in).\nconst parentSpanSymbol = Symbol('sentry.orchestrion.knex.parent-span');\n\ninterface KnexQuery {\n  sql?: string;\n  method?: string;\n  bindings?: unknown[];\n}\n\ninterface KnexConnectionConfig {\n  filename?: string;\n  database?: string;\n  user?: string;\n  host?: string;\n  port?: number;\n  connectionString?: string;\n}\n\ninterface KnexBuilder {\n  _single?: { table?: unknown };\n  toString?: () => string;\n  [parentSpanSymbol]?: Span;\n}\n\ninterface KnexClient {\n  driverName?: string;\n  config?: { connection?: KnexConnectionConfig };\n  _formatQuery?: (sql: string, bindings: unknown[]) => string;\n  SqlString?: { format: (sql: string, bindings: unknown[]) => string };\n}\n\ninterface KnexRunner {\n  client?: KnexClient;\n  builder?: KnexBuilder;\n}\n\n/** Context orchestrion attaches to the `orchestrion:knex:query` channel (wrapping `Runner.query`). */\ninterface KnexQueryChannelContext {\n  // `arguments[0]` is the query object (`{ sql, method, bindings }`).\n  arguments: [KnexQuery?];\n  self?: KnexRunner;\n  moduleVersion?: string;\n  result?: unknown;\n  error?: unknown;\n}\n\n/** Context orchestrion attaches to the `Client.queryBuilder`/`schemaBuilder`/`raw` channels. */\ninterface KnexBuilderChannelContext {\n  arguments: unknown[];\n  self?: unknown;\n  // The builder returned by the wrapped method.\n  result?: KnexBuilder;\n}\n\nconst _knexChannelIntegration = (() => {\n  return {\n    name: INTEGRATION_NAME,\n    setupOnce() {\n      // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.\n      if (!diagnosticsChannel.tracingChannel) {\n        return;\n      }\n\n      DEBUG_BUILD && debug.log(`[orchestrion:knex] subscribing to channel \"${CHANNELS.KNEX_QUERY}\"`);\n\n      waitForTracingChannelBinding(() => {\n        subscribeBuilder(CHANNELS.KNEX_QUERY_BUILDER);\n        subscribeBuilder(CHANNELS.KNEX_SCHEMA_BUILDER);\n        subscribeBuilder(CHANNELS.KNEX_RAW);\n        subscribeQuery();\n      });\n    },\n  };\n}) satisfies IntegrationFn;\n\n/**\n * Bookkeeping only: stash the span active at builder-creation time onto the returned builder. It is\n * read back as the parent when the query runs (see `subscribeQuery`), because the query often executes\n * in a different async context. A `Client` builder method is synchronous, so its `result` (the builder)\n * is available on the channel's `end`.\n */\nfunction subscribeBuilder(channelName: string): void {\n  diagnosticsChannel.tracingChannel(channelName).end.subscribe(message => {\n    const builder = (message as KnexBuilderChannelContext).result;\n    if (!builder || typeof builder !== 'object' || parentSpanSymbol in builder) {\n      return;\n    }\n\n    const activeSpan = getActiveSpan();\n    if (!activeSpan) {\n      return;\n    }\n\n    Object.defineProperty(builder, parentSpanSymbol, { value: activeSpan });\n  });\n}\n\nfunction subscribeQuery(): void {\n  bindTracingChannelToSpan<KnexQueryChannelContext>(\n    diagnosticsChannel.tracingChannel<KnexQueryChannelContext>(CHANNELS.KNEX_QUERY),\n    data => {\n      const runner = data.self;\n      const builder = runner?.builder;\n\n      // The builder captures the span active when it was created (see `subscribeBuilder`).\n      // `onlyIfParent`: only instrument queries that run as part of an existing trace, matching OTel.\n      const parentSpan = builder?.[parentSpanSymbol] ?? getActiveSpan();\n      if (!parentSpan) {\n        return undefined;\n      }\n\n      const query = data.arguments[0];\n      const client = runner?.client;\n      const connection = client?.config?.connection;\n      const connectionString = connection?.connectionString;\n      const table = extractTableName(builder);\n      const operation = query?.method;\n      const name =\n        connection?.filename || connection?.database || extractDatabaseFromConnectionString(connectionString);\n\n      const attributes: SpanAttributes = {\n        [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,\n        'knex.version': data.moduleVersion,\n        [DB_SYSTEM]: mapSystem(client?.driverName),\n        [ATTR_DB_SQL_TABLE]: table,\n        [DB_OPERATION]: operation,\n        [DB_USER]: connection?.user,\n        [DB_NAME]: name,\n        [NET_PEER_NAME]: connection?.host ?? extractHostFromConnectionString(connectionString),\n        [NET_PEER_PORT]: connection?.port ?? extractPortFromConnectionString(connectionString),\n        [NET_TRANSPORT]: connection?.filename === ':memory:' ? 'inproc' : undefined,\n        [DB_STATEMENT]: query?.sql != null ? truncate(query.sql, MAX_QUERY_LENGTH) : undefined,\n      };\n\n      return startInactiveSpan({\n        name: getName(name, operation, table) ?? 'knex.query',\n        kind: SPAN_KIND.CLIENT,\n        op: 'db',\n        parentSpan,\n        attributes,\n      });\n    },\n    {\n      beforeSpanEnd(span, data) {\n        // knex prefixes query errors with the full SQL (\"<query> - <error>\"). Strip it so the span\n        // status message is just the driver error, matching the vendored OTel instrumentation.\n        if ('error' in data) {\n          const message = cleanErrorMessage(data);\n          if (message !== undefined) {\n            span.setStatus({ code: SPAN_STATUS_ERROR, message });\n          }\n        }\n      },\n    },\n  );\n}\n\nfunction cleanErrorMessage(data: KnexQueryChannelContext): string | undefined {\n  const error = data.error;\n  if (!error || typeof error !== 'object' || typeof (error as { message?: unknown }).message !== 'string') {\n    return undefined;\n  }\n\n  const rawMessage = (error as { message: string }).message;\n  const query = data.arguments[0];\n  if (!query?.sql) {\n    return rawMessage;\n  }\n\n  try {\n    const formatter = getFormatter(data.self);\n    const fullQuery = formatter(query.sql, query.bindings || []);\n    return rawMessage.replace(`${fullQuery} - `, '');\n  } catch {\n    return rawMessage;\n  }\n}\n\nfunction getFormatter(runner: KnexRunner | undefined): (sql: string, bindings: unknown[]) => string {\n  if (runner) {\n    const client = runner.client;\n    if (client) {\n      if (client._formatQuery) {\n        return client._formatQuery.bind(client);\n      } else if (client.SqlString) {\n        return client.SqlString.format.bind(client.SqlString);\n      }\n    }\n    if (runner.builder?.toString) {\n      return runner.builder.toString.bind(runner.builder);\n    }\n  }\n\n  return () => '<noop formatter>';\n}\n\nfunction mapSystem(driverName: string | undefined): string | undefined {\n  if (driverName === 'sqlite3') {\n    return DB_SYSTEM_SQLITE;\n  }\n  if (driverName === 'pg') {\n    return DB_SYSTEM_POSTGRESQL;\n  }\n  return driverName;\n}\n\nfunction getName(db: string | undefined, operation?: string, table?: string): string | undefined {\n  // `db` can be undefined when the database can't be determined from the knex config. Guard against\n  // interpolating it (which would emit the literal \"undefined\") and let the call site fall back.\n  if (operation && db) {\n    return table ? `${operation} ${db}.${table}` : `${operation} ${db}`;\n  }\n  return db;\n}\n\nfunction extractTableName(builder: KnexBuilder | undefined): string | undefined {\n  const table = builder?._single?.table;\n  if (table && typeof table === 'object') {\n    return extractTableName(table as KnexBuilder);\n  }\n  return typeof table === 'string' ? table : undefined;\n}\n\nfunction extractDatabaseFromConnectionString(connectionString: string | undefined): string | undefined {\n  if (!connectionString) {\n    return undefined;\n  }\n  try {\n    const db = new URL(connectionString).pathname?.replace(/^\\//, '');\n    return db || undefined;\n  } catch {\n    return undefined;\n  }\n}\n\nfunction extractHostFromConnectionString(connectionString: string | undefined): string | undefined {\n  if (!connectionString) {\n    return undefined;\n  }\n  try {\n    return new URL(connectionString).hostname || undefined;\n  } catch {\n    return undefined;\n  }\n}\n\nfunction extractPortFromConnectionString(connectionString: string | undefined): number | undefined {\n  if (!connectionString) {\n    return undefined;\n  }\n  try {\n    const port = new URL(connectionString).port;\n    return port ? parseInt(port, 10) : undefined;\n  } catch {\n    return undefined;\n  }\n}\n\n/**\n * EXPERIMENTAL - orchestrion-driven knex integration.\n *\n * Subscribes to the `orchestrion:knex:*` diagnostics_channels that the orchestrion code transform\n * injects into knex's `Runner.query` (span) and `Client.queryBuilder`/`schemaBuilder`/`raw` (parent-span\n * bookkeeping). Requires the orchestrion runtime hook or bundler plugin to be active.\n */\nexport const knexChannelIntegration = defineIntegration(_knexChannelIntegration);\n"],"names":[],"mappings":";;;;;;;AAiCA,MAAM,gBAAA,GAAmB,MAAA;AACzB,MAAM,MAAA,GAAS,0BAAA;AAIf,MAAM,gBAAA,GAAmB,IAAA;AAIzB,MAAM,iBAAA,GAAoB,cAAA;AAE1B,MAAM,gBAAA,GAAmB,QAAA;AACzB,MAAM,oBAAA,GAAuB,YAAA;AAI7B,MAAM,gBAAA,0BAA0B,qCAAqC,CAAA;AAqDrE,MAAM,2BAA2B,MAAM;AACrC,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,gBAAA;AAAA,IACN,SAAA,GAAY;AAEV,MAAA,IAAI,CAAC,mBAAmB,cAAA,EAAgB;AACtC,QAAA;AAAA,MACF;AAEA,MAAA,WAAA,IAAe,KAAA,CAAM,GAAA,CAAI,CAAA,2CAAA,EAA8C,QAAA,CAAS,UAAU,CAAA,CAAA,CAAG,CAAA;AAE7F,MAAA,4BAAA,CAA6B,MAAM;AACjC,QAAA,gBAAA,CAAiB,SAAS,kBAAkB,CAAA;AAC5C,QAAA,gBAAA,CAAiB,SAAS,mBAAmB,CAAA;AAC7C,QAAA,gBAAA,CAAiB,SAAS,QAAQ,CAAA;AAClC,QAAA,cAAA,EAAe;AAAA,MACjB,CAAC,CAAA;AAAA,IACH;AAAA,GACF;AACF,CAAA,CAAA;AAQA,SAAS,iBAAiB,WAAA,EAA2B;AACnD,EAAA,kBAAA,CAAmB,cAAA,CAAe,WAAW,CAAA,CAAE,GAAA,CAAI,UAAU,CAAA,OAAA,KAAW;AACtE,IAAA,MAAM,UAAW,OAAA,CAAsC,MAAA;AACvD,IAAA,IAAI,CAAC,OAAA,IAAW,OAAO,OAAA,KAAY,QAAA,IAAY,oBAAoB,OAAA,EAAS;AAC1E,MAAA;AAAA,IACF;AAEA,IAAA,MAAM,aAAa,aAAA,EAAc;AACjC,IAAA,IAAI,CAAC,UAAA,EAAY;AACf,MAAA;AAAA,IACF;AAEA,IAAA,MAAA,CAAO,eAAe,OAAA,EAAS,gBAAA,EAAkB,EAAE,KAAA,EAAO,YAAY,CAAA;AAAA,EACxE,CAAC,CAAA;AACH;AAEA,SAAS,cAAA,GAAuB;AAC9B,EAAA,wBAAA;AAAA,IACE,kBAAA,CAAmB,cAAA,CAAwC,QAAA,CAAS,UAAU,CAAA;AAAA,IAC9E,CAAA,IAAA,KAAQ;AACN,MAAA,MAAM,SAAS,IAAA,CAAK,IAAA;AACpB,MAAA,MAAM,UAAU,MAAA,EAAQ,OAAA;AAIxB,MAAA,MAAM,UAAA,GAAa,OAAA,GAAU,gBAAgB,CAAA,IAAK,aAAA,EAAc;AAChE,MAAA,IAAI,CAAC,UAAA,EAAY;AACf,QAAA,OAAO,MAAA;AAAA,MACT;AAEA,MAAA,MAAM,KAAA,GAAQ,IAAA,CAAK,SAAA,CAAU,CAAC,CAAA;AAC9B,MAAA,MAAM,SAAS,MAAA,EAAQ,MAAA;AACvB,MAAA,MAAM,UAAA,GAAa,QAAQ,MAAA,EAAQ,UAAA;AACnC,MAAA,MAAM,mBAAmB,UAAA,EAAY,gBAAA;AACrC,MAAA,MAAM,KAAA,GAAQ,iBAAiB,OAAO,CAAA;AACtC,MAAA,MAAM,YAAY,KAAA,EAAO,MAAA;AACzB,MAAA,MAAM,OACJ,UAAA,EAAY,QAAA,IAAY,UAAA,EAAY,QAAA,IAAY,oCAAoC,gBAAgB,CAAA;AAEtG,MAAA,MAAM,UAAA,GAA6B;AAAA,QACjC,CAAC,gCAAgC,GAAG,MAAA;AAAA,QACpC,gBAAgB,IAAA,CAAK,aAAA;AAAA,QACrB,CAAC,SAAS,GAAG,SAAA,CAAU,QAAQ,UAAU,CAAA;AAAA,QACzC,CAAC,iBAAiB,GAAG,KAAA;AAAA,QACrB,CAAC,YAAY,GAAG,SAAA;AAAA,QAChB,CAAC,OAAO,GAAG,UAAA,EAAY,IAAA;AAAA,QACvB,CAAC,OAAO,GAAG,IAAA;AAAA,QACX,CAAC,aAAa,GAAG,UAAA,EAAY,IAAA,IAAQ,gCAAgC,gBAAgB,CAAA;AAAA,QACrF,CAAC,aAAa,GAAG,UAAA,EAAY,IAAA,IAAQ,gCAAgC,gBAAgB,CAAA;AAAA,QACrF,CAAC,aAAa,GAAG,UAAA,EAAY,QAAA,KAAa,aAAa,QAAA,GAAW,MAAA;AAAA,QAClE,CAAC,YAAY,GAAG,KAAA,EAAO,GAAA,IAAO,OAAO,QAAA,CAAS,KAAA,CAAM,GAAA,EAAK,gBAAgB,CAAA,GAAI;AAAA,OAC/E;AAEA,MAAA,OAAO,iBAAA,CAAkB;AAAA,QACvB,IAAA,EAAM,OAAA,CAAQ,IAAA,EAAM,SAAA,EAAW,KAAK,CAAA,IAAK,YAAA;AAAA,QACzC,MAAM,SAAA,CAAU,MAAA;AAAA,QAChB,EAAA,EAAI,IAAA;AAAA,QACJ,UAAA;AAAA,QACA;AAAA,OACD,CAAA;AAAA,IACH,CAAA;AAAA,IACA;AAAA,MACE,aAAA,CAAc,MAAM,IAAA,EAAM;AAGxB,QAAA,IAAI,WAAW,IAAA,EAAM;AACnB,UAAA,MAAM,OAAA,GAAU,kBAAkB,IAAI,CAAA;AACtC,UAAA,IAAI,YAAY,MAAA,EAAW;AACzB,YAAA,IAAA,CAAK,SAAA,CAAU,EAAE,IAAA,EAAM,iBAAA,EAAmB,SAAS,CAAA;AAAA,UACrD;AAAA,QACF;AAAA,MACF;AAAA;AACF,GACF;AACF;AAEA,SAAS,kBAAkB,IAAA,EAAmD;AAC5E,EAAA,MAAM,QAAQ,IAAA,CAAK,KAAA;AACnB,EAAA,IAAI,CAAC,SAAS,OAAO,KAAA,KAAU,YAAY,OAAQ,KAAA,CAAgC,YAAY,QAAA,EAAU;AACvG,IAAA,OAAO,MAAA;AAAA,EACT;AAEA,EAAA,MAAM,aAAc,KAAA,CAA8B,OAAA;AAClD,EAAA,MAAM,KAAA,GAAQ,IAAA,CAAK,SAAA,CAAU,CAAC,CAAA;AAC9B,EAAA,IAAI,CAAC,OAAO,GAAA,EAAK;AACf,IAAA,OAAO,UAAA;AAAA,EACT;AAEA,EAAA,IAAI;AACF,IAAA,MAAM,SAAA,GAAY,YAAA,CAAa,IAAA,CAAK,IAAI,CAAA;AACxC,IAAA,MAAM,YAAY,SAAA,CAAU,KAAA,CAAM,KAAK,KAAA,CAAM,QAAA,IAAY,EAAE,CAAA;AAC3D,IAAA,OAAO,UAAA,CAAW,OAAA,CAAQ,CAAA,EAAG,SAAS,OAAO,EAAE,CAAA;AAAA,EACjD,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,UAAA;AAAA,EACT;AACF;AAEA,SAAS,aAAa,MAAA,EAA8E;AAClG,EAAA,IAAI,MAAA,EAAQ;AACV,IAAA,MAAM,SAAS,MAAA,CAAO,MAAA;AACtB,IAAA,IAAI,MAAA,EAAQ;AACV,MAAA,IAAI,OAAO,YAAA,EAAc;AACvB,QAAA,OAAO,MAAA,CAAO,YAAA,CAAa,IAAA,CAAK,MAAM,CAAA;AAAA,MACxC,CAAA,MAAA,IAAW,OAAO,SAAA,EAAW;AAC3B,QAAA,OAAO,MAAA,CAAO,SAAA,CAAU,MAAA,CAAO,IAAA,CAAK,OAAO,SAAS,CAAA;AAAA,MACtD;AAAA,IACF;AACA,IAAA,IAAI,MAAA,CAAO,SAAS,QAAA,EAAU;AAC5B,MAAA,OAAO,MAAA,CAAO,OAAA,CAAQ,QAAA,CAAS,IAAA,CAAK,OAAO,OAAO,CAAA;AAAA,IACpD;AAAA,EACF;AAEA,EAAA,OAAO,MAAM,kBAAA;AACf;AAEA,SAAS,UAAU,UAAA,EAAoD;AACrE,EAAA,IAAI,eAAe,SAAA,EAAW;AAC5B,IAAA,OAAO,gBAAA;AAAA,EACT;AACA,EAAA,IAAI,eAAe,IAAA,EAAM;AACvB,IAAA,OAAO,oBAAA;AAAA,EACT;AACA,EAAA,OAAO,UAAA;AACT;AAEA,SAAS,OAAA,CAAQ,EAAA,EAAwB,SAAA,EAAoB,KAAA,EAAoC;AAG/F,EAAA,IAAI,aAAa,EAAA,EAAI;AACnB,IAAA,OAAO,KAAA,GAAQ,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,EAAE,CAAA,CAAA,EAAI,KAAK,CAAA,CAAA,GAAK,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,EAAE,CAAA,CAAA;AAAA,EACnE;AACA,EAAA,OAAO,EAAA;AACT;AAEA,SAAS,iBAAiB,OAAA,EAAsD;AAC9E,EAAA,MAAM,KAAA,GAAQ,SAAS,OAAA,EAAS,KAAA;AAChC,EAAA,IAAI,KAAA,IAAS,OAAO,KAAA,KAAU,QAAA,EAAU;AACtC,IAAA,OAAO,iBAAiB,KAAoB,CAAA;AAAA,EAC9C;AACA,EAAA,OAAO,OAAO,KAAA,KAAU,QAAA,GAAW,KAAA,GAAQ,MAAA;AAC7C;AAEA,SAAS,oCAAoC,gBAAA,EAA0D;AACrG,EAAA,IAAI,CAAC,gBAAA,EAAkB;AACrB,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,IAAI;AACF,IAAA,MAAM,EAAA,GAAK,IAAI,GAAA,CAAI,gBAAgB,EAAE,QAAA,EAAU,OAAA,CAAQ,OAAO,EAAE,CAAA;AAChE,IAAA,OAAO,EAAA,IAAM,KAAA,CAAA;AAAA,EACf,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,MAAA;AAAA,EACT;AACF;AAEA,SAAS,gCAAgC,gBAAA,EAA0D;AACjG,EAAA,IAAI,CAAC,gBAAA,EAAkB;AACrB,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,IAAI;AACF,IAAA,OAAO,IAAI,GAAA,CAAI,gBAAgB,CAAA,CAAE,QAAA,IAAY,KAAA,CAAA;AAAA,EAC/C,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,MAAA;AAAA,EACT;AACF;AAEA,SAAS,gCAAgC,gBAAA,EAA0D;AACjG,EAAA,IAAI,CAAC,gBAAA,EAAkB;AACrB,IAAA,OAAO,MAAA;AAAA,EACT;AACA,EAAA,IAAI;AACF,IAAA,MAAM,IAAA,GAAO,IAAI,GAAA,CAAI,gBAAgB,CAAA,CAAE,IAAA;AACvC,IAAA,OAAO,IAAA,GAAO,QAAA,CAAS,IAAA,EAAM,EAAE,CAAA,GAAI,KAAA,CAAA;AAAA,EACrC,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,MAAA;AAAA,EACT;AACF;AASO,MAAM,sBAAA,GAAyB,kBAAkB,uBAAuB;;;;"}

package/build/esm/integrations/tracing-channel/koa.js

@@ -0,0 +1,144 @@
+import * as diagnosticsChannel from 'node:diagnostics_channel';
+import { defineIntegration, debug, getActiveSpan, startSpan, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, getIsolationScope, getDefaultIsolationScope, getRootSpan, spanToJSON, SEMANTIC_ATTRIBUTE_SENTRY_OP } from '@sentry/core';
+import { KOA_NAME, HTTP_ROUTE, KOA_TYPE, CODE_FUNCTION_NAME } from '@sentry/conventions/attributes';
+import { DEBUG_BUILD } from '../../debug-build.js';
+import { CHANNELS } from '../../orchestrion/channels.js';
+
+const INTEGRATION_NAME = "Koa";
+const ORIGIN = "auto.http.orchestrion.koa";
+const LAYER_TYPE = {
+  ROUTER: "router",
+  MIDDLEWARE: "middleware"
+};
+const kLayerPatched = /* @__PURE__ */ Symbol("sentry.koa.layer-patched");
+let subscribed = false;
+const _koaChannelIntegration = ((options = {}) => {
+  const ignoreLayersType = options.ignoreLayersType ?? [];
+  return {
+    name: INTEGRATION_NAME,
+    setupOnce() {
+      if (!diagnosticsChannel.tracingChannel || subscribed) {
+        return;
+      }
+      subscribed = true;
+      DEBUG_BUILD && debug.log(`[orchestrion:koa] subscribing to channel "${CHANNELS.KOA_USE}"`);
+      diagnosticsChannel.tracingChannel(CHANNELS.KOA_USE).subscribe({
+        start(rawCtx) {
+          handleUse(rawCtx, ignoreLayersType);
+        },
+        end() {
+        },
+        asyncStart() {
+        },
+        asyncEnd() {
+        },
+        error() {
+        }
+      });
+    }
+  };
+});
+function handleUse(ctx, ignoreLayersType) {
+  const middleware = ctx.arguments[0];
+  if (typeof middleware === "function") {
+    ctx.arguments[0] = patchUse(middleware, ignoreLayersType);
+  }
+}
+function patchUse(middleware, ignoreLayersType) {
+  return middleware.router ? patchRouterDispatch(middleware, ignoreLayersType) : patchLayer(middleware, false, ignoreLayersType);
+}
+function patchRouterDispatch(dispatchLayer, ignoreLayersType) {
+  const router = dispatchLayer.router;
+  const routesStack = router?.stack ?? [];
+  for (const pathLayer of routesStack) {
+    const path = pathLayer.path;
+    const pathStack = pathLayer.stack;
+    pathStack.forEach((routedMiddleware, j) => {
+      pathStack[j] = patchLayer(routedMiddleware, true, ignoreLayersType, path);
+    });
+  }
+  return dispatchLayer;
+}
+function patchLayer(middlewareLayer, isRouter, ignoreLayersType, layerPath) {
+  const layerType = isRouter ? LAYER_TYPE.ROUTER : LAYER_TYPE.MIDDLEWARE;
+  if (middlewareLayer[kLayerPatched] === true || ignoreLayersType.includes(layerType)) {
+    return middlewareLayer;
+  }
+  if (middlewareLayer.constructor.name === "GeneratorFunction" || middlewareLayer.constructor.name === "AsyncGeneratorFunction") {
+    return middlewareLayer;
+  }
+  middlewareLayer[kLayerPatched] = true;
+  return (context, next) => {
+    if (!getActiveSpan()) {
+      return middlewareLayer(context, next);
+    }
+    const metadata = getMiddlewareMetadata(context, middlewareLayer, isRouter, layerPath);
+    if (context._matchedRoute) {
+      setHttpServerSpanRouteAttribute(context._matchedRoute.toString());
+    }
+    const koaName = metadata.attributes[KOA_NAME];
+    const name = typeof koaName === "string" ? koaName || "< unknown >" : metadata.name;
+    return startSpan(
+      {
+        name,
+        op: `${layerType}.koa`,
+        attributes: {
+          ...metadata.attributes,
+          [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN
+        }
+      },
+      () => {
+        const route = metadata.attributes[HTTP_ROUTE];
+        if (getIsolationScope() === getDefaultIsolationScope()) {
+          DEBUG_BUILD && debug.warn("Isolation scope is default isolation scope - skipping setting transactionName");
+        } else if (route) {
+          const method = context.request?.method?.toUpperCase() || "GET";
+          getIsolationScope().setTransactionName(`${method} ${route}`);
+        }
+        return middlewareLayer(context, next);
+      }
+    );
+  };
+}
+function getMiddlewareMetadata(context, layer, isRouter, layerPath) {
+  if (isRouter) {
+    return {
+      attributes: {
+        // oxlint-disable-next-line typescript/no-deprecated
+        [KOA_NAME]: layerPath?.toString(),
+        // TODO(v11): remove, replaced by http.route
+        [KOA_TYPE]: LAYER_TYPE.ROUTER,
+        [HTTP_ROUTE]: layerPath?.toString()
+      },
+      name: context._matchedRouteName || `router - ${layerPath}`
+    };
+  }
+  return {
+    attributes: {
+      // oxlint-disable-next-line typescript/no-deprecated
+      [KOA_NAME]: layer.name || "middleware",
+      // TODO(v11): remove, replaced by code.function.name
+      [KOA_TYPE]: LAYER_TYPE.MIDDLEWARE,
+      [CODE_FUNCTION_NAME]: layer.name || "middleware"
+    },
+    name: `middleware - ${layer.name}`
+  };
+}
+function setHttpServerSpanRouteAttribute(route) {
+  const activeSpan = getActiveSpan();
+  if (!activeSpan) {
+    return;
+  }
+  const rootSpan = getRootSpan(activeSpan);
+  if (!rootSpan) {
+    return;
+  }
+  if (spanToJSON(rootSpan).data[SEMANTIC_ATTRIBUTE_SENTRY_OP] !== "http.server") {
+    return;
+  }
+  rootSpan.setAttribute(HTTP_ROUTE, route);
+}
+const koaChannelIntegration = defineIntegration(_koaChannelIntegration);
+
+export { koaChannelIntegration };
+//# sourceMappingURL=koa.js.map

package/build/esm/integrations/tracing-channel/koa.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"koa.js","sources":["../../../../src/integrations/tracing-channel/koa.ts"],"sourcesContent":["import * as diagnosticsChannel from 'node:diagnostics_channel';\nimport type { IntegrationFn } from '@sentry/core';\nimport {\n  debug,\n  defineIntegration,\n  getActiveSpan,\n  getDefaultIsolationScope,\n  getIsolationScope,\n  getRootSpan,\n  SEMANTIC_ATTRIBUTE_SENTRY_OP,\n  SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,\n  spanToJSON,\n  startSpan,\n} from '@sentry/core';\n// oxlint-disable-next-line typescript/no-deprecated\nimport { CODE_FUNCTION_NAME, HTTP_ROUTE, KOA_NAME, KOA_TYPE } from '@sentry/conventions/attributes';\nimport { DEBUG_BUILD } from '../../debug-build';\nimport { CHANNELS } from '../../orchestrion/channels';\n\n// Same name as the OTel integration. When enabled, the OTel 'Koa' integration is omitted from the default set.\nconst INTEGRATION_NAME = 'Koa' as const;\n\nconst ORIGIN = 'auto.http.orchestrion.koa';\n\nconst LAYER_TYPE = {\n  ROUTER: 'router',\n  MIDDLEWARE: 'middleware',\n} as const;\ntype KoaLayerType = (typeof LAYER_TYPE)[keyof typeof LAYER_TYPE];\n\n// Keeps wrapping idempotent — the same middleware instance can be registered on\n// multiple routes (mirrors the vendored OTel instrumentation's symbol).\nconst kLayerPatched: unique symbol = Symbol('sentry.koa.layer-patched');\n\n// Core dedupes `setupOnce` by integration name, but the Deno SDK also runs this\n// under the name `DenoKoa` (via `extendIntegration`), so guard against a second\n// subscription here.\nlet subscribed = false;\n\ntype Next = () => Promise<unknown>;\n\ninterface KoaContext {\n  [key: string]: unknown;\n  _matchedRoute?: string | RegExp;\n  _matchedRouteName?: string;\n  request?: { method?: string };\n}\n\ninterface Layer {\n  path: string | RegExp;\n  stack: KoaMiddleware[];\n}\n\ninterface Router {\n  stack: Layer[];\n}\n\ntype KoaMiddleware = ((context: KoaContext, next: Next) => unknown) & {\n  router?: Router;\n  [kLayerPatched]?: boolean;\n};\n\ntype KoaSpanAttributes = Record<string, string | undefined>;\n\ninterface KoaMiddlewareMetadata {\n  attributes: KoaSpanAttributes;\n  name: string;\n}\n\ninterface KoaUseContext {\n  arguments: unknown[];\n}\n\nexport interface KoaChannelIntegrationOptions {\n  /** Ignore layers of the specified types (`'middleware'` and/or `'router'`). */\n  ignoreLayersType?: Array<'middleware' | 'router'>;\n}\n\nconst _koaChannelIntegration = ((options: KoaChannelIntegrationOptions = {}) => {\n  const ignoreLayersType = options.ignoreLayersType ?? [];\n\n  return {\n    name: INTEGRATION_NAME,\n    setupOnce() {\n      // `tracingChannel` is unavailable before Node 18.19 so do nothing in that case.\n      if (!diagnosticsChannel.tracingChannel || subscribed) {\n        return;\n      }\n      subscribed = true;\n      DEBUG_BUILD && debug.log(`[orchestrion:koa] subscribing to channel \"${CHANNELS.KOA_USE}\"`);\n\n      diagnosticsChannel.tracingChannel(CHANNELS.KOA_USE).subscribe({\n        start(rawCtx) {\n          handleUse(rawCtx as KoaUseContext, ignoreLayersType);\n        },\n        end() {},\n        asyncStart() {},\n        asyncEnd() {},\n        error() {},\n      });\n    },\n  };\n}) satisfies IntegrationFn;\n\nfunction handleUse(ctx: KoaUseContext, ignoreLayersType: KoaLayerType[]): void {\n  const middleware = ctx.arguments[0];\n  if (typeof middleware === 'function') {\n    ctx.arguments[0] = patchUse(middleware as KoaMiddleware, ignoreLayersType);\n  }\n}\n\n/**\n * Wrap a registered koa middleware. A `@koa/router` dispatch layer\n * (`router.routes()`) exposes a `.router`, in which case we patch each routed\n * middleware in its stack (in place) and leave the dispatch itself unwrapped;\n * everything else is a plain middleware.\n */\nfunction patchUse(middleware: KoaMiddleware, ignoreLayersType: KoaLayerType[]): KoaMiddleware {\n  return middleware.router\n    ? patchRouterDispatch(middleware, ignoreLayersType)\n    : patchLayer(middleware, false, ignoreLayersType);\n}\n\n/**\n * Patches the dispatch function used by `@koa/router`, wrapping each routed\n * middleware in the router's stack so routed spans carry their matched path.\n */\nfunction patchRouterDispatch(dispatchLayer: KoaMiddleware, ignoreLayersType: KoaLayerType[]): KoaMiddleware {\n  const router = dispatchLayer.router;\n  const routesStack = router?.stack ?? [];\n  for (const pathLayer of routesStack) {\n    const path = pathLayer.path;\n    const pathStack = pathLayer.stack;\n    pathStack.forEach((routedMiddleware, j) => {\n      pathStack[j] = patchLayer(routedMiddleware, true, ignoreLayersType, path);\n    });\n  }\n  return dispatchLayer;\n}\n\n/**\n * Wraps an individual middleware layer so it opens a span when invoked. No span\n * is created when there is no active (parent) span, matching the vendored OTel\n * instrumentation's `api.trace.getSpan(api.context.active())` guard.\n */\nfunction patchLayer(\n  middlewareLayer: KoaMiddleware,\n  isRouter: boolean,\n  ignoreLayersType: KoaLayerType[],\n  layerPath?: string | RegExp,\n): KoaMiddleware {\n  const layerType = isRouter ? LAYER_TYPE.ROUTER : LAYER_TYPE.MIDDLEWARE;\n  // Skip patching the layer if it's ignored by config or already wrapped.\n  if (middlewareLayer[kLayerPatched] === true || ignoreLayersType.includes(layerType)) {\n    return middlewareLayer;\n  }\n\n  if (\n    middlewareLayer.constructor.name === 'GeneratorFunction' ||\n    middlewareLayer.constructor.name === 'AsyncGeneratorFunction'\n  ) {\n    return middlewareLayer;\n  }\n\n  middlewareLayer[kLayerPatched] = true;\n\n  return (context: KoaContext, next: Next) => {\n    if (!getActiveSpan()) {\n      return middlewareLayer(context, next);\n    }\n    const metadata = getMiddlewareMetadata(context, middlewareLayer, isRouter, layerPath);\n\n    if (context._matchedRoute) {\n      setHttpServerSpanRouteAttribute(context._matchedRoute.toString());\n    }\n\n    // oxlint-disable-next-line typescript/no-deprecated\n    const koaName = metadata.attributes[KOA_NAME];\n    // Somehow, name is sometimes `''` for middleware spans.\n    // See: https://github.com/open-telemetry/opentelemetry-js-contrib/issues/2220\n    const name = typeof koaName === 'string' ? koaName || '< unknown >' : metadata.name;\n\n    return startSpan(\n      {\n        name,\n        op: `${layerType}.koa`,\n        attributes: {\n          ...metadata.attributes,\n          [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN,\n        },\n      },\n      () => {\n        const route = metadata.attributes[HTTP_ROUTE];\n        if (getIsolationScope() === getDefaultIsolationScope()) {\n          DEBUG_BUILD && debug.warn('Isolation scope is default isolation scope - skipping setting transactionName');\n        } else if (route) {\n          const method = context.request?.method?.toUpperCase() || 'GET';\n          getIsolationScope().setTransactionName(`${method} ${route}`);\n        }\n        return middlewareLayer(context, next);\n      },\n    );\n  };\n}\n\nfunction getMiddlewareMetadata(\n  context: KoaContext,\n  layer: KoaMiddleware,\n  isRouter: boolean,\n  layerPath?: string | RegExp,\n): KoaMiddlewareMetadata {\n  if (isRouter) {\n    return {\n      attributes: {\n        // oxlint-disable-next-line typescript/no-deprecated\n        [KOA_NAME]: layerPath?.toString(), // TODO(v11): remove, replaced by http.route\n        [KOA_TYPE]: LAYER_TYPE.ROUTER,\n        [HTTP_ROUTE]: layerPath?.toString(),\n      },\n      name: context._matchedRouteName || `router - ${layerPath}`,\n    };\n  }\n  return {\n    attributes: {\n      // oxlint-disable-next-line typescript/no-deprecated\n      [KOA_NAME]: layer.name || 'middleware', // TODO(v11): remove, replaced by code.function.name\n      [KOA_TYPE]: LAYER_TYPE.MIDDLEWARE,\n      [CODE_FUNCTION_NAME]: layer.name || 'middleware',\n    },\n    name: `middleware - ${layer.name}`,\n  };\n}\n\n/**\n * Set the `http.route` attribute on the root HTTP server span for the current trace.\n *\n * No-op when there is no active span, no root span, or the root span is not an\n * `http.server` span — so this can be called unconditionally without risking\n * attribute pollution on non-HTTP root spans.\n */\nfunction setHttpServerSpanRouteAttribute(route: string): void {\n  const activeSpan = getActiveSpan();\n  if (!activeSpan) {\n    return;\n  }\n  const rootSpan = getRootSpan(activeSpan);\n  if (!rootSpan) {\n    return;\n  }\n  if (spanToJSON(rootSpan).data[SEMANTIC_ATTRIBUTE_SENTRY_OP] !== 'http.server') {\n    return;\n  }\n  rootSpan.setAttribute(HTTP_ROUTE, route);\n}\n\n/**\n * EXPERIMENTAL — orchestrion-driven koa integration. Subscribes to the\n * `orchestrion:koa:use` channel injected into `Application.prototype.use` and\n * wraps each registered middleware/router layer in a span-creating proxy.\n * Requires the orchestrion runtime hook or bundler plugin.\n */\nexport const koaChannelIntegration = defineIntegration(_koaChannelIntegration);\n"],"names":[],"mappings":";;;;;;AAoBA,MAAM,gBAAA,GAAmB,KAAA;AAEzB,MAAM,MAAA,GAAS,2BAAA;AAEf,MAAM,UAAA,GAAa;AAAA,EACjB,MAAA,EAAQ,QAAA;AAAA,EACR,UAAA,EAAY;AACd,CAAA;AAKA,MAAM,aAAA,0BAAsC,0BAA0B,CAAA;AAKtE,IAAI,UAAA,GAAa,KAAA;AAyCjB,MAAM,sBAAA,IAA0B,CAAC,OAAA,GAAwC,EAAC,KAAM;AAC9E,EAAA,MAAM,gBAAA,GAAmB,OAAA,CAAQ,gBAAA,IAAoB,EAAC;AAEtD,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,gBAAA;AAAA,IACN,SAAA,GAAY;AAEV,MAAA,IAAI,CAAC,kBAAA,CAAmB,cAAA,IAAkB,UAAA,EAAY;AACpD,QAAA;AAAA,MACF;AACA,MAAA,UAAA,GAAa,IAAA;AACb,MAAA,WAAA,IAAe,KAAA,CAAM,GAAA,CAAI,CAAA,0CAAA,EAA6C,QAAA,CAAS,OAAO,CAAA,CAAA,CAAG,CAAA;AAEzF,MAAA,kBAAA,CAAmB,cAAA,CAAe,QAAA,CAAS,OAAO,CAAA,CAAE,SAAA,CAAU;AAAA,QAC5D,MAAM,MAAA,EAAQ;AACZ,UAAA,SAAA,CAAU,QAAyB,gBAAgB,CAAA;AAAA,QACrD,CAAA;AAAA,QACA,GAAA,GAAM;AAAA,QAAC,CAAA;AAAA,QACP,UAAA,GAAa;AAAA,QAAC,CAAA;AAAA,QACd,QAAA,GAAW;AAAA,QAAC,CAAA;AAAA,QACZ,KAAA,GAAQ;AAAA,QAAC;AAAA,OACV,CAAA;AAAA,IACH;AAAA,GACF;AACF,CAAA,CAAA;AAEA,SAAS,SAAA,CAAU,KAAoB,gBAAA,EAAwC;AAC7E,EAAA,MAAM,UAAA,GAAa,GAAA,CAAI,SAAA,CAAU,CAAC,CAAA;AAClC,EAAA,IAAI,OAAO,eAAe,UAAA,EAAY;AACpC,IAAA,GAAA,CAAI,SAAA,CAAU,CAAC,CAAA,GAAI,QAAA,CAAS,YAA6B,gBAAgB,CAAA;AAAA,EAC3E;AACF;AAQA,SAAS,QAAA,CAAS,YAA2B,gBAAA,EAAiD;AAC5F,EAAA,OAAO,UAAA,CAAW,SACd,mBAAA,CAAoB,UAAA,EAAY,gBAAgB,CAAA,GAChD,UAAA,CAAW,UAAA,EAAY,KAAA,EAAO,gBAAgB,CAAA;AACpD;AAMA,SAAS,mBAAA,CAAoB,eAA8B,gBAAA,EAAiD;AAC1G,EAAA,MAAM,SAAS,aAAA,CAAc,MAAA;AAC7B,EAAA,MAAM,WAAA,GAAc,MAAA,EAAQ,KAAA,IAAS,EAAC;AACtC,EAAA,KAAA,MAAW,aAAa,WAAA,EAAa;AACnC,IAAA,MAAM,OAAO,SAAA,CAAU,IAAA;AACvB,IAAA,MAAM,YAAY,SAAA,CAAU,KAAA;AAC5B,IAAA,SAAA,CAAU,OAAA,CAAQ,CAAC,gBAAA,EAAkB,CAAA,KAAM;AACzC,MAAA,SAAA,CAAU,CAAC,CAAA,GAAI,UAAA,CAAW,gBAAA,EAAkB,IAAA,EAAM,kBAAkB,IAAI,CAAA;AAAA,IAC1E,CAAC,CAAA;AAAA,EACH;AACA,EAAA,OAAO,aAAA;AACT;AAOA,SAAS,UAAA,CACP,eAAA,EACA,QAAA,EACA,gBAAA,EACA,SAAA,EACe;AACf,EAAA,MAAM,SAAA,GAAY,QAAA,GAAW,UAAA,CAAW,MAAA,GAAS,UAAA,CAAW,UAAA;AAE5D,EAAA,IAAI,gBAAgB,aAAa,CAAA,KAAM,QAAQ,gBAAA,CAAiB,QAAA,CAAS,SAAS,CAAA,EAAG;AACnF,IAAA,OAAO,eAAA;AAAA,EACT;AAEA,EAAA,IACE,gBAAgB,WAAA,CAAY,IAAA,KAAS,uBACrC,eAAA,CAAgB,WAAA,CAAY,SAAS,wBAAA,EACrC;AACA,IAAA,OAAO,eAAA;AAAA,EACT;AAEA,EAAA,eAAA,CAAgB,aAAa,CAAA,GAAI,IAAA;AAEjC,EAAA,OAAO,CAAC,SAAqB,IAAA,KAAe;AAC1C,IAAA,IAAI,CAAC,eAAc,EAAG;AACpB,MAAA,OAAO,eAAA,CAAgB,SAAS,IAAI,CAAA;AAAA,IACtC;AACA,IAAA,MAAM,QAAA,GAAW,qBAAA,CAAsB,OAAA,EAAS,eAAA,EAAiB,UAAU,SAAS,CAAA;AAEpF,IAAA,IAAI,QAAQ,aAAA,EAAe;AACzB,MAAA,+BAAA,CAAgC,OAAA,CAAQ,aAAA,CAAc,QAAA,EAAU,CAAA;AAAA,IAClE;AAGA,IAAA,MAAM,OAAA,GAAU,QAAA,CAAS,UAAA,CAAW,QAAQ,CAAA;AAG5C,IAAA,MAAM,OAAO,OAAO,OAAA,KAAY,QAAA,GAAW,OAAA,IAAW,gBAAgB,QAAA,CAAS,IAAA;AAE/E,IAAA,OAAO,SAAA;AAAA,MACL;AAAA,QACE,IAAA;AAAA,QACA,EAAA,EAAI,GAAG,SAAS,CAAA,IAAA,CAAA;AAAA,QAChB,UAAA,EAAY;AAAA,UACV,GAAG,QAAA,CAAS,UAAA;AAAA,UACZ,CAAC,gCAAgC,GAAG;AAAA;AACtC,OACF;AAAA,MACA,MAAM;AACJ,QAAA,MAAM,KAAA,GAAQ,QAAA,CAAS,UAAA,CAAW,UAAU,CAAA;AAC5C,QAAA,IAAI,iBAAA,EAAkB,KAAM,wBAAA,EAAyB,EAAG;AACtD,UAAA,WAAA,IAAe,KAAA,CAAM,KAAK,+EAA+E,CAAA;AAAA,QAC3G,WAAW,KAAA,EAAO;AAChB,UAAA,MAAM,MAAA,GAAS,OAAA,CAAQ,OAAA,EAAS,MAAA,EAAQ,aAAY,IAAK,KAAA;AACzD,UAAA,iBAAA,GAAoB,kBAAA,CAAmB,CAAA,EAAG,MAAM,CAAA,CAAA,EAAI,KAAK,CAAA,CAAE,CAAA;AAAA,QAC7D;AACA,QAAA,OAAO,eAAA,CAAgB,SAAS,IAAI,CAAA;AAAA,MACtC;AAAA,KACF;AAAA,EACF,CAAA;AACF;AAEA,SAAS,qBAAA,CACP,OAAA,EACA,KAAA,EACA,QAAA,EACA,SAAA,EACuB;AACvB,EAAA,IAAI,QAAA,EAAU;AACZ,IAAA,OAAO;AAAA,MACL,UAAA,EAAY;AAAA;AAAA,QAEV,CAAC,QAAQ,GAAG,SAAA,EAAW,QAAA,EAAS;AAAA;AAAA,QAChC,CAAC,QAAQ,GAAG,UAAA,CAAW,MAAA;AAAA,QACvB,CAAC,UAAU,GAAG,SAAA,EAAW,QAAA;AAAS,OACpC;AAAA,MACA,IAAA,EAAM,OAAA,CAAQ,iBAAA,IAAqB,CAAA,SAAA,EAAY,SAAS,CAAA;AAAA,KAC1D;AAAA,EACF;AACA,EAAA,OAAO;AAAA,IACL,UAAA,EAAY;AAAA;AAAA,MAEV,CAAC,QAAQ,GAAG,KAAA,CAAM,IAAA,IAAQ,YAAA;AAAA;AAAA,MAC1B,CAAC,QAAQ,GAAG,UAAA,CAAW,UAAA;AAAA,MACvB,CAAC,kBAAkB,GAAG,KAAA,CAAM,IAAA,IAAQ;AAAA,KACtC;AAAA,IACA,IAAA,EAAM,CAAA,aAAA,EAAgB,KAAA,CAAM,IAAI,CAAA;AAAA,GAClC;AACF;AASA,SAAS,gCAAgC,KAAA,EAAqB;AAC5D,EAAA,MAAM,aAAa,aAAA,EAAc;AACjC,EAAA,IAAI,CAAC,UAAA,EAAY;AACf,IAAA;AAAA,EACF;AACA,EAAA,MAAM,QAAA,GAAW,YAAY,UAAU,CAAA;AACvC,EAAA,IAAI,CAAC,QAAA,EAAU;AACb,IAAA;AAAA,EACF;AACA,EAAA,IAAI,WAAW,QAAQ,CAAA,CAAE,IAAA,CAAK,4BAA4B,MAAM,aAAA,EAAe;AAC7E,IAAA;AAAA,EACF;AACA,EAAA,QAAA,CAAS,YAAA,CAAa,YAAY,KAAK,CAAA;AACzC;AAQO,MAAM,qBAAA,GAAwB,kBAAkB,sBAAsB;;;;"}

package/build/esm/integrations/tracing-channel/langchain.js

@@ -0,0 +1,61 @@
+import * as diagnosticsChannel from 'node:diagnostics_channel';
+import { defineIntegration, LANGCHAIN_INTEGRATION_NAME, createLangChainCallbackHandler, debug, waitForTracingChannelBinding, _INTERNAL_mergeLangChainCallbackHandler, startInactiveSpan, _INTERNAL_getLangChainEmbeddingsSpanOptions, _INTERNAL_skipAiProviderWrapping, OPENAI_INTEGRATION_NAME, ANTHROPIC_AI_INTEGRATION_NAME, GOOGLE_GENAI_INTEGRATION_NAME } from '@sentry/core';
+import { DEBUG_BUILD } from '../../debug-build.js';
+import { CHANNELS } from '../../orchestrion/channels.js';
+import { langchainEmbeddingsChannels } from '../../orchestrion/config/langchain.js';
+import { bindTracingChannelToSpan } from '../../tracing-channel.js';
+
+const INTEGRATION_NAME = LANGCHAIN_INTEGRATION_NAME;
+const SKIPPED_PROVIDERS = [OPENAI_INTEGRATION_NAME, ANTHROPIC_AI_INTEGRATION_NAME, GOOGLE_GENAI_INTEGRATION_NAME];
+let subscribed = false;
+function markProvidersSkipped() {
+  _INTERNAL_skipAiProviderWrapping(SKIPPED_PROVIDERS);
+}
+const _langChainChannelIntegration = ((options = {}) => {
+  return {
+    name: INTEGRATION_NAME,
+    setupOnce() {
+      if (!diagnosticsChannel.tracingChannel || subscribed) {
+        return;
+      }
+      subscribed = true;
+      const sentryHandler = createLangChainCallbackHandler(options);
+      const injectHandler = (message) => {
+        markProvidersSkipped();
+        const args = message.arguments;
+        if (!Array.isArray(args)) {
+          return;
+        }
+        let callOptions = args[1];
+        if (!callOptions || typeof callOptions !== "object" || Array.isArray(callOptions)) {
+          callOptions = {};
+          args[1] = callOptions;
+        }
+        callOptions.callbacks = _INTERNAL_mergeLangChainCallbackHandler(callOptions.callbacks, sentryHandler);
+      };
+      for (const channelName of [CHANNELS.LANGCHAIN_CHAT_MODEL_INVOKE, CHANNELS.LANGCHAIN_CHAT_MODEL_STREAM]) {
+        DEBUG_BUILD && debug.log(`[orchestrion:langchain] subscribing to channel "${channelName}"`);
+        diagnosticsChannel.tracingChannel(channelName).start.subscribe(injectHandler);
+      }
+      waitForTracingChannelBinding(() => {
+        for (const channelName of langchainEmbeddingsChannels) {
+          DEBUG_BUILD && debug.log(`[orchestrion:langchain] subscribing to channel "${channelName}"`);
+          bindTracingChannelToSpan(
+            diagnosticsChannel.tracingChannel(channelName),
+            (data) => createEmbeddingsSpan(data, options),
+            { captureError: () => ({ mechanism: { handled: false, type: "auto.ai.langchain" } }) }
+          );
+        }
+      });
+    }
+  };
+});
+function createEmbeddingsSpan(data, options) {
+  markProvidersSkipped();
+  const input = (data.arguments ?? [])[0];
+  return startInactiveSpan(_INTERNAL_getLangChainEmbeddingsSpanOptions(data.self, input, options));
+}
+const langChainChannelIntegration = defineIntegration(_langChainChannelIntegration);
+
+export { langChainChannelIntegration };
+//# sourceMappingURL=langchain.js.map

package/build/esm/integrations/tracing-channel/langchain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"langchain.js","sources":["../../../../src/integrations/tracing-channel/langchain.ts"],"sourcesContent":["import * as diagnosticsChannel from 'node:diagnostics_channel';\nimport type { IntegrationFn, LangChainOptions, Span } from '@sentry/core';\nimport {\n  _INTERNAL_getLangChainEmbeddingsSpanOptions,\n  _INTERNAL_mergeLangChainCallbackHandler,\n  _INTERNAL_skipAiProviderWrapping,\n  ANTHROPIC_AI_INTEGRATION_NAME,\n  createLangChainCallbackHandler,\n  debug,\n  defineIntegration,\n  GOOGLE_GENAI_INTEGRATION_NAME,\n  LANGCHAIN_INTEGRATION_NAME,\n  OPENAI_INTEGRATION_NAME,\n  startInactiveSpan,\n  waitForTracingChannelBinding,\n} from '@sentry/core';\nimport { DEBUG_BUILD } from '../../debug-build';\nimport { CHANNELS } from '../../orchestrion/channels';\nimport { langchainEmbeddingsChannels } from '../../orchestrion/config/langchain';\nimport { bindTracingChannelToSpan } from '../../tracing-channel';\n\n// Same name as the OTel integration by design: when enabled, the OTel 'LangChain' integration is\n// dropped from the default set (see the Node opt-in loader).\nconst INTEGRATION_NAME = LANGCHAIN_INTEGRATION_NAME;\n\n// LangChain drives the underlying AI provider SDKs itself, so while it's active those providers must\n// not also instrument, or every call would produce two spans (mirrors the OTel path's skip list).\nconst SKIPPED_PROVIDERS = [OPENAI_INTEGRATION_NAME, ANTHROPIC_AI_INTEGRATION_NAME, GOOGLE_GENAI_INTEGRATION_NAME];\n\n// The chat-model channels carry the live args array of `invoke(input, options)` / `_streamIterator(input, options)`.\ninterface RunnableChannelContext {\n  arguments: unknown[];\n}\n\n// The embeddings channels carry the instance (`self`) and the `embedQuery(text)` / `embedDocuments(texts)` args.\ninterface EmbeddingsChannelContext {\n  self?: unknown;\n  arguments: unknown[];\n}\n\nlet subscribed = false;\n\n// Registered lazily on the first LangChain call (not at `setupOnce`) so a direct provider call made\n// before any LangChain call still gets its own span — matches the OTel patch-on-import timing. It\n// also stops the underlying SDK from double-instrumenting embeddings, whose `embedQuery`/\n// `embedDocuments` call the provider SDK (e.g. `openai`) internally.\nfunction markProvidersSkipped(): void {\n  _INTERNAL_skipAiProviderWrapping(SKIPPED_PROVIDERS);\n}\n\nconst _langChainChannelIntegration = ((options: LangChainOptions = {}) => {\n  return {\n    name: INTEGRATION_NAME,\n    setupOnce() {\n      // `tracingChannel` is unavailable before Node 18.19, and a second `init()` would double-subscribe.\n      if (!diagnosticsChannel.tracingChannel || subscribed) {\n        return;\n      }\n      subscribed = true;\n\n      // One stateful handler tracks spans across the whole run tree, just like the OTel path.\n      const sentryHandler = createLangChainCallbackHandler(options);\n\n      // Chat models: inject the Sentry callback handler into the call options (arg 1). LangChain's own\n      // callback dispatch then creates the spans, exactly as in the OTel path, so no span is opened\n      // here — a `start` subscriber (which also makes orchestrion wrap the function) is enough.\n      const injectHandler = (message: unknown): void => {\n        markProvidersSkipped();\n\n        const args = (message as RunnableChannelContext).arguments;\n        if (!Array.isArray(args)) {\n          return;\n        }\n\n        let callOptions = args[1] as Record<string, unknown> | undefined;\n        if (!callOptions || typeof callOptions !== 'object' || Array.isArray(callOptions)) {\n          callOptions = {};\n          args[1] = callOptions;\n        }\n\n        callOptions.callbacks = _INTERNAL_mergeLangChainCallbackHandler(callOptions.callbacks, sentryHandler);\n      };\n\n      for (const channelName of [CHANNELS.LANGCHAIN_CHAT_MODEL_INVOKE, CHANNELS.LANGCHAIN_CHAT_MODEL_STREAM]) {\n        DEBUG_BUILD && debug.log(`[orchestrion:langchain] subscribing to channel \"${channelName}\"`);\n        diagnosticsChannel.tracingChannel<RunnableChannelContext>(channelName).start.subscribe(injectHandler);\n      }\n\n      // Embeddings don't use the callback system — the OTel path wraps the method in its own span, so\n      // do the same here. `bindTracingChannelToSpan` needs the async-context binding that\n      // `initOpenTelemetry()` registers after `setupOnce`, so wait for it before subscribing.\n      waitForTracingChannelBinding(() => {\n        for (const channelName of langchainEmbeddingsChannels) {\n          DEBUG_BUILD && debug.log(`[orchestrion:langchain] subscribing to channel \"${channelName}\"`);\n          bindTracingChannelToSpan(\n            diagnosticsChannel.tracingChannel<EmbeddingsChannelContext>(channelName),\n            data => createEmbeddingsSpan(data, options),\n            { captureError: () => ({ mechanism: { handled: false, type: 'auto.ai.langchain' } }) },\n          );\n        }\n      });\n    },\n  };\n}) satisfies IntegrationFn;\n\nfunction createEmbeddingsSpan(data: EmbeddingsChannelContext, options: LangChainOptions): Span {\n  // `embedQuery`/`embedDocuments` call the provider SDK internally, so skip that SDK's own\n  // instrumentation before its channel fires (the producer runs at the embeddings channel's `start`).\n  markProvidersSkipped();\n\n  const input = (data.arguments ?? [])[0];\n\n  return startInactiveSpan(_INTERNAL_getLangChainEmbeddingsSpanOptions(data.self, input, options));\n}\n\n/**\n * EXPERIMENTAL — orchestrion-driven LangChain integration. Subscribes to the diagnostics_channels\n * injected into `@langchain/core`'s `BaseChatModel` (to inject the Sentry callback handler) and into\n * `@langchain/openai`'s embedding methods, so it requires the orchestrion runtime hook or bundler plugin.\n */\nexport const langChainChannelIntegration = defineIntegration(_langChainChannelIntegration);\n"],"names":[],"mappings":";;;;;;;AAuBA,MAAM,gBAAA,GAAmB,0BAAA;AAIzB,MAAM,iBAAA,GAAoB,CAAC,uBAAA,EAAyB,6BAAA,EAA+B,6BAA6B,CAAA;AAahH,IAAI,UAAA,GAAa,KAAA;AAMjB,SAAS,oBAAA,GAA6B;AACpC,EAAA,gCAAA,CAAiC,iBAAiB,CAAA;AACpD;AAEA,MAAM,4BAAA,IAAgC,CAAC,OAAA,GAA4B,EAAC,KAAM;AACxE,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,gBAAA;AAAA,IACN,SAAA,GAAY;AAEV,MAAA,IAAI,CAAC,kBAAA,CAAmB,cAAA,IAAkB,UAAA,EAAY;AACpD,QAAA;AAAA,MACF;AACA,MAAA,UAAA,GAAa,IAAA;AAGb,MAAA,MAAM,aAAA,GAAgB,+BAA+B,OAAO,CAAA;AAK5D,MAAA,MAAM,aAAA,GAAgB,CAAC,OAAA,KAA2B;AAChD,QAAA,oBAAA,EAAqB;AAErB,QAAA,MAAM,OAAQ,OAAA,CAAmC,SAAA;AACjD,QAAA,IAAI,CAAC,KAAA,CAAM,OAAA,CAAQ,IAAI,CAAA,EAAG;AACxB,UAAA;AAAA,QACF;AAEA,QAAA,IAAI,WAAA,GAAc,KAAK,CAAC,CAAA;AACxB,QAAA,IAAI,CAAC,eAAe,OAAO,WAAA,KAAgB,YAAY,KAAA,CAAM,OAAA,CAAQ,WAAW,CAAA,EAAG;AACjF,UAAA,WAAA,GAAc,EAAC;AACf,UAAA,IAAA,CAAK,CAAC,CAAA,GAAI,WAAA;AAAA,QACZ;AAEA,QAAA,WAAA,CAAY,SAAA,GAAY,uCAAA,CAAwC,WAAA,CAAY,SAAA,EAAW,aAAa,CAAA;AAAA,MACtG,CAAA;AAEA,MAAA,KAAA,MAAW,eAAe,CAAC,QAAA,CAAS,2BAAA,EAA6B,QAAA,CAAS,2BAA2B,CAAA,EAAG;AACtG,QAAA,WAAA,IAAe,KAAA,CAAM,GAAA,CAAI,CAAA,gDAAA,EAAmD,WAAW,CAAA,CAAA,CAAG,CAAA;AAC1F,QAAA,kBAAA,CAAmB,cAAA,CAAuC,WAAW,CAAA,CAAE,KAAA,CAAM,UAAU,aAAa,CAAA;AAAA,MACtG;AAKA,MAAA,4BAAA,CAA6B,MAAM;AACjC,QAAA,KAAA,MAAW,eAAe,2BAAA,EAA6B;AACrD,UAAA,WAAA,IAAe,KAAA,CAAM,GAAA,CAAI,CAAA,gDAAA,EAAmD,WAAW,CAAA,CAAA,CAAG,CAAA;AAC1F,UAAA,wBAAA;AAAA,YACE,kBAAA,CAAmB,eAAyC,WAAW,CAAA;AAAA,YACvE,CAAA,IAAA,KAAQ,oBAAA,CAAqB,IAAA,EAAM,OAAO,CAAA;AAAA,YAC1C,EAAE,YAAA,EAAc,OAAO,EAAE,SAAA,EAAW,EAAE,OAAA,EAAS,KAAA,EAAO,IAAA,EAAM,mBAAA,EAAoB,EAAE,CAAA;AAAG,WACvF;AAAA,QACF;AAAA,MACF,CAAC,CAAA;AAAA,IACH;AAAA,GACF;AACF,CAAA,CAAA;AAEA,SAAS,oBAAA,CAAqB,MAAgC,OAAA,EAAiC;AAG7F,EAAA,oBAAA,EAAqB;AAErB,EAAA,MAAM,KAAA,GAAA,CAAS,IAAA,CAAK,SAAA,IAAa,IAAI,CAAC,CAAA;AAEtC,EAAA,OAAO,kBAAkB,2CAAA,CAA4C,IAAA,CAAK,IAAA,EAAM,KAAA,EAAO,OAAO,CAAC,CAAA;AACjG;AAOO,MAAM,2BAAA,GAA8B,kBAAkB,4BAA4B;;;;"}