@oas-tools/oas-telemetry 0.7.1 → 0.8.0-alpha.0

package/dist/cjs/routesManager.cjs

@@ -1,76 +1,68 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.configureRoutes = void 0;
-var _express = require("express");
-var _logger = _interopRequireDefault(require("./utils/logger.cjs"));
-var _cors = _interopRequireDefault(require("cors"));
-var _traceRoutes = require("./tlm-trace/traceRoutes.cjs");
-var _metricsRoutes = require("./tlm-metric/metricsRoutes.cjs");
-var _logRoutes = require("./tlm-log/logRoutes.cjs");
-var _cookieParser = _interopRequireDefault(require("cookie-parser"));
-var _authRoutes = require("./tlm-auth/authRoutes.cjs");
-var _uiRoutes = require("./tlm-ui/uiRoutes.cjs");
-var _authMiddleware = require("./tlm-auth/authMiddleware.cjs");
-var _utilRoutes = require("./tlm-util/utilRoutes.cjs");
-var _aiRoutes = require("./tlm-ai/aiRoutes.cjs");
-var _bootConfig = require("./config/bootConfig.cjs");
-var _pluginRoutes = require("./tlm-plugin/pluginRoutes.cjs");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const express_1 = require("express");
+const logger_js_1 = __importDefault(require("./utils/logger.cjs"));
+const cors_1 = __importDefault(require("cors"));
+const traceRoutes_js_1 = require("./tlm-trace/traceRoutes.cjs");
+const metricsRoutes_js_1 = require("./tlm-metric/metricsRoutes.cjs");
+const logRoutes_js_1 = require("./tlm-log/logRoutes.cjs");
+const cookie_parser_1 = __importDefault(require("cookie-parser"));
+const authRoutes_js_1 = require("./tlm-auth/authRoutes.cjs");
+const uiRoutes_js_1 = require("./tlm-ui/uiRoutes.cjs");
+const authMiddleware_js_1 = require("./tlm-auth/authMiddleware.cjs");
+const utilRoutes_js_1 = require("./tlm-util/utilRoutes.cjs");
+const aiRoutes_js_1 = require("./tlm-ai/aiRoutes.cjs");
+const bootConfig_js_1 = require("./config/bootConfig.cjs");
+const pluginRoutes_js_1 = require("./tlm-plugin/pluginRoutes.cjs");
 const configureRoutes = (router, oasTlmConfig) => {
-  if (_bootConfig.bootEnvVariables.OASTLM_BOOT_ENV === 'development') {
-    _logger.default.info("Running in development mode, enabling CORS for all origins");
-    router.use((0, _cors.default)({
-      origin: (origin, callback) => {
-        if (!origin || /^http:\/\/localhost:\d+$/.test(origin)) {
-          callback(null, true);
-        } else {
-          callback(new Error('Not allowed by CORS'));
-        }
-      },
-      credentials: true
-    }));
-  }
-  const telemetryBaseUrl = oasTlmConfig.general.baseUrl;
-  // Sub-router for all telemetry endpoints
-  const telemetryRouter = (0, _express.Router)();
-  // Body parser for JSON requests
-  telemetryRouter.use((req, res, next) => {
-    if (req.body !== undefined) {
-      return next(); // Already parsed, no need to parse again.
+    if (!oasTlmConfig.general.spec && !oasTlmConfig.general.specFileName) {
+        logger_js_1.default.warn("No spec provided, endpoint filtering will not be available. Please provide either `spec` or `specFileName` in the configuration.");
     }
-    return (0, _express.json)({
-      limit: '10mb'
-    })(req, res, next);
-  });
-  telemetryRouter.get('/health', (_req, res) => {
-    res.status(200).send({
-      status: 'OK'
+    if (bootConfig_js_1.bootEnvVariables.OASTLM_BOOT_ENV === 'development') {
+        logger_js_1.default.info("Running in development mode, enabling CORS for all origins");
+        router.use((0, cors_1.default)({
+            origin: true,
+            credentials: true
+        }));
+    }
+    const telemetryBaseUrl = bootConfig_js_1.bootEnvVariables.OASTLM_BOOT_BASE_URL;
+    // Sub-router for all telemetry endpoints
+    const telemetryRouter = (0, express_1.Router)();
+    // Body parser for JSON requests
+    telemetryRouter.use((req, res, next) => {
+        if (req.body !== undefined) {
+            return next(); // Already parsed, no need to parse again.
+        }
+        return (0, express_1.json)({ limit: '500mb' })(req, res, next);
     });
-  });
-  // Redirect to the UI when accessing the base URL
-  telemetryRouter.get('/', (req, res) => {
-    res.redirect(`${telemetryBaseUrl}/oas-telemetry-ui/`);
-  });
-  // WARNING: This path must be the same as the one used in the UI package App.tsx "oas-telemetry-ui"
-  telemetryRouter.use("/oas-telemetry-ui", (0, _uiRoutes.getUIRoutes)());
-  telemetryRouter.use("/utils", (0, _utilRoutes.getUtilsRoutes)(oasTlmConfig));
-  // Auth routes must be registered. If authentication is not enabled, all requests will be allowed.
-  // Frontend will use these endpoints;
-  telemetryRouter.use((0, _cookieParser.default)());
-  // Refresh token uses /auth/refresh path, careful if you change it
-  telemetryRouter.use('/auth', (0, _authRoutes.getAuthRoutes)(oasTlmConfig));
-  telemetryRouter.use((0, _authMiddleware.getAuthMiddleware)(oasTlmConfig));
-  telemetryRouter.use("/traces", (0, _traceRoutes.getTraceRoutes)());
-  telemetryRouter.use("/metrics", (0, _metricsRoutes.getMetricsRoutes)());
-  telemetryRouter.use("/logs", (0, _logRoutes.getLogRoutes)());
-  if (oasTlmConfig.ai.openAIKey) {
-    telemetryRouter.use("/ai", (0, _aiRoutes.getAIRoutes)(oasTlmConfig));
-  }
-  telemetryRouter.use("/plugins", (0, _pluginRoutes.getPluginRoutes)());
-  // Mount the telemetryRouter under telemetryBaseUrl
-  router.use(telemetryBaseUrl, telemetryRouter);
+    telemetryRouter.get('/health', (_req, res) => {
+        res.status(200).send({ status: 'OK' });
+    });
+    // Redirect to the UI when accessing the base URL
+    telemetryRouter.get('/', (req, res) => {
+        res.redirect(`${telemetryBaseUrl}/oas-telemetry-ui/`);
+    });
+    // WARNING: This path must be the same as the one used in the UI package App.tsx "oas-telemetry-ui"
+    telemetryRouter.use("/oas-telemetry-ui", (0, uiRoutes_js_1.getUIRoutes)());
+    telemetryRouter.use("/utils", (0, utilRoutes_js_1.getUtilsRoutes)(oasTlmConfig));
+    // Auth routes must be registered. If authentication is not enabled, all requests will be allowed.
+    // Frontend will use these endpoints;
+    telemetryRouter.use((0, cookie_parser_1.default)());
+    // Refresh token uses /auth/refresh path, careful if you change it
+    telemetryRouter.use('/auth', (0, authRoutes_js_1.getAuthRoutes)(oasTlmConfig));
+    telemetryRouter.use((0, authMiddleware_js_1.getAuthMiddleware)(oasTlmConfig));
+    telemetryRouter.use("/traces", (0, traceRoutes_js_1.getTraceRoutes)());
+    telemetryRouter.use("/metrics", (0, metricsRoutes_js_1.getMetricsRoutes)());
+    telemetryRouter.use("/logs", (0, logRoutes_js_1.getLogRoutes)());
+    if (oasTlmConfig.ai.openAIKey) {
+        telemetryRouter.use("/ai", (0, aiRoutes_js_1.getAIRoutes)(oasTlmConfig));
+    }
+    telemetryRouter.use("/plugins", (0, pluginRoutes_js_1.getPluginRoutes)());
+    // Mount the telemetryRouter under telemetryBaseUrl
+    router.use(telemetryBaseUrl, telemetryRouter);
 };
-exports.configureRoutes = configureRoutes;
+exports.configureRoutes = configureRoutes;

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

@@ -1,199 +1,211 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.InMemoryDbLogExporter = void 0;
-var _core = require("@opentelemetry/core");
-var _nedb = _interopRequireDefault(require("@seald-io/nedb"));
-var _minisearch = _interopRequireDefault(require("minisearch"));
-var _circular = require("../utils/circular.cjs");
-var _wrappers = require("../wrappers.cjs");
-var _logger = _interopRequireDefault(require("../../../utils/logger.cjs"));
-var _pluginService = require("../../../tlm-plugin/pluginService.cjs");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
-function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
-function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
-class InMemoryDbLogExporter extends _wrappers.Enabler {
-  constructor(retentionTimeInSeconds = 3600) {
-    super();
-    this._retentionTimeInSeconds = retentionTimeInSeconds;
-    this._db = new _nedb.default({
-      timestampData: true
-    });
-    this._db.ensureIndex({
-      fieldName: 'createdAt'
-    });
-    this._miniSearch = new _minisearch.default({
-      fields: ['body'],
-      storeFields: ['_id'],
-      idField: '_id'
-    });
-    this._startCleanupJob();
-  }
-  /*
-  * SUPER WARNING:
-  * Do NOT use console.log, console.error, or any logger inside this class's export function.
-  * Doing so will cause an infinite loop.
-  * Only console.dir is allowed, as it is not tracked by our log export implementation.
-  */
-  /**
-   * Export logs.
-   * @param logs
-   * @param resultCallback
-   */
-  export(logs, resultCallback) {
-    const logsToInsert = logs.map(logRecord => {
-      // Remove circular references first, then apply nesting, then export info
-      const formattedLog = this._formatLogRecord(logRecord);
-      const cleanedLog = (0, _circular.removeCircularRefs)(formattedLog);
-      const nestedLog = (0, _circular.applyNesting)(cleanedLog);
-      return nestedLog;
-    });
-    logsToInsert.forEach(log => {
-      _pluginService.pluginService.broadcastLog(log);
-    });
-    // ENABLED only affect storage not plugin broadcasting
-    if (this.isEnabled()) {
-      this._insertLogs(logsToInsert, resultCallback);
+const core_1 = require("@opentelemetry/core");
+const core_2 = require("@opentelemetry/core");
+const nedb_1 = __importDefault(require("@seald-io/nedb"));
+const minisearch_1 = __importDefault(require("minisearch"));
+const circular_js_1 = require("../utils/circular.cjs");
+const wrappers_js_1 = require("../wrappers.cjs");
+const logger_js_1 = __importDefault(require("../../../utils/logger.cjs"));
+const pluginService_js_1 = require("../../../tlm-plugin/pluginService.cjs");
+const storagePath_js_1 = require("../utils/storagePath.cjs");
+class InMemoryDbLogExporter extends wrappers_js_1.Enabler {
+    _db = null;
+    _miniSearch = null;
+    _retentionTimeInSeconds;
+    _storagePath = null;
+    _initialized = false;
+    constructor(retentionTimeInSeconds = 3600) {
+        super();
+        this._retentionTimeInSeconds = retentionTimeInSeconds;
+        this._storagePath = (0, storagePath_js_1.getStoragePath)('logs');
+        this._startCleanupJob();
     }
-    resultCallback({
-      code: _core.ExportResultCode.SUCCESS
-    });
-  }
-  reset() {
-    this._db = new _nedb.default();
-    this._miniSearch = new _minisearch.default({
-      fields: ['body'],
-      storeFields: ['_id'],
-      idField: '_id'
-    });
-  }
-  /**
-   * Shutdown the exporter.
-   */
-  async shutdown() {
-    this._db = null;
-    this._miniSearch = null;
-  }
-  async find(findConfig) {
-    const {
-      query,
-      messageSearch,
-      limit,
-      sortOrder
-    } = findConfig;
-    const finalQuery = _objectSpread({}, query);
-    const effectiveSortOrder = sortOrder || {
-      timestamp: -1
-    };
-    if (messageSearch) {
-      const searchResults = this._miniSearch.search(messageSearch, {
-        prefix: true,
-        fuzzy: 0.2
-      });
-      const ids = searchResults.map(result => result._id);
-      _logger.default.debug(`MiniSearch found ${ids.length} results for search term "${messageSearch}"`, {
-        depth: 3
-      });
-      finalQuery._id = {
-        $in: ids
-      };
-    }
-    const docs = await new Promise((resolve, reject) => {
-      this._db.find(finalQuery).sort(effectiveSortOrder).limit(limit).exec((err, docs) => {
-        if (err) reject(err);else resolve(docs);
-      });
-    });
-    return docs;
-  }
-  insert(data, callback) {
-    this._insertLogs(data, result => {
-      if (result.code === _core.ExportResultCode.SUCCESS) {
-        this._db.find({}, (err, docs) => {
-          if (err) {
-            _logger.default.debug(err);
-            callback(err, []);
+    _ensureInitialized() {
+        if (this._initialized)
             return;
-          }
-          callback(null, docs);
+        this._initialized = true;
+        this._db = new nedb_1.default(this._storagePath ? { filename: this._storagePath, timestampData: true, autoload: true } : { timestampData: true });
+        this._db.ensureIndex({ fieldName: 'createdAt' });
+        this._miniSearch = new minisearch_1.default({
+            fields: ['body'],
+            storeFields: ['_id'],
+            idField: '_id',
+        });
+        if (this._storagePath) {
+            logger_js_1.default.info(`[LogExporter] Disk storage enabled at: ${this._storagePath}`);
+        }
+        else {
+            logger_js_1.default.info(`[LogExporter] Using in-memory storage`);
+        }
+    }
+    /*
+    * SUPER WARNING:
+    * Do NOT use console.log, console.error, or any logger inside this class's export function.
+    * Doing so will cause an infinite loop.
+    * Only console.dir is allowed, as it is not tracked by our log export implementation.
+    */
+    /**
+     * Export logs.
+     * @param logs
+     * @param resultCallback
+     */
+    export(logs, resultCallback) {
+        this._ensureInitialized();
+        const logsToInsert = logs.map(logRecord => {
+            // Remove circular references first, then apply nesting, then export info
+            const formattedLog = this._formatLogRecord(logRecord);
+            const cleanedLog = (0, circular_js_1.removeCircularRefs)(formattedLog);
+            const nestedLog = (0, circular_js_1.applyNesting)(cleanedLog);
+            return nestedLog;
         });
-      } else {
-        callback(new Error('Failed to insert logs'), []);
-      }
-    });
-  }
-  getFinishedLogs() {
-    return this._db.getAllData();
-  }
-  /**
-   *  @copyright The OpenTelemetry Authors
-   *  @license Apache-2.0
-   * converts logRecord info into more readable format
-   * @param logRecord
-   */
-  _formatLogRecord(logRecord) {
-    return {
-      resource: {
-        attributes: logRecord.resource.attributes
-      },
-      instrumentationScope: logRecord.instrumentationScope,
-      timestamp: (0, _core.hrTimeToMicroseconds)(logRecord.hrTime) ?? Date.now(),
-      observedTimestamp: (0, _core.hrTimeToMicroseconds)(logRecord.hrTimeObserved) ?? Date.now(),
-      traceId: logRecord.spanContext?.traceId,
-      spanId: logRecord.spanContext?.spanId,
-      traceFlags: logRecord.spanContext?.traceFlags,
-      severityText: logRecord.severityText,
-      severityNumber: logRecord.severityNumber,
-      body: logRecord.body,
-      attributes: logRecord.attributes
-    };
-  }
-  set retentionTimeInSeconds(retentionTimeInSeconds) {
-    this._retentionTimeInSeconds = retentionTimeInSeconds;
-    _logger.default.info(`InMemoryDbLogExporter retention time set to ${this._retentionTimeInSeconds} seconds`);
-  }
-  get retentionTimeInSeconds() {
-    return this._retentionTimeInSeconds;
-  }
-  _insertLogs(logsToInsert, resultCallback) {
-    this._db.insert(logsToInsert, (err, newDocs) => {
-      if (err) {
-        console.dir(err);
-        resultCallback({
-          code: _core.ExportResultCode.FAILED
+        logsToInsert.forEach(log => {
+            pluginService_js_1.pluginService.broadcastLog(log);
         });
-        return;
-      }
-      // console.dir(newDocs, { depth: 3 });
-      newDocs.forEach(doc => this._miniSearch.add(doc));
-      resultCallback({
-        code: _core.ExportResultCode.SUCCESS
-      });
-    });
-    return;
-  }
-  _startCleanupJob() {
-    const interval = 1000;
-    setInterval(() => {
-      const expirationDate = new Date(Date.now() - this._retentionTimeInSeconds * 1000);
-      this._db.remove({
-        createdAt: {
-          $lt: expirationDate
+        // ENABLED only affect storage not plugin broadcasting
+        if (this.isEnabled()) {
+            this._insertLogs(logsToInsert, resultCallback);
         }
-      }, {
-        multi: true
-      }, (err, numRemoved) => {
-        if (err) {
-          _logger.default.error('Error in TTL cleanup:', err);
-        } else if (numRemoved > 0) {
-          _logger.default.debug(`TTL cleanup: removed ${numRemoved} expired logs`);
+        resultCallback({ code: core_2.ExportResultCode.SUCCESS });
+    }
+    reset() {
+        this._ensureInitialized();
+        // Remove all logs from database but keep persistence enabled
+        this._db.remove({}, { multi: true }, (err) => {
+            if (err) {
+                logger_js_1.default.error(`[LogExporter] Error during reset: ${err.message}`);
+            }
+            else {
+                logger_js_1.default.info(`[LogExporter] Reset - all logs cleared`);
+            }
+        });
+        // Clear mini search index
+        this._miniSearch = new minisearch_1.default({
+            fields: ['body'],
+            storeFields: ['_id'],
+            idField: '_id',
+        });
+    }
+    /**
+     * Shutdown the exporter.
+     */
+    async shutdown() {
+        this._db = null;
+        this._miniSearch = null;
+        this._initialized = false;
+    }
+    async find(findConfig) {
+        this._ensureInitialized();
+        const { query, messageSearch, limit, sortOrder } = findConfig;
+        const finalQuery = { ...query };
+        const effectiveSortOrder = sortOrder || { timestamp: -1 };
+        if (messageSearch) {
+            const searchResults = this._miniSearch.search(messageSearch, { prefix: true, fuzzy: 0.2 });
+            const ids = searchResults.map((result) => result._id);
+            logger_js_1.default.debug(`MiniSearch found ${ids.length} results for search term "${messageSearch}"`, { depth: 3 });
+            finalQuery._id = { $in: ids };
         }
-      });
-    }, interval);
-  }
+        const docs = await new Promise((resolve, reject) => {
+            let query_exec = this._db.find(finalQuery)
+                .sort(effectiveSortOrder);
+            // Only apply limit if provided
+            if (limit !== undefined) {
+                query_exec = query_exec.limit(limit);
+            }
+            query_exec.exec((err, docs) => {
+                if (err)
+                    reject(err);
+                else
+                    resolve(docs);
+            });
+        });
+        return docs;
+    }
+    insert(data, callback) {
+        this._insertLogs(data, (result) => {
+            if (result.code === core_2.ExportResultCode.SUCCESS) {
+                this._db.find({}, (err, docs) => {
+                    if (err) {
+                        logger_js_1.default.debug(err);
+                        callback(err, []);
+                        return;
+                    }
+                    callback(null, docs);
+                });
+            }
+            else {
+                callback(new Error('Failed to insert logs'), []);
+            }
+        });
+    }
+    getFinishedLogs() {
+        this._ensureInitialized();
+        return this._db.getAllData();
+    }
+    /**
+     *  @copyright The OpenTelemetry Authors
+     *  @license Apache-2.0
+     * converts logRecord info into more readable format
+     * @param logRecord
+     */
+    _formatLogRecord(logRecord) {
+        return {
+            resource: {
+                attributes: logRecord.resource.attributes,
+            },
+            instrumentationScope: logRecord.instrumentationScope,
+            timestamp: (0, core_1.hrTimeToMicroseconds)(logRecord.hrTime) ?? Date.now(),
+            observedTimestamp: (0, core_1.hrTimeToMicroseconds)(logRecord.hrTimeObserved) ?? Date.now(),
+            traceId: logRecord.spanContext?.traceId,
+            spanId: logRecord.spanContext?.spanId,
+            traceFlags: logRecord.spanContext?.traceFlags,
+            severityText: logRecord.severityText,
+            severityNumber: logRecord.severityNumber,
+            body: logRecord.body,
+            attributes: logRecord.attributes,
+        };
+    }
+    set retentionTimeInSeconds(retentionTimeInSeconds) {
+        this._retentionTimeInSeconds = retentionTimeInSeconds;
+        logger_js_1.default.info(`InMemoryDbLogExporter retention time set to ${this._retentionTimeInSeconds} seconds`);
+    }
+    get retentionTimeInSeconds() {
+        return this._retentionTimeInSeconds;
+    }
+    _insertLogs(logsToInsert, resultCallback) {
+        if (!this._db)
+            return resultCallback({ code: core_2.ExportResultCode.FAILED });
+        this._db.insert(logsToInsert, (err, newDocs) => {
+            if (err) {
+                console.dir(err);
+                resultCallback({ code: core_2.ExportResultCode.FAILED });
+                return;
+            }
+            // console.dir(newDocs, { depth: 3 });
+            newDocs.forEach((doc) => this._miniSearch?.add(doc));
+            resultCallback({ code: core_2.ExportResultCode.SUCCESS });
+        });
+        return;
+    }
+    _startCleanupJob() {
+        const interval = 1000;
+        setInterval(() => {
+            if (!this._db)
+                return; // Safety check
+            const expirationDate = new Date(Date.now() - this._retentionTimeInSeconds * 1000);
+            this._db.remove({ createdAt: { $lt: expirationDate } }, { multi: true }, (err, numRemoved) => {
+                if (err) {
+                    logger_js_1.default.error('Error in TTL cleanup:', err);
+                }
+                else if (numRemoved > 0) {
+                    logger_js_1.default.debug(`TTL cleanup: removed ${numRemoved} expired logs`);
+                }
+            });
+        }, interval);
+    }
 }
-exports.InMemoryDbLogExporter = InMemoryDbLogExporter;
+exports.InMemoryDbLogExporter = InMemoryDbLogExporter;