ai-perf-sdk 1.0.0 → 1.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai-perf-sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Plug-and-play performance monitoring SDK using OpenTelemetry",
   "license": "MIT",
   "author": "Akash",

package/src/sdk.js

@@ -1,38 +1,116 @@
 const { NodeSDK } = require("@opentelemetry/sdk-node");
 const { getNodeAutoInstrumentations } = require("@opentelemetry/auto-instrumentations-node");
 const { OTLPTraceExporter } = require("@opentelemetry/exporter-trace-otlp-http");
+const { diag, DiagConsoleLogger, DiagLogLevel } = require("@opentelemetry/api");
 const defaults = require("./config");
 
 let sdkInstance = null;
 
+/**
+ * Initializes the AI Performance SDK.
+ * @param {Object} options Configuration options
+ * @param {string} [options.collectorEndpoint] - URL of the telemetry collector
+ * @param {Object} [options.headers] - Headers to send with telemetry (e.g., x-session-id)
+ * @param {string} [options.serviceName] - Name of the service
+ * @param {boolean} [options.debug] - Enable debug logging
+ * @param {boolean} [options.disableDbInstrumentation] - Disable DB auto-instrumentation (MongoDB/Mongoose/Redis) to prevent crashes
+ */
 function startSDK(options = {}) {
-    if (sdkInstance) return;
+    if (sdkInstance) {
+        if (options.debug) console.log("[AI-PERF] SDK already started.");
+        return;
+    }
 
+    // 1. Merge Configuration
     const config = {
         ...defaults,
         ...options
     };
 
+    // 2. Enable Debug Logging if requested
+    if (config.debug) {
+        console.log("[AI-PERF] Debug Mode Enabled");
+        diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.DEBUG);
+    }
+
+    // 3. Force JSON Protocol (Critical for backend compatibility)
+    if (!process.env.OTEL_EXPORTER_OTLP_PROTOCOL) {
+        process.env.OTEL_EXPORTER_OTLP_PROTOCOL = 'http/json';
+    }
+
+    // 4. Robust Header Handling
+    // Merge headers from:
+    // a. Environment Variable OTEL_EXPORTER_OTLP_HEADERS (Standard)
+    // b. options.headers (User provided)
+    // c. defaults.headers (If any)
+
+    let combinedHeaders = { ...config.headers };
+
+    // Parse OTEL_EXPORTER_OTLP_HEADERS env var manually to ensure they aren't lost
+    if (process.env.OTEL_EXPORTER_OTLP_HEADERS) {
+        try {
+            const envHeaders = process.env.OTEL_EXPORTER_OTLP_HEADERS.split(',').reduce((acc, pair) => {
+                const [k, v] = pair.split('=');
+                if (k && v) acc[k.trim()] = v.trim();
+                return acc;
+            }, {});
+            combinedHeaders = { ...combinedHeaders, ...envHeaders };
+        } catch (e) {
+            console.warn("[AI-PERF] Failed to parse OTEL_EXPORTER_OTLP_HEADERS", e);
+        }
+    }
+
+    if (config.debug) {
+        console.log("[AI-PERF] Exporter Config:", {
+            url: config.collectorEndpoint,
+            headers: combinedHeaders,
+            protocol: process.env.OTEL_EXPORTER_OTLP_PROTOCOL
+        });
+    }
+
     const exporter = new OTLPTraceExporter({
-        url: config.collectorEndpoint
+        url: config.collectorEndpoint,
+        headers: combinedHeaders
     });
 
+    // 5. Configure Auto-Instrumentation
+    // Allow disabling DB instrumentation to prevent crashes (e.g. Mongoose 8.x conflicts)
+    const instrumentationConfig = {};
+
+    if (config.disableDbInstrumentation) {
+        if (config.debug) console.log("[AI-PERF] Disabling DB Instrumentations");
+        instrumentationConfig['@opentelemetry/instrumentation-mongodb'] = { enabled: false };
+        instrumentationConfig['@opentelemetry/instrumentation-mongoose'] = { enabled: false };
+        instrumentationConfig['@opentelemetry/instrumentation-redis'] = { enabled: false };
+        instrumentationConfig['@opentelemetry/instrumentation-ioredis'] = { enabled: false };
+        instrumentationConfig['@opentelemetry/instrumentation-pg'] = { enabled: false };
+        instrumentationConfig['@opentelemetry/instrumentation-mysql'] = { enabled: false };
+        instrumentationConfig['@opentelemetry/instrumentation-mysql2'] = { enabled: false };
+    }
+
     sdkInstance = new NodeSDK({
         serviceName: config.serviceName,
         traceExporter: exporter,
-        instrumentations: [getNodeAutoInstrumentations()]
+        instrumentations: [getNodeAutoInstrumentations(instrumentationConfig)]
     });
 
-    sdkInstance.start();
-    console.log(`[AI-PERF] SDK started for ${config.serviceName}`);
+    try {
+        sdkInstance.start();
+        console.log(`[AI-PERF] SDK started for ${config.serviceName} ` + (config.disableDbInstrumentation ? "(Safe Mode)" : ""));
+    } catch (e) {
+        console.error("[AI-PERF] Failed to start SDK:", e);
+    }
 }
 
 function shutdownSDK() {
     if (!sdkInstance) return;
 
-    sdkInstance.shutdown();
-    sdkInstance = null;
-    console.log("[AI-PERF] SDK shutdown");
+    sdkInstance.shutdown().then(() => {
+        console.log("[AI-PERF] SDK shutdown");
+        sdkInstance = null;
+    }).catch((error) => {
+        console.error("[AI-PERF] Error shutting down SDK", error);
+    });
 }
 
 module.exports = {