@oas-tools/oas-telemetry 0.1.10 → 0.2.1

package/dist/exporters/InMemoryDbExporter.cjs

@@ -12,13 +12,15 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 class InMemoryExporter {
   constructor() {
     this._spans = new _nedb.default();
-    this._stopped = false;
+    this._stopped = true;
   }
   export(readableSpans, resultCallback) {
     try {
       if (!this._stopped) {
-        // Remove circular references
-        const cleanSpans = readableSpans.map(span => removeCircular(span));
+        // 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) => {
@@ -50,8 +52,8 @@ class InMemoryExporter {
     this._spans = new _nedb.default();
     return this.forceFlush();
   }
-  /**
-   * Exports any pending spans in the exporter
+  /**
+   * Exports any pending spans in the exporter
    */
   forceFlush() {
     return Promise.resolve();
@@ -64,7 +66,7 @@ class InMemoryExporter {
   }
 }
 exports.InMemoryExporter = InMemoryExporter;
-function removeCircular(obj) {
+function removeCircularRefs(obj) {
   const seen = new WeakMap(); // Used to keep track of visited objects
 
   // Replacer function to handle circular references
@@ -86,10 +88,68 @@ function removeCircular(obj) {
   // 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);
+  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);
 }

package/dist/index.cjs

@@ -14,9 +14,6 @@ var _ui = _interopRequireDefault(require("./ui.cjs"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // telemetryMiddleware.js
 
-let telemetryStatus = {
-  active: true
-};
 let baseURL = '/telemetry';
 let telemetryConfig = {
   exporter: _telemetry.inMemoryExporter,
@@ -34,14 +31,17 @@ function oasTelemetry(tlConfig) {
     }
   }
   const router = (0, _express.Router)();
+
+  //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 + "/reset", resetTelemetry);
   router.get(baseURL + "/list", listTelemetry);
   router.post(baseURL + "/find", findTelemetry);
   router.get(baseURL + "/heapStats", heapStats);
@@ -63,9 +63,11 @@ const apiPage = (req, res) => {
   res.send(text);
 };
 const mainPage = (req, res) => {
+  res.set('Content-Type', 'text/html');
   res.send((0, _ui.default)().main);
 };
 const detailPage = (req, res) => {
+  res.set('Content-Type', 'text/html');
   res.send((0, _ui.default)().detail);
 };
 const specLoader = (req, res) => {
@@ -81,10 +83,10 @@ const specLoader = (req, res) => {
       res.setHeader('Content-Type', 'application/json');
       res.send(json);
     } catch (e) {
-      console.log(`ERROR loading spec file ${telemetryConfig.specFileName}: ${e}`);
+      console.error(`ERROR loading spec file ${telemetryConfig.specFileName}: ${e}`);
     }
   } else {
-    if (typeof telemetryConfig.spec === 'string' || telemetryConfig.spec instanceof String) {
+    if (telemetryConfig.spec) {
       let spec = false;
       try {
         spec = JSON.parse(telemetryConfig.spec);
@@ -92,7 +94,7 @@ const specLoader = (req, res) => {
         try {
           spec = JSON.stringify(_jsYaml.default.load(telemetryConfig.spec), null, 2);
         } catch (ey) {
-          console.log(`Error parsing spec: ${ej} - ${ey}`);
+          console.error(`Error parsing spec: ${ej} - ${ey}`);
         }
       }
       if (!spec) {
@@ -101,26 +103,22 @@ const specLoader = (req, res) => {
         res.setHeader('Content-Type', 'application/json');
         res.send(spec);
       }
-    } else if (typeof telemetryConfig.spec === 'object') {
-      res.setHeader('Content-Type', 'application/json');
-      res.send(telemetryConfig.spec);
-    } else {
-      res.status(404);
     }
   }
 };
 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 status = !telemetryConfig.exporter._stopped || false;
+  res.send({
+    active: status
+  });
 };
 const resetTelemetry = (req, res) => {
   telemetryConfig.exporter.reset();
@@ -142,22 +140,39 @@ const listTelemetry = (req, res) => {
 };
 const findTelemetry = (req, res) => {
   const spansDB = telemetryConfig.exporter.getFinishedSpans();
-  const search = req.body;
-  spansDB.find(search, (err, docs) => {
-    if (err) {
-      console.error(err);
-      res.send({
-        spansCount: "error",
-        spans: []
+  const body = req.body;
+  const search = body?.search ? body.search : {};
+  if (body?.flags?.containsRegex) {
+    try {
+      body.config?.regexIds?.forEach(regexId => {
+        search[regexId] = new RegExp(search[regexId]);
+      });
+    } catch (e) {
+      console.error(e);
+      res.status(404).send({
+        spansCount: 0,
+        spans: [],
+        error: e
       });
       return;
     }
-    const spans = docs;
-    res.send({
-      spansCount: spans.length,
-      spans: spans
+    spansDB.find(search, (err, docs) => {
+      if (err) {
+        console.error(err);
+        res.status(404).send({
+          spansCount: 0,
+          spans: [],
+          error: err
+        });
+        return;
+      }
+      const spans = docs;
+      res.send({
+        spansCount: spans.length,
+        spans: spans
+      });
     });
-  });
+  }
 };
 const heapStats = (req, res) => {
   var heapStats = _v.default.getHeapStatistics();

package/dist/telemetry.cjs

@@ -12,35 +12,12 @@ var _instrumentationHttp = require("@opentelemetry/instrumentation-http");
 var _InMemoryDbExporter = require("./exporters/InMemoryDbExporter.cjs");
 // import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
 
-// initialize the SDK and register with the OpenTelemetry API
-// import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
-// import { SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base';
-
 // Create an in-memory span exporter
 const inMemoryExporter = exports.inMemoryExporter = new _InMemoryDbExporter.InMemoryExporter();
-// configure the SDK to export telemetry data to the console
-// enable all auto-instrumentations from the meta package
 const traceExporter = inMemoryExporter;
 const sdk = new _sdkNode.NodeSDK({
   resource: new _resources.Resource(),
   traceExporter,
   instrumentations: [new _instrumentationHttp.HttpInstrumentation()]
 });
-sdk.start();
-// Create a tracer provider
-// const tracerProvider = new NodeTracerProvider({
-//   resource: new Resource({
-//     [SemanticResourceAttributes.SERVICE_NAME]: 'basic-service',
-//   }),
-//   instrumentations: [new HttpInstrumentation()],
-// });
-
-// // maybe BatchSpanProcessorBase
-// tracerProvider.addSpanProcessor(new SimpleSpanProcessor(inMemoryExporter));
-
-// // Register the tracer provider
-// tracerProvider.register();
-
-//WARNING: this is configured with batchSpanProcessor, it takes 5 seconds to flush the spans
-// import {startTracesInstrumentation} from '@restsense/agent/api'
-// startTracesInstrumentation(inMemoryExporter,resource);
+sdk.start();