apitally 0.25.8 → 1.0.0-beta.1

package/dist/sentry.js

@@ -0,0 +1,79 @@
+import { createRequire } from "node:module";
+import { getRequestRecord, getServerSpan } from "./context.js";
+import { logDebug } from "./logger.js";
+import { resolvePackageEntryPath } from "./packageVersion.js";
+import { writeRequestAttribute } from "./requestAttributes.js";
+function installSentryEventIdRecording() {
+  try {
+    const client = getClientThroughPeerResolution() ?? getClientFromGlobalCarrier();
+    if (!client) {
+      logDebug("No Sentry client was detected");
+      return;
+    }
+    client.on("preprocessEvent", (event) => {
+      try {
+        if (typeof event.event_id !== "string" || !event.exception?.values?.length) {
+          return;
+        }
+        writeRequestAttribute(
+          getServerSpan(),
+          getRequestRecord(),
+          "apitally.exception.sentry_event_id",
+          event.event_id
+        );
+      } catch (error) {
+        logDebug(`Error writing the Sentry event id: ${String(error)}`);
+      }
+    });
+  } catch (error) {
+    logDebug(`Error setting up the Sentry integration: ${String(error)}`);
+  }
+}
+function getClientThroughPeerResolution() {
+  try {
+    const entryPath = resolvePackageEntryPath("@sentry/node");
+    const sentry = createRequire(entryPath)(entryPath);
+    return typeof sentry.getClient === "function" ? asSentryClient(sentry.getClient()) : void 0;
+  } catch {
+    return void 0;
+  }
+}
+function getClientFromGlobalCarrier() {
+  const carrier = globalThis.__SENTRY__;
+  if (!isRecord(carrier)) {
+    return void 0;
+  }
+  const hub = carrier.hub;
+  if (isRecord(hub) && typeof hub.getClient === "function") {
+    return asSentryClient(hub.getClient());
+  }
+  const versioned = typeof carrier.version === "string" ? carrier[carrier.version] : void 0;
+  if (!isRecord(versioned)) {
+    return void 0;
+  }
+  const acs = versioned.acs;
+  if (isRecord(acs) && typeof acs.getCurrentScope === "function") {
+    const scope = acs.getCurrentScope();
+    if (isRecord(scope) && typeof scope.getClient === "function") {
+      const client = asSentryClient(scope.getClient());
+      if (client) {
+        return client;
+      }
+    }
+  }
+  const defaultScope = versioned.defaultCurrentScope;
+  if (isRecord(defaultScope) && typeof defaultScope.getClient === "function") {
+    return asSentryClient(defaultScope.getClient());
+  }
+  return void 0;
+}
+function asSentryClient(value) {
+  return isRecord(value) && typeof value.on === "function" ? value : void 0;
+}
+function isRecord(value) {
+  return typeof value === "object" && value !== null;
+}
+export {
+  installSentryEventIdRecording
+};
+//# sourceMappingURL=sentry.js.map

package/dist/sentry.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/sentry.ts"],"sourcesContent":["import { createRequire } from \"node:module\";\nimport { getRequestRecord, getServerSpan } from \"./context.js\";\nimport { logDebug } from \"./logger.js\";\nimport { resolvePackageEntryPath } from \"./packageVersion.js\";\nimport { writeRequestAttribute } from \"./requestAttributes.js\";\n\n// Minimal structural types: @sentry/node is an optional peer that is resolved\n// at runtime and never imported.\ninterface SentryEvent {\n  event_id?: string;\n  exception?: { values?: unknown[] };\n}\n\ninterface SentryClient {\n  on(hook: \"preprocessEvent\", callback: (event: SentryEvent) => void): unknown;\n}\n\n// An initialized Sentry client opts in to recording exception event IDs on\n// active SERVER spans. Calls outside a request are no-ops.\nexport function installSentryEventIdRecording(): void {\n  try {\n    const client = getClientThroughPeerResolution() ?? getClientFromGlobalCarrier();\n    if (!client) {\n      logDebug(\"No Sentry client was detected\");\n      return;\n    }\n    // preprocessEvent runs before asynchronous event processors can outlive the request.\n    client.on(\"preprocessEvent\", (event) => {\n      try {\n        if (typeof event.event_id !== \"string\" || !event.exception?.values?.length) {\n          return;\n        }\n        writeRequestAttribute(\n          getServerSpan(),\n          getRequestRecord(),\n          \"apitally.exception.sentry_event_id\",\n          event.event_id,\n        );\n      } catch (error) {\n        logDebug(`Error writing the Sentry event id: ${String(error)}`);\n      }\n    });\n  } catch (error) {\n    logDebug(`Error setting up the Sentry integration: ${String(error)}`);\n  }\n}\n\n// getClient() resolves wherever @sentry/node is reachable, including as the\n// transitive dependency of a Sentry wrapper package on npm-style layouts.\nfunction getClientThroughPeerResolution(): SentryClient | undefined {\n  try {\n    const entryPath = resolvePackageEntryPath(\"@sentry/node\");\n    const sentry = createRequire(entryPath)(entryPath) as {\n      getClient?: () => unknown;\n    };\n    return typeof sentry.getClient === \"function\" ? asSentryClient(sentry.getClient()) : undefined;\n  } catch {\n    return undefined;\n  }\n}\n\n// Strict package layouts may prevent peer resolution. Sentry 7 to 10 still\n// expose initialized clients through two globalThis carrier shapes.\nfunction getClientFromGlobalCarrier(): SentryClient | undefined {\n  const carrier = (globalThis as { __SENTRY__?: unknown }).__SENTRY__;\n  if (!isRecord(carrier)) {\n    return undefined;\n  }\n  const hub = carrier.hub;\n  if (isRecord(hub) && typeof hub.getClient === \"function\") {\n    return asSentryClient(hub.getClient());\n  }\n  const versioned = typeof carrier.version === \"string\" ? carrier[carrier.version] : undefined;\n  if (!isRecord(versioned)) {\n    return undefined;\n  }\n  const acs = versioned.acs;\n  if (isRecord(acs) && typeof acs.getCurrentScope === \"function\") {\n    const scope: unknown = acs.getCurrentScope();\n    if (isRecord(scope) && typeof scope.getClient === \"function\") {\n      const client = asSentryClient(scope.getClient());\n      if (client) {\n        return client;\n      }\n    }\n  }\n  const defaultScope = versioned.defaultCurrentScope;\n  if (isRecord(defaultScope) && typeof defaultScope.getClient === \"function\") {\n    return asSentryClient(defaultScope.getClient());\n  }\n  return undefined;\n}\n\nfunction asSentryClient(value: unknown): SentryClient | undefined {\n  return isRecord(value) && typeof value.on === \"function\"\n    ? (value as unknown as SentryClient)\n    : undefined;\n}\n\nfunction isRecord(value: unknown): value is Record<string, unknown> {\n  return typeof value === \"object\" && value !== null;\n}\n"],"mappings":"AAAA,SAAS,qBAAqB;AAC9B,SAAS,kBAAkB,qBAAqB;AAChD,SAAS,gBAAgB;AACzB,SAAS,+BAA+B;AACxC,SAAS,6BAA6B;AAe/B,SAAS,gCAAsC;AACpD,MAAI;AACF,UAAM,SAAS,+BAA+B,KAAK,2BAA2B;AAC9E,QAAI,CAAC,QAAQ;AACX,eAAS,+BAA+B;AACxC;AAAA,IACF;AAEA,WAAO,GAAG,mBAAmB,CAAC,UAAU;AACtC,UAAI;AACF,YAAI,OAAO,MAAM,aAAa,YAAY,CAAC,MAAM,WAAW,QAAQ,QAAQ;AAC1E;AAAA,QACF;AACA;AAAA,UACE,cAAc;AAAA,UACd,iBAAiB;AAAA,UACjB;AAAA,UACA,MAAM;AAAA,QACR;AAAA,MACF,SAAS,OAAO;AACd,iBAAS,sCAAsC,OAAO,KAAK,CAAC,EAAE;AAAA,MAChE;AAAA,IACF,CAAC;AAAA,EACH,SAAS,OAAO;AACd,aAAS,4CAA4C,OAAO,KAAK,CAAC,EAAE;AAAA,EACtE;AACF;AAIA,SAAS,iCAA2D;AAClE,MAAI;AACF,UAAM,YAAY,wBAAwB,cAAc;AACxD,UAAM,SAAS,cAAc,SAAS,EAAE,SAAS;AAGjD,WAAO,OAAO,OAAO,cAAc,aAAa,eAAe,OAAO,UAAU,CAAC,IAAI;AAAA,EACvF,QAAQ;AACN,WAAO;AAAA,EACT;AACF;AAIA,SAAS,6BAAuD;AAC9D,QAAM,UAAW,WAAwC;AACzD,MAAI,CAAC,SAAS,OAAO,GAAG;AACtB,WAAO;AAAA,EACT;AACA,QAAM,MAAM,QAAQ;AACpB,MAAI,SAAS,GAAG,KAAK,OAAO,IAAI,cAAc,YAAY;AACxD,WAAO,eAAe,IAAI,UAAU,CAAC;AAAA,EACvC;AACA,QAAM,YAAY,OAAO,QAAQ,YAAY,WAAW,QAAQ,QAAQ,OAAO,IAAI;AACnF,MAAI,CAAC,SAAS,SAAS,GAAG;AACxB,WAAO;AAAA,EACT;AACA,QAAM,MAAM,UAAU;AACtB,MAAI,SAAS,GAAG,KAAK,OAAO,IAAI,oBAAoB,YAAY;AAC9D,UAAM,QAAiB,IAAI,gBAAgB;AAC3C,QAAI,SAAS,KAAK,KAAK,OAAO,MAAM,cAAc,YAAY;AAC5D,YAAM,SAAS,eAAe,MAAM,UAAU,CAAC;AAC/C,UAAI,QAAQ;AACV,eAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AACA,QAAM,eAAe,UAAU;AAC/B,MAAI,SAAS,YAAY,KAAK,OAAO,aAAa,cAAc,YAAY;AAC1E,WAAO,eAAe,aAAa,UAAU,CAAC;AAAA,EAChD;AACA,SAAO;AACT;AAEA,SAAS,eAAe,OAA0C;AAChE,SAAO,SAAS,KAAK,KAAK,OAAO,MAAM,OAAO,aACzC,QACD;AACN;AAEA,SAAS,SAAS,OAAkD;AAClE,SAAO,OAAO,UAAU,YAAY,UAAU;AAChD;","names":[]}

package/dist/serverErrors.cjs

@@ -0,0 +1,118 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var serverErrors_exports = {};
+__export(serverErrors_exports, {
+  SERVER_ERROR_EVENT_NAME: () => SERVER_ERROR_EVENT_NAME,
+  addServerError: () => addServerError,
+  drainServerErrors: () => drainServerErrors,
+  resetServerErrors: () => resetServerErrors
+});
+module.exports = __toCommonJS(serverErrors_exports);
+var import_exceptions = require('./exceptions.cjs');
+const SERVER_ERROR_EVENT_NAME = "apitally.request.server_error";
+const MAX_GROUPS = 100;
+const MAX_CONSUMER_LENGTH = 128;
+const MAX_PATH_LENGTH = 2e3;
+const MAX_TYPE_LENGTH = 256;
+const MAX_MESSAGE_LENGTH = 2048;
+const MAX_STACKTRACE_LENGTH = 65536;
+const MAX_COUNT = 2 ** 32 - 1;
+const MESSAGE_TRUNCATION_SUFFIX = "... (truncated)";
+const STACKTRACE_TRUNCATION_SUFFIX = "\n... (truncated) ...";
+const SERVER_ERROR_GROUPS_KEY = /* @__PURE__ */ Symbol.for("apitally.serverErrorGroups");
+const serverErrorGroupsHolder = globalThis;
+const serverErrorGroups = serverErrorGroupsHolder[SERVER_ERROR_GROUPS_KEY] ?? /* @__PURE__ */ new Map();
+serverErrorGroupsHolder[SERVER_ERROR_GROUPS_KEY] = serverErrorGroups;
+function addServerError(consumer, method, path, error, sentryEventId) {
+  method = method.toUpperCase();
+  if (method === "OPTIONS" || !path) {
+    return;
+  }
+  const exception = (0, import_exceptions.coerceToException)(error);
+  const { name, message, stack } = typeof exception === "string" ? { name: "", message: exception, stack: "" } : exception;
+  const group = {
+    method,
+    path: path.slice(0, MAX_PATH_LENGTH),
+    type: String(name ?? "").slice(0, MAX_TYPE_LENGTH),
+    message: formatMessage(message),
+    stacktrace: formatStacktrace(stack),
+    count: 1
+  };
+  if (consumer !== void 0) {
+    group.consumer = consumer.slice(0, MAX_CONSUMER_LENGTH);
+  }
+  if (sentryEventId !== void 0) {
+    group.sentry_event_id = sentryEventId;
+  }
+  const key = [
+    group.consumer ?? "",
+    group.method,
+    group.path,
+    group.type,
+    group.message,
+    group.stacktrace
+  ].join("\0");
+  const existing = serverErrorGroups.get(key);
+  if (existing) {
+    existing.count = Math.min(existing.count + 1, MAX_COUNT);
+    existing.sentry_event_id = group.sentry_event_id ?? existing.sentry_event_id;
+  } else if (serverErrorGroups.size < MAX_GROUPS) {
+    serverErrorGroups.set(key, group);
+  }
+}
+function drainServerErrors() {
+  const groups = [...serverErrorGroups.values()];
+  serverErrorGroups.clear();
+  return groups;
+}
+function resetServerErrors() {
+  serverErrorGroups.clear();
+}
+function formatMessage(message) {
+  const text = String(message ?? "").trim();
+  if (text.length <= MAX_MESSAGE_LENGTH) {
+    return text;
+  }
+  return text.slice(0, MAX_MESSAGE_LENGTH - MESSAGE_TRUNCATION_SUFFIX.length) + MESSAGE_TRUNCATION_SUFFIX;
+}
+function formatStacktrace(stack) {
+  const text = typeof stack === "string" ? stack.trim() : "";
+  if (text.length <= MAX_STACKTRACE_LENGTH) {
+    return text;
+  }
+  const cutoff = MAX_STACKTRACE_LENGTH - STACKTRACE_TRUNCATION_SUFFIX.length;
+  const lines = [];
+  let length = 0;
+  for (const line of text.split("\n")) {
+    if (length + line.length + 1 > cutoff) {
+      break;
+    }
+    lines.push(line);
+    length += line.length + 1;
+  }
+  return lines.join("\n") + STACKTRACE_TRUNCATION_SUFFIX;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  SERVER_ERROR_EVENT_NAME,
+  addServerError,
+  drainServerErrors,
+  resetServerErrors
+});
+//# sourceMappingURL=serverErrors.cjs.map

package/dist/serverErrors.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/serverErrors.ts"],"sourcesContent":["import type { AnyValueMap } from \"@opentelemetry/api-logs\";\nimport { coerceToException } from \"./exceptions.js\";\n\nexport const SERVER_ERROR_EVENT_NAME = \"apitally.request.server_error\";\n\nconst MAX_GROUPS = 100;\nconst MAX_CONSUMER_LENGTH = 128;\nconst MAX_PATH_LENGTH = 2_000;\nconst MAX_TYPE_LENGTH = 256;\nconst MAX_MESSAGE_LENGTH = 2_048;\nconst MAX_STACKTRACE_LENGTH = 65_536;\nconst MAX_COUNT = 2 ** 32 - 1;\nconst MESSAGE_TRUNCATION_SUFFIX = \"... (truncated)\";\nconst STACKTRACE_TRUNCATION_SUFFIX = \"\\n... (truncated) ...\";\n\ntype ServerErrorGroup = {\n  consumer?: string;\n  method: string;\n  path: string;\n  type: string;\n  message: string;\n  stacktrace: string;\n  count: number;\n  sentry_event_id?: string;\n};\n\nconst SERVER_ERROR_GROUPS_KEY = Symbol.for(\"apitally.serverErrorGroups\");\nconst serverErrorGroupsHolder = globalThis as Record<\n  symbol,\n  Map<string, ServerErrorGroup> | undefined\n>;\nconst serverErrorGroups =\n  serverErrorGroupsHolder[SERVER_ERROR_GROUPS_KEY] ?? new Map<string, ServerErrorGroup>();\nserverErrorGroupsHolder[SERVER_ERROR_GROUPS_KEY] = serverErrorGroups;\n\nexport function addServerError(\n  consumer: string | undefined,\n  method: string,\n  path: string,\n  error: unknown,\n  sentryEventId: string | undefined,\n): void {\n  method = method.toUpperCase();\n  if (method === \"OPTIONS\" || !path) {\n    return;\n  }\n  const exception = coerceToException(error);\n  const { name, message, stack } =\n    typeof exception === \"string\"\n      ? { name: \"\", message: exception, stack: \"\" }\n      : (exception as { name?: unknown; message?: unknown; stack?: unknown });\n  const group: ServerErrorGroup = {\n    method,\n    path: path.slice(0, MAX_PATH_LENGTH),\n    type: String(name ?? \"\").slice(0, MAX_TYPE_LENGTH),\n    message: formatMessage(message),\n    stacktrace: formatStacktrace(stack),\n    count: 1,\n  };\n  if (consumer !== undefined) {\n    group.consumer = consumer.slice(0, MAX_CONSUMER_LENGTH);\n  }\n  if (sentryEventId !== undefined) {\n    group.sentry_event_id = sentryEventId;\n  }\n  const key = [\n    group.consumer ?? \"\",\n    group.method,\n    group.path,\n    group.type,\n    group.message,\n    group.stacktrace,\n  ].join(\"\\0\");\n  const existing = serverErrorGroups.get(key);\n  if (existing) {\n    existing.count = Math.min(existing.count + 1, MAX_COUNT);\n    existing.sentry_event_id = group.sentry_event_id ?? existing.sentry_event_id;\n  } else if (serverErrorGroups.size < MAX_GROUPS) {\n    serverErrorGroups.set(key, group);\n  }\n}\n\nexport function drainServerErrors(): AnyValueMap[] {\n  const groups = [...serverErrorGroups.values()];\n  serverErrorGroups.clear();\n  return groups;\n}\n\nexport function resetServerErrors(): void {\n  serverErrorGroups.clear();\n}\n\nfunction formatMessage(message: unknown): string {\n  const text = String(message ?? \"\").trim();\n  if (text.length <= MAX_MESSAGE_LENGTH) {\n    return text;\n  }\n  return (\n    text.slice(0, MAX_MESSAGE_LENGTH - MESSAGE_TRUNCATION_SUFFIX.length) + MESSAGE_TRUNCATION_SUFFIX\n  );\n}\n\n// The error line and innermost frames come first in a JS stack, so the head is kept.\nfunction formatStacktrace(stack: unknown): string {\n  const text = typeof stack === \"string\" ? stack.trim() : \"\";\n  if (text.length <= MAX_STACKTRACE_LENGTH) {\n    return text;\n  }\n  const cutoff = MAX_STACKTRACE_LENGTH - STACKTRACE_TRUNCATION_SUFFIX.length;\n  const lines: string[] = [];\n  let length = 0;\n  for (const line of text.split(\"\\n\")) {\n    if (length + line.length + 1 > cutoff) {\n      break;\n    }\n    lines.push(line);\n    length += line.length + 1;\n  }\n  return lines.join(\"\\n\") + STACKTRACE_TRUNCATION_SUFFIX;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,wBAAkC;AAE3B,MAAM,0BAA0B;AAEvC,MAAM,aAAa;AACnB,MAAM,sBAAsB;AAC5B,MAAM,kBAAkB;AACxB,MAAM,kBAAkB;AACxB,MAAM,qBAAqB;AAC3B,MAAM,wBAAwB;AAC9B,MAAM,YAAY,KAAK,KAAK;AAC5B,MAAM,4BAA4B;AAClC,MAAM,+BAA+B;AAarC,MAAM,0BAA0B,uBAAO,IAAI,4BAA4B;AACvE,MAAM,0BAA0B;AAIhC,MAAM,oBACJ,wBAAwB,uBAAuB,KAAK,oBAAI,IAA8B;AACxF,wBAAwB,uBAAuB,IAAI;AAE5C,SAAS,eACd,UACA,QACA,MACA,OACA,eACM;AACN,WAAS,OAAO,YAAY;AAC5B,MAAI,WAAW,aAAa,CAAC,MAAM;AACjC;AAAA,EACF;AACA,QAAM,gBAAY,qCAAkB,KAAK;AACzC,QAAM,EAAE,MAAM,SAAS,MAAM,IAC3B,OAAO,cAAc,WACjB,EAAE,MAAM,IAAI,SAAS,WAAW,OAAO,GAAG,IACzC;AACP,QAAM,QAA0B;AAAA,IAC9B;AAAA,IACA,MAAM,KAAK,MAAM,GAAG,eAAe;AAAA,IACnC,MAAM,OAAO,QAAQ,EAAE,EAAE,MAAM,GAAG,eAAe;AAAA,IACjD,SAAS,cAAc,OAAO;AAAA,IAC9B,YAAY,iBAAiB,KAAK;AAAA,IAClC,OAAO;AAAA,EACT;AACA,MAAI,aAAa,QAAW;AAC1B,UAAM,WAAW,SAAS,MAAM,GAAG,mBAAmB;AAAA,EACxD;AACA,MAAI,kBAAkB,QAAW;AAC/B,UAAM,kBAAkB;AAAA,EAC1B;AACA,QAAM,MAAM;AAAA,IACV,MAAM,YAAY;AAAA,IAClB,MAAM;AAAA,IACN,MAAM;AAAA,IACN,MAAM;AAAA,IACN,MAAM;AAAA,IACN,MAAM;AAAA,EACR,EAAE,KAAK,IAAI;AACX,QAAM,WAAW,kBAAkB,IAAI,GAAG;AAC1C,MAAI,UAAU;AACZ,aAAS,QAAQ,KAAK,IAAI,SAAS,QAAQ,GAAG,SAAS;AACvD,aAAS,kBAAkB,MAAM,mBAAmB,SAAS;AAAA,EAC/D,WAAW,kBAAkB,OAAO,YAAY;AAC9C,sBAAkB,IAAI,KAAK,KAAK;AAAA,EAClC;AACF;AAEO,SAAS,oBAAmC;AACjD,QAAM,SAAS,CAAC,GAAG,kBAAkB,OAAO,CAAC;AAC7C,oBAAkB,MAAM;AACxB,SAAO;AACT;AAEO,SAAS,oBAA0B;AACxC,oBAAkB,MAAM;AAC1B;AAEA,SAAS,cAAc,SAA0B;AAC/C,QAAM,OAAO,OAAO,WAAW,EAAE,EAAE,KAAK;AACxC,MAAI,KAAK,UAAU,oBAAoB;AACrC,WAAO;AAAA,EACT;AACA,SACE,KAAK,MAAM,GAAG,qBAAqB,0BAA0B,MAAM,IAAI;AAE3E;AAGA,SAAS,iBAAiB,OAAwB;AAChD,QAAM,OAAO,OAAO,UAAU,WAAW,MAAM,KAAK,IAAI;AACxD,MAAI,KAAK,UAAU,uBAAuB;AACxC,WAAO;AAAA,EACT;AACA,QAAM,SAAS,wBAAwB,6BAA6B;AACpE,QAAM,QAAkB,CAAC;AACzB,MAAI,SAAS;AACb,aAAW,QAAQ,KAAK,MAAM,IAAI,GAAG;AACnC,QAAI,SAAS,KAAK,SAAS,IAAI,QAAQ;AACrC;AAAA,IACF;AACA,UAAM,KAAK,IAAI;AACf,cAAU,KAAK,SAAS;AAAA,EAC1B;AACA,SAAO,MAAM,KAAK,IAAI,IAAI;AAC5B;","names":[]}

package/dist/serverErrors.d.cts

@@ -0,0 +1,8 @@
+import { AnyValueMap } from '@opentelemetry/api-logs';
+
+declare const SERVER_ERROR_EVENT_NAME = "apitally.request.server_error";
+declare function addServerError(consumer: string | undefined, method: string, path: string, error: unknown, sentryEventId: string | undefined): void;
+declare function drainServerErrors(): AnyValueMap[];
+declare function resetServerErrors(): void;
+
+export { SERVER_ERROR_EVENT_NAME, addServerError, drainServerErrors, resetServerErrors };

package/dist/serverErrors.d.ts

@@ -0,0 +1,8 @@
+import { AnyValueMap } from '@opentelemetry/api-logs';
+
+declare const SERVER_ERROR_EVENT_NAME = "apitally.request.server_error";
+declare function addServerError(consumer: string | undefined, method: string, path: string, error: unknown, sentryEventId: string | undefined): void;
+declare function drainServerErrors(): AnyValueMap[];
+declare function resetServerErrors(): void;
+
+export { SERVER_ERROR_EVENT_NAME, addServerError, drainServerErrors, resetServerErrors };

package/dist/serverErrors.js

@@ -0,0 +1,91 @@
+import { coerceToException } from "./exceptions.js";
+const SERVER_ERROR_EVENT_NAME = "apitally.request.server_error";
+const MAX_GROUPS = 100;
+const MAX_CONSUMER_LENGTH = 128;
+const MAX_PATH_LENGTH = 2e3;
+const MAX_TYPE_LENGTH = 256;
+const MAX_MESSAGE_LENGTH = 2048;
+const MAX_STACKTRACE_LENGTH = 65536;
+const MAX_COUNT = 2 ** 32 - 1;
+const MESSAGE_TRUNCATION_SUFFIX = "... (truncated)";
+const STACKTRACE_TRUNCATION_SUFFIX = "\n... (truncated) ...";
+const SERVER_ERROR_GROUPS_KEY = /* @__PURE__ */ Symbol.for("apitally.serverErrorGroups");
+const serverErrorGroupsHolder = globalThis;
+const serverErrorGroups = serverErrorGroupsHolder[SERVER_ERROR_GROUPS_KEY] ?? /* @__PURE__ */ new Map();
+serverErrorGroupsHolder[SERVER_ERROR_GROUPS_KEY] = serverErrorGroups;
+function addServerError(consumer, method, path, error, sentryEventId) {
+  method = method.toUpperCase();
+  if (method === "OPTIONS" || !path) {
+    return;
+  }
+  const exception = coerceToException(error);
+  const { name, message, stack } = typeof exception === "string" ? { name: "", message: exception, stack: "" } : exception;
+  const group = {
+    method,
+    path: path.slice(0, MAX_PATH_LENGTH),
+    type: String(name ?? "").slice(0, MAX_TYPE_LENGTH),
+    message: formatMessage(message),
+    stacktrace: formatStacktrace(stack),
+    count: 1
+  };
+  if (consumer !== void 0) {
+    group.consumer = consumer.slice(0, MAX_CONSUMER_LENGTH);
+  }
+  if (sentryEventId !== void 0) {
+    group.sentry_event_id = sentryEventId;
+  }
+  const key = [
+    group.consumer ?? "",
+    group.method,
+    group.path,
+    group.type,
+    group.message,
+    group.stacktrace
+  ].join("\0");
+  const existing = serverErrorGroups.get(key);
+  if (existing) {
+    existing.count = Math.min(existing.count + 1, MAX_COUNT);
+    existing.sentry_event_id = group.sentry_event_id ?? existing.sentry_event_id;
+  } else if (serverErrorGroups.size < MAX_GROUPS) {
+    serverErrorGroups.set(key, group);
+  }
+}
+function drainServerErrors() {
+  const groups = [...serverErrorGroups.values()];
+  serverErrorGroups.clear();
+  return groups;
+}
+function resetServerErrors() {
+  serverErrorGroups.clear();
+}
+function formatMessage(message) {
+  const text = String(message ?? "").trim();
+  if (text.length <= MAX_MESSAGE_LENGTH) {
+    return text;
+  }
+  return text.slice(0, MAX_MESSAGE_LENGTH - MESSAGE_TRUNCATION_SUFFIX.length) + MESSAGE_TRUNCATION_SUFFIX;
+}
+function formatStacktrace(stack) {
+  const text = typeof stack === "string" ? stack.trim() : "";
+  if (text.length <= MAX_STACKTRACE_LENGTH) {
+    return text;
+  }
+  const cutoff = MAX_STACKTRACE_LENGTH - STACKTRACE_TRUNCATION_SUFFIX.length;
+  const lines = [];
+  let length = 0;
+  for (const line of text.split("\n")) {
+    if (length + line.length + 1 > cutoff) {
+      break;
+    }
+    lines.push(line);
+    length += line.length + 1;
+  }
+  return lines.join("\n") + STACKTRACE_TRUNCATION_SUFFIX;
+}
+export {
+  SERVER_ERROR_EVENT_NAME,
+  addServerError,
+  drainServerErrors,
+  resetServerErrors
+};
+//# sourceMappingURL=serverErrors.js.map

package/dist/serverErrors.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/serverErrors.ts"],"sourcesContent":["import type { AnyValueMap } from \"@opentelemetry/api-logs\";\nimport { coerceToException } from \"./exceptions.js\";\n\nexport const SERVER_ERROR_EVENT_NAME = \"apitally.request.server_error\";\n\nconst MAX_GROUPS = 100;\nconst MAX_CONSUMER_LENGTH = 128;\nconst MAX_PATH_LENGTH = 2_000;\nconst MAX_TYPE_LENGTH = 256;\nconst MAX_MESSAGE_LENGTH = 2_048;\nconst MAX_STACKTRACE_LENGTH = 65_536;\nconst MAX_COUNT = 2 ** 32 - 1;\nconst MESSAGE_TRUNCATION_SUFFIX = \"... (truncated)\";\nconst STACKTRACE_TRUNCATION_SUFFIX = \"\\n... (truncated) ...\";\n\ntype ServerErrorGroup = {\n  consumer?: string;\n  method: string;\n  path: string;\n  type: string;\n  message: string;\n  stacktrace: string;\n  count: number;\n  sentry_event_id?: string;\n};\n\nconst SERVER_ERROR_GROUPS_KEY = Symbol.for(\"apitally.serverErrorGroups\");\nconst serverErrorGroupsHolder = globalThis as Record<\n  symbol,\n  Map<string, ServerErrorGroup> | undefined\n>;\nconst serverErrorGroups =\n  serverErrorGroupsHolder[SERVER_ERROR_GROUPS_KEY] ?? new Map<string, ServerErrorGroup>();\nserverErrorGroupsHolder[SERVER_ERROR_GROUPS_KEY] = serverErrorGroups;\n\nexport function addServerError(\n  consumer: string | undefined,\n  method: string,\n  path: string,\n  error: unknown,\n  sentryEventId: string | undefined,\n): void {\n  method = method.toUpperCase();\n  if (method === \"OPTIONS\" || !path) {\n    return;\n  }\n  const exception = coerceToException(error);\n  const { name, message, stack } =\n    typeof exception === \"string\"\n      ? { name: \"\", message: exception, stack: \"\" }\n      : (exception as { name?: unknown; message?: unknown; stack?: unknown });\n  const group: ServerErrorGroup = {\n    method,\n    path: path.slice(0, MAX_PATH_LENGTH),\n    type: String(name ?? \"\").slice(0, MAX_TYPE_LENGTH),\n    message: formatMessage(message),\n    stacktrace: formatStacktrace(stack),\n    count: 1,\n  };\n  if (consumer !== undefined) {\n    group.consumer = consumer.slice(0, MAX_CONSUMER_LENGTH);\n  }\n  if (sentryEventId !== undefined) {\n    group.sentry_event_id = sentryEventId;\n  }\n  const key = [\n    group.consumer ?? \"\",\n    group.method,\n    group.path,\n    group.type,\n    group.message,\n    group.stacktrace,\n  ].join(\"\\0\");\n  const existing = serverErrorGroups.get(key);\n  if (existing) {\n    existing.count = Math.min(existing.count + 1, MAX_COUNT);\n    existing.sentry_event_id = group.sentry_event_id ?? existing.sentry_event_id;\n  } else if (serverErrorGroups.size < MAX_GROUPS) {\n    serverErrorGroups.set(key, group);\n  }\n}\n\nexport function drainServerErrors(): AnyValueMap[] {\n  const groups = [...serverErrorGroups.values()];\n  serverErrorGroups.clear();\n  return groups;\n}\n\nexport function resetServerErrors(): void {\n  serverErrorGroups.clear();\n}\n\nfunction formatMessage(message: unknown): string {\n  const text = String(message ?? \"\").trim();\n  if (text.length <= MAX_MESSAGE_LENGTH) {\n    return text;\n  }\n  return (\n    text.slice(0, MAX_MESSAGE_LENGTH - MESSAGE_TRUNCATION_SUFFIX.length) + MESSAGE_TRUNCATION_SUFFIX\n  );\n}\n\n// The error line and innermost frames come first in a JS stack, so the head is kept.\nfunction formatStacktrace(stack: unknown): string {\n  const text = typeof stack === \"string\" ? stack.trim() : \"\";\n  if (text.length <= MAX_STACKTRACE_LENGTH) {\n    return text;\n  }\n  const cutoff = MAX_STACKTRACE_LENGTH - STACKTRACE_TRUNCATION_SUFFIX.length;\n  const lines: string[] = [];\n  let length = 0;\n  for (const line of text.split(\"\\n\")) {\n    if (length + line.length + 1 > cutoff) {\n      break;\n    }\n    lines.push(line);\n    length += line.length + 1;\n  }\n  return lines.join(\"\\n\") + STACKTRACE_TRUNCATION_SUFFIX;\n}\n"],"mappings":"AACA,SAAS,yBAAyB;AAE3B,MAAM,0BAA0B;AAEvC,MAAM,aAAa;AACnB,MAAM,sBAAsB;AAC5B,MAAM,kBAAkB;AACxB,MAAM,kBAAkB;AACxB,MAAM,qBAAqB;AAC3B,MAAM,wBAAwB;AAC9B,MAAM,YAAY,KAAK,KAAK;AAC5B,MAAM,4BAA4B;AAClC,MAAM,+BAA+B;AAarC,MAAM,0BAA0B,uBAAO,IAAI,4BAA4B;AACvE,MAAM,0BAA0B;AAIhC,MAAM,oBACJ,wBAAwB,uBAAuB,KAAK,oBAAI,IAA8B;AACxF,wBAAwB,uBAAuB,IAAI;AAE5C,SAAS,eACd,UACA,QACA,MACA,OACA,eACM;AACN,WAAS,OAAO,YAAY;AAC5B,MAAI,WAAW,aAAa,CAAC,MAAM;AACjC;AAAA,EACF;AACA,QAAM,YAAY,kBAAkB,KAAK;AACzC,QAAM,EAAE,MAAM,SAAS,MAAM,IAC3B,OAAO,cAAc,WACjB,EAAE,MAAM,IAAI,SAAS,WAAW,OAAO,GAAG,IACzC;AACP,QAAM,QAA0B;AAAA,IAC9B;AAAA,IACA,MAAM,KAAK,MAAM,GAAG,eAAe;AAAA,IACnC,MAAM,OAAO,QAAQ,EAAE,EAAE,MAAM,GAAG,eAAe;AAAA,IACjD,SAAS,cAAc,OAAO;AAAA,IAC9B,YAAY,iBAAiB,KAAK;AAAA,IAClC,OAAO;AAAA,EACT;AACA,MAAI,aAAa,QAAW;AAC1B,UAAM,WAAW,SAAS,MAAM,GAAG,mBAAmB;AAAA,EACxD;AACA,MAAI,kBAAkB,QAAW;AAC/B,UAAM,kBAAkB;AAAA,EAC1B;AACA,QAAM,MAAM;AAAA,IACV,MAAM,YAAY;AAAA,IAClB,MAAM;AAAA,IACN,MAAM;AAAA,IACN,MAAM;AAAA,IACN,MAAM;AAAA,IACN,MAAM;AAAA,EACR,EAAE,KAAK,IAAI;AACX,QAAM,WAAW,kBAAkB,IAAI,GAAG;AAC1C,MAAI,UAAU;AACZ,aAAS,QAAQ,KAAK,IAAI,SAAS,QAAQ,GAAG,SAAS;AACvD,aAAS,kBAAkB,MAAM,mBAAmB,SAAS;AAAA,EAC/D,WAAW,kBAAkB,OAAO,YAAY;AAC9C,sBAAkB,IAAI,KAAK,KAAK;AAAA,EAClC;AACF;AAEO,SAAS,oBAAmC;AACjD,QAAM,SAAS,CAAC,GAAG,kBAAkB,OAAO,CAAC;AAC7C,oBAAkB,MAAM;AACxB,SAAO;AACT;AAEO,SAAS,oBAA0B;AACxC,oBAAkB,MAAM;AAC1B;AAEA,SAAS,cAAc,SAA0B;AAC/C,QAAM,OAAO,OAAO,WAAW,EAAE,EAAE,KAAK;AACxC,MAAI,KAAK,UAAU,oBAAoB;AACrC,WAAO;AAAA,EACT;AACA,SACE,KAAK,MAAM,GAAG,qBAAqB,0BAA0B,MAAM,IAAI;AAE3E;AAGA,SAAS,iBAAiB,OAAwB;AAChD,QAAM,OAAO,OAAO,UAAU,WAAW,MAAM,KAAK,IAAI;AACxD,MAAI,KAAK,UAAU,uBAAuB;AACxC,WAAO;AAAA,EACT;AACA,QAAM,SAAS,wBAAwB,6BAA6B;AACpE,QAAM,QAAkB,CAAC;AACzB,MAAI,SAAS;AACb,aAAW,QAAQ,KAAK,MAAM,IAAI,GAAG;AACnC,QAAI,SAAS,KAAK,SAAS,IAAI,QAAQ;AACrC;AAAA,IACF;AACA,UAAM,KAAK,IAAI;AACf,cAAU,KAAK,SAAS;AAAA,EAC1B;AACA,SAAO,MAAM,KAAK,IAAI,IAAI;AAC5B;","names":[]}

package/dist/spanExporter.cjs

@@ -0,0 +1,217 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var spanExporter_exports = {};
+__export(spanExporter_exports, {
+  ApitallySpanExporter: () => ApitallySpanExporter
+});
+module.exports = __toCommonJS(spanExporter_exports);
+var import_api = require("@opentelemetry/api");
+var import_otlp_transformer = require("@opentelemetry/otlp-transformer");
+var import_resources = require("@opentelemetry/resources");
+var import_bodyCapture = require('./bodyCapture.cjs');
+var import_exportSerialization = require('./exportSerialization.cjs');
+var import_logger = require('./logger.cjs');
+var import_redaction = require('./redaction.cjs');
+var import_spanProcessor = require('./spanProcessor.cjs');
+const QUERY_ATTRIBUTES = /* @__PURE__ */ new Set(["url.query", "url.full", "http.target", "http.url"]);
+const REQUEST_HEADER_ATTRIBUTE_PREFIX = "http.request.header.";
+const RESPONSE_HEADER_ATTRIBUTE_PREFIX = "http.response.header.";
+const DEPLOYMENT_ENVIRONMENT_NAME = "deployment.environment.name";
+const SERVICE_INSTANCE_ID = "service.instance.id";
+class ApitallySpanExporter {
+  redaction;
+  env;
+  instanceId;
+  spool;
+  maskRequestBody;
+  maskResponseBody;
+  constructor(options) {
+    this.redaction = options.redaction;
+    this.env = options.env;
+    this.instanceId = options.instanceId;
+    this.spool = options.spool;
+    this.maskRequestBody = options.maskRequestBody;
+    this.maskResponseBody = options.maskResponseBody;
+  }
+  export(spans, resultCallback) {
+    const rewrittenResources = /* @__PURE__ */ new Map();
+    const exportCopies = [];
+    for (const span of spans) {
+      try {
+        exportCopies.push(this.buildExportCopy(span, rewrittenResources));
+      } catch {
+        (0, import_logger.logWarning)("Failed to prepare a span for export to Apitally, so the span was dropped");
+      }
+    }
+    (0, import_exportSerialization.serializeInChunksToSpool)(
+      exportCopies,
+      (chunk) => import_otlp_transformer.ProtobufTraceSerializer.serializeRequest(chunk),
+      this.spool,
+      "traces",
+      resultCallback
+    );
+  }
+  forceFlush() {
+    return Promise.resolve();
+  }
+  shutdown() {
+    return Promise.resolve();
+  }
+  buildExportCopy(span, rewrittenResources) {
+    const data = span.apitallyData;
+    const stash = data?.stash;
+    const attributes = {
+      ...span.attributes,
+      ...data?.record?.attributes
+    };
+    this.redactQueryAndHeaderAttributes(attributes);
+    if (stash?.requestHeaders) {
+      writeCapturedHeaderAttributes(
+        attributes,
+        REQUEST_HEADER_ATTRIBUTE_PREFIX,
+        stash.requestHeaders,
+        this.redaction
+      );
+    }
+    if (stash?.responseHeaders) {
+      writeCapturedHeaderAttributes(
+        attributes,
+        RESPONSE_HEADER_ATTRIBUTE_PREFIX,
+        stash.responseHeaders,
+        this.redaction
+      );
+    }
+    const copy = (0, import_spanProcessor.copySpan)(span);
+    copy.attributes = attributes;
+    copy.resource = this.resolveExportResource(span.resource, rewrittenResources);
+    if (data?.demoteToInternal) {
+      copy.kind = import_api.SpanKind.INTERNAL;
+    }
+    if (stash && (stash.requestBody !== void 0 || stash.responseBody !== void 0)) {
+      const snapshot = (0, import_spanProcessor.copySpan)(copy);
+      snapshot.attributes = { ...attributes };
+      if (stash.requestBody !== void 0) {
+        attributes["apitally.request.body"] = this.processBody(
+          snapshot,
+          stash.requestBody,
+          this.maskRequestBody,
+          "maskRequestBody"
+        );
+      }
+      if (stash.responseBody !== void 0) {
+        attributes["apitally.response.body"] = this.processBody(
+          snapshot,
+          stash.responseBody,
+          this.maskResponseBody,
+          "maskResponseBody"
+        );
+      }
+    }
+    return copy;
+  }
+  // OpenTelemetry HTTP instrumentations leave query and header attributes raw.
+  // Both legacy and stable HTTP attribute names are redacted before export.
+  redactQueryAndHeaderAttributes(attributes) {
+    for (const [key, value] of Object.entries(attributes)) {
+      if (QUERY_ATTRIBUTES.has(key) && typeof value === "string") {
+        attributes[key] = this.redaction.redactQueryParams(value, key === "url.query");
+      } else if (key.startsWith(REQUEST_HEADER_ATTRIBUTE_PREFIX) || key.startsWith(RESPONSE_HEADER_ATTRIBUTE_PREFIX)) {
+        const headerName = key.slice(
+          key.startsWith(REQUEST_HEADER_ATTRIBUTE_PREFIX) ? REQUEST_HEADER_ATTRIBUTE_PREFIX.length : RESPONSE_HEADER_ATTRIBUTE_PREFIX.length
+        );
+        attributes[key] = this.redaction.redactHeaderValue(headerName, value);
+      }
+    }
+  }
+  // Bodies are masked, parsed, field-redacted, and serialized in that order.
+  // Masking failures redact the entire body.
+  processBody(snapshot, body, maskCallback, optionName) {
+    if (body.equals(import_bodyCapture.BODY_TOO_LARGE_BUFFER)) {
+      return import_bodyCapture.BODY_TOO_LARGE;
+    }
+    let processed = body;
+    if (maskCallback) {
+      let masked;
+      try {
+        masked = maskCallback(body, snapshot);
+      } catch {
+        (0, import_logger.logWarning)(
+          `The Apitally ${optionName} callback threw an error, so the body was replaced with ${import_redaction.REDACTED}`
+        );
+        return import_redaction.REDACTED;
+      }
+      if (masked === null || masked === void 0) {
+        return import_redaction.REDACTED;
+      }
+      if (!Buffer.isBuffer(masked)) {
+        (0, import_logger.logWarning)(
+          `The Apitally ${optionName} callback returned an invalid value, so the body was replaced with ${import_redaction.REDACTED}. Mask callbacks must synchronously return a Buffer or null.`
+        );
+        return import_redaction.REDACTED;
+      }
+      if (masked.length > import_bodyCapture.MAX_BODY_SIZE) {
+        return import_bodyCapture.BODY_TOO_LARGE;
+      }
+      processed = masked;
+    }
+    return this.redaction.redactBody(processed);
+  }
+  // Export resources must carry Apitally's process identity and match Apitally-Env.
+  // Rewrites apply only to Apitally's copies.
+  resolveExportResource(resource, rewrittenResources) {
+    const resourceEnv = resource.attributes[DEPLOYMENT_ENVIRONMENT_NAME];
+    const resourceInstanceId = resource.attributes[SERVICE_INSTANCE_ID];
+    const envDiffers = typeof resourceEnv === "string" && resourceEnv !== this.env;
+    const envMissing = resourceEnv === void 0;
+    const instanceIdDiffers = resourceInstanceId !== this.instanceId;
+    if (!envDiffers && !envMissing && !instanceIdDiffers) {
+      return resource;
+    }
+    const existing = rewrittenResources.get(resource);
+    if (existing) {
+      return existing;
+    }
+    if (envDiffers) {
+      (0, import_logger.logWarning)(
+        `The tracer provider's resource sets deployment.environment.name to "${resourceEnv}", which differs from the Apitally env "${this.env}". Spans are exported to Apitally with the env "${this.env}".`
+      );
+    }
+    const attributes = {
+      ...resource.attributes,
+      [SERVICE_INSTANCE_ID]: this.instanceId
+    };
+    if (envDiffers || envMissing) {
+      attributes[DEPLOYMENT_ENVIRONMENT_NAME] = this.env;
+    }
+    const rewritten = (0, import_resources.resourceFromAttributes)(attributes);
+    rewrittenResources.set(resource, rewritten);
+    return rewritten;
+  }
+}
+function writeCapturedHeaderAttributes(attributes, prefix, headers, redaction) {
+  for (const [name, values] of Object.entries(headers)) {
+    const redactedValues = redaction.redactHeaderValue(name, values);
+    attributes[prefix + name] = Array.isArray(redactedValues) ? redactedValues : [redactedValues];
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ApitallySpanExporter
+});
+//# sourceMappingURL=spanExporter.cjs.map

package/dist/spanExporter.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/spanExporter.ts"],"sourcesContent":["import type { Attributes } from \"@opentelemetry/api\";\nimport { SpanKind } from \"@opentelemetry/api\";\nimport type { ExportResult } from \"@opentelemetry/core\";\nimport { ProtobufTraceSerializer } from \"@opentelemetry/otlp-transformer\";\nimport { type Resource, resourceFromAttributes } from \"@opentelemetry/resources\";\nimport type { ReadableSpan, SpanExporter } from \"@opentelemetry/sdk-trace-base\";\nimport { BODY_TOO_LARGE, BODY_TOO_LARGE_BUFFER, MAX_BODY_SIZE } from \"./bodyCapture.js\";\nimport type { BodyMaskingCallback } from \"./config.js\";\nimport { serializeInChunksToSpool } from \"./exportSerialization.js\";\nimport { logWarning } from \"./logger.js\";\nimport { REDACTED, type Redaction } from \"./redaction.js\";\nimport { copySpan, type SpanCopy } from \"./spanProcessor.js\";\nimport type { Spool } from \"./spool.js\";\n\nconst QUERY_ATTRIBUTES = new Set([\"url.query\", \"url.full\", \"http.target\", \"http.url\"]);\nconst REQUEST_HEADER_ATTRIBUTE_PREFIX = \"http.request.header.\";\nconst RESPONSE_HEADER_ATTRIBUTE_PREFIX = \"http.response.header.\";\nconst DEPLOYMENT_ENVIRONMENT_NAME = \"deployment.environment.name\";\nconst SERVICE_INSTANCE_ID = \"service.instance.id\";\n\nexport interface ApitallySpanExporterOptions {\n  redaction: Redaction;\n  env: string;\n  instanceId: string;\n  spool: Spool;\n  maskRequestBody?: BodyMaskingCallback;\n  maskResponseBody?: BodyMaskingCallback;\n}\n\n// Export copies receive transport attributes, captured data, and redaction\n// without mutating the original spans.\nexport class ApitallySpanExporter implements SpanExporter {\n  private readonly redaction: Redaction;\n  private readonly env: string;\n  private readonly instanceId: string;\n  private readonly spool: Spool;\n  private readonly maskRequestBody?: BodyMaskingCallback;\n  private readonly maskResponseBody?: BodyMaskingCallback;\n\n  constructor(options: ApitallySpanExporterOptions) {\n    this.redaction = options.redaction;\n    this.env = options.env;\n    this.instanceId = options.instanceId;\n    this.spool = options.spool;\n    this.maskRequestBody = options.maskRequestBody;\n    this.maskResponseBody = options.maskResponseBody;\n  }\n\n  export(spans: ReadableSpan[], resultCallback: (result: ExportResult) => void): void {\n    // Rewritten resources are shared across the batch: the serializer groups\n    // resourceSpans by object identity, never by attribute equality.\n    const rewrittenResources = new Map<Resource, Resource>();\n    const exportCopies: ReadableSpan[] = [];\n    for (const span of spans) {\n      try {\n        exportCopies.push(this.buildExportCopy(span, rewrittenResources));\n      } catch {\n        // A span that failed redaction must never leave the process.\n        logWarning(\"Failed to prepare a span for export to Apitally, so the span was dropped\");\n      }\n    }\n    serializeInChunksToSpool(\n      exportCopies,\n      (chunk) => ProtobufTraceSerializer.serializeRequest(chunk),\n      this.spool,\n      \"traces\",\n      resultCallback,\n    );\n  }\n\n  forceFlush(): Promise<void> {\n    return Promise.resolve();\n  }\n\n  shutdown(): Promise<void> {\n    return Promise.resolve();\n  }\n\n  private buildExportCopy(\n    span: ReadableSpan,\n    rewrittenResources: Map<Resource, Resource>,\n  ): ReadableSpan {\n    const data = (span as SpanCopy).apitallyData;\n    const stash = data?.stash;\n    // The record is applied last: a transport-observed value wins over anything\n    // the producing instrumentation set for the same key.\n    const attributes: Record<string, unknown> = {\n      ...span.attributes,\n      ...data?.record?.attributes,\n    };\n    this.redactQueryAndHeaderAttributes(attributes);\n    if (stash?.requestHeaders) {\n      writeCapturedHeaderAttributes(\n        attributes,\n        REQUEST_HEADER_ATTRIBUTE_PREFIX,\n        stash.requestHeaders,\n        this.redaction,\n      );\n    }\n    if (stash?.responseHeaders) {\n      writeCapturedHeaderAttributes(\n        attributes,\n        RESPONSE_HEADER_ATTRIBUTE_PREFIX,\n        stash.responseHeaders,\n        this.redaction,\n      );\n    }\n    const copy = copySpan(span);\n    copy.attributes = attributes as Attributes;\n    copy.resource = this.resolveExportResource(span.resource, rewrittenResources);\n    if (data?.demoteToInternal) {\n      copy.kind = SpanKind.INTERNAL;\n    }\n    if (stash && (stash.requestBody !== undefined || stash.responseBody !== undefined)) {\n      // Mask callbacks receive the redacted export copy with captured headers\n      // attached, but without body attributes.\n      const snapshot = copySpan(copy);\n      snapshot.attributes = { ...attributes } as Attributes;\n      if (stash.requestBody !== undefined) {\n        attributes[\"apitally.request.body\"] = this.processBody(\n          snapshot,\n          stash.requestBody,\n          this.maskRequestBody,\n          \"maskRequestBody\",\n        );\n      }\n      if (stash.responseBody !== undefined) {\n        attributes[\"apitally.response.body\"] = this.processBody(\n          snapshot,\n          stash.responseBody,\n          this.maskResponseBody,\n          \"maskResponseBody\",\n        );\n      }\n    }\n    return copy;\n  }\n\n  // OpenTelemetry HTTP instrumentations leave query and header attributes raw.\n  // Both legacy and stable HTTP attribute names are redacted before export.\n  private redactQueryAndHeaderAttributes(attributes: Record<string, unknown>): void {\n    for (const [key, value] of Object.entries(attributes)) {\n      if (QUERY_ATTRIBUTES.has(key) && typeof value === \"string\") {\n        attributes[key] = this.redaction.redactQueryParams(value, key === \"url.query\");\n      } else if (\n        key.startsWith(REQUEST_HEADER_ATTRIBUTE_PREFIX) ||\n        key.startsWith(RESPONSE_HEADER_ATTRIBUTE_PREFIX)\n      ) {\n        const headerName = key.slice(\n          key.startsWith(REQUEST_HEADER_ATTRIBUTE_PREFIX)\n            ? REQUEST_HEADER_ATTRIBUTE_PREFIX.length\n            : RESPONSE_HEADER_ATTRIBUTE_PREFIX.length,\n        );\n        attributes[key] = this.redaction.redactHeaderValue(headerName, value);\n      }\n    }\n  }\n\n  // Bodies are masked, parsed, field-redacted, and serialized in that order.\n  // Masking failures redact the entire body.\n  private processBody(\n    snapshot: ReadableSpan,\n    body: Buffer,\n    maskCallback: BodyMaskingCallback | undefined,\n    optionName: string,\n  ): string | Buffer {\n    if (body.equals(BODY_TOO_LARGE_BUFFER)) {\n      return BODY_TOO_LARGE;\n    }\n    let processed = body;\n    if (maskCallback) {\n      let masked: unknown;\n      try {\n        masked = maskCallback(body, snapshot);\n      } catch {\n        logWarning(\n          `The Apitally ${optionName} callback threw an error, so the body was replaced with ${REDACTED}`,\n        );\n        return REDACTED;\n      }\n      if (masked === null || masked === undefined) {\n        return REDACTED;\n      }\n      if (!Buffer.isBuffer(masked)) {\n        logWarning(\n          `The Apitally ${optionName} callback returned an invalid value, so the body was replaced with ${REDACTED}. Mask callbacks must synchronously return a Buffer or null.`,\n        );\n        return REDACTED;\n      }\n      if (masked.length > MAX_BODY_SIZE) {\n        return BODY_TOO_LARGE;\n      }\n      processed = masked;\n    }\n    return this.redaction.redactBody(processed);\n  }\n\n  // Export resources must carry Apitally's process identity and match Apitally-Env.\n  // Rewrites apply only to Apitally's copies.\n  private resolveExportResource(\n    resource: Resource,\n    rewrittenResources: Map<Resource, Resource>,\n  ): Resource {\n    const resourceEnv = resource.attributes[DEPLOYMENT_ENVIRONMENT_NAME];\n    const resourceInstanceId = resource.attributes[SERVICE_INSTANCE_ID];\n    const envDiffers = typeof resourceEnv === \"string\" && resourceEnv !== this.env;\n    const envMissing = resourceEnv === undefined;\n    const instanceIdDiffers = resourceInstanceId !== this.instanceId;\n    if (!envDiffers && !envMissing && !instanceIdDiffers) {\n      return resource;\n    }\n    const existing = rewrittenResources.get(resource);\n    if (existing) {\n      return existing;\n    }\n    if (envDiffers) {\n      logWarning(\n        `The tracer provider's resource sets deployment.environment.name to \"${resourceEnv}\", which differs from the Apitally env \"${this.env}\". Spans are exported to Apitally with the env \"${this.env}\".`,\n      );\n    }\n    const attributes: Attributes = {\n      ...resource.attributes,\n      [SERVICE_INSTANCE_ID]: this.instanceId,\n    };\n    if (envDiffers || envMissing) {\n      attributes[DEPLOYMENT_ENVIRONMENT_NAME] = this.env;\n    }\n    const rewritten = resourceFromAttributes(attributes);\n    rewrittenResources.set(resource, rewritten);\n    return rewritten;\n  }\n}\n\nfunction writeCapturedHeaderAttributes(\n  attributes: Record<string, unknown>,\n  prefix: string,\n  headers: Record<string, string | string[]>,\n  redaction: Redaction,\n): void {\n  for (const [name, values] of Object.entries(headers)) {\n    const redactedValues = redaction.redactHeaderValue(name, values);\n    attributes[prefix + name] = Array.isArray(redactedValues) ? redactedValues : [redactedValues];\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,iBAAyB;AAEzB,8BAAwC;AACxC,uBAAsD;AAEtD,yBAAqE;AAErE,iCAAyC;AACzC,oBAA2B;AAC3B,uBAAyC;AACzC,2BAAwC;AAGxC,MAAM,mBAAmB,oBAAI,IAAI,CAAC,aAAa,YAAY,eAAe,UAAU,CAAC;AACrF,MAAM,kCAAkC;AACxC,MAAM,mCAAmC;AACzC,MAAM,8BAA8B;AACpC,MAAM,sBAAsB;AAarB,MAAM,qBAA6C;AAAA,EACvC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAEjB,YAAY,SAAsC;AAChD,SAAK,YAAY,QAAQ;AACzB,SAAK,MAAM,QAAQ;AACnB,SAAK,aAAa,QAAQ;AAC1B,SAAK,QAAQ,QAAQ;AACrB,SAAK,kBAAkB,QAAQ;AAC/B,SAAK,mBAAmB,QAAQ;AAAA,EAClC;AAAA,EAEA,OAAO,OAAuB,gBAAsD;AAGlF,UAAM,qBAAqB,oBAAI,IAAwB;AACvD,UAAM,eAA+B,CAAC;AACtC,eAAW,QAAQ,OAAO;AACxB,UAAI;AACF,qBAAa,KAAK,KAAK,gBAAgB,MAAM,kBAAkB,CAAC;AAAA,MAClE,QAAQ;AAEN,sCAAW,0EAA0E;AAAA,MACvF;AAAA,IACF;AACA;AAAA,MACE;AAAA,MACA,CAAC,UAAU,gDAAwB,iBAAiB,KAAK;AAAA,MACzD,KAAK;AAAA,MACL;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA,EAEA,aAA4B;AAC1B,WAAO,QAAQ,QAAQ;AAAA,EACzB;AAAA,EAEA,WAA0B;AACxB,WAAO,QAAQ,QAAQ;AAAA,EACzB;AAAA,EAEQ,gBACN,MACA,oBACc;AACd,UAAM,OAAQ,KAAkB;AAChC,UAAM,QAAQ,MAAM;AAGpB,UAAM,aAAsC;AAAA,MAC1C,GAAG,KAAK;AAAA,MACR,GAAG,MAAM,QAAQ;AAAA,IACnB;AACA,SAAK,+BAA+B,UAAU;AAC9C,QAAI,OAAO,gBAAgB;AACzB;AAAA,QACE;AAAA,QACA;AAAA,QACA,MAAM;AAAA,QACN,KAAK;AAAA,MACP;AAAA,IACF;AACA,QAAI,OAAO,iBAAiB;AAC1B;AAAA,QACE;AAAA,QACA;AAAA,QACA,MAAM;AAAA,QACN,KAAK;AAAA,MACP;AAAA,IACF;AACA,UAAM,WAAO,+BAAS,IAAI;AAC1B,SAAK,aAAa;AAClB,SAAK,WAAW,KAAK,sBAAsB,KAAK,UAAU,kBAAkB;AAC5E,QAAI,MAAM,kBAAkB;AAC1B,WAAK,OAAO,oBAAS;AAAA,IACvB;AACA,QAAI,UAAU,MAAM,gBAAgB,UAAa,MAAM,iBAAiB,SAAY;AAGlF,YAAM,eAAW,+BAAS,IAAI;AAC9B,eAAS,aAAa,EAAE,GAAG,WAAW;AACtC,UAAI,MAAM,gBAAgB,QAAW;AACnC,mBAAW,uBAAuB,IAAI,KAAK;AAAA,UACzC;AAAA,UACA,MAAM;AAAA,UACN,KAAK;AAAA,UACL;AAAA,QACF;AAAA,MACF;AACA,UAAI,MAAM,iBAAiB,QAAW;AACpC,mBAAW,wBAAwB,IAAI,KAAK;AAAA,UAC1C;AAAA,UACA,MAAM;AAAA,UACN,KAAK;AAAA,UACL;AAAA,QACF;AAAA,MACF;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA,EAIQ,+BAA+B,YAA2C;AAChF,eAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,UAAU,GAAG;AACrD,UAAI,iBAAiB,IAAI,GAAG,KAAK,OAAO,UAAU,UAAU;AAC1D,mBAAW,GAAG,IAAI,KAAK,UAAU,kBAAkB,OAAO,QAAQ,WAAW;AAAA,MAC/E,WACE,IAAI,WAAW,+BAA+B,KAC9C,IAAI,WAAW,gCAAgC,GAC/C;AACA,cAAM,aAAa,IAAI;AAAA,UACrB,IAAI,WAAW,+BAA+B,IAC1C,gCAAgC,SAChC,iCAAiC;AAAA,QACvC;AACA,mBAAW,GAAG,IAAI,KAAK,UAAU,kBAAkB,YAAY,KAAK;AAAA,MACtE;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA,EAIQ,YACN,UACA,MACA,cACA,YACiB;AACjB,QAAI,KAAK,OAAO,wCAAqB,GAAG;AACtC,aAAO;AAAA,IACT;AACA,QAAI,YAAY;AAChB,QAAI,cAAc;AAChB,UAAI;AACJ,UAAI;AACF,iBAAS,aAAa,MAAM,QAAQ;AAAA,MACtC,QAAQ;AACN;AAAA,UACE,gBAAgB,UAAU,2DAA2D,yBAAQ;AAAA,QAC/F;AACA,eAAO;AAAA,MACT;AACA,UAAI,WAAW,QAAQ,WAAW,QAAW;AAC3C,eAAO;AAAA,MACT;AACA,UAAI,CAAC,OAAO,SAAS,MAAM,GAAG;AAC5B;AAAA,UACE,gBAAgB,UAAU,sEAAsE,yBAAQ;AAAA,QAC1G;AACA,eAAO;AAAA,MACT;AACA,UAAI,OAAO,SAAS,kCAAe;AACjC,eAAO;AAAA,MACT;AACA,kBAAY;AAAA,IACd;AACA,WAAO,KAAK,UAAU,WAAW,SAAS;AAAA,EAC5C;AAAA;AAAA;AAAA,EAIQ,sBACN,UACA,oBACU;AACV,UAAM,cAAc,SAAS,WAAW,2BAA2B;AACnE,UAAM,qBAAqB,SAAS,WAAW,mBAAmB;AAClE,UAAM,aAAa,OAAO,gBAAgB,YAAY,gBAAgB,KAAK;AAC3E,UAAM,aAAa,gBAAgB;AACnC,UAAM,oBAAoB,uBAAuB,KAAK;AACtD,QAAI,CAAC,cAAc,CAAC,cAAc,CAAC,mBAAmB;AACpD,aAAO;AAAA,IACT;AACA,UAAM,WAAW,mBAAmB,IAAI,QAAQ;AAChD,QAAI,UAAU;AACZ,aAAO;AAAA,IACT;AACA,QAAI,YAAY;AACd;AAAA,QACE,uEAAuE,WAAW,2CAA2C,KAAK,GAAG,mDAAmD,KAAK,GAAG;AAAA,MAClM;AAAA,IACF;AACA,UAAM,aAAyB;AAAA,MAC7B,GAAG,SAAS;AAAA,MACZ,CAAC,mBAAmB,GAAG,KAAK;AAAA,IAC9B;AACA,QAAI,cAAc,YAAY;AAC5B,iBAAW,2BAA2B,IAAI,KAAK;AAAA,IACjD;AACA,UAAM,gBAAY,yCAAuB,UAAU;AACnD,uBAAmB,IAAI,UAAU,SAAS;AAC1C,WAAO;AAAA,EACT;AACF;AAEA,SAAS,8BACP,YACA,QACA,SACA,WACM;AACN,aAAW,CAAC,MAAM,MAAM,KAAK,OAAO,QAAQ,OAAO,GAAG;AACpD,UAAM,iBAAiB,UAAU,kBAAkB,MAAM,MAAM;AAC/D,eAAW,SAAS,IAAI,IAAI,MAAM,QAAQ,cAAc,IAAI,iBAAiB,CAAC,cAAc;AAAA,EAC9F;AACF;","names":[]}

package/dist/spanExporter.d.cts

@@ -0,0 +1,34 @@
+import { ExportResult } from '@opentelemetry/core';
+import { SpanExporter, ReadableSpan } from '@opentelemetry/sdk-trace-base';
+import { BodyMaskingCallback } from './config.cjs';
+import { Redaction } from './redaction.cjs';
+import { Spool } from './spool.cjs';
+import '@opentelemetry/sdk-logs';
+import 'node:zlib';
+
+interface ApitallySpanExporterOptions {
+    redaction: Redaction;
+    env: string;
+    instanceId: string;
+    spool: Spool;
+    maskRequestBody?: BodyMaskingCallback;
+    maskResponseBody?: BodyMaskingCallback;
+}
+declare class ApitallySpanExporter implements SpanExporter {
+    private readonly redaction;
+    private readonly env;
+    private readonly instanceId;
+    private readonly spool;
+    private readonly maskRequestBody?;
+    private readonly maskResponseBody?;
+    constructor(options: ApitallySpanExporterOptions);
+    export(spans: ReadableSpan[], resultCallback: (result: ExportResult) => void): void;
+    forceFlush(): Promise<void>;
+    shutdown(): Promise<void>;
+    private buildExportCopy;
+    private redactQueryAndHeaderAttributes;
+    private processBody;
+    private resolveExportResource;
+}
+
+export { ApitallySpanExporter, type ApitallySpanExporterOptions };