@forinda/kickjs-otel 1.2.10 → 1.2.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -1,135 +1 @@
1
- var __defProp = Object.defineProperty;
2
- var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
3
- var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
4
- get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
5
- }) : x)(function(x) {
6
- if (typeof require !== "undefined") return require.apply(this, arguments);
7
- throw Error('Dynamic require of "' + x + '" is not supported');
8
- });
9
-
10
- // src/otel.adapter.ts
11
- import { Logger } from "@forinda/kickjs-core";
12
- var log = Logger.for("OtelAdapter");
13
- var OtelAdapter = class {
14
- static {
15
- __name(this, "OtelAdapter");
16
- }
17
- name = "OtelAdapter";
18
- options;
19
- tracer = null;
20
- meter = null;
21
- requestCounter = null;
22
- requestDuration = null;
23
- constructor(options = {}) {
24
- this.options = {
25
- serviceName: options.serviceName ?? "kickjs-app",
26
- serviceVersion: options.serviceVersion ?? "0.0.0",
27
- tracing: options.tracing ?? true,
28
- metrics: options.metrics ?? true,
29
- ...options
30
- };
31
- }
32
- beforeStart(_app, _container) {
33
- try {
34
- const otelApi = __require("@opentelemetry/api");
35
- if (this.options.tracing) {
36
- this.tracer = otelApi.trace.getTracer(this.options.serviceName, this.options.serviceVersion);
37
- log.info(`Tracing enabled for ${this.options.serviceName}`);
38
- }
39
- if (this.options.metrics) {
40
- this.meter = otelApi.metrics.getMeter(this.options.serviceName, this.options.serviceVersion);
41
- this.requestCounter = this.meter.createCounter("http.server.request.count", {
42
- description: "Total number of HTTP requests"
43
- });
44
- this.requestDuration = this.meter.createHistogram("http.server.request.duration", {
45
- description: "HTTP request duration in milliseconds",
46
- unit: "ms"
47
- });
48
- log.info("Metrics enabled \u2014 http.server.request.count, http.server.request.duration");
49
- }
50
- } catch {
51
- log.warn("OpenTelemetry API not found. Install @opentelemetry/api to enable tracing and metrics.");
52
- }
53
- }
54
- middleware() {
55
- return [
56
- {
57
- handler: /* @__PURE__ */ __name((req, res, next) => {
58
- if (this.shouldIgnore(req.path)) {
59
- return next();
60
- }
61
- const startTime = performance.now();
62
- let span = null;
63
- if (this.tracer) {
64
- const otelApi = __require("@opentelemetry/api");
65
- span = this.tracer.startSpan(`${req.method} ${req.route?.path ?? req.path}`, {
66
- attributes: {
67
- "http.method": req.method,
68
- "http.url": req.originalUrl,
69
- "http.target": req.path,
70
- "http.user_agent": req.get("user-agent") ?? "",
71
- "net.host.name": req.hostname,
72
- ...this.options.customAttributes?.(req) ?? {}
73
- }
74
- });
75
- const ctx = otelApi.trace.setSpan(otelApi.context.active(), span);
76
- otelApi.context.with(ctx, () => {
77
- this.onFinish(req, res, startTime, span);
78
- next();
79
- });
80
- return;
81
- }
82
- this.onFinish(req, res, startTime, null);
83
- next();
84
- }, "handler"),
85
- phase: "beforeGlobal"
86
- }
87
- ];
88
- }
89
- onFinish(req, res, startTime, span) {
90
- res.on("finish", () => {
91
- const duration = performance.now() - startTime;
92
- const route = req.route?.path ?? req.path;
93
- const attributes = {
94
- "http.method": req.method,
95
- "http.route": route,
96
- "http.status_code": res.statusCode
97
- };
98
- if (span) {
99
- span.setAttributes({
100
- "http.status_code": res.statusCode,
101
- "http.route": route
102
- });
103
- if (res.statusCode >= 400) {
104
- span.setStatus({
105
- code: 2,
106
- message: `HTTP ${res.statusCode}`
107
- });
108
- }
109
- span.end();
110
- }
111
- if (this.requestCounter) {
112
- this.requestCounter.add(1, attributes);
113
- }
114
- if (this.requestDuration) {
115
- this.requestDuration.record(duration, attributes);
116
- }
117
- });
118
- }
119
- shouldIgnore(path) {
120
- if (!this.options.ignoreRoutes) return false;
121
- return this.options.ignoreRoutes.some((pattern) => {
122
- if (pattern.endsWith("*")) {
123
- return path.startsWith(pattern.slice(0, -1));
124
- }
125
- return path === pattern;
126
- });
127
- }
128
- async shutdown() {
129
- log.info("OTel adapter shutdown");
130
- }
131
- };
132
- export {
133
- OtelAdapter
134
- };
135
- //# sourceMappingURL=index.js.map
1
+ var l=Object.defineProperty;var h=(s,t)=>l(s,"name",{value:t,configurable:!0}),p=(s=>typeof require<"u"?require:typeof Proxy<"u"?new Proxy(s,{get:(t,e)=>(typeof require<"u"?require:t)[e]}):s)(function(s){if(typeof require<"u")return require.apply(this,arguments);throw Error('Dynamic require of "'+s+'" is not supported')});import{Logger as d}from"@forinda/kickjs-core";var u=d.for("OtelAdapter"),c=class{static{h(this,"OtelAdapter")}name="OtelAdapter";options;tracer=null;meter=null;requestCounter=null;requestDuration=null;constructor(t={}){this.options={serviceName:t.serviceName??"kickjs-app",serviceVersion:t.serviceVersion??"0.0.0",tracing:t.tracing??!0,metrics:t.metrics??!0,...t}}beforeStart(t,e){try{let r=p("@opentelemetry/api");this.options.tracing&&(this.tracer=r.trace.getTracer(this.options.serviceName,this.options.serviceVersion),u.info(`Tracing enabled for ${this.options.serviceName}`)),this.options.metrics&&(this.meter=r.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"}),u.info("Metrics enabled \u2014 http.server.request.count, http.server.request.duration"))}catch{u.warn("OpenTelemetry API not found. Install @opentelemetry/api to enable tracing and metrics.")}}middleware(){return[{handler:h((t,e,r)=>{if(this.shouldIgnore(t.path))return r();let i=performance.now(),n=null;if(this.tracer){let o=p("@opentelemetry/api");n=this.tracer.startSpan(`${t.method} ${t.route?.path??t.path}`,{attributes:{"http.method":t.method,"http.url":t.originalUrl,"http.target":t.path,"http.user_agent":t.get("user-agent")??"","net.host.name":t.hostname,...this.options.customAttributes?.(t)??{}}});let a=o.trace.setSpan(o.context.active(),n);o.context.with(a,()=>{this.onFinish(t,e,i,n),r()});return}this.onFinish(t,e,i,null),r()},"handler"),phase:"beforeGlobal"}]}onFinish(t,e,r,i){e.on("finish",()=>{let n=performance.now()-r,o=t.route?.path??t.path,a={"http.method":t.method,"http.route":o,"http.status_code":e.statusCode};i&&(i.setAttributes({"http.status_code":e.statusCode,"http.route":o}),e.statusCode>=400&&i.setStatus({code:2,message:`HTTP ${e.statusCode}`}),i.end()),this.requestCounter&&this.requestCounter.add(1,a),this.requestDuration&&this.requestDuration.record(n,a)})}shouldIgnore(t){return this.options.ignoreRoutes?this.options.ignoreRoutes.some(e=>e.endsWith("*")?t.startsWith(e.slice(0,-1)):t===e):!1}async shutdown(){u.info("OTel adapter shutdown")}};export{c as OtelAdapter};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forinda/kickjs-otel",
3
- "version": "1.2.10",
3
+ "version": "1.2.12",
4
4
  "description": "OpenTelemetry adapter for KickJS — automatic tracing, metrics, and export to any OTel backend",
5
5
  "keywords": [
6
6
  "kickjs",
@@ -33,8 +33,8 @@
33
33
  ],
34
34
  "dependencies": {
35
35
  "reflect-metadata": "^0.2.2",
36
- "@forinda/kickjs-core": "1.2.10",
37
- "@forinda/kickjs-http": "1.2.10"
36
+ "@forinda/kickjs-core": "1.2.12",
37
+ "@forinda/kickjs-http": "1.2.12"
38
38
  },
39
39
  "peerDependencies": {
40
40
  "@opentelemetry/api": ">=1.4.0",
package/dist/index.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/otel.adapter.ts"],"sourcesContent":["import {\n Logger,\n type AppAdapter,\n type AdapterMiddleware,\n type Container,\n} from '@forinda/kickjs-core'\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\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 }\n\n beforeStart(_app: any, _container: Container): 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: {\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 'http.status_code': res.statusCode,\n 'http.route': route,\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 async shutdown(): Promise<void> {\n log.info('OTel adapter shutdown')\n }\n}\n"],"mappings":";;;;;;;;;;AAAA,SACEA,cAIK;AAIP,IAAMC,MAAMC,OAAOC,IAAI,aAAA;AA4BhB,IAAMC,cAAN,MAAMA;EArCb,OAqCaA;;;EACXC,OAAO;EACCC;EAIAC,SAAc;EACdC,QAAa;EACbC,iBAAsB;EACtBC,kBAAuB;EAE/B,YAAYJ,UAA8B,CAAC,GAAG;AAC5C,SAAKA,UAAU;MACbK,aAAaL,QAAQK,eAAe;MACpCC,gBAAgBN,QAAQM,kBAAkB;MAC1CC,SAASP,QAAQO,WAAW;MAC5BC,SAASR,QAAQQ,WAAW;MAC5B,GAAGR;IACL;EACF;EAEAS,YAAYC,MAAWC,YAA6B;AAClD,QAAI;AAEF,YAAMC,UAAUC,UAAQ,oBAAA;AAExB,UAAI,KAAKb,QAAQO,SAAS;AACxB,aAAKN,SAASW,QAAQE,MAAMC,UAAU,KAAKf,QAAQK,aAAa,KAAKL,QAAQM,cAAc;AAC3FX,YAAIqB,KAAK,uBAAuB,KAAKhB,QAAQK,WAAW,EAAE;MAC5D;AAEA,UAAI,KAAKL,QAAQQ,SAAS;AACxB,aAAKN,QAAQU,QAAQJ,QAAQS,SAAS,KAAKjB,QAAQK,aAAa,KAAKL,QAAQM,cAAc;AAE3F,aAAKH,iBAAiB,KAAKD,MAAMgB,cAAc,6BAA6B;UAC1EC,aAAa;QACf,CAAA;AAEA,aAAKf,kBAAkB,KAAKF,MAAMkB,gBAAgB,gCAAgC;UAChFD,aAAa;UACbE,MAAM;QACR,CAAA;AAEA1B,YAAIqB,KAAK,gFAAA;MACX;IACF,QAAQ;AACNrB,UAAI2B,KACF,wFAAA;IAEJ;EACF;EAEAC,aAAkC;AAChC,WAAO;MACL;QACEC,SAAS,wBAACC,KAAcC,KAAeC,SAAAA;AAErC,cAAI,KAAKC,aAAaH,IAAII,IAAI,GAAG;AAC/B,mBAAOF,KAAAA;UACT;AAEA,gBAAMG,YAAYC,YAAYC,IAAG;AAGjC,cAAIC,OAAY;AAChB,cAAI,KAAKhC,QAAQ;AACf,kBAAMW,UAAUC,UAAQ,oBAAA;AACxBoB,mBAAO,KAAKhC,OAAOiC,UAAU,GAAGT,IAAIU,MAAM,IAAIV,IAAIW,OAAOP,QAAQJ,IAAII,IAAI,IAAI;cAC3EQ,YAAY;gBACV,eAAeZ,IAAIU;gBACnB,YAAYV,IAAIa;gBAChB,eAAeb,IAAII;gBACnB,mBAAmBJ,IAAIc,IAAI,YAAA,KAAiB;gBAC5C,iBAAiBd,IAAIe;gBACrB,GAAI,KAAKxC,QAAQyC,mBAAmBhB,GAAAA,KAAQ,CAAC;cAC/C;YACF,CAAA;AAGA,kBAAMiB,MAAM9B,QAAQE,MAAM6B,QAAQ/B,QAAQgC,QAAQC,OAAM,GAAIZ,IAAAA;AAC5DrB,oBAAQgC,QAAQE,KAAKJ,KAAK,MAAA;AACxB,mBAAKK,SAAStB,KAAKC,KAAKI,WAAWG,IAAAA;AACnCN,mBAAAA;YACF,CAAA;AACA;UACF;AAEA,eAAKoB,SAAStB,KAAKC,KAAKI,WAAW,IAAA;AACnCH,eAAAA;QACF,GAlCS;QAmCTqB,OAAO;MACT;;EAEJ;EAEQD,SAAStB,KAAcC,KAAeI,WAAmBG,MAAiB;AAChFP,QAAIuB,GAAG,UAAU,MAAA;AACf,YAAMC,WAAWnB,YAAYC,IAAG,IAAKF;AACrC,YAAMM,QAASX,IAAYW,OAAOP,QAAQJ,IAAII;AAC9C,YAAMQ,aAAa;QACjB,eAAeZ,IAAIU;QACnB,cAAcC;QACd,oBAAoBV,IAAIyB;MAC1B;AAGA,UAAIlB,MAAM;AACRA,aAAKmB,cAAc;UACjB,oBAAoB1B,IAAIyB;UACxB,cAAcf;QAChB,CAAA;AACA,YAAIV,IAAIyB,cAAc,KAAK;AACzBlB,eAAKoB,UAAU;YAAEC,MAAM;YAAGC,SAAS,QAAQ7B,IAAIyB,UAAU;UAAG,CAAA;QAC9D;AACAlB,aAAKuB,IAAG;MACV;AAGA,UAAI,KAAKrD,gBAAgB;AACvB,aAAKA,eAAesD,IAAI,GAAGpB,UAAAA;MAC7B;AACA,UAAI,KAAKjC,iBAAiB;AACxB,aAAKA,gBAAgBsD,OAAOR,UAAUb,UAAAA;MACxC;IACF,CAAA;EACF;EAEQT,aAAaC,MAAuB;AAC1C,QAAI,CAAC,KAAK7B,QAAQ2D,aAAc,QAAO;AACvC,WAAO,KAAK3D,QAAQ2D,aAAaC,KAAK,CAACC,YAAAA;AACrC,UAAIA,QAAQC,SAAS,GAAA,GAAM;AACzB,eAAOjC,KAAKkC,WAAWF,QAAQG,MAAM,GAAG,EAAC,CAAA;MAC3C;AACA,aAAOnC,SAASgC;IAClB,CAAA;EACF;EAEA,MAAMI,WAA0B;AAC9BtE,QAAIqB,KAAK,uBAAA;EACX;AACF;","names":["Logger","log","Logger","for","OtelAdapter","name","options","tracer","meter","requestCounter","requestDuration","serviceName","serviceVersion","tracing","metrics","beforeStart","_app","_container","otelApi","require","trace","getTracer","info","getMeter","createCounter","description","createHistogram","unit","warn","middleware","handler","req","res","next","shouldIgnore","path","startTime","performance","now","span","startSpan","method","route","attributes","originalUrl","get","hostname","customAttributes","ctx","setSpan","context","active","with","onFinish","phase","on","duration","statusCode","setAttributes","setStatus","code","message","end","add","record","ignoreRoutes","some","pattern","endsWith","startsWith","slice","shutdown"]}