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

package/dist/cjs/tlm-util/utilController.cjs

@@ -1,83 +1,81 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.specLoader = exports.heapStats = exports.getOasTelemetrySpec = void 0;
-var _fs = require("fs");
-var _path = _interopRequireDefault(require("path"));
-var _jsYaml = _interopRequireDefault(require("js-yaml"));
-var _nodeV = _interopRequireDefault(require("node:v8"));
-var _nodeUrl = require("node:url");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOasTelemetrySpec = exports.heapStats = exports.specLoader = void 0;
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const js_yaml_1 = __importDefault(require("js-yaml"));
+const node_v8_1 = __importDefault(require("node:v8"));
+const node_url_1 = require("node:url");
 const specLoader = (_req, res, oasTlmConfig) => {
-  if (oasTlmConfig.general.specFileName) {
-    try {
-      const data = (0, _fs.readFileSync)(oasTlmConfig.general.specFileName, {
-        encoding: 'utf8',
-        flag: 'r'
-      });
-      const extension = _path.default.extname(oasTlmConfig.general.specFileName);
-      let json = data;
-      if (extension == "yaml")
-        //@ts-expect-error yes
-        json = JSON.stringify(_jsYaml.default.SafeLoad(data), null, 2);
-      res.setHeader('Content-Type', 'application/json');
-      res.send(json);
-    } catch (e) {
-      console.error(`ERROR loading spec file ${oasTlmConfig.general.specFileName}: ${e}`);
+    if (oasTlmConfig.general.specFileName) {
+        try {
+            const data = (0, fs_1.readFileSync)(oasTlmConfig.general.specFileName, { encoding: 'utf8', flag: 'r' });
+            const extension = path_1.default.extname(oasTlmConfig.general.specFileName);
+            let json = data;
+            if (extension == "yaml")
+                //@ts-expect-error yes
+                json = JSON.stringify(js_yaml_1.default.SafeLoad(data), null, 2);
+            res.setHeader('Content-Type', 'application/json');
+            res.send(json);
+        }
+        catch (e) {
+            console.error(`ERROR loading spec file ${oasTlmConfig.general.specFileName}: ${e}`);
+        }
     }
-  } else if (oasTlmConfig.general.spec) {
-    let spec = null;
-    try {
-      spec = JSON.parse(oasTlmConfig.general.spec);
-    } catch (ej) {
-      try {
-        spec = JSON.stringify(_jsYaml.default.load(oasTlmConfig.general.spec), null, 2);
-      } catch (ey) {
-        console.error(`Error parsing spec: ${ej} - ${ey}`);
-      }
+    else if (oasTlmConfig.general.spec) {
+        let spec = null;
+        try {
+            spec = JSON.parse(oasTlmConfig.general.spec);
+        }
+        catch (ej) {
+            try {
+                spec = JSON.stringify(js_yaml_1.default.load(oasTlmConfig.general.spec), null, 2);
+            }
+            catch (ey) {
+                console.error(`Error parsing spec: ${ej} - ${ey}`);
+            }
+        }
+        if (!spec) {
+            res.status(404);
+        }
+        else {
+            res.setHeader('Content-Type', 'application/json');
+            res.send(spec);
+        }
     }
-    if (!spec) {
-      res.status(404);
-    } else {
-      res.setHeader('Content-Type', 'application/json');
-      res.send(spec);
+    else {
+        res.status(404);
     }
-  } else {
-    res.status(404);
-  }
 };
 exports.specLoader = specLoader;
 const heapStats = (req, res) => {
-  const heapStats = _nodeV.default.getHeapStatistics();
-  const roundedHeapStats = Object.getOwnPropertyNames(heapStats).reduce(function (map, stat) {
-    //@ts-expect-error yes
-    map[stat] = Math.round(heapStats[stat] / 1024 / 1024 * 1000) / 1000;
-    return map;
-  }, {});
-  // @ts-expect-error yes
-  roundedHeapStats['units'] = 'MB';
-  res.send(roundedHeapStats);
+    const heapStats = node_v8_1.default.getHeapStatistics();
+    const roundedHeapStats = Object.getOwnPropertyNames(heapStats).reduce(function (map, stat) {
+        map[stat] = Math.round((heapStats[stat] / 1024 / 1024) * 1000) / 1000;
+        return map;
+    }, {});
+    roundedHeapStats['units'] = 'MB';
+    res.send(roundedHeapStats);
 };
 exports.heapStats = heapStats;
 const isCjs = typeof __filename !== "undefined" && typeof __dirname !== "undefined";
-const __filenameUniversal = isCjs ? __filename : (0, _nodeUrl.fileURLToPath)(require('url').pathToFileURL(__filename).toString());
-const __dirnameUniversal = isCjs ? __dirname : _path.default.dirname(__filenameUniversal);
+// @ts-ignore -- import.meta no existe en el build CJS
+const currentDirectory = isCjs ? __dirname : path_1.default.dirname((0, node_url_1.fileURLToPath)(__filename));
 const getOasTelemetrySpec = (_req, res) => {
-  try {
-    const specPath = _path.default.join(__dirnameUniversal, '../docs/openapi.yaml');
-    const data = (0, _fs.readFileSync)(specPath, {
-      encoding: 'utf8',
-      flag: 'r'
-    });
-    let json = data;
-    json = JSON.stringify(_jsYaml.default.load(data), null, 2);
-    res.setHeader('Content-Type', 'application/json');
-    res.send(json);
-  } catch (e) {
-    console.error(`ERROR loading OAS Telemetry OpenAPI spec file: ${e}`);
-    res.status(500).send(`ERROR loading OAS Telemetry OpenAPI spec file: ${e}`);
-  }
+    try {
+        const specPath = path_1.default.join(currentDirectory, '../docs/openapi.yaml');
+        const data = (0, fs_1.readFileSync)(specPath, { encoding: 'utf8', flag: 'r' });
+        let json = data;
+        json = JSON.stringify(js_yaml_1.default.load(data), null, 2);
+        res.setHeader('Content-Type', 'application/json');
+        res.send(json);
+    }
+    catch (e) {
+        console.error(`ERROR loading OAS Telemetry OpenAPI spec file: ${e}`);
+        res.status(500).send(`ERROR loading OAS Telemetry OpenAPI spec file: ${e}`);
+    }
 };
-exports.getOasTelemetrySpec = getOasTelemetrySpec;
+exports.getOasTelemetrySpec = getOasTelemetrySpec;

package/dist/cjs/tlm-util/utilRoutes.cjs

@@ -1,70 +1,58 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUtilsRoutes = void 0;
-var _express = require("express");
-var _utilController = require("./utilController.cjs");
-const getUtilsRoutes = oasTlmConfig => {
-  const router = (0, _express.Router)();
-  router.get('/spec', (req, res) => (0, _utilController.specLoader)(req, res, oasTlmConfig));
-  router.get('/oas-telemetry-spec', (req, res) => (0, _utilController.getOasTelemetrySpec)(req, res));
-  router.get('/heapStats', _utilController.heapStats);
-  //This route is NOT ignored by the spanExporter (includes "generate")
-  router.post('/generate-log', async (req, res) => {
-    const log = req.body.log || 'Default log message';
-    const repeat = parseInt(req.body.repeat) || 1;
-    const method = req.body.method?.toLowerCase() || 'log';
-    if (!['log', 'warn', 'error', 'info', 'debug'].includes(method)) {
-      res.status(400).send({
-        error: 'Invalid method. Use log, warn, error, info, or debug.'
-      });
-      return;
-    }
-    res.send({
-      message: 'Log generated',
-      log: log
+const express_1 = require("express");
+const utilController_js_1 = require("./utilController.cjs");
+const getUtilsRoutes = (oasTlmConfig) => {
+    const router = (0, express_1.Router)();
+    router.get('/spec', (req, res) => (0, utilController_js_1.specLoader)(req, res, oasTlmConfig));
+    router.get('/oas-telemetry-spec', (req, res) => (0, utilController_js_1.getOasTelemetrySpec)(req, res));
+    router.get('/heapStats', utilController_js_1.heapStats);
+    //This route is NOT ignored by the spanExporter (includes "generate")
+    router.post('/generate-log', async (req, res) => {
+        const log = req.body.log || 'Default log message';
+        const repeat = parseInt(req.body.repeat) || 1;
+        const method = req.body.method?.toLowerCase() || 'log';
+        if (!['log', 'warn', 'error', 'info', 'debug'].includes(method)) {
+            res.status(400).send({ error: 'Invalid method. Use log, warn, error, info, or debug.' });
+            return;
+        }
+        res.send({ message: 'Log generated', log: log });
+        for (let i = 0; i < repeat; i++) {
+            console[method](log);
+            await new Promise(resolve => setTimeout(resolve, 50)); // Slight delay between logs
+        }
     });
-    for (let i = 0; i < repeat; i++) {
-      console[method](log);
-      await new Promise(resolve => setTimeout(resolve, 50)); // Slight delay between logs
-    }
-  });
-  // This route is NOT ignored by the spanExporter (includes "generate")
-  router.post('/generate-mock-logs', async (req, res) => {
-    const count = parseInt(req.body.count) || 50;
-    generateMockLogs(count);
-    res.send({
-      message: 'Started generating mock logs'
+    // This route is NOT ignored by the spanExporter (includes "generate")
+    router.post('/generate-mock-logs', async (req, res) => {
+        const count = parseInt(req.body.count) || 50;
+        generateMockLogs(count);
+        res.send({ message: 'Started generating mock logs' });
     });
-  });
-  // This route is NOT ignored by the spanExporter
-  router.get('/generate-wait/:seconds?', async (req, res) => {
-    const seconds = parseInt(req.params.seconds ?? "1", 10);
-    const waitTime = isNaN(seconds) ? 1 : seconds;
-    await new Promise(resolve => setTimeout(resolve, waitTime * 1000));
-    res.send({
-      waited: waitTime
+    // This route is NOT ignored by the spanExporter
+    router.get('/generate-wait', async (req, res) => {
+        const seconds = parseInt(req.query.seconds ?? "1", 10);
+        const waitTime = isNaN(seconds) ? 1 : seconds;
+        await new Promise(resolve => setTimeout(resolve, waitTime * 1000));
+        res.send({ waited: waitTime });
     });
-  });
-  return router;
+    return router;
 };
 exports.getUtilsRoutes = getUtilsRoutes;
-const generateMockLogs = async count => {
-  const methodMessages = {
-    log: ['User logged in', 'Data fetched successfully'],
-    warn: ['Warning: Disk space low', 'Warning: High memory usage'],
-    error: ['Error connecting to database', 'Error: Invalid credentials'],
-    info: ['Info: Scheduled job started', 'Info: Configuration loaded'],
-    debug: ['Debugging mode enabled', 'Debug: Variable x = 42']
-  };
-  const methods = Object.keys(methodMessages);
-  for (let i = 0; i < count; i++) {
-    await new Promise(resolve => setTimeout(resolve, 50)); // Slight delay between logs
-    const method = methods[Math.floor(Math.random() * methods.length)];
-    const messages = methodMessages[method];
-    const message = messages[Math.floor(Math.random() * messages.length)];
-    console[method](`[${new Date().toISOString()}][MOCK LOG][${method.toUpperCase()}] -${i + 1}- ${message}`);
-  }
-};
+const generateMockLogs = async (count) => {
+    const methodMessages = {
+        log: ['User logged in', 'Data fetched successfully'],
+        warn: ['Warning: Disk space low', 'Warning: High memory usage'],
+        error: ['Error connecting to database', 'Error: Invalid credentials'],
+        info: ['Info: Scheduled job started', 'Info: Configuration loaded'],
+        debug: ['Debugging mode enabled', 'Debug: Variable x = 42'],
+    };
+    const methods = Object.keys(methodMessages);
+    for (let i = 0; i < count; i++) {
+        await new Promise(resolve => setTimeout(resolve, 50)); // Slight delay between logs
+        const method = methods[Math.floor(Math.random() * methods.length)];
+        const messages = methodMessages[method];
+        const message = messages[Math.floor(Math.random() * messages.length)];
+        console[method](`[${new Date().toISOString()}][MOCK LOG][${method.toUpperCase()}] -${i + 1}- ${message}`);
+    }
+};

package/dist/cjs/types/index.cjs

@@ -1,7 +1,4 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+Object.defineProperty(exports, "__esModule", { value: true });
+;
 ;
-;

package/dist/cjs/utils/logger.cjs

@@ -1,48 +1,43 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _bootConfig = require("../config/bootConfig.cjs");
-var _telemetryRegistry = require("../telemetry/telemetryRegistry.cjs");
+Object.defineProperty(exports, "__esModule", { value: true });
+const bootConfig_js_1 = require("../config/bootConfig.cjs");
+const telemetryRegistry_js_1 = require("../telemetry/telemetryRegistry.cjs");
 const LOG_LEVELS = ['DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'];
-const currentLogLevel = _bootConfig.bootEnvVariables.OASTLM_BOOT_LOG_LEVEL.toUpperCase();
-const serviceName = 'OAS-TLM-@-' + _bootConfig.bootEnvVariables.OASTLM_BOOT_SERVICE_NAME;
+const currentLogLevel = (bootConfig_js_1.bootEnvVariables.OASTLM_BOOT_LOG_LEVEL).toUpperCase();
+const serviceName = 'OAS-TLM-@-' + bootConfig_js_1.bootEnvVariables.OASTLM_BOOT_SERVICE_NAME;
 function shouldLog(level) {
-  return LOG_LEVELS.indexOf(level) >= LOG_LEVELS.indexOf(currentLogLevel);
+    return LOG_LEVELS.indexOf(level) >= LOG_LEVELS.indexOf(currentLogLevel);
 }
-var _default = exports.default = {
-  debug: (...messages) => {
-    if (shouldLog('DEBUG')) {
-      const timestamp = new Date().toISOString();
-      _telemetryRegistry.originalConsoleMethods.debug(`${timestamp} [${serviceName}] [DEBUG]:`, ...messages);
-    }
-  },
-  info: (...messages) => {
-    if (shouldLog('INFO')) {
-      const timestamp = new Date().toISOString();
-      _telemetryRegistry.originalConsoleMethods.info(`${timestamp} [${serviceName}] [INFO]:`, ...messages);
-    }
-  },
-  log: (...messages) => {
-    if (shouldLog('INFO')) {
-      const timestamp = new Date().toISOString();
-      _telemetryRegistry.originalConsoleMethods.log(`${timestamp} [${serviceName}] [INFO]:`, ...messages);
-    }
-  },
-  warn: (...messages) => {
-    if (shouldLog('WARN')) {
-      const timestamp = new Date().toISOString();
-      _telemetryRegistry.originalConsoleMethods.warn(`${timestamp} [${serviceName}] [WARN]:`, ...messages);
-    }
-  },
-  error: (...messages) => {
-    if (shouldLog('ERROR')) {
-      const timestamp = new Date().toISOString();
-      _telemetryRegistry.originalConsoleMethods.error(`${timestamp} [${serviceName}] [ERROR]:`, ...messages);
-    }
-  },
-  currentLogLevel
+exports.default = {
+    debug: (...messages) => {
+        if (shouldLog('DEBUG')) {
+            const timestamp = new Date().toISOString();
+            telemetryRegistry_js_1.originalConsoleMethods.debug(`${timestamp} [${serviceName}] [DEBUG]:`, ...messages);
+        }
+    },
+    info: (...messages) => {
+        if (shouldLog('INFO')) {
+            const timestamp = new Date().toISOString();
+            telemetryRegistry_js_1.originalConsoleMethods.info(`${timestamp} [${serviceName}] [INFO]:`, ...messages);
+        }
+    },
+    log: (...messages) => {
+        if (shouldLog('INFO')) {
+            const timestamp = new Date().toISOString();
+            telemetryRegistry_js_1.originalConsoleMethods.log(`${timestamp} [${serviceName}] [INFO]:`, ...messages);
+        }
+    },
+    warn: (...messages) => {
+        if (shouldLog('WARN')) {
+            const timestamp = new Date().toISOString();
+            telemetryRegistry_js_1.originalConsoleMethods.warn(`${timestamp} [${serviceName}] [WARN]:`, ...messages);
+        }
+    },
+    error: (...messages) => {
+        if (shouldLog('ERROR')) {
+            const timestamp = new Date().toISOString();
+            telemetryRegistry_js_1.originalConsoleMethods.error(`${timestamp} [${serviceName}] [ERROR]:`, ...messages);
+        }
+    },
+    currentLogLevel
 };
-module.exports = exports.default;

package/dist/cjs/utils/regexUtils.cjs

@@ -1,27 +1,27 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertRegexRecursively = void 0;
-const convertRegexRecursively = obj => {
-  if (Array.isArray(obj)) {
-    return obj.map(convertRegexRecursively);
-  } else if (obj && typeof obj === 'object') {
-    const newObj = {};
-    for (const key of Object.keys(obj)) {
-      if (key === '$regex' && typeof obj[key] === 'string') {
-        try {
-          return new RegExp(obj[key]);
-        } catch {
-          throw new Error(`Invalid regex value "${obj[key]}"`);
+const convertRegexRecursively = (obj) => {
+    if (Array.isArray(obj)) {
+        return obj.map(exports.convertRegexRecursively);
+    }
+    else if (obj && typeof obj === 'object') {
+        const newObj = {};
+        for (const key of Object.keys(obj)) {
+            if (key === '$regex' && typeof obj[key] === 'string') {
+                try {
+                    return new RegExp(obj[key]);
+                }
+                catch {
+                    throw new Error(`Invalid regex value "${obj[key]}"`);
+                }
+            }
+            else {
+                newObj[key] = (0, exports.convertRegexRecursively)(obj[key]);
+            }
         }
-      } else {
-        newObj[key] = convertRegexRecursively(obj[key]);
-      }
+        return newObj;
     }
-    return newObj;
-  }
-  return obj;
+    return obj;
 };
-exports.convertRegexRecursively = convertRegexRecursively;
+exports.convertRegexRecursively = convertRegexRecursively;

package/dist/esm/config/bootConfig.js

@@ -10,4 +10,10 @@ export const bootEnvVariables = {
     OASTLM_BOOT_MODULE_DISABLED: process.env.OASTLM_BOOT_MODULE_DISABLED === 'true',
     OASTLM_BOOT_LOG_LEVEL: process.env.OASTLM_BOOT_LOG_LEVEL || 'INFO',
     OASTLM_BOOT_SERVICE_NAME: process.env.OASTLM_BOOT_SERVICE_NAME || `SERVICE-${randomUUID().slice(0, 8).toUpperCase()}`,
+    OASTLM_BOOT_BASE_URL: process.env.OASTLM_BOOT_BASE_URL || '/oas-telemetry',
+    OASTLM_BOOT_AUTOINSTRUMENTATIONS_NODE_DISABLED: process.env.OASTLM_BOOT_AUTOINSTRUMENTATIONS_NODE_DISABLED == 'true',
+    OASTLM_BOOT_AUTOINSTRUMENTATIONS_LOGS_DISABLED: process.env.OASTLM_BOOT_AUTOINSTRUMENTATIONS_LOGS_DISABLED == 'true',
+    // Storage path: empty string = in-memory, else = disk storage at specified path
+    OASTLM_BOOT_STORAGE_PATH: process.env.OASTLM_BOOT_STORAGE_PATH || '',
 };
+// REMEMBER TO UPDATE THE .env.example FILE WITH ANY NEW BOOT VARIABLE ADDED HERE.

package/dist/esm/config/config.js

@@ -5,7 +5,6 @@ import merge from 'lodash.merge';
 const loadEnv = () => {
     return {
         general: {
-            baseUrl: getParsedEnvVar("OASTLM_CONFIG_GENERAL_BASE_URL"),
             specFileName: getParsedEnvVar("OASTLM_CONFIG_GENERAL_SPEC_FILE_NAME"),
             // spec Not settable via env
         },
@@ -55,7 +54,6 @@ const loadEnv = () => {
 // This means certain settings may affect application startup behavior outside of this configuration system.
 export const defaultConfig = {
     general: {
-        baseUrl: "/telemetry",
         specFileName: null, // e.g. "oas.json" or null if not provided
         spec: null, // e.g. JSON.stringify(oasSpec) or null if not provided,
         uiPath: "/oas-telemetry-ui", // path to the UI, e.g. "/oas-telemetry-ui" WARN: This must match the UI package's App.tsx "oas-telemetry-ui" path
@@ -110,6 +108,7 @@ export const defaultConfig = {
         enabled: true, // future feature
         extraPlugins: [], // future feature
     },
+    instrumentations: [],
 };
 // Helper to get an environment variable with optional transform
 const getParsedEnvVar = (envKey, transform) => {