@oas-tools/oas-telemetry 0.2.2 → 0.3.0

package/package.json

@@ -1,69 +1,71 @@
-{
-  "name": "@oas-tools/oas-telemetry",
-  "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"
-  ],
-  "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",
-    "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",
-    "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",
-    "launchKSApi": "npm run build; (cd test/performance/ks-api ; node indexTelemetry.js)",
-    "launchDevel": "export OTDEBUG=true && npm run launchKSApi"
-  },
-  "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"
-  }
-}
+{
+  "name": "@oas-tools/oas-telemetry",
+  "version": "0.3.0",
+  "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"
+  ],
+  "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",
+    "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",
+    "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",
+    "launchKSApi": "npm run build; (cd test/performance/ks-api ; node indexTelemetry.js)",
+    "launchDevel": "export OTDEBUG=true && npm run launchKSApi"
+  },
+  "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",
+    "dynamic-installer": "^1.0.1",
+    "express": "^4.19.2",
+    "import-from-string": "^0.0.4",
+    "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,175 +1,176 @@
-import { ExportResultCode } from '@opentelemetry/core';
-
-let dbglog = ()=>{};
-
-if(process.env.OTDEBUG == "true")
-    dbglog = console.log;
-
-//import in memory database
-import dataStore from 'nedb';
-
-export class InMemoryExporter {
-    constructor() {
-        this._spans = new dataStore();
-        this._stopped = true;
-    };
-
-    static plugins = [];
-
-    export(readableSpans, resultCallback) {
-        try {
-            if (!this._stopped) {
-                // 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 => !span.attributes?.http?.target?.includes("/telemetry"));// to avoid telemetry spans
-
-                // 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;
-                    }
-                });
-
-            }
-            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;
-    };
-    activatePlugin(plugin){
-        dbglog(`Activating plugin <${plugin.getName()}>...`);
-        InMemoryExporter.plugins.push(plugin);
-        dbglog(`Plugin <${plugin.getName()}> active (Total active plugins: ${InMemoryExporter.plugins.length})`);
-    }
-}
-
-function removeCircularRefs(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);
-    return JSON.parse(jsonString);
-}
-
-/**
- * Recursively converts dot-separated keys in an object to nested objects.
- * 
- * @param {Object} obj - The object to process.
- * @returns {Object} - The object with all dot-separated keys converted to nested objects.
- * @example
- * // Input:
- * // {
- * //   "http.method": "GET",
- * //   "http.url": "http://example.com",
- * //   "nested.obj.key": "value"
- * // }
- * // Output:
- * // {
- * //   "http": {
- * //     "method": "GET",
- * //     "url": "http://example.com"
- * //   },
- * //   "nested": {
- * //     "obj": {
- * //       "key": "value"
- * //     }
- * //   }
- * // }
- */
-function convertToNestedObject(obj) {
-    const result = {};
-
-    for (const key in obj) {
-        const keys = key.split('.');
-        let temp = result;
-
-        for (let i = 0; i < keys.length; i++) {
-            const currentKey = keys[i];
-
-            if (i === keys.length - 1) {
-                // Last key, set the value
-                temp[currentKey] = obj[key];
-            } else {
-                // Intermediate key, ensure the object exists
-                if (!temp[currentKey]) {
-                    temp[currentKey] = {};
-                }
-                temp = temp[currentKey];
-            }
-        }
-    }
-
-    return result;
-}
-
-/**
- * Applies nesting to all dot-separated keys within an object.
- * 
- * @param {Object} obj - The object to apply nesting to.
- * @returns {Object} - The transformed object with nested structures.
- */
-function applyNesting(obj) {
-    // Recursively apply convertToNestedObject to each level of the object
-    for (const key in obj) {
-        if (typeof obj[key] === 'object' && obj[key] !== null) {
-            obj[key] = applyNesting(obj[key]);
-        }
-    }
-
-    return convertToNestedObject(obj);
+import { ExportResultCode } from '@opentelemetry/core';
+
+let dbglog = ()=>{};
+
+if(process.env.OTDEBUG == "true")
+    dbglog = console.log;
+
+//import in memory database
+import dataStore from 'nedb';
+
+export class InMemoryExporter {
+    constructor() {
+        this._spans = new dataStore();
+        this._stopped = true;
+    };
+
+    static plugins = [];
+
+    export(readableSpans, resultCallback) {
+        try {
+            if (!this._stopped) {
+                // 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 => !span.attributes?.http?.target?.includes("/telemetry"));// to avoid telemetry spans
+
+                // 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)}`);
+                            //TODO: This should be called newSpan instead of newTrace
+                            p.newTrace(t);
+                        });
+                    });
+                    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;
+    };
+    activatePlugin(plugin){
+        dbglog(`Activating plugin <${plugin.getName()}>...`);
+        InMemoryExporter.plugins.push(plugin);
+        dbglog(`Plugin <${plugin.getName()}> active (Total active plugins: ${InMemoryExporter.plugins.length})`);
+    }
+}
+
+function removeCircularRefs(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);
+    return JSON.parse(jsonString);
+}
+
+/**
+ * Recursively converts dot-separated keys in an object to nested objects.
+ * 
+ * @param {Object} obj - The object to process.
+ * @returns {Object} - The object with all dot-separated keys converted to nested objects.
+ * @example
+ * // Input:
+ * // {
+ * //   "http.method": "GET",
+ * //   "http.url": "http://example.com",
+ * //   "nested.obj.key": "value"
+ * // }
+ * // Output:
+ * // {
+ * //   "http": {
+ * //     "method": "GET",
+ * //     "url": "http://example.com"
+ * //   },
+ * //   "nested": {
+ * //     "obj": {
+ * //       "key": "value"
+ * //     }
+ * //   }
+ * // }
+ */
+function convertToNestedObject(obj) {
+    const result = {};
+
+    for (const key in obj) {
+        const keys = key.split('.');
+        let temp = result;
+
+        for (let i = 0; i < keys.length; i++) {
+            const currentKey = keys[i];
+
+            if (i === keys.length - 1) {
+                // Last key, set the value
+                temp[currentKey] = obj[key];
+            } else {
+                // Intermediate key, ensure the object exists
+                if (!temp[currentKey]) {
+                    temp[currentKey] = {};
+                }
+                temp = temp[currentKey];
+            }
+        }
+    }
+
+    return result;
+}
+
+/**
+ * Applies nesting to all dot-separated keys within an object.
+ * 
+ * @param {Object} obj - The object to apply nesting to.
+ * @returns {Object} - The transformed object with nested structures.
+ */
+function applyNesting(obj) {
+    // Recursively apply convertToNestedObject to each level of the object
+    for (const key in obj) {
+        if (typeof obj[key] === 'object' && obj[key] !== null) {
+            obj[key] = applyNesting(obj[key]);
+        }
+    }
+
+    return convertToNestedObject(obj);
 }