@oas-tools/oas-telemetry 0.1.5 → 0.1.6

package/dist/index.cjs

@@ -7,36 +7,58 @@ exports.default = oasTelemetry;
 var _telemetry = require("./telemetry.cjs");
 var _express = require("express");
 var _v = _interopRequireDefault(require("v8"));
+var _fs = require("fs");
+var _path = _interopRequireDefault(require("path"));
+var _jsYaml = _interopRequireDefault(require("js-yaml"));
+var _url = require("url");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // telemetryMiddleware.js
 
+const _filename = (0, _url.fileURLToPath)(import.meta.url);
+const _dirname = _path.default.dirname(_filename);
+let telemetryStatus = {
+  active: true
+};
+let baseURL = '/telemetry';
 let telemetryConfig = {
   exporter: _telemetry.inMemoryExporter,
-  baseURL: '/telemetry'
+  specFileName: ""
 };
 function oasTelemetry(tlConfig) {
   if (tlConfig) {
     console.log('Telemetry config provided');
     telemetryConfig = tlConfig;
+    if (telemetryConfig.exporter == undefined) telemetryConfig.exporter = _telemetry.inMemoryExporter;
+  }
+  if (telemetryConfig.spec) console.log(`Spec content provided`);else {
+    if (telemetryConfig.specFileName != "") console.log(`Spec file used for telemetry: ${telemetryConfig.specFileName}`);else {
+      console.log("No spec available !");
+    }
   }
   const router = (0, _express.Router)();
-  const baseURL = telemetryConfig.baseURL;
-  router.get(baseURL, landingPage);
+
+  //const baseURL = telemetryConfig.baseURL;
+
+  router.get(baseURL, mainPage);
+  router.get(baseURL + "/detail/*", detailPage);
+  router.get(baseURL + "/spec", specLoader);
+  router.get(baseURL + "/api", apiPage);
   router.get(baseURL + "/reset", resetTelemetry);
   router.get(baseURL + "/start", startTelemetry);
   router.get(baseURL + "/stop", stopTelemetry);
+  router.get(baseURL + "/status", statusTelemetry);
   router.get(baseURL + "/list", listTelemetry);
   router.post(baseURL + "/find", findTelemetry);
   router.get(baseURL + "/heapStats", heapStats);
   return router;
 }
-const landingPage = (req, res) => {
+const apiPage = (req, res) => {
   let text = `
-    <h1>Telemetry showcase</h1>s
-    <h2>Available routes:</h2>
+    <h1>Telemetry API routes:</h1>
     <ul>
         <li><a href="/telemetry/start">/telemetry/start</a></li>
         <li><a href="/telemetry/stop">/telemetry/stop</a></li>
+        <li><a href="/telemetry/status">/telemetry/status</a></li>
         <li><a href="/telemetry/reset">/telemetry/reset</a></li>
         <li><a href="/telemetry/list">/telemetry/list</a></li>
         <li><a href="/telemetry/heapStats">/telemetry/heapStats</a></li>
@@ -45,14 +67,69 @@ const landingPage = (req, res) => {
     `;
   res.send(text);
 };
+const mainPage = (req, res) => {
+  const data = (0, _fs.readFileSync)(_dirname + '/ui/main.html', {
+    encoding: 'utf8',
+    flag: 'r'
+  });
+  res.send(data);
+};
+const detailPage = (req, res) => {
+  const data = (0, _fs.readFileSync)(_dirname + '/ui/detail.html', {
+    encoding: 'utf8',
+    flag: 'r'
+  });
+  res.send(data);
+};
+const specLoader = (req, res) => {
+  if (telemetryConfig.specFileName) {
+    try {
+      const data = (0, _fs.readFileSync)(telemetryConfig.specFileName, {
+        encoding: 'utf8',
+        flag: 'r'
+      });
+      const extension = _path.default.extname(telemetryConfig.specFileName);
+      let json = data;
+      if (extension == _jsYaml.default) json = JSON.stringify(_jsYaml.default.SafeLoad(data), null, 2);
+      res.setHeader('Content-Type', 'application/json');
+      res.send(json);
+    } catch (e) {
+      console.log(`ERROR loading spec file ${telemetryConfig.specFileName}: ${e}`);
+    }
+  } else {
+    if (telemetryConfig.spec) {
+      let spec = false;
+      try {
+        spec = JSON.parse(telemetryConfig.spec);
+      } catch (ej) {
+        try {
+          spec = JSON.stringify(_jsYaml.default.load(telemetryConfig.spec), null, 2);
+        } catch (ey) {
+          console.log(`Error parsing spec: ${ej} - ${ey}`);
+        }
+      }
+      if (!spec) {
+        res.status(404);
+      } else {
+        res.setHeader('Content-Type', 'application/json');
+        res.send(spec);
+      }
+    }
+  }
+};
 const startTelemetry = (req, res) => {
   telemetryConfig.exporter.start();
+  telemetryStatus.active = true;
   res.send('Telemetry started');
 };
 const stopTelemetry = (req, res) => {
   telemetryConfig.exporter.stop();
+  telemetryStatus.active = false;
   res.send('Telemetry stopped');
 };
+const statusTelemetry = (req, res) => {
+  res.send(telemetryStatus);
+};
 const resetTelemetry = (req, res) => {
   telemetryConfig.exporter.reset();
   res.send('Telemetry reset');

package/package.json

@@ -1,46 +1,51 @@
-{
-  "name": "@oas-tools/oas-telemetry",
-  "version": "0.1.5",
-  "description": "This package exports an express midelware that allows to trace the requests and responses of an express application using OpenTelemetry",
-  "author": "Manuel Otero",
-  "contributors": [
-    "Alejandro Santisteban"
-  ],
-  "license": "Apache-2.0",
-  "type": "module",
-  "scripts": {
-    "build": "babel src -d dist --out-file-extension .cjs",
-    "publish": "npm run build && npm publish"
-  },
-  "files": [
-    "dist",
-    "src"
-  ],
-  "main": "./dist/index.cjs",
-  "module": "./src/index.js",
-  "exports": {
-    "require": "./dist/index.cjs",
-    "import": "./src/index.js",
-    "default": "./src/index.js"
-  },
-  "dependencies": {
-    "@opentelemetry/instrumentation-http": "^0.51.0",
-    "@opentelemetry/resources": "^1.24.0",
-    "@opentelemetry/sdk-node": "^0.49.1",
-    "express": "^4.19.2",
-    "nedb": "^1.8.0",
-    "v8": "^0.1.0"
-  },
-  "devDependencies": {
-    "@babel/cli": "^7.24.1",
-    "@babel/core": "^7.24.4",
-    "@babel/plugin-proposal-class-properties": "^7.18.6",
-    "@babel/plugin-proposal-object-rest-spread": "^7.20.7",
-    "@babel/preset-env": "^7.24.4",
-    "@opentelemetry/api": "^1.8.0",
-    "@opentelemetry/auto-instrumentations-node": "^0.43.0",
-    "babel-plugin-add-module-exports": "^1.0.4",
-    "babel-plugin-module-extension": "^0.1.3",
-    "nodemon": "^3.1.0"
-  }
-}
+{
+  "name": "@oas-tools/oas-telemetry",
+  "version": "0.1.6",
+  "description": "This package exports an express midelware that allows to trace the requests and responses of an express application using OpenTelemetry",
+  "author": "Manuel Otero",
+  "contributors": [
+    "Alejandro Santisteban","Pablo Fernandez"
+  ],
+  "license": "Apache-2.0",
+  "type": "module",
+  "scripts": {
+    "build": "babel src -d dist --out-file-extension .cjs",
+    "publish": "npm run build && npm publish",
+    "test": "npm i && cd test/performance/ && ./test.sh"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./src/index.js",
+  "exports": {
+    "require": "./dist/index.cjs",
+    "import": "./src/index.js",
+    "default": "./src/index.js"
+  },
+  "dependencies": {
+    "@opentelemetry/instrumentation-http": "^0.51.0",
+    "@opentelemetry/resources": "^1.24.0",
+    "@opentelemetry/sdk-node": "^0.49.1",
+    "axios": "^1.6.8",
+    "express": "^4.19.2",
+    "js-yaml": "^4.1.0",
+    "nedb": "^1.8.0",
+    "readline": "^1.3.0",
+    "v8": "^0.1.0"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.24.1",
+    "@babel/core": "^7.24.4",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/plugin-proposal-object-rest-spread": "^7.20.7",
+    "@babel/preset-env": "^7.24.4",
+    "@opentelemetry/api": "^1.8.0",
+    "@opentelemetry/auto-instrumentations-node": "^0.43.0",
+    "apipecker": "^1.3.1",
+    "babel-plugin-add-module-exports": "^1.0.4",
+    "babel-plugin-module-extension": "^0.1.3",
+    "nodemon": "^3.1.0"
+  }
+}

package/src/exporters/InMemoryDbExporter.js

@@ -1,90 +1,90 @@
-import { ExportResultCode } from '@opentelemetry/core';
-
-//import in memory database
-import dataStore from 'nedb'
-
-export class InMemoryExporter {
-    constructor() {
-        this._spans = new dataStore();
-        this._stopped = false;
-    }
-    export(readableSpans, resultCallback) {
-        try {
-            if (!this._stopped) {
-                // Remove circular references
-                const cleanSpans = readableSpans.map(span => removeCircular(span));
-
-                // Insert spans into the in-memory database
-                this._spans.insert(cleanSpans, (err, newDoc) => {
-                    if (err) {
-                        console.error(err);
-                        return;
-                    }
-                });
-
-            }
-            setTimeout(() => resultCallback({ code: ExportResultCode.SUCCESS }), 0);
-        } catch (error) {
-            console.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),
-            })
-        }
-    }
-    start() {
-        this._stopped = false;
-    }
-    stop() {
-        this._stopped = true;
-    }
-    shutdown() {
-        this._stopped = true;
-        this._spans = new dataStore();
-        return this.forceFlush();
-    }
-    /**
-     * Exports any pending spans in the exporter
-     */
-    forceFlush() {
-        return Promise.resolve();
-    }
-    reset() {
-        this._spans = new dataStore();
-    }
-    getFinishedSpans() {
-        return this._spans;
-    }
-}
-
-function removeCircular(obj) {
-    const seen = new WeakMap(); // Used to keep track of visited objects
-
-
-    // Replacer function to handle circular references
-    function replacer(key, value) {
-        if (key === "_spanProcessor") {
-            return "oas-telemetry skips this field to avoid circular reference";
-        }
-        // GENERIC CIRCULAR REFERENCE HANDLING
-        // if (typeof value === "object" && value !== null) {
-        //     // If the object has been visited before, return the name prefixed with "CIRCULAR+"
-        //     if (seen.has(value)) {
-        //         return `CIRCULAR${key}`;
-        //     }
-        //     seen.set(value, key); // Mark the object as visited with its name
-        // }
-        return value;
-    }
-    
-    // Convert the object to a string and then parse it back
-    // This will trigger the replacer function to handle circular references
-    const jsonString = JSON.stringify(obj, replacer);
-    const spanNoDotsInKeys =jsonString.replace(/[^"]*":/g, (match) => {
-        // Replace all dots in the key with underscores (e.g. "http.method" -> "http_method")
-        const newMatch = match.replace(/\./g,"_dot_")
-
-        return newMatch
-    })  
-    return JSON.parse(spanNoDotsInKeys);
+import { ExportResultCode } from '@opentelemetry/core';
+
+//import in memory database
+import dataStore from 'nedb'
+
+export class InMemoryExporter {
+    constructor() {
+        this._spans = new dataStore();
+        this._stopped = false;
+    }
+    export(readableSpans, resultCallback) {
+        try {
+            if (!this._stopped) {
+                // Remove circular references
+                const cleanSpans = readableSpans.map(span => removeCircular(span));
+
+                // Insert spans into the in-memory database
+                this._spans.insert(cleanSpans, (err, newDoc) => {
+                    if (err) {
+                        console.error(err);
+                        return;
+                    }
+                });
+
+            }
+            setTimeout(() => resultCallback({ code: ExportResultCode.SUCCESS }), 0);
+        } catch (error) {
+            console.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),
+            })
+        }
+    }
+    start() {
+        this._stopped = false;
+    }
+    stop() {
+        this._stopped = true;
+    }
+    shutdown() {
+        this._stopped = true;
+        this._spans = new dataStore();
+        return this.forceFlush();
+    }
+    /**
+     * Exports any pending spans in the exporter
+     */
+    forceFlush() {
+        return Promise.resolve();
+    }
+    reset() {
+        this._spans = new dataStore();
+    }
+    getFinishedSpans() {
+        return this._spans;
+    }
+}
+
+function removeCircular(obj) {
+    const seen = new WeakMap(); // Used to keep track of visited objects
+
+
+    // Replacer function to handle circular references
+    function replacer(key, value) {
+        if (key === "_spanProcessor") {
+            return "oas-telemetry skips this field to avoid circular reference";
+        }
+        // GENERIC CIRCULAR REFERENCE HANDLING
+        // if (typeof value === "object" && value !== null) {
+        //     // If the object has been visited before, return the name prefixed with "CIRCULAR+"
+        //     if (seen.has(value)) {
+        //         return `CIRCULAR${key}`;
+        //     }
+        //     seen.set(value, key); // Mark the object as visited with its name
+        // }
+        return value;
+    }
+    
+    // Convert the object to a string and then parse it back
+    // This will trigger the replacer function to handle circular references
+    const jsonString = JSON.stringify(obj, replacer);
+    const spanNoDotsInKeys =jsonString.replace(/[^"]*":/g, (match) => {
+        // Replace all dots in the key with underscores (e.g. "http.method" -> "http_method")
+        const newMatch = match.replace(/\./g,"_dot_")
+
+        return newMatch
+    })  
+    return JSON.parse(spanNoDotsInKeys);
 }