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

package/dist/cjs/telemetry/custom-implementations/processors/dynamicMultiSpanProcessor.cjs

@@ -1,70 +1,71 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.DynamicMultiSpanProcessor = void 0;
-var _logger = _interopRequireDefault(require("../../../utils/logger.cjs"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const logger_js_1 = __importDefault(require("../../../utils/logger.cjs"));
 class DynamicMultiSpanProcessor {
-  constructor(initialProcessors = []) {
-    this._spanProcessors = [];
-    this._spanProcessors = [...initialProcessors];
-  }
-  /**
-   * Add a new SpanProcessor or an array of SpanProcessors at runtime.
-   */
-  addProcessors(processor) {
-    if (Array.isArray(processor)) {
-      this._spanProcessors.push(...processor);
-    } else {
-      this._spanProcessors.push(processor);
+    _spanProcessors = [];
+    constructor(initialProcessors = []) {
+        this._spanProcessors = [...initialProcessors];
     }
-  }
-  /**
-   * Remove a specific SpanProcessor if needed.
-   */
-  removeProcessor(processor) {
-    this._spanProcessors = this._spanProcessors.filter(p => p !== processor);
-  }
-  /**
-   * Clear all processors.
-   */
-  clearProcessors() {
-    this._spanProcessors = [];
-  }
-  /**
-   * Called when a span is started.
-   */
-  onStart(span, context) {
-    for (const processor of this._spanProcessors) {
-      processor.onStart(span, context);
+    /**
+     * Add a new SpanProcessor or an array of SpanProcessors at runtime.
+     */
+    addProcessors(processor) {
+        if (Array.isArray(processor)) {
+            this._spanProcessors.push(...processor);
+        }
+        else {
+            this._spanProcessors.push(processor);
+        }
     }
-  }
-  /**
-   * Called when a span ends.
-   */
-  onEnd(span) {
-    for (const processor of this._spanProcessors) {
-      processor.onEnd(span);
+    /**
+     * Remove a specific SpanProcessor if needed.
+     */
+    removeProcessor(processor) {
+        this._spanProcessors = this._spanProcessors.filter(p => p !== processor);
     }
-  }
-  /**
-   * Force flush all processors.
-   */
-  async forceFlush() {
-    const promises = this._spanProcessors.map(p => p.forceFlush());
-    try {
-      await Promise.all(promises);
-    } catch (error) {
-      _logger.default.error('Error during forceFlush:', error);
+    /**
+     * Clear all processors.
+     */
+    clearProcessors() {
+        this._spanProcessors = [];
+    }
+    /**
+     * Called when a span is started.
+     */
+    onStart(span, context) {
+        for (const processor of this._spanProcessors) {
+            processor.onStart(span, context);
+        }
+    }
+    /**
+     * Called when a span ends.
+     */
+    onEnd(span) {
+        for (const processor of this._spanProcessors) {
+            processor.onEnd(span);
+        }
+    }
+    /**
+     * Force flush all processors.
+     */
+    async forceFlush() {
+        const promises = this._spanProcessors.map(p => p.forceFlush());
+        try {
+            await Promise.all(promises);
+        }
+        catch (error) {
+            logger_js_1.default.error('Error during forceFlush:', error);
+        }
+    }
+    /**
+     * Shutdown all processors.
+     */
+    async shutdown() {
+        await Promise.all(this._spanProcessors.map(p => p.shutdown()));
     }
-  }
-  /**
-   * Shutdown all processors.
-   */
-  async shutdown() {
-    await Promise.all(this._spanProcessors.map(p => p.shutdown()));
-  }
 }
-exports.DynamicMultiSpanProcessor = DynamicMultiSpanProcessor;
+exports.DynamicMultiSpanProcessor = DynamicMultiSpanProcessor;

package/dist/cjs/telemetry/custom-implementations/utils/circular.cjs

@@ -1,31 +1,28 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.applyNesting = applyNesting;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.removeCircularRefs = removeCircularRefs;
+exports.applyNesting = applyNesting;
 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";
+    // 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;
     }
-    // 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);
+    // 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.
@@ -53,28 +50,31 @@ function removeCircularRefs(obj) {
  *  }
  */
 function applyNesting(obj) {
-  if (Array.isArray(obj)) {
-    return obj.map(item => applyNesting(item));
-  } else if (typeof obj === 'object' && obj !== null) {
-    const result = {};
-    for (const key in obj) {
-      const value = applyNesting(obj[key]);
-      const keys = key.split('.');
-      let temp = result;
-      for (let i = 0; i < keys.length; i++) {
-        const currentKey = keys[i];
-        if (i === keys.length - 1) {
-          temp[currentKey] = value;
-        } else {
-          if (!temp[currentKey]) {
-            temp[currentKey] = {};
-          }
-          temp = temp[currentKey];
+    if (Array.isArray(obj)) {
+        return obj.map(item => applyNesting(item));
+    }
+    else if (typeof obj === 'object' && obj !== null) {
+        const result = {};
+        for (const key in obj) {
+            const value = applyNesting(obj[key]);
+            const keys = key.split('.');
+            let temp = result;
+            for (let i = 0; i < keys.length; i++) {
+                const currentKey = keys[i];
+                if (i === keys.length - 1) {
+                    temp[currentKey] = value;
+                }
+                else {
+                    if (!temp[currentKey]) {
+                        temp[currentKey] = {};
+                    }
+                    temp = temp[currentKey];
+                }
+            }
         }
-      }
+        return result;
+    }
+    else {
+        return obj;
     }
-    return result;
-  } else {
-    return obj;
-  }
-}
+}

package/dist/cjs/telemetry/custom-implementations/utils/storagePath.cjs

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getStoragePath = getStoragePath;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const bootConfig_js_1 = require("../../../config/bootConfig.cjs");
+/**
+ * Get storage path for disk-based persistence
+ * Returns null if storage is in-memory (when OASTLM_BOOT_STORAGE_PATH is empty or not set)
+ *
+ * Environment variables (BOOT - set at startup):
+ * - OASTLM_BOOT_STORAGE_PATH: empty or not set = in-memory, else = disk path
+ *   Examples:
+ *   - OASTLM_BOOT_STORAGE_PATH="" (or not set) -> in-memory
+ *   - OASTLM_BOOT_STORAGE_PATH="data/telemetry" -> disk at ./data/telemetry
+ *   - OASTLM_BOOT_STORAGE_PATH="/var/lib/telemetry" -> disk at /var/lib/telemetry
+ */
+function getStoragePath(name) {
+    // If storage path is empty, use in-memory
+    if (!bootConfig_js_1.bootEnvVariables.OASTLM_BOOT_STORAGE_PATH) {
+        console.warn(`BOOT STORAGE: No storage path configured for ${name}. Using in-memory storage. To enable disk storage, set OASTLM_BOOT_STORAGE_PATH environment variable.`);
+        return null;
+    }
+    const filePath = path_1.default.join(bootConfig_js_1.bootEnvVariables.OASTLM_BOOT_STORAGE_PATH, `${name}.db`);
+    try {
+        const dir = path_1.default.dirname(filePath);
+        if (!fs_1.default.existsSync(dir)) {
+            fs_1.default.mkdirSync(dir, { recursive: true });
+        }
+    }
+    catch (error) {
+        console.warn(`Failed to create storage directory for ${name}`, error);
+        return null;
+    }
+    return filePath;
+}

package/dist/cjs/telemetry/custom-implementations/wrappers.cjs

@@ -1,35 +1,35 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.EnablerSpanExporter = exports.EnablerMultiSpanExporter = exports.EnablerMultiLogExporter = exports.EnablerMetricReader = exports.EnablerLogExporter = exports.Enabler = void 0;
-var _resources = require("@opentelemetry/resources");
-var _logger = _interopRequireDefault(require("../../utils/logger.cjs"));
-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.EnablerMetricReader = exports.EnablerMultiLogExporter = exports.EnablerMultiSpanExporter = exports.EnablerLogExporter = exports.EnablerSpanExporter = exports.Enabler = void 0;
+const resources_1 = require("@opentelemetry/resources");
+const logger_js_1 = __importDefault(require("../../utils/logger.cjs"));
 class Enabler {
-  constructor(enabled) {
-    this._enabled = true;
-    if (typeof enabled === 'boolean') {
-      this._enabled = enabled;
-    }
-  }
-  setEnabledValue(value) {
-    this._enabled = value;
-  }
-  enable() {
-    this._enabled = true;
-  }
-  disable() {
-    this._enabled = false;
-  }
-  isEnabled() {
-    return this._enabled;
-  }
-  toggle() {
-    this._enabled = !this._enabled;
-  }
+    _enabled = true;
+    constructor(enabled) {
+        if (typeof enabled === 'boolean') {
+            this._enabled = enabled;
+        }
+    }
+    setEnabledValue(value) {
+        this._enabled = value;
+    }
+    enable() {
+        this._enabled = true;
+    }
+    disable() {
+        this._enabled = false;
+    }
+    isEnabled() {
+        return this._enabled;
+    }
+    toggle() {
+        this._enabled = !this._enabled;
+    }
 }
+exports.Enabler = Enabler;
 /*
  * Classes for enabler exporters, allowing enable/disable toggling of exporters at runtime.
  *
@@ -46,130 +46,133 @@ class Enabler {
  * disabled, the reader's `collect` method is not called at all, saving additional resources compared to disabling the exporter.
  *
  */
-exports.Enabler = Enabler;
 class EnablerSpanExporter extends Enabler {
-  constructor(exporter) {
-    super();
-    this.exporter = exporter;
-  }
-  export(spans, resultCallback) {
-    if (this.isEnabled()) {
-      this.exporter.export(spans, resultCallback);
-    }
-  }
-  shutdown() {
-    return this.exporter.shutdown();
-  }
-  forceFlush() {
-    if (typeof this.exporter.forceFlush === 'function') {
-      return this.exporter.forceFlush();
-    }
-    return Promise.resolve();
-  }
+    exporter;
+    constructor(exporter) {
+        super();
+        this.exporter = exporter;
+    }
+    export(spans, resultCallback) {
+        if (this.isEnabled()) {
+            this.exporter.export(spans, resultCallback);
+        }
+    }
+    shutdown() {
+        return this.exporter.shutdown();
+    }
+    forceFlush() {
+        if (typeof this.exporter.forceFlush === 'function') {
+            return this.exporter.forceFlush();
+        }
+        return Promise.resolve();
+    }
 }
 exports.EnablerSpanExporter = EnablerSpanExporter;
 class EnablerLogExporter extends Enabler {
-  constructor(exporter) {
-    super();
-    this.exporter = exporter;
-  }
-  export(logs, resultCallback) {
-    if (this.isEnabled()) {
-      this.exporter.export(logs, resultCallback);
-    }
-  }
-  shutdown() {
-    return this.exporter.shutdown();
-  }
+    exporter;
+    constructor(exporter) {
+        super();
+        this.exporter = exporter;
+    }
+    export(logs, resultCallback) {
+        if (this.isEnabled()) {
+            this.exporter.export(logs, resultCallback);
+        }
+    }
+    shutdown() {
+        return this.exporter.shutdown();
+    }
 }
 exports.EnablerLogExporter = EnablerLogExporter;
 class EnablerMultiExporter extends Enabler {
-  constructor(exporters) {
-    super();
-    this._exporters = [];
-    if (exporters && Array.isArray(exporters)) {
-      this._exporters = exporters;
-    }
-  }
-  addExporters(exporter) {
-    if (!this._exporters) {
-      this._exporters = [];
-    }
-    if (Array.isArray(exporter)) {
-      this._exporters.push(...exporter);
-    } else {
-      this._exporters.push(exporter);
-    }
-  }
+    _exporters = [];
+    constructor(exporters) {
+        super();
+        if (exporters && Array.isArray(exporters)) {
+            this._exporters = exporters;
+        }
+    }
+    addExporters(exporter) {
+        if (!this._exporters) {
+            this._exporters = [];
+        }
+        if (Array.isArray(exporter)) {
+            this._exporters.push(...exporter);
+        }
+        else {
+            this._exporters.push(exporter);
+        }
+    }
 }
 class EnablerMultiSpanExporter extends EnablerMultiExporter {
-  export(spans, resultCallback) {
-    _logger.default.debug(`EnablerMultiSpanExporter.export called with ${spans.length} spans, exporters: ${this._exporters?.length ?? 0}, enabled: ${this.isEnabled()}`);
-    if (this.isEnabled() && this._exporters) {
-      this._exporters.forEach(exporter => exporter.export(spans, resultCallback));
-    }
-  }
-  async shutdown() {
-    if (this._exporters) {
-      await Promise.all(this._exporters.map(exporter => exporter.shutdown()));
-    }
-    return;
-  }
+    export(spans, resultCallback) {
+        logger_js_1.default.debug(`EnablerMultiSpanExporter.export called with ${spans.length} spans, exporters: ${this._exporters?.length ?? 0}, enabled: ${this.isEnabled()}`);
+        if (this.isEnabled() && this._exporters) {
+            this._exporters.forEach((exporter) => exporter.export(spans, resultCallback));
+        }
+    }
+    async shutdown() {
+        if (this._exporters) {
+            await Promise.all(this._exporters.map((exporter) => exporter.shutdown()));
+        }
+        return;
+    }
 }
 exports.EnablerMultiSpanExporter = EnablerMultiSpanExporter;
 class EnablerMultiLogExporter extends EnablerMultiExporter {
-  export(logs, resultCallback) {
-    if (this.isEnabled() && this._exporters) {
-      this._exporters.forEach(exporter => exporter.export(logs, resultCallback));
+    export(logs, resultCallback) {
+        if (this.isEnabled() && this._exporters) {
+            this._exporters.forEach((exporter) => exporter.export(logs, resultCallback));
+        }
     }
-  }
-  async shutdown() {
-    if (this._exporters) {
-      await Promise.all(this._exporters.map(exporter => exporter.shutdown()));
+    async shutdown() {
+        if (this._exporters) {
+            await Promise.all(this._exporters.map((exporter) => exporter.shutdown()));
+        }
+        return;
     }
-    return;
-  }
 }
 exports.EnablerMultiLogExporter = EnablerMultiLogExporter;
 class EnablerMetricReader extends Enabler {
-  constructor(reader) {
-    super();
-    this.reader = reader;
-  }
-  forceFlush(options) {
-    if (this.isEnabled()) {
-      return this.reader.forceFlush(options);
-    }
-    return Promise.resolve();
-  }
-  setMetricProducer(metricProducer) {
-    if (this.isEnabled()) {
-      this.reader.setMetricProducer(metricProducer);
-    }
-  }
-  selectAggregation(instrumentType) {
-    return this.reader.selectAggregation(instrumentType);
-  }
-  selectAggregationTemporality(instrumentType) {
-    return this.reader.selectAggregationTemporality(instrumentType);
-  }
-  selectCardinalityLimit(instrumentType) {
-    return this.reader.selectCardinalityLimit(instrumentType);
-  }
-  async collect(options) {
-    if (this.isEnabled()) {
-      return await this.reader.collect(options);
-    }
-    return {
-      resourceMetrics: {
-        resource: (0, _resources.resourceFromAttributes)({}),
-        scopeMetrics: []
-      },
-      errors: []
-    };
-  }
-  shutdown(options) {
-    return this.reader.shutdown(options);
-  }
+    reader;
+    constructor(reader) {
+        super();
+        this.reader = reader;
+    }
+    forceFlush(options) {
+        if (this.isEnabled()) {
+            return this.reader.forceFlush(options);
+        }
+        return Promise.resolve();
+    }
+    setMetricProducer(metricProducer) {
+        if (this.isEnabled()) {
+            this.reader.setMetricProducer(metricProducer);
+        }
+    }
+    selectAggregation(instrumentType) {
+        return this.reader.selectAggregation(instrumentType);
+    }
+    selectAggregationTemporality(instrumentType) {
+        return this.reader.selectAggregationTemporality(instrumentType);
+    }
+    selectCardinalityLimit(instrumentType) {
+        return this.reader.selectCardinalityLimit(instrumentType);
+    }
+    async collect(options) {
+        if (this.isEnabled()) {
+            return await this.reader.collect(options);
+        }
+        return {
+            resourceMetrics: {
+                resource: (0, resources_1.resourceFromAttributes)({}),
+                scopeMetrics: [],
+            },
+            errors: [],
+        };
+    }
+    shutdown(options) {
+        return this.reader.shutdown(options);
+    }
 }
-exports.EnablerMetricReader = EnablerMetricReader;
+exports.EnablerMetricReader = EnablerMetricReader;