@oas-tools/oas-telemetry 0.2.1 → 0.2.2

package/dist/exporters/InMemoryDbExporter.cjs

@@ -7,6 +7,12 @@ exports.InMemoryExporter = void 0;
 var _core = require("@opentelemetry/core");
 var _nedb = _interopRequireDefault(require("nedb"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+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); }
+let dbglog = () => {};
+if (process.env.OTDEBUG == "true") dbglog = console.log;
+
 //import in memory database
 
 class InMemoryExporter {
@@ -24,6 +30,13 @@ class InMemoryExporter {
 
         // Insert spans into the in-memory database
         this._spans.insert(cleanSpans, (err, newDoc) => {
+          InMemoryExporter.plugins.forEach((p, i) => {
+            cleanSpans.forEach(t => {
+              dbglog(`Sending trace <${t._id}> to plugin (Plugin #${i}) <${p.name}>`);
+              dbglog(`Trace: \n<${JSON.stringify(t, null, 2)}`);
+              p.newTrace(t);
+            });
+          });
           if (err) {
             console.error(err);
             return;
@@ -64,8 +77,14 @@ class InMemoryExporter {
   getFinishedSpans() {
     return this._spans;
   }
+  activatePlugin(plugin) {
+    dbglog(`Activating plugin <${plugin.getName()}>...`);
+    InMemoryExporter.plugins.push(plugin);
+    dbglog(`Plugin <${plugin.getName()}> active (Total active plugins: ${InMemoryExporter.plugins.length})`);
+  }
 }
 exports.InMemoryExporter = InMemoryExporter;
+_defineProperty(InMemoryExporter, "plugins", []);
 function removeCircularRefs(obj) {
   const seen = new WeakMap(); // Used to keep track of visited objects
 

package/dist/index.cjs

@@ -11,9 +11,16 @@ var _fs = require("fs");
 var _path = _interopRequireDefault(require("path"));
 var _jsYaml = _interopRequireDefault(require("js-yaml"));
 var _ui = _interopRequireDefault(require("./ui.cjs"));
+var _axios = _interopRequireDefault(require("axios"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // telemetryMiddleware.js
 
+let dbglog = () => {};
+if (process.env.OTDEBUG == "true") dbglog = console.log;
+let plugins = [];
+let telemetryStatus = {
+  active: true
+};
 let baseURL = '/telemetry';
 let telemetryConfig = {
   exporter: _telemetry.inMemoryExporter,
@@ -21,19 +28,18 @@ let telemetryConfig = {
 };
 function oasTelemetry(tlConfig) {
   if (tlConfig) {
-    console.log('Telemetry config provided');
+    dbglog('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 !");
+  if (telemetryConfig.spec) dbglog(`Spec content provided`);else {
+    if (telemetryConfig.specFileName != "") dbglog(`Spec file used for telemetry: ${telemetryConfig.specFileName}`);else {
+      console.error("No spec available !");
     }
   }
   const router = (0, _express.Router)();
-
-  //const baseURL = telemetryConfig.baseURL;
-
+  if (telemetryConfig.baseURL) baseURL = telemetryConfig.baseURL;
+  router.use((0, _express.json)());
   router.get(baseURL, mainPage);
   router.get(baseURL + "/detail/*", detailPage);
   router.get(baseURL + "/spec", specLoader);
@@ -45,6 +51,8 @@ function oasTelemetry(tlConfig) {
   router.get(baseURL + "/list", listTelemetry);
   router.post(baseURL + "/find", findTelemetry);
   router.get(baseURL + "/heapStats", heapStats);
+  router.get(baseURL + "/plugins", listPlugins);
+  router.post(baseURL + "/plugins", registerPlugin);
   return router;
 }
 const apiPage = (req, res) => {
@@ -138,6 +146,17 @@ const listTelemetry = (req, res) => {
     });
   });
 };
+const heapStats = (req, res) => {
+  var heapStats = _v.default.getHeapStatistics();
+
+  // Round stats to MB
+  var 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);
+};
 const findTelemetry = (req, res) => {
   const spansDB = telemetryConfig.exporter.getFinishedSpans();
   const body = req.body;
@@ -174,15 +193,38 @@ const findTelemetry = (req, res) => {
     });
   }
 };
-const heapStats = (req, res) => {
-  var heapStats = _v.default.getHeapStatistics();
-
-  // Round stats to MB
-  var 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);
+const listPlugins = (req, res) => {
+  res.send(plugins.map(p => {
+    return {
+      id: p.id,
+      url: p.url,
+      active: p.active
+    };
+  }));
+};
+const registerPlugin = (req, res) => {
+  let pluginResource = req.body;
+  dbglog(`Plugin Registration Request: = ${JSON.stringify(req.body, null, 2)}...`);
+  dbglog(`Getting plugin at ${pluginResource.url}...`);
+  _axios.default.get(pluginResource.url).then(response => {
+    dbglog(`Plugin fetched.`);
+    const pluginCode = response.data;
+    dbglog("Plugin size: " + pluginCode.length);
+    var plugin;
+    eval(pluginCode);
+    plugin.load(pluginResource.config);
+    if (plugin.isConfigured()) {
+      dbglog(`Loaded plugin <${plugin.getName()}>`);
+      pluginResource.plugin = plugin;
+      pluginResource.name = plugin.getName();
+      pluginResource.active = true;
+      plugins.push(pluginResource);
+      _telemetry.inMemoryExporter.activatePlugin(pluginResource.plugin);
+      res.status(201).send(`Plugin registered`);
+    } else {
+      console.error(`Plugin <${plugin.getName()}> can not be configured`);
+      res.status(400).send(`Plugin configuration problem`);
+    }
+  }).catch(err => console.error("registerPlugin:" + err));
 };
 module.exports = exports.default;

package/dist/ui.cjs

@@ -6,8 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = ui;
 function ui() {
   return {
-    main: `
-<!DOCTYPE html>
+    main: `<!DOCTYPE html>
 <html lang="en">
 
 <head>
@@ -124,14 +123,16 @@ function ui() {
                 if (c != "") {
                     pathRegExpStr += "/";
                     if (c.charAt(0) == "{" && c.charAt(c.length - 1) == "}") {
-                        pathRegExpStr += "(.*)";
+                        // Ensure it matches at least one character (.+)
+                        pathRegExpStr += "(.+)";
                     } else {
                         pathRegExpStr += c;
                     }
                 }
             });
-
-            pathRegExpStr += "\$";
+            
+            // Allow an optional trailing slash
+            pathRegExpStr += "/?\$";
 
             return pathRegExpStr;
         }
@@ -380,8 +381,7 @@ function ui() {
 </body>
 
 </html>`,
-    detail: `
-<!DOCTYPE html>
+    detail: `<!DOCTYPE html>
 <html lang="en">
 
 <head>
@@ -584,14 +584,16 @@ function ui() {
                 if (c != "") {
                     pathRegExpStr += "/";
                     if (c.charAt(0) == "{" && c.charAt(c.length - 1) == "}") {
-                        pathRegExpStr += "(.*)";
+                        // Ensure it matches at least one character (.+)
+                        pathRegExpStr += "(.+)";
                     } else {
                         pathRegExpStr += c;
                     }
                 }
             });
 
-            pathRegExpStr += "\$";
+            // Allow an optional trailing slash
+            pathRegExpStr += "/?\$";
 
             return pathRegExpStr;
         }
@@ -600,7 +602,24 @@ function ui() {
             try {
                 log(\`Fetchig traces for <\${path}> - \${method} - \${status},.. \`);
 
-                const response = await fetch("/telemetry/list");
+                const body = {
+                    "flags": { "containsRegex": true },
+                    "config": { "regexIds": ["attributes.http.target"] },
+                    "search": {
+                        "attributes.http.target": getPathRegEx(path),
+                        "attributes.http.method": method.toUpperCase(),
+                        "attributes.http.status_code": parseInt(status)
+                    }
+                };
+                log("body: " + JSON.stringify(body, null, 2));
+                //response is to the post at /telemetry/find
+                const response = await fetch("/telemetry/find", {
+                    method: "POST",
+                    headers: {
+                        "Content-Type": "application/json"
+                    },
+                    body: JSON.stringify(body)
+                });
 
                 if (!response.ok) {
                     throw new Error("ERROR getting the Traces.");
@@ -608,13 +627,12 @@ function ui() {
 
                 const responseJSON = await response.json();
                 const traces = responseJSON.spans;
-                const filteredTraces = traces; //filter made in server side
-                log(\`Feched \${traces.length} traces.\`);
-                //log(\`First trace: \${JSON.stringify(traces[0],null,2)}\`);
 
-                if (filteredTraces.length != traceCount) {
-                    loadTraces(filteredTraces);
-                    traceCount = filteredTraces.length;
+                log(\`Fetched \${traces.length} traces.\`);
+
+                if (traces.length != traceCount) {
+                    loadTraces(traces);
+                    traceCount = traces.length;
                 }
 
                 setTimeout(fetchTracesByParsing, 1000, path, method, status);

package/package.json

@@ -1,29 +1,35 @@
 {
   "name": "@oas-tools/oas-telemetry",
-  "version": "0.2.1",
-  "description": "This package exports an express midelware that allows to trace the requests and responses of an express application using OpenTelemetry",
+  "version": "0.2.2",
+  "description": "This package exports an Express middleware that traces requests and responses of an Express application using OpenTelemetry.",
   "author": "Manuel Otero",
   "contributors": [
-    "Alejandro Santisteban","Pablo Fernandez"
+    "Alejandro Santisteban",
+    "Pablo Fernandez"
   ],
   "license": "Apache-2.0",
   "type": "module",
   "scripts": {
+    "devImportUi": "node dev/ui/importUiToHtml.js",
+    "devExportUi": "node dev/ui/exportHtmlToUi.js",
     "build": "babel src -d dist --out-file-extension .cjs",
+    "devUi": "nodemon --watch dev/ui --ext html --exec \"npm run devExportUi && npm run build && node test/functional/otTestServer.cjs\"",
     "publish": "npm run build && npm publish",
     "testPerformance": "npm i && cd test/performance/ && ./test.sh",
     "pretest": "npm run build",
-    "test": "npm run testCJS && npm run testMJS", 
-    "testCJS": "npm run preTestCJS && npm run launchTestCJS && npm run postTestCJS", 
+    "test": "npm run testCJS && npm run testMJS",
+    "testCJS": "npm run preTestCJS && npm run launchTestCJS && npm run postTestCJS",
     "preTestCJS": "node test/functional/otTestServer.cjs &",
     "launchTestCJS": "npx -y wait-on http://localhost:3000/api/v1/pets && npm run sendRequests && sleep 4 && npm run checkRequestsLog",
     "postTestCJS": "kill `ps -uax | grep \"node test/functional/otTestServer\" | grep -v \"grep\" | grep -v \"sh\" | awk '{print $2}'`",
-    "testMJS": "npm run preTestMJS && npm run launchTestMJS && npm run postTestMJS", 
+    "testMJS": "npm run preTestMJS && npm run launchTestMJS && npm run postTestMJS",
     "preTestMJS": "node test/functional/otTestServer.mjs &",
     "launchTestMJS": "npx -y wait-on http://localhost:3000/api/v1/pets && npm run sendRequests && sleep 4 && npm run checkRequestsLog",
     "postTestMJS": "kill `ps -uax | grep \"node test/functional/otTestServer\" | grep -v \"grep\" | grep -v \"sh\" | awk '{print $2}'`",
     "sendRequests": "npx -y newman run test/functional/request-collection.json -e test/functional/request-environment.json",
-    "checkRequestsLog": "npx -y newman run test/functional/request-collection-check.json -e test/functional/request-environment.json"
+    "checkRequestsLog": "npx -y newman run test/functional/request-collection-check.json -e test/functional/request-environment.json",
+    "launchKSApi": "npm run build; (cd test/performance/ks-api ; node indexTelemetry.js)",
+    "launchDevel": "export OTDEBUG=true && npm run launchKSApi"
   },
   "files": [
     "dist",

package/src/exporters/InMemoryDbExporter.js

@@ -1,13 +1,21 @@
 import { ExportResultCode } from '@opentelemetry/core';
 
+let dbglog = ()=>{};
+
+if(process.env.OTDEBUG == "true")
+    dbglog = console.log;
+
 //import in memory database
-import dataStore from 'nedb'
+import dataStore from 'nedb';
 
 export class InMemoryExporter {
     constructor() {
         this._spans = new dataStore();
         this._stopped = true;
-    }
+    };
+
+    static plugins = [];
+
     export(readableSpans, resultCallback) {
         try {
             if (!this._stopped) {
@@ -19,6 +27,13 @@ export class InMemoryExporter {
 
                 // Insert spans into the in-memory database
                 this._spans.insert(cleanSpans, (err, newDoc) => {
+                    InMemoryExporter.plugins.forEach((p,i)=>{                        
+                        cleanSpans.forEach((t)=>{
+                            dbglog(`Sending trace <${t._id}> to plugin (Plugin #${i}) <${p.name}>`);
+                            dbglog(`Trace: \n<${JSON.stringify(t,null,2)}`);
+                            p.newTrace(t);
+                        });
+                    });
                     if (err) {
                         console.error(err);
                         return;
@@ -34,29 +49,34 @@ export class InMemoryExporter {
                 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;
+    };
+    activatePlugin(plugin){
+        dbglog(`Activating plugin <${plugin.getName()}>...`);
+        InMemoryExporter.plugins.push(plugin);
+        dbglog(`Plugin <${plugin.getName()}> active (Total active plugins: ${InMemoryExporter.plugins.length})`);
     }
 }
 

package/src/index.js

@@ -1,11 +1,23 @@
 // telemetryMiddleware.js
 import { inMemoryExporter } from './telemetry.js';
-import { Router } from 'express';
+import { Router,json } from 'express';
 import v8 from 'v8';
 import { readFileSync, existsSync } from 'fs';
 import path from 'path';
 import yaml from 'js-yaml';
 import ui from './ui.js'
+import axios from 'axios';
+
+let dbglog = ()=>{};
+
+if(process.env.OTDEBUG == "true")
+    dbglog = console.log;
+
+let  plugins = [];
+
+let telemetryStatus = {
+    active : true
+};
 
 let baseURL = '/telemetry';
 
@@ -16,40 +28,42 @@ let telemetryConfig = {
 
 export default function oasTelemetry(tlConfig) {
     if (tlConfig) {
-        console.log('Telemetry config provided');
+        dbglog('Telemetry config provided');
         telemetryConfig = tlConfig;
         if (telemetryConfig.exporter == undefined)
             telemetryConfig.exporter = inMemoryExporter;
     }
 
     if (telemetryConfig.spec)
-        console.log(`Spec content provided`);
+        dbglog(`Spec content provided`);
     else {
         if (telemetryConfig.specFileName != "")
-            console.log(`Spec file used for telemetry: ${telemetryConfig.specFileName}`);
+            dbglog(`Spec file used for telemetry: ${telemetryConfig.specFileName}`);
         else {
-            console.log("No spec available !");
+            console.error("No spec available !");
         }
     }
 
-
-
     const router = Router();
 
-    //const baseURL = telemetryConfig.baseURL;
+    if (telemetryConfig.baseURL)
+        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 + "/start", startTelemetry);
-    router.get(baseURL + "/stop", stopTelemetry);
-    router.get(baseURL + "/status", statusTelemetry);
-    router.get(baseURL + "/reset", resetTelemetry);
-    router.get(baseURL + "/list", listTelemetry);
-    router.post(baseURL + "/find", findTelemetry);
-    router.get(baseURL + "/heapStats", heapStats);
+    router.use(json());
 
+    router.get(baseURL, mainPage);
+    router.get(baseURL+"/detail/*", detailPage);
+    router.get(baseURL+"/spec", specLoader);
+    router.get(baseURL+"/api", apiPage);
+    router.get(baseURL+"/start", startTelemetry);
+    router.get(baseURL+"/stop", stopTelemetry);
+    router.get(baseURL+"/status", statusTelemetry);
+    router.get(baseURL+"/reset", resetTelemetry);
+    router.get(baseURL+"/list", listTelemetry);
+    router.post(baseURL+"/find", findTelemetry);
+    router.get(baseURL+"/heapStats", heapStats);
+    router.get(baseURL+"/plugins", listPlugins);
+    router.post(baseURL+"/plugins", registerPlugin);
     return router;
 }
 
@@ -154,6 +168,19 @@ const listTelemetry = (req, res) => {
     });
 }
 
+const heapStats = (req, res) => {
+    var heapStats = v8.getHeapStatistics();
+
+    // Round stats to MB
+    var 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);
+}
+
 const findTelemetry = (req, res) => {
     const spansDB = telemetryConfig.exporter.getFinishedSpans();
     const body = req.body;
@@ -181,17 +208,48 @@ const findTelemetry = (req, res) => {
     }
 }
 
-const heapStats = (req, res) => {
-    var heapStats = v8.getHeapStatistics();
-
-    // Round stats to MB
-    var roundedHeapStats = Object.getOwnPropertyNames(heapStats).reduce(function (map, stat) {
-        map[stat] = Math.round((heapStats[stat] / 1024 / 1024) * 1000) / 1000;
-        return map;
-    }, {});
-    roundedHeapStats['units'] = 'MB';
+const listPlugins = (req, res) => {
+    res.send(plugins.map((p)=>{
+        return {
+          id:p.id, 
+          url:p.url, 
+          active:p.active
+        };
+    }));
+}
 
-    res.send(roundedHeapStats);
+const registerPlugin = (req, res) => {
+    let pluginResource = req.body;
+    dbglog(`Plugin Registration Request: = ${JSON.stringify(req.body,null,2)}...`);
+    dbglog(`Getting plugin at ${pluginResource.url}...`);
+    
+    axios
+    .get(pluginResource.url)
+    .then((response) => {
+      dbglog(`Plugin fetched.`);
+      const pluginCode = response.data;
+      dbglog("Plugin size: "+pluginCode.length);
+      var plugin;
+      eval(pluginCode);
+      plugin.load(pluginResource.config);
+      if(plugin.isConfigured()){
+        dbglog(`Loaded plugin <${plugin.getName()}>`);
+        pluginResource.plugin = plugin;
+        pluginResource.name = plugin.getName();
+        
+        pluginResource.active = true;
+        plugins.push(pluginResource);
+        inMemoryExporter.activatePlugin(pluginResource.plugin);
+        res.status(201).send(`Plugin registered`);
+      }else{
+        console.error(`Plugin <${plugin.getName()}> can not be configured`);
+        res.status(400).send(`Plugin configuration problem`);
+      }
+
+    }).catch((err) => console.error("registerPlugin:"+err));
+  
+    
 }
 
 
+