@forinda/kickjs-otel 3.1.3 → 4.0.0

package/README.md

@@ -1,58 +1,46 @@
 # @forinda/kickjs-otel
 
-OpenTelemetry adapter for KickJS — automatic tracing, metrics, and export to any OTel backend.
+OpenTelemetry adapter for KickJS — auto request spans + counter/histogram metrics, route ignore list, span-attribute redaction. Works with any OTel backend (Jaeger, Grafana Tempo, Datadog, Honeycomb, etc.).
 
 ## Install
 
 ```bash
-# Using the KickJS CLI (recommended — auto-installs peer dependencies)
 kick add otel
-
-# Manual install
-pnpm add @forinda/kickjs-otel @opentelemetry/api @opentelemetry/semantic-conventions
-# Optional SDK packages
-pnpm add @opentelemetry/sdk-node @opentelemetry/sdk-trace-base @opentelemetry/sdk-metrics
 ```
 
-## Features
-
-- `OtelAdapter` — lifecycle adapter that instruments requests with spans and metrics
-- Works with any OpenTelemetry-compatible backend (Jaeger, Grafana Tempo, Datadog, etc.)
-- Zero-config console exporter for development
-
 ## Quick Example
 
-```typescript
+```ts
+import { bootstrap } from '@forinda/kickjs'
 import { OtelAdapter } from '@forinda/kickjs-otel'
+import { modules } from './modules'
 
-bootstrap({
+export const app = await bootstrap({
   modules,
   adapters: [
-    new OtelAdapter({
+    OtelAdapter({
       serviceName: 'my-api',
-      enabled: true,
+      ignoreRoutes: ['/health', '/_debug/*'],
+      sensitiveKeys: ['authorization', /^x-api-key/i],
     }),
   ],
 })
 ```
 
-For production, initialize the OTel SDK before bootstrap:
+For production, initialize the OTel SDK before `bootstrap()`:
 
-```typescript
+```ts
 import { NodeSDK } from '@opentelemetry/sdk-node'
 import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http'
 
-const sdk = new NodeSDK({
-  traceExporter: new OTLPTraceExporter({
-    url: 'http://localhost:4318/v1/traces',
-  }),
-})
-sdk.start()
+new NodeSDK({
+  traceExporter: new OTLPTraceExporter({ url: 'http://localhost:4318/v1/traces' }),
+}).start()
 ```
 
 ## Documentation
 
-[Full documentation](https://forinda.github.io/kick-js/)
+[forinda.github.io/kick-js/api/otel](https://forinda.github.io/kick-js/api/otel)
 
 ## License
 

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 
-import { AdapterContext, AdapterMiddleware, AppAdapter } from "@forinda/kickjs";
+import * as _$_forinda_kickjs0 from "@forinda/kickjs";
 
 //#region src/types.d.ts
 interface OtelAdapterOptions {
@@ -31,7 +31,7 @@ interface OtelAdapterOptions {
    * import { sensitiveKeys } from './config/redaction'
    *
    * pino({ redact: { paths: sensitiveKeys } })
-   * new OtelAdapter({ sensitiveKeys })
+   * OtelAdapter({ sensitiveKeys })
    * ```
    *
    * String entries do case-insensitive exact match on the attribute
@@ -53,6 +53,21 @@ interface OtelAdapterOptions {
 }
 //#endregion
 //#region src/otel.adapter.d.ts
+/**
+ * Public extension methods exposed by an OtelAdapter instance beyond
+ * the standard {@link AppAdapter} contract. Surfaced via `TExtra` on
+ * `defineAdapter` so peer adapters / tests / downstream code that
+ * adds attributes directly on a span can share the redaction contract.
+ */
+interface OtelAdapterExtensions {
+  /**
+   * Run the configured redactor over an attribute bag. Useful for code
+   * that adds attributes directly on a span (`span.setAttributes(...)`)
+   * outside the request middleware path — applies the same key matching
+   * (case-insensitive strings, regex patterns) declared on the adapter.
+   */
+  applyRedaction<T extends Record<string, unknown>>(attrs: T): Record<string, unknown>;
+}
 /**
  * OpenTelemetry adapter for KickJS — automatic tracing and metrics.
  *
@@ -70,7 +85,7 @@ interface OtelAdapterOptions {
  * bootstrap({
  *   modules,
  *   adapters: [
- *     new OtelAdapter({
+ *     OtelAdapter({
  *       serviceName: 'my-api',
  *       serviceVersion: '1.0.0',
  *       ignoreRoutes: ['/health', '/_debug/*'],
@@ -79,27 +94,7 @@ interface OtelAdapterOptions {
  * })
  * ```
  */
-declare class OtelAdapter implements AppAdapter {
-  name: string;
-  private options;
-  private tracer;
-  private meter;
-  private requestCounter;
-  private requestDuration;
-  private readonly redact;
-  constructor(options?: OtelAdapterOptions);
-  beforeStart({}: AdapterContext): void;
-  middleware(): AdapterMiddleware[];
-  private onFinish;
-  private shouldIgnore;
-  /**
-   * Run the configured redactor over an attribute bag. Exposed so
-   * downstream code that adds attributes directly on a span
-   * (`span.setAttributes(...)`) can share the same redaction contract.
-   */
-  applyRedaction<T extends Record<string, unknown>>(attrs: T): Record<string, unknown>;
-  shutdown(): Promise<void>;
-}
+declare const OtelAdapter: _$_forinda_kickjs0.AdapterFactory<OtelAdapterOptions, OtelAdapterExtensions>;
 //#endregion
 export { OtelAdapter, type OtelAdapterOptions };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/otel.adapter.ts"],"mappings":";;;;UAAiB,kBAAA;;EAEf,WAAA;EAFe;EAKf,cAAA;;EAGA,OAAA;EANA;EASA,OAAA;EAHA;;;;EASA,gBAAA,IAAoB,GAAA,UAAa,MAAA;EAOjC;;;;;EAAA,YAAA;EA8B8C;;;;;ACjBhD;;;;;;;;;;;;;;;;EDUE,aAAA,aAA0B,MAAA;ECHlB;;;;;EDUR,eAAA,IAAmB,GAAA,UAAa,KAAA;AAAA;;;;AAtDlC;;;;;;;;;;;;;;;;;;;;;;ACqCA;;;cAAa,WAAA,YAAuB,UAAA;EAClC,IAAA;EAAA,QACQ,OAAA;EAAA,QAIA,MAAA;EAAA,QACA,KAAA;EAAA,QACA,cAAA;EAAA,QACA,eAAA;EAAA,iBACS,MAAA;cAEL,OAAA,GAAS,kBAAA;EAWrB,WAAA,CAAA,IAAgB,cAAA;EA+BhB,UAAA,CAAA,GAAc,iBAAA;EAAA,QA2CN,QAAA;EAAA,QAkCA,YAAA;EA7HA;;;;;EA4IR,cAAA,WAAyB,MAAA,kBAAA,CAAyB,KAAA,EAAO,CAAA,GAAI,MAAA;EAQvD,QAAA,CAAA,GAAY,OAAA;AAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/otel.adapter.ts"],"mappings":";;;;UAAiB,kBAAA;;EAEf,WAAA;EAFe;EAKf,cAAA;;EAGA,OAAA;EANA;EASA,OAAA;EAHA;;;;EASA,gBAAA,IAAoB,GAAA,UAAa,MAAA;EAOjC;;;;;EAAA,YAAA;EA8B8C;;;;;AC1ChD;;;;;;;;;;;;;;;;EDmCE,aAAA,aAA0B,MAAA;ECoJ1B;;;;;ED7IA,eAAA,IAAmB,GAAA,UAAa,KAAA;AAAA;;;;;AAtDlC;;;;UCYiB,qBAAA;EDPf;;;;;;ECcA,cAAA,WAAyB,MAAA,mBAAyB,KAAA,EAAO,CAAA,GAAI,MAAA;AAAA;;;;;;;;;;AAP/D;;;;;;;;;;;;;;;;AAoCA;cAAa,WAAA,EAAW,kBAAA,CAAA,cAAA,CAAA,kBAAA,EAAA,qBAAA"}

package/dist/index.mjs

@@ -1,5 +1,5 @@
 /**
- * @forinda/kickjs-otel v3.1.3
+ * @forinda/kickjs-otel v4.0.0
  *
  * Copyright (c) Felix Orinda
  *
@@ -9,7 +9,7 @@
  * @license MIT
  */
 import { createRequire } from "node:module";
-import { Logger } from "@forinda/kickjs";
+import { Logger, defineAdapter } from "@forinda/kickjs";
 //#region \0rolldown/runtime.js
 var __require = /* @__PURE__ */ createRequire(import.meta.url);
 //#endregion
@@ -32,7 +32,7 @@ const log = Logger.for("OtelAdapter");
 * bootstrap({
 *   modules,
 *   adapters: [
-*     new OtelAdapter({
+*     OtelAdapter({
 *       serviceName: 'my-api',
 *       serviceVersion: '1.0.0',
 *       ignoreRoutes: ['/health', '/_debug/*'],
@@ -41,118 +41,113 @@ const log = Logger.for("OtelAdapter");
 * })
 * ```
 */
-var OtelAdapter = class {
-	name = "OtelAdapter";
-	options;
-	tracer = null;
-	meter = null;
-	requestCounter = null;
-	requestDuration = null;
-	redact;
-	constructor(options = {}) {
-		this.options = {
-			serviceName: options.serviceName ?? "kickjs-app",
-			serviceVersion: options.serviceVersion ?? "0.0.0",
-			tracing: options.tracing ?? true,
-			metrics: options.metrics ?? true,
-			...options
+const OtelAdapter = defineAdapter({
+	name: "OtelAdapter",
+	defaults: {
+		serviceName: "kickjs-app",
+		serviceVersion: "0.0.0",
+		tracing: true,
+		metrics: true
+	},
+	build: (options) => {
+		const redact = buildRedactor(options.sensitiveKeys, options.redactAttribute);
+		let tracer = null;
+		let meter = null;
+		let requestCounter = null;
+		let requestDuration = null;
+		const applyRedaction = (attrs) => {
+			const out = {};
+			for (const key of Object.keys(attrs)) out[key] = redact(key, attrs[key]);
+			return out;
 		};
-		this.redact = buildRedactor(this.options.sensitiveKeys, this.options.redactAttribute);
-	}
-	beforeStart({}) {
-		try {
-			const otelApi = __require("@opentelemetry/api");
-			if (this.options.tracing) {
-				this.tracer = otelApi.trace.getTracer(this.options.serviceName, this.options.serviceVersion);
-				log.info(`Tracing enabled for ${this.options.serviceName}`);
-			}
-			if (this.options.metrics) {
-				this.meter = otelApi.metrics.getMeter(this.options.serviceName, this.options.serviceVersion);
-				this.requestCounter = this.meter.createCounter("http.server.request.count", { description: "Total number of HTTP requests" });
-				this.requestDuration = this.meter.createHistogram("http.server.request.duration", {
-					description: "HTTP request duration in milliseconds",
-					unit: "ms"
-				});
-				log.info("Metrics enabled — http.server.request.count, http.server.request.duration");
-			}
-		} catch {
-			log.warn("OpenTelemetry API not found. Install @opentelemetry/api to enable tracing and metrics.");
-		}
-	}
-	middleware() {
-		return [{
-			handler: (req, res, next) => {
-				if (this.shouldIgnore(req.path)) return next();
-				const startTime = performance.now();
-				let span = null;
-				if (this.tracer) {
-					const otelApi = __require("@opentelemetry/api");
-					span = this.tracer.startSpan(`${req.method} ${req.route?.path ?? req.path}`, { attributes: this.applyRedaction({
-						"http.method": req.method,
-						"http.url": req.originalUrl,
-						"http.target": req.path,
-						"http.user_agent": req.get("user-agent") ?? "",
-						"net.host.name": req.hostname,
-						...this.options.customAttributes?.(req) ?? {}
-					}) });
-					const ctx = otelApi.trace.setSpan(otelApi.context.active(), span);
-					otelApi.context.with(ctx, () => {
-						this.onFinish(req, res, startTime, span);
-						next();
+		const shouldIgnore = (path) => {
+			if (!options.ignoreRoutes) return false;
+			return options.ignoreRoutes.some((pattern) => {
+				if (pattern.endsWith("*")) return path.startsWith(pattern.slice(0, -1));
+				return path === pattern;
+			});
+		};
+		const onFinish = (req, res, startTime, span) => {
+			res.on("finish", () => {
+				const duration = performance.now() - startTime;
+				const route = req.route?.path ?? req.path;
+				const attributes = {
+					"http.method": req.method,
+					"http.route": route,
+					"http.status_code": res.statusCode
+				};
+				if (span) {
+					span.setAttributes(applyRedaction({
+						"http.status_code": res.statusCode,
+						"http.route": route
+					}));
+					if (res.statusCode >= 400) span.setStatus({
+						code: 2,
+						message: `HTTP ${res.statusCode}`
 					});
-					return;
+					span.end();
+				}
+				if (requestCounter) requestCounter.add(1, attributes);
+				if (requestDuration) requestDuration.record(duration, attributes);
+			});
+		};
+		return {
+			applyRedaction,
+			beforeStart() {
+				try {
+					const otelApi = __require("@opentelemetry/api");
+					if (options.tracing) {
+						tracer = otelApi.trace.getTracer(options.serviceName, options.serviceVersion);
+						log.info(`Tracing enabled for ${options.serviceName}`);
+					}
+					if (options.metrics) {
+						meter = otelApi.metrics.getMeter(options.serviceName, options.serviceVersion);
+						requestCounter = meter.createCounter("http.server.request.count", { description: "Total number of HTTP requests" });
+						requestDuration = meter.createHistogram("http.server.request.duration", {
+							description: "HTTP request duration in milliseconds",
+							unit: "ms"
+						});
+						log.info("Metrics enabled — http.server.request.count, http.server.request.duration");
+					}
+				} catch {
+					log.warn("OpenTelemetry API not found. Install @opentelemetry/api to enable tracing and metrics.");
 				}
-				this.onFinish(req, res, startTime, null);
-				next();
 			},
-			phase: "beforeGlobal"
-		}];
-	}
-	onFinish(req, res, startTime, span) {
-		res.on("finish", () => {
-			const duration = performance.now() - startTime;
-			const route = req.route?.path ?? req.path;
-			const attributes = {
-				"http.method": req.method,
-				"http.route": route,
-				"http.status_code": res.statusCode
-			};
-			if (span) {
-				span.setAttributes(this.applyRedaction({
-					"http.status_code": res.statusCode,
-					"http.route": route
-				}));
-				if (res.statusCode >= 400) span.setStatus({
-					code: 2,
-					message: `HTTP ${res.statusCode}`
-				});
-				span.end();
+			middleware() {
+				return [{
+					handler: (req, res, next) => {
+						if (shouldIgnore(req.path)) return next();
+						const startTime = performance.now();
+						let span = null;
+						if (tracer) {
+							const otelApi = __require("@opentelemetry/api");
+							span = tracer.startSpan(`${req.method} ${req.route?.path ?? req.path}`, { attributes: applyRedaction({
+								"http.method": req.method,
+								"http.url": req.originalUrl,
+								"http.target": req.path,
+								"http.user_agent": req.get("user-agent") ?? "",
+								"net.host.name": req.hostname,
+								...options.customAttributes?.(req) ?? {}
+							}) });
+							const ctx = otelApi.trace.setSpan(otelApi.context.active(), span);
+							otelApi.context.with(ctx, () => {
+								onFinish(req, res, startTime, span);
+								next();
+							});
+							return;
+						}
+						onFinish(req, res, startTime, null);
+						next();
+					},
+					phase: "beforeGlobal"
+				}];
+			},
+			async shutdown() {
+				log.info("OTel adapter shutdown");
 			}
-			if (this.requestCounter) this.requestCounter.add(1, attributes);
-			if (this.requestDuration) this.requestDuration.record(duration, attributes);
-		});
-	}
-	shouldIgnore(path) {
-		if (!this.options.ignoreRoutes) return false;
-		return this.options.ignoreRoutes.some((pattern) => {
-			if (pattern.endsWith("*")) return path.startsWith(pattern.slice(0, -1));
-			return path === pattern;
-		});
-	}
-	/**
-	* Run the configured redactor over an attribute bag. Exposed so
-	* downstream code that adds attributes directly on a span
-	* (`span.setAttributes(...)`) can share the same redaction contract.
-	*/
-	applyRedaction(attrs) {
-		const out = {};
-		for (const key of Object.keys(attrs)) out[key] = this.redact(key, attrs[key]);
-		return out;
-	}
-	async shutdown() {
-		log.info("OTel adapter shutdown");
+		};
 	}
-};
+});
 /**
 * Build an attribute redactor from `sensitiveKeys` + optional
 * `redactAttribute` override. String keys match case-insensitively

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/otel.adapter.ts"],"sourcesContent":["import {\n  Logger,\n  type AppAdapter,\n  type AdapterContext,\n  type AdapterMiddleware,\n} from '@forinda/kickjs'\nimport type { Request, Response, NextFunction } from 'express'\nimport type { OtelAdapterOptions } from './types'\n\nconst log = Logger.for('OtelAdapter')\n\n/**\n * OpenTelemetry adapter for KickJS — automatic tracing and metrics.\n *\n * Creates spans for each HTTP request with route, method, status code,\n * and duration. Optionally records request count and latency histograms.\n *\n * Works with any OTel-compatible backend: Jaeger, Grafana Tempo, Datadog,\n * Honeycomb, etc. Configure exporters via the OTel SDK before bootstrapping.\n *\n * @example\n * ```ts\n * import { OtelAdapter } from '@forinda/kickjs-otel'\n *\n * // Set up OTel SDK (e.g., with Jaeger exporter) before bootstrap\n * bootstrap({\n *   modules,\n *   adapters: [\n *     new OtelAdapter({\n *       serviceName: 'my-api',\n *       serviceVersion: '1.0.0',\n *       ignoreRoutes: ['/health', '/_debug/*'],\n *     }),\n *   ],\n * })\n * ```\n */\nexport class OtelAdapter implements AppAdapter {\n  name = 'OtelAdapter'\n  private options: Required<\n    Pick<OtelAdapterOptions, 'serviceName' | 'serviceVersion' | 'tracing' | 'metrics'>\n  > &\n    OtelAdapterOptions\n  private tracer: any = null\n  private meter: any = null\n  private requestCounter: any = null\n  private requestDuration: any = null\n  private readonly redact: (key: string, value: unknown) => unknown\n\n  constructor(options: OtelAdapterOptions = {}) {\n    this.options = {\n      serviceName: options.serviceName ?? 'kickjs-app',\n      serviceVersion: options.serviceVersion ?? '0.0.0',\n      tracing: options.tracing ?? true,\n      metrics: options.metrics ?? true,\n      ...options,\n    }\n    this.redact = buildRedactor(this.options.sensitiveKeys, this.options.redactAttribute)\n  }\n\n  beforeStart({}: AdapterContext): void {\n    try {\n      // Dynamically import OTel API — it's a peer dependency\n      const otelApi = require('@opentelemetry/api')\n\n      if (this.options.tracing) {\n        this.tracer = otelApi.trace.getTracer(this.options.serviceName, this.options.serviceVersion)\n        log.info(`Tracing enabled for ${this.options.serviceName}`)\n      }\n\n      if (this.options.metrics) {\n        this.meter = otelApi.metrics.getMeter(this.options.serviceName, this.options.serviceVersion)\n\n        this.requestCounter = this.meter.createCounter('http.server.request.count', {\n          description: 'Total number of HTTP requests',\n        })\n\n        this.requestDuration = this.meter.createHistogram('http.server.request.duration', {\n          description: 'HTTP request duration in milliseconds',\n          unit: 'ms',\n        })\n\n        log.info('Metrics enabled — http.server.request.count, http.server.request.duration')\n      }\n    } catch {\n      log.warn(\n        'OpenTelemetry API not found. Install @opentelemetry/api to enable tracing and metrics.',\n      )\n    }\n  }\n\n  middleware(): AdapterMiddleware[] {\n    return [\n      {\n        handler: (req: Request, res: Response, next: NextFunction) => {\n          // Skip ignored routes\n          if (this.shouldIgnore(req.path)) {\n            return next()\n          }\n\n          const startTime = performance.now()\n\n          // Start a span if tracing is enabled\n          let span: any = null\n          if (this.tracer) {\n            const otelApi = require('@opentelemetry/api')\n            span = this.tracer.startSpan(`${req.method} ${req.route?.path ?? req.path}`, {\n              attributes: this.applyRedaction({\n                'http.method': req.method,\n                'http.url': req.originalUrl,\n                'http.target': req.path,\n                'http.user_agent': req.get('user-agent') ?? '',\n                'net.host.name': req.hostname,\n                ...(this.options.customAttributes?.(req) ?? {}),\n              }),\n            })\n\n            // Set span on context so downstream code can add attributes\n            const ctx = otelApi.trace.setSpan(otelApi.context.active(), span)\n            otelApi.context.with(ctx, () => {\n              this.onFinish(req, res, startTime, span)\n              next()\n            })\n            return\n          }\n\n          this.onFinish(req, res, startTime, null)\n          next()\n        },\n        phase: 'beforeGlobal',\n      },\n    ]\n  }\n\n  private onFinish(req: Request, res: Response, startTime: number, span: any): void {\n    res.on('finish', () => {\n      const duration = performance.now() - startTime\n      const route = (req as any).route?.path ?? req.path\n      const attributes = {\n        'http.method': req.method,\n        'http.route': route,\n        'http.status_code': res.statusCode,\n      }\n\n      // End span\n      if (span) {\n        span.setAttributes(\n          this.applyRedaction({\n            'http.status_code': res.statusCode,\n            'http.route': route,\n          }),\n        )\n        if (res.statusCode >= 400) {\n          span.setStatus({ code: 2, message: `HTTP ${res.statusCode}` })\n        }\n        span.end()\n      }\n\n      // Record metrics\n      if (this.requestCounter) {\n        this.requestCounter.add(1, attributes)\n      }\n      if (this.requestDuration) {\n        this.requestDuration.record(duration, attributes)\n      }\n    })\n  }\n\n  private shouldIgnore(path: string): boolean {\n    if (!this.options.ignoreRoutes) return false\n    return this.options.ignoreRoutes.some((pattern) => {\n      if (pattern.endsWith('*')) {\n        return path.startsWith(pattern.slice(0, -1))\n      }\n      return path === pattern\n    })\n  }\n\n  /**\n   * Run the configured redactor over an attribute bag. Exposed so\n   * downstream code that adds attributes directly on a span\n   * (`span.setAttributes(...)`) can share the same redaction contract.\n   */\n  applyRedaction<T extends Record<string, unknown>>(attrs: T): Record<string, unknown> {\n    const out: Record<string, unknown> = {}\n    for (const key of Object.keys(attrs)) {\n      out[key] = this.redact(key, attrs[key])\n    }\n    return out\n  }\n\n  async shutdown(): Promise<void> {\n    log.info('OTel adapter shutdown')\n  }\n}\n\n/**\n * Build an attribute redactor from `sensitiveKeys` + optional\n * `redactAttribute` override. String keys match case-insensitively\n * against the attribute name; `RegExp` entries are matched verbatim.\n * A custom `redactAttribute` runs after the key-based mask so users\n * can inspect values too.\n */\nfunction buildRedactor(\n  sensitiveKeys: (string | RegExp)[] | undefined,\n  custom: ((key: string, value: unknown) => unknown) | undefined,\n): (key: string, value: unknown) => unknown {\n  if (custom) return custom\n  if (!sensitiveKeys || sensitiveKeys.length === 0) return (_k, v) => v\n\n  const lowered = new Set<string>()\n  const patterns: RegExp[] = []\n  for (const entry of sensitiveKeys) {\n    if (typeof entry === 'string') lowered.add(entry.toLowerCase())\n    else patterns.push(entry)\n  }\n\n  return (key: string, value: unknown) => {\n    const lower = key.toLowerCase()\n    if (lowered.has(lower)) return '[REDACTED]'\n    for (const p of patterns) {\n      if (p.test(key)) return '[REDACTED]'\n    }\n    return value\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;AASA,MAAM,MAAM,OAAO,IAAI,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BrC,IAAa,cAAb,MAA+C;CAC7C,OAAO;CACP;CAIA,SAAsB;CACtB,QAAqB;CACrB,iBAA8B;CAC9B,kBAA+B;CAC/B;CAEA,YAAY,UAA8B,EAAE,EAAE;AAC5C,OAAK,UAAU;GACb,aAAa,QAAQ,eAAe;GACpC,gBAAgB,QAAQ,kBAAkB;GAC1C,SAAS,QAAQ,WAAW;GAC5B,SAAS,QAAQ,WAAW;GAC5B,GAAG;GACJ;AACD,OAAK,SAAS,cAAc,KAAK,QAAQ,eAAe,KAAK,QAAQ,gBAAgB;;CAGvF,YAAY,IAA0B;AACpC,MAAI;GAEF,MAAM,UAAA,UAAkB,qBAAqB;AAE7C,OAAI,KAAK,QAAQ,SAAS;AACxB,SAAK,SAAS,QAAQ,MAAM,UAAU,KAAK,QAAQ,aAAa,KAAK,QAAQ,eAAe;AAC5F,QAAI,KAAK,uBAAuB,KAAK,QAAQ,cAAc;;AAG7D,OAAI,KAAK,QAAQ,SAAS;AACxB,SAAK,QAAQ,QAAQ,QAAQ,SAAS,KAAK,QAAQ,aAAa,KAAK,QAAQ,eAAe;AAE5F,SAAK,iBAAiB,KAAK,MAAM,cAAc,6BAA6B,EAC1E,aAAa,iCACd,CAAC;AAEF,SAAK,kBAAkB,KAAK,MAAM,gBAAgB,gCAAgC;KAChF,aAAa;KACb,MAAM;KACP,CAAC;AAEF,QAAI,KAAK,4EAA4E;;UAEjF;AACN,OAAI,KACF,yFACD;;;CAIL,aAAkC;AAChC,SAAO,CACL;GACE,UAAU,KAAc,KAAe,SAAuB;AAE5D,QAAI,KAAK,aAAa,IAAI,KAAK,CAC7B,QAAO,MAAM;IAGf,MAAM,YAAY,YAAY,KAAK;IAGnC,IAAI,OAAY;AAChB,QAAI,KAAK,QAAQ;KACf,MAAM,UAAA,UAAkB,qBAAqB;AAC7C,YAAO,KAAK,OAAO,UAAU,GAAG,IAAI,OAAO,GAAG,IAAI,OAAO,QAAQ,IAAI,QAAQ,EAC3E,YAAY,KAAK,eAAe;MAC9B,eAAe,IAAI;MACnB,YAAY,IAAI;MAChB,eAAe,IAAI;MACnB,mBAAmB,IAAI,IAAI,aAAa,IAAI;MAC5C,iBAAiB,IAAI;MACrB,GAAI,KAAK,QAAQ,mBAAmB,IAAI,IAAI,EAAE;MAC/C,CAAC,EACH,CAAC;KAGF,MAAM,MAAM,QAAQ,MAAM,QAAQ,QAAQ,QAAQ,QAAQ,EAAE,KAAK;AACjE,aAAQ,QAAQ,KAAK,WAAW;AAC9B,WAAK,SAAS,KAAK,KAAK,WAAW,KAAK;AACxC,YAAM;OACN;AACF;;AAGF,SAAK,SAAS,KAAK,KAAK,WAAW,KAAK;AACxC,UAAM;;GAER,OAAO;GACR,CACF;;CAGH,SAAiB,KAAc,KAAe,WAAmB,MAAiB;AAChF,MAAI,GAAG,gBAAgB;GACrB,MAAM,WAAW,YAAY,KAAK,GAAG;GACrC,MAAM,QAAS,IAAY,OAAO,QAAQ,IAAI;GAC9C,MAAM,aAAa;IACjB,eAAe,IAAI;IACnB,cAAc;IACd,oBAAoB,IAAI;IACzB;AAGD,OAAI,MAAM;AACR,SAAK,cACH,KAAK,eAAe;KAClB,oBAAoB,IAAI;KACxB,cAAc;KACf,CAAC,CACH;AACD,QAAI,IAAI,cAAc,IACpB,MAAK,UAAU;KAAE,MAAM;KAAG,SAAS,QAAQ,IAAI;KAAc,CAAC;AAEhE,SAAK,KAAK;;AAIZ,OAAI,KAAK,eACP,MAAK,eAAe,IAAI,GAAG,WAAW;AAExC,OAAI,KAAK,gBACP,MAAK,gBAAgB,OAAO,UAAU,WAAW;IAEnD;;CAGJ,aAAqB,MAAuB;AAC1C,MAAI,CAAC,KAAK,QAAQ,aAAc,QAAO;AACvC,SAAO,KAAK,QAAQ,aAAa,MAAM,YAAY;AACjD,OAAI,QAAQ,SAAS,IAAI,CACvB,QAAO,KAAK,WAAW,QAAQ,MAAM,GAAG,GAAG,CAAC;AAE9C,UAAO,SAAS;IAChB;;;;;;;CAQJ,eAAkD,OAAmC;EACnF,MAAM,MAA+B,EAAE;AACvC,OAAK,MAAM,OAAO,OAAO,KAAK,MAAM,CAClC,KAAI,OAAO,KAAK,OAAO,KAAK,MAAM,KAAK;AAEzC,SAAO;;CAGT,MAAM,WAA0B;AAC9B,MAAI,KAAK,wBAAwB;;;;;;;;;;AAWrC,SAAS,cACP,eACA,QAC0C;AAC1C,KAAI,OAAQ,QAAO;AACnB,KAAI,CAAC,iBAAiB,cAAc,WAAW,EAAG,SAAQ,IAAI,MAAM;CAEpE,MAAM,0BAAU,IAAI,KAAa;CACjC,MAAM,WAAqB,EAAE;AAC7B,MAAK,MAAM,SAAS,cAClB,KAAI,OAAO,UAAU,SAAU,SAAQ,IAAI,MAAM,aAAa,CAAC;KAC1D,UAAS,KAAK,MAAM;AAG3B,SAAQ,KAAa,UAAmB;EACtC,MAAM,QAAQ,IAAI,aAAa;AAC/B,MAAI,QAAQ,IAAI,MAAM,CAAE,QAAO;AAC/B,OAAK,MAAM,KAAK,SACd,KAAI,EAAE,KAAK,IAAI,CAAE,QAAO;AAE1B,SAAO"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/otel.adapter.ts"],"sourcesContent":["import { Logger, defineAdapter, type AdapterMiddleware } from '@forinda/kickjs'\nimport type { Request, Response, NextFunction } from 'express'\nimport type { OtelAdapterOptions } from './types'\n\nconst log = Logger.for('OtelAdapter')\n\n/**\n * Public extension methods exposed by an OtelAdapter instance beyond\n * the standard {@link AppAdapter} contract. Surfaced via `TExtra` on\n * `defineAdapter` so peer adapters / tests / downstream code that\n * adds attributes directly on a span can share the redaction contract.\n */\nexport interface OtelAdapterExtensions {\n  /**\n   * Run the configured redactor over an attribute bag. Useful for code\n   * that adds attributes directly on a span (`span.setAttributes(...)`)\n   * outside the request middleware path — applies the same key matching\n   * (case-insensitive strings, regex patterns) declared on the adapter.\n   */\n  applyRedaction<T extends Record<string, unknown>>(attrs: T): Record<string, unknown>\n}\n\n/**\n * OpenTelemetry adapter for KickJS — automatic tracing and metrics.\n *\n * Creates spans for each HTTP request with route, method, status code,\n * and duration. Optionally records request count and latency histograms.\n *\n * Works with any OTel-compatible backend: Jaeger, Grafana Tempo, Datadog,\n * Honeycomb, etc. Configure exporters via the OTel SDK before bootstrapping.\n *\n * @example\n * ```ts\n * import { OtelAdapter } from '@forinda/kickjs-otel'\n *\n * // Set up OTel SDK (e.g., with Jaeger exporter) before bootstrap\n * bootstrap({\n *   modules,\n *   adapters: [\n *     OtelAdapter({\n *       serviceName: 'my-api',\n *       serviceVersion: '1.0.0',\n *       ignoreRoutes: ['/health', '/_debug/*'],\n *     }),\n *   ],\n * })\n * ```\n */\nexport const OtelAdapter = defineAdapter<OtelAdapterOptions, OtelAdapterExtensions>({\n  name: 'OtelAdapter',\n  defaults: {\n    serviceName: 'kickjs-app',\n    serviceVersion: '0.0.0',\n    tracing: true,\n    metrics: true,\n  },\n  build: (options) => {\n    const redact = buildRedactor(options.sensitiveKeys, options.redactAttribute)\n\n    let tracer: any = null\n    let meter: any = null\n    let requestCounter: any = null\n    let requestDuration: any = null\n\n    const applyRedaction = <T extends Record<string, unknown>>(\n      attrs: T,\n    ): Record<string, unknown> => {\n      const out: Record<string, unknown> = {}\n      for (const key of Object.keys(attrs)) {\n        out[key] = redact(key, attrs[key])\n      }\n      return out\n    }\n\n    const shouldIgnore = (path: string): boolean => {\n      if (!options.ignoreRoutes) return false\n      return options.ignoreRoutes.some((pattern) => {\n        if (pattern.endsWith('*')) {\n          return path.startsWith(pattern.slice(0, -1))\n        }\n        return path === pattern\n      })\n    }\n\n    const onFinish = (req: Request, res: Response, startTime: number, span: any): void => {\n      res.on('finish', () => {\n        const duration = performance.now() - startTime\n        const route = (req as any).route?.path ?? req.path\n        const attributes = {\n          'http.method': req.method,\n          'http.route': route,\n          'http.status_code': res.statusCode,\n        }\n\n        if (span) {\n          span.setAttributes(\n            applyRedaction({\n              'http.status_code': res.statusCode,\n              'http.route': route,\n            }),\n          )\n          if (res.statusCode >= 400) {\n            span.setStatus({ code: 2, message: `HTTP ${res.statusCode}` })\n          }\n          span.end()\n        }\n\n        if (requestCounter) {\n          requestCounter.add(1, attributes)\n        }\n        if (requestDuration) {\n          requestDuration.record(duration, attributes)\n        }\n      })\n    }\n\n    return {\n      applyRedaction,\n\n      beforeStart() {\n        try {\n          // Dynamically import OTel API — it's a peer dependency\n          const otelApi = require('@opentelemetry/api')\n\n          if (options.tracing) {\n            tracer = otelApi.trace.getTracer(options.serviceName!, options.serviceVersion!)\n            log.info(`Tracing enabled for ${options.serviceName}`)\n          }\n\n          if (options.metrics) {\n            meter = otelApi.metrics.getMeter(options.serviceName!, options.serviceVersion!)\n\n            requestCounter = meter.createCounter('http.server.request.count', {\n              description: 'Total number of HTTP requests',\n            })\n\n            requestDuration = meter.createHistogram('http.server.request.duration', {\n              description: 'HTTP request duration in milliseconds',\n              unit: 'ms',\n            })\n\n            log.info('Metrics enabled — http.server.request.count, http.server.request.duration')\n          }\n        } catch {\n          log.warn(\n            'OpenTelemetry API not found. Install @opentelemetry/api to enable tracing and metrics.',\n          )\n        }\n      },\n\n      middleware(): AdapterMiddleware[] {\n        return [\n          {\n            handler: (req: Request, res: Response, next: NextFunction) => {\n              if (shouldIgnore(req.path)) {\n                return next()\n              }\n\n              const startTime = performance.now()\n\n              let span: any = null\n              if (tracer) {\n                const otelApi = require('@opentelemetry/api')\n                span = tracer.startSpan(`${req.method} ${req.route?.path ?? req.path}`, {\n                  attributes: applyRedaction({\n                    'http.method': req.method,\n                    'http.url': req.originalUrl,\n                    'http.target': req.path,\n                    'http.user_agent': req.get('user-agent') ?? '',\n                    'net.host.name': req.hostname,\n                    ...(options.customAttributes?.(req) ?? {}),\n                  }),\n                })\n\n                const ctx = otelApi.trace.setSpan(otelApi.context.active(), span)\n                otelApi.context.with(ctx, () => {\n                  onFinish(req, res, startTime, span)\n                  next()\n                })\n                return\n              }\n\n              onFinish(req, res, startTime, null)\n              next()\n            },\n            phase: 'beforeGlobal',\n          },\n        ]\n      },\n\n      async shutdown() {\n        log.info('OTel adapter shutdown')\n      },\n    }\n  },\n})\n\n/**\n * Build an attribute redactor from `sensitiveKeys` + optional\n * `redactAttribute` override. String keys match case-insensitively\n * against the attribute name; `RegExp` entries are matched verbatim.\n * A custom `redactAttribute` runs after the key-based mask so users\n * can inspect values too.\n */\nfunction buildRedactor(\n  sensitiveKeys: (string | RegExp)[] | undefined,\n  custom: ((key: string, value: unknown) => unknown) | undefined,\n): (key: string, value: unknown) => unknown {\n  if (custom) return custom\n  if (!sensitiveKeys || sensitiveKeys.length === 0) return (_k, v) => v\n\n  const lowered = new Set<string>()\n  const patterns: RegExp[] = []\n  for (const entry of sensitiveKeys) {\n    if (typeof entry === 'string') lowered.add(entry.toLowerCase())\n    else patterns.push(entry)\n  }\n\n  return (key: string, value: unknown) => {\n    const lower = key.toLowerCase()\n    if (lowered.has(lower)) return '[REDACTED]'\n    for (const p of patterns) {\n      if (p.test(key)) return '[REDACTED]'\n    }\n    return value\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAIA,MAAM,MAAM,OAAO,IAAI,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CrC,MAAa,cAAc,cAAyD;CAClF,MAAM;CACN,UAAU;EACR,aAAa;EACb,gBAAgB;EAChB,SAAS;EACT,SAAS;EACV;CACD,QAAQ,YAAY;EAClB,MAAM,SAAS,cAAc,QAAQ,eAAe,QAAQ,gBAAgB;EAE5E,IAAI,SAAc;EAClB,IAAI,QAAa;EACjB,IAAI,iBAAsB;EAC1B,IAAI,kBAAuB;EAE3B,MAAM,kBACJ,UAC4B;GAC5B,MAAM,MAA+B,EAAE;AACvC,QAAK,MAAM,OAAO,OAAO,KAAK,MAAM,CAClC,KAAI,OAAO,OAAO,KAAK,MAAM,KAAK;AAEpC,UAAO;;EAGT,MAAM,gBAAgB,SAA0B;AAC9C,OAAI,CAAC,QAAQ,aAAc,QAAO;AAClC,UAAO,QAAQ,aAAa,MAAM,YAAY;AAC5C,QAAI,QAAQ,SAAS,IAAI,CACvB,QAAO,KAAK,WAAW,QAAQ,MAAM,GAAG,GAAG,CAAC;AAE9C,WAAO,SAAS;KAChB;;EAGJ,MAAM,YAAY,KAAc,KAAe,WAAmB,SAAoB;AACpF,OAAI,GAAG,gBAAgB;IACrB,MAAM,WAAW,YAAY,KAAK,GAAG;IACrC,MAAM,QAAS,IAAY,OAAO,QAAQ,IAAI;IAC9C,MAAM,aAAa;KACjB,eAAe,IAAI;KACnB,cAAc;KACd,oBAAoB,IAAI;KACzB;AAED,QAAI,MAAM;AACR,UAAK,cACH,eAAe;MACb,oBAAoB,IAAI;MACxB,cAAc;MACf,CAAC,CACH;AACD,SAAI,IAAI,cAAc,IACpB,MAAK,UAAU;MAAE,MAAM;MAAG,SAAS,QAAQ,IAAI;MAAc,CAAC;AAEhE,UAAK,KAAK;;AAGZ,QAAI,eACF,gBAAe,IAAI,GAAG,WAAW;AAEnC,QAAI,gBACF,iBAAgB,OAAO,UAAU,WAAW;KAE9C;;AAGJ,SAAO;GACL;GAEA,cAAc;AACZ,QAAI;KAEF,MAAM,UAAA,UAAkB,qBAAqB;AAE7C,SAAI,QAAQ,SAAS;AACnB,eAAS,QAAQ,MAAM,UAAU,QAAQ,aAAc,QAAQ,eAAgB;AAC/E,UAAI,KAAK,uBAAuB,QAAQ,cAAc;;AAGxD,SAAI,QAAQ,SAAS;AACnB,cAAQ,QAAQ,QAAQ,SAAS,QAAQ,aAAc,QAAQ,eAAgB;AAE/E,uBAAiB,MAAM,cAAc,6BAA6B,EAChE,aAAa,iCACd,CAAC;AAEF,wBAAkB,MAAM,gBAAgB,gCAAgC;OACtE,aAAa;OACb,MAAM;OACP,CAAC;AAEF,UAAI,KAAK,4EAA4E;;YAEjF;AACN,SAAI,KACF,yFACD;;;GAIL,aAAkC;AAChC,WAAO,CACL;KACE,UAAU,KAAc,KAAe,SAAuB;AAC5D,UAAI,aAAa,IAAI,KAAK,CACxB,QAAO,MAAM;MAGf,MAAM,YAAY,YAAY,KAAK;MAEnC,IAAI,OAAY;AAChB,UAAI,QAAQ;OACV,MAAM,UAAA,UAAkB,qBAAqB;AAC7C,cAAO,OAAO,UAAU,GAAG,IAAI,OAAO,GAAG,IAAI,OAAO,QAAQ,IAAI,QAAQ,EACtE,YAAY,eAAe;QACzB,eAAe,IAAI;QACnB,YAAY,IAAI;QAChB,eAAe,IAAI;QACnB,mBAAmB,IAAI,IAAI,aAAa,IAAI;QAC5C,iBAAiB,IAAI;QACrB,GAAI,QAAQ,mBAAmB,IAAI,IAAI,EAAE;QAC1C,CAAC,EACH,CAAC;OAEF,MAAM,MAAM,QAAQ,MAAM,QAAQ,QAAQ,QAAQ,QAAQ,EAAE,KAAK;AACjE,eAAQ,QAAQ,KAAK,WAAW;AAC9B,iBAAS,KAAK,KAAK,WAAW,KAAK;AACnC,cAAM;SACN;AACF;;AAGF,eAAS,KAAK,KAAK,WAAW,KAAK;AACnC,YAAM;;KAER,OAAO;KACR,CACF;;GAGH,MAAM,WAAW;AACf,QAAI,KAAK,wBAAwB;;GAEpC;;CAEJ,CAAC;;;;;;;;AASF,SAAS,cACP,eACA,QAC0C;AAC1C,KAAI,OAAQ,QAAO;AACnB,KAAI,CAAC,iBAAiB,cAAc,WAAW,EAAG,SAAQ,IAAI,MAAM;CAEpE,MAAM,0BAAU,IAAI,KAAa;CACjC,MAAM,WAAqB,EAAE;AAC7B,MAAK,MAAM,SAAS,cAClB,KAAI,OAAO,UAAU,SAAU,SAAQ,IAAI,MAAM,aAAa,CAAC;KAC1D,UAAS,KAAK,MAAM;AAG3B,SAAQ,KAAa,UAAmB;EACtC,MAAM,QAAQ,IAAI,aAAa;AAC/B,MAAI,QAAQ,IAAI,MAAM,CAAE,QAAO;AAC/B,OAAK,MAAM,KAAK,SACd,KAAI,EAAE,KAAK,IAAI,CAAE,QAAO;AAE1B,SAAO"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forinda/kickjs-otel",
-  "version": "3.1.3",
+  "version": "4.0.0",
   "description": "OpenTelemetry adapter for KickJS — automatic tracing, metrics, and export to any OTel backend",
   "keywords": [
     "kickjs",
@@ -24,13 +24,10 @@
     "@forinda/kickjs",
     "@forinda/kickjs-auth",
     "@forinda/kickjs-cli",
-    "@forinda/kickjs-config",
-    "@forinda/kickjs-core",
     "@forinda/kickjs-cron",
     "@forinda/kickjs-devtools",
     "@forinda/kickjs-drizzle",
     "@forinda/kickjs-graphql",
-    "@forinda/kickjs-http",
     "@forinda/kickjs-mailer",
     "@forinda/kickjs-multi-tenant",
     "@forinda/kickjs-notifications",
@@ -66,10 +63,7 @@
       "output": [
         "dist/**"
       ],
-      "dependencies": [
-        "../core:build",
-        "../http:build"
-      ]
+      "dependencies": []
     }
   },
   "dependencies": {
@@ -96,14 +90,14 @@
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
-    "@opentelemetry/sdk-metrics": "^2.6.1",
-    "@opentelemetry/sdk-trace-base": "^2.6.1",
+    "@opentelemetry/sdk-metrics": "^2.7.0",
+    "@opentelemetry/sdk-trace-base": "^2.7.0",
     "@opentelemetry/semantic-conventions": "^1.4.0",
-    "@types/node": "^25.0.0",
-    "typescript": "^5.9.2",
+    "@types/node": "^25.6.0",
+    "typescript": "^6.0.3",
     "unplugin-swc": "^1.5.9",
-    "vitest": "^4.1.2",
-    "@forinda/kickjs": "3.1.3"
+    "vitest": "^4.1.5",
+    "@forinda/kickjs": "4.0.0"
   },
   "publishConfig": {
     "access": "public"