@oas-tools/oas-telemetry 0.7.0 → 0.7.1

package/dist/cjs/index.cjs

@@ -15,6 +15,7 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
 // Load environment variables before any other imports
 // Initialize OpenTelemetry instrumentation
 
+// WARN: If changed the API, also change in packages/lib/src/types/cjs-index.d.ts (used for CJS compilation)
 /**
  * Returns the OAS-Telemetry middleware.
  * All parameters are optional. However, either `spec` or `specFileName` must be provided to enable endpoint filtering.

package/dist/esm/index.js

@@ -6,6 +6,7 @@ import { Router } from 'express';
 import { configureRoutes } from './routesManager.js';
 import { configureTelemetry } from './telemetry/telemetryConfigurator.js';
 import { bootEnvVariables } from "./config/bootConfig.js";
+// WARN: If changed the API, also change in packages/lib/src/types/cjs-index.d.ts (used for CJS compilation)
 /**
  * Returns the OAS-Telemetry middleware.
  * All parameters are optional. However, either `spec` or `specFileName` must be provided to enable endpoint filtering.

package/dist/types/index.d.ts

@@ -6,4 +6,5 @@ import { UserConfig } from './config/config.types.js';
  * Returns the OAS-Telemetry middleware.
  * All parameters are optional. However, either `spec` or `specFileName` must be provided to enable endpoint filtering.
  */
-export default function oasTelemetry(oasTlmInputConfig?: UserConfig): Router;
+declare function oasTelemetry(oasTlmInputConfig?: UserConfig): Router;
+export = oasTelemetry;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oas-tools/oas-telemetry",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "Automatically collects and stores telemetry data in memory using OpenTelemetry. Just import the Express middleware to access it through the built-in REST API or web UI—no extra setup required.",
   "author": "Manuel Otero",
   "contributors": [
@@ -13,26 +13,30 @@
     "dev": "env OASTLM_BOOT_ENV=development tsx test/e2e/servers/otTestServer.ts",
     "esm": "echo 'Remember to execute: \"npm run build\"' && node test/e2e/servers/otTestServer.mjs",
     "cjs": "echo 'Remember to execute: \"npm run build\"' && node test/e2e/servers/otTestServer.cjs",
-    "build": "npm run build:esm && npm run build:cjs",
+    "build": "npm run build:esm && npm run build:cjs && npm run copy:types",
     "build:esm": "tsc -p tsconfig.json && npm run copy:spec",
     "copy:spec": "mkdir -p dist/esm/docs dist/cjs/docs && cp src/docs/openapi.yaml dist/esm/docs/ && cp src/docs/openapi.yaml dist/cjs/docs/",
     "build:cjs": "babel ./dist/esm -d ./dist/cjs --out-file-extension .cjs --config-file ./.babelrc",
     "test": "vitest --run",
     "test:watch": "vitest",
-    "lint": "eslint --ext .ts . --fix"
+    "lint": "eslint --ext .ts . --fix",
+    "copy:types": "mkdir -p dist/types && cp src/types/cjs-index.d.ts dist/types/index.d.ts"
   },
   "files": [
     ".env.example",
     "NOTICE",
     "dist"
   ],
-  "main": "./dist/cjs/index.cjs",
-  "module": "./dist/esm/index.js",
-  "types": "./dist/types/index.d.ts",
   "exports": {
     ".": {
-      "require": "./dist/cjs/index.cjs",
-      "import": "./dist/esm/index.js"
+      "require": {
+        "types": "./dist/types/index.d.ts",
+        "require": "./dist/cjs/index.cjs"
+      },
+      "import": {
+        "types": "./dist/types/index.d.ts",
+        "import": "./dist/esm/index.js"
+      }
     }
   },
   "engines": {
@@ -51,6 +55,7 @@
     "@opentelemetry/sdk-trace-node": "^2.0.1",
     "@opentelemetry/semantic-conventions": "^1.34.0",
     "@seald-io/nedb": "^4.1.2",
+    "axios": "^1.12.2",
     "cookie-parser": "^1.4.7",
     "cors": "^2.8.5",
     "dotenv": "^17.0.1",
@@ -72,14 +77,13 @@
     "@babel/plugin-transform-object-rest-spread": "^7.27.3",
     "@babel/preset-env": "^7.24.4",
     "@eslint/js": "^9.29.0",
-    "@opentelemetry/api": "^1.8.0",
+    "@opentelemetry/api": "^1.9.0",
     "@types/cookie-parser": "^1.4.9",
     "@types/cors": "^2.8.19",
     "@types/express": "^5.0.3",
     "@types/js-yaml": "^4.0.9",
     "@types/jsonwebtoken": "^9.0.9",
     "@types/lodash.merge": "^4.6.9",
-    "axios": "1.12.2",
     "babel-plugin-add-module-exports": "^1.0.4",
     "babel-plugin-module-extension": "^0.1.3",
     "babel-plugin-transform-import-meta": "^2.3.3",
@@ -89,10 +93,5 @@
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.34.1",
     "vitest": "^3.2.4"
-  },
-  "optionalDependencies": {
-    "typescript": "^5.9.3",
-    "typescriptasdfasdfasdfasdfasdfasdfasdf": "*",
-    "typescriptttt": "*"
   }
 }

package/dist/cjs/telemetry/custom-implementations/exporters/PluginLogExporter.cjs

@@ -1,45 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.PluginLogExporter = void 0;
-var _core = require("@opentelemetry/core");
-var _logger = _interopRequireDefault(require("../../../utils/logger.cjs"));
-var _wrappers = require("../wrappers.cjs");
-var _pluginService = require("../../../tlm-plugin/pluginService.cjs");
-var _circular = require("../utils/circular.cjs");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-class PluginLogExporter extends _wrappers.Enabler {
-  constructor() {
-    super();
-  }
-  export(logs, resultCallback) {
-    _logger.default.debug('PluginLogExporter.export called with logs: ', logs.length);
-    try {
-      if (!this.isEnabled()) {
-        _logger.default.debug('PluginLogExporter is not enabled. Skipping export.');
-        return resultCallback({
-          code: _core.ExportResultCode.SUCCESS
-        });
-      }
-      const cleanLogs = logs.map(log => (0, _circular.removeCircularRefs)(log)).map(log => (0, _circular.applyNesting)(log));
-      cleanLogs.forEach(log => {
-        _pluginService.pluginService.broadcastLog(log);
-      });
-      setTimeout(() => resultCallback({
-        code: _core.ExportResultCode.SUCCESS
-      }), 0);
-    } catch (error) {
-      _logger.default.error('Error exporting logs\n' + error.message + '\n' + error.stack);
-      return resultCallback({
-        code: _core.ExportResultCode.FAILED,
-        error: new Error('Error exporting logs\n' + error.message + '\n' + error.stack)
-      });
-    }
-  }
-  shutdown() {
-    return Promise.resolve();
-  }
-}
-exports.PluginLogExporter = PluginLogExporter;

package/dist/cjs/telemetry/custom-implementations/exporters/PluginMetricExporter.cjs

@@ -1,46 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.PluginMetricExporter = void 0;
-var _core = require("@opentelemetry/core");
-var _logger = _interopRequireDefault(require("../../../utils/logger.cjs"));
-var _wrappers = require("../wrappers.cjs");
-var _pluginService = require("../../../tlm-plugin/pluginService.cjs");
-var _circular = require("../utils/circular.cjs");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-class PluginMetricExporter extends _wrappers.Enabler {
-  constructor() {
-    super();
-  }
-  export(metrics, resultCallback) {
-    _logger.default.debug('PluginMetricExporter.export called');
-    try {
-      if (!this.isEnabled()) {
-        _logger.default.debug('PluginMetricExporter is not enabled. Skipping export.');
-        return resultCallback({
-          code: _core.ExportResultCode.SUCCESS
-        });
-      }
-      const cleanMetrics = (0, _circular.applyNesting)((0, _circular.removeCircularRefs)(metrics));
-      _pluginService.pluginService.broadcastMetric(cleanMetrics);
-      setTimeout(() => resultCallback({
-        code: _core.ExportResultCode.SUCCESS
-      }), 0);
-    } catch (error) {
-      _logger.default.error('Error exporting metrics\n' + error.message + '\n' + error.stack);
-      return resultCallback({
-        code: _core.ExportResultCode.FAILED,
-        error: new Error('Error exporting metrics\n' + error.message + '\n' + error.stack)
-      });
-    }
-  }
-  shutdown() {
-    return Promise.resolve();
-  }
-  forceFlush() {
-    return Promise.resolve();
-  }
-}
-exports.PluginMetricExporter = PluginMetricExporter;

package/dist/cjs/telemetry/custom-implementations/exporters/PluginSpanExporter.cjs

@@ -1,61 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.PluginSpanExporter = void 0;
-var _core = require("@opentelemetry/core");
-var _logger = _interopRequireDefault(require("../../../utils/logger.cjs"));
-var _wrappers = require("../wrappers.cjs");
-var _pluginService = require("../../../tlm-plugin/pluginService.cjs");
-var _circular = require("../utils/circular.cjs");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-class PluginSpanExporter extends _wrappers.Enabler {
-  constructor() {
-    super();
-    this._baseUrl = '/telemetry'; // Default base URL, can be overridden by the config
-  }
-  set baseUrl(baseUrl) {
-    this._baseUrl = baseUrl;
-  }
-  export(readableSpans, resultCallback) {
-    _logger.default.debug('PluginSpanExporter.export called with spans: ', readableSpans.length);
-    try {
-      if (!this.isEnabled()) {
-        _logger.default.debug('PluginSpanExporter is not enabled. Skipping export.');
-        return resultCallback({
-          code: _core.ExportResultCode.SUCCESS
-        });
-      }
-      // Prepare spans to be inserted into the in-memory database (remove circular references and convert to nested objects)
-      const cleanSpans = readableSpans.map(nestedSpan => (0, _circular.removeCircularRefs)(nestedSpan)) // to avoid JSON parsing error
-      .map(span => (0, _circular.applyNesting)(span)) // to avoid dot notation in keys (neDB does not support dot notation in keys)
-      .filter(span => {
-        const target = span?.attributes?.http?.target; // Exclude spans where target includes 'telemetry' but NOT 'telemetry/utils'
-        if (target && target.includes(this._baseUrl)) {
-          return target.includes(this._baseUrl + '/utils');
-        }
-        return true;
-      });
-      cleanSpans.forEach(span => {
-        _pluginService.pluginService.broadcastTrace(span);
-      });
-      setTimeout(() => resultCallback({
-        code: _core.ExportResultCode.SUCCESS
-      }), 0);
-    } catch (error) {
-      _logger.default.error('Error exporting spans\n' + error.message + '\n' + error.stack);
-      return resultCallback({
-        code: _core.ExportResultCode.FAILED,
-        error: new Error('Error exporting spans\n' + error.message + '\n' + error.stack)
-      });
-    }
-  }
-  shutdown() {
-    return this.forceFlush();
-  }
-  forceFlush() {
-    return Promise.resolve();
-  }
-}
-exports.PluginSpanExporter = PluginSpanExporter;

package/dist/cjs/tlm-ai/knownMicroservices.cjs

@@ -1,13 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.setKnownMicroservices = exports.getKnownMicroservices = void 0;
-let knownMicroservices = null;
-const getKnownMicroservices = () => knownMicroservices || [];
-exports.getKnownMicroservices = getKnownMicroservices;
-const setKnownMicroservices = microservices => {
-  knownMicroservices = microservices;
-};
-exports.setKnownMicroservices = setKnownMicroservices;

package/dist/esm/telemetry/custom-implementations/exporters/PluginLogExporter.js

@@ -1,36 +0,0 @@
-import { ExportResultCode } from '@opentelemetry/core';
-import logger from '../../../utils/logger.js';
-import { Enabler } from '../wrappers.js';
-import { pluginService } from '../../../tlm-plugin/pluginService.js';
-import { applyNesting, removeCircularRefs } from '../utils/circular.js';
-export class PluginLogExporter extends Enabler {
-    constructor() {
-        super();
-    }
-    export(logs, resultCallback) {
-        logger.debug('PluginLogExporter.export called with logs: ', logs.length);
-        try {
-            if (!this.isEnabled()) {
-                logger.debug('PluginLogExporter is not enabled. Skipping export.');
-                return resultCallback({ code: ExportResultCode.SUCCESS });
-            }
-            const cleanLogs = logs
-                .map(log => removeCircularRefs(log))
-                .map(log => applyNesting(log));
-            cleanLogs.forEach(log => {
-                pluginService.broadcastLog(log);
-            });
-            setTimeout(() => resultCallback({ code: ExportResultCode.SUCCESS }), 0);
-        }
-        catch (error) {
-            logger.error('Error exporting logs\n' + error.message + '\n' + error.stack);
-            return resultCallback({
-                code: ExportResultCode.FAILED,
-                error: new Error('Error exporting logs\n' + error.message + '\n' + error.stack),
-            });
-        }
-    }
-    shutdown() {
-        return Promise.resolve();
-    }
-}

package/dist/esm/telemetry/custom-implementations/exporters/PluginMetricExporter.js

@@ -1,35 +0,0 @@
-import { ExportResultCode } from '@opentelemetry/core';
-import logger from '../../../utils/logger.js';
-import { Enabler } from '../wrappers.js';
-import { pluginService } from '../../../tlm-plugin/pluginService.js';
-import { applyNesting, removeCircularRefs } from '../utils/circular.js';
-export class PluginMetricExporter extends Enabler {
-    constructor() {
-        super();
-    }
-    export(metrics, resultCallback) {
-        logger.debug('PluginMetricExporter.export called');
-        try {
-            if (!this.isEnabled()) {
-                logger.debug('PluginMetricExporter is not enabled. Skipping export.');
-                return resultCallback({ code: ExportResultCode.SUCCESS });
-            }
-            const cleanMetrics = applyNesting(removeCircularRefs(metrics));
-            pluginService.broadcastMetric(cleanMetrics);
-            setTimeout(() => resultCallback({ code: ExportResultCode.SUCCESS }), 0);
-        }
-        catch (error) {
-            logger.error('Error exporting metrics\n' + error.message + '\n' + error.stack);
-            return resultCallback({
-                code: ExportResultCode.FAILED,
-                error: new Error('Error exporting metrics\n' + error.message + '\n' + error.stack),
-            });
-        }
-    }
-    shutdown() {
-        return Promise.resolve();
-    }
-    forceFlush() {
-        return Promise.resolve();
-    }
-}

package/dist/esm/telemetry/custom-implementations/exporters/PluginSpanExporter.js

@@ -1,52 +0,0 @@
-import { ExportResultCode } from '@opentelemetry/core';
-import logger from '../../../utils/logger.js';
-import { Enabler } from '../wrappers.js';
-import { pluginService } from '../../../tlm-plugin/pluginService.js';
-import { applyNesting, removeCircularRefs } from '../utils/circular.js';
-export class PluginSpanExporter extends Enabler {
-    constructor() {
-        super();
-        this._baseUrl = '/telemetry'; // Default base URL, can be overridden by the config
-    }
-    ;
-    set baseUrl(baseUrl) {
-        this._baseUrl = baseUrl;
-    }
-    export(readableSpans, resultCallback) {
-        logger.debug('PluginSpanExporter.export called with spans: ', readableSpans.length);
-        try {
-            if (!this.isEnabled()) {
-                logger.debug('PluginSpanExporter is not enabled. Skipping export.');
-                return resultCallback({ code: ExportResultCode.SUCCESS });
-            }
-            // Prepare spans to be inserted into the in-memory database (remove circular references and convert to nested objects)
-            const cleanSpans = readableSpans
-                .map(nestedSpan => removeCircularRefs(nestedSpan)) // to avoid JSON parsing error
-                .map(span => applyNesting(span)) // to avoid dot notation in keys (neDB does not support dot notation in keys)
-                .filter(span => {
-                const target = span?.attributes?.http?.target; // Exclude spans where target includes 'telemetry' but NOT 'telemetry/utils'
-                if (target && target.includes(this._baseUrl)) {
-                    return target.includes(this._baseUrl + '/utils');
-                }
-                return true;
-            });
-            cleanSpans.forEach(span => {
-                pluginService.broadcastTrace(span);
-            });
-            setTimeout(() => resultCallback({ code: ExportResultCode.SUCCESS }), 0);
-        }
-        catch (error) {
-            logger.error('Error exporting spans\n' + error.message + '\n' + error.stack);
-            return resultCallback({
-                code: ExportResultCode.FAILED,
-                error: new Error('Error exporting spans\n' + error.message + '\n' + error.stack),
-            });
-        }
-    }
-    shutdown() {
-        return this.forceFlush();
-    }
-    forceFlush() {
-        return Promise.resolve();
-    }
-}

package/dist/esm/tlm-ai/knownMicroservices.js

@@ -1,5 +0,0 @@
-let knownMicroservices = null;
-export const getKnownMicroservices = () => knownMicroservices || [];
-export const setKnownMicroservices = (microservices) => {
-    knownMicroservices = microservices;
-};

package/dist/types/telemetry/custom-implementations/exporters/PluginLogExporter.d.ts

@@ -1,8 +0,0 @@
-import { ExportResult } from '@opentelemetry/core';
-import { ReadableLogRecord, LogRecordExporter } from '@opentelemetry/sdk-logs';
-import { Enabler } from '../wrappers.js';
-export declare class PluginLogExporter extends Enabler implements LogRecordExporter {
-    constructor();
-    export(logs: ReadableLogRecord[], resultCallback: (result: ExportResult) => void): void;
-    shutdown(): Promise<void>;
-}

package/dist/types/telemetry/custom-implementations/exporters/PluginMetricExporter.d.ts

@@ -1,12 +0,0 @@
-import { ExportResultCode } from '@opentelemetry/core';
-import { ResourceMetrics, PushMetricExporter } from '@opentelemetry/sdk-metrics';
-import { Enabler } from '../wrappers.js';
-export declare class PluginMetricExporter extends Enabler implements PushMetricExporter {
-    constructor();
-    export(metrics: ResourceMetrics, resultCallback: (result: {
-        code: ExportResultCode;
-        error?: Error;
-    }) => void): void;
-    shutdown(): Promise<void>;
-    forceFlush(): Promise<void>;
-}

package/dist/types/telemetry/custom-implementations/exporters/PluginSpanExporter.d.ts

@@ -1,14 +0,0 @@
-import { ExportResultCode } from '@opentelemetry/core';
-import { ReadableSpan, SpanExporter } from '@opentelemetry/sdk-trace-base';
-import { Enabler } from '../wrappers.js';
-export declare class PluginSpanExporter extends Enabler implements SpanExporter {
-    private _baseUrl;
-    constructor();
-    set baseUrl(baseUrl: string);
-    export(readableSpans: ReadableSpan[], resultCallback: (result: {
-        code: ExportResultCode;
-        error?: Error;
-    }) => void): void;
-    shutdown(): Promise<void>;
-    forceFlush(): Promise<void>;
-}

package/dist/types/tlm-ai/knownMicroservices.d.ts

@@ -1,6 +0,0 @@
-export interface KnownMicroservice {
-    id: string;
-    url: string;
-}
-export declare const getKnownMicroservices: () => KnownMicroservice[];
-export declare const setKnownMicroservices: (microservices: KnownMicroservice[]) => void;