@vtvlive/interactive-apm 0.0.2 → 0.0.4

package/dist/utils/debug-logger.js

@@ -0,0 +1,236 @@
+"use strict";
+/**
+ * Debug Logger for APM Package
+ *
+ * Provides centralized debug logging that only outputs when APM_DEBUG=true.
+ * Used by both Elastic APM and OpenTelemetry providers.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDebugEnabled = isDebugEnabled;
+exports.sanitizeHeaders = sanitizeHeaders;
+exports.sanitizeConfig = sanitizeConfig;
+exports.debugLog = debugLog;
+exports.infoLog = infoLog;
+exports.errorLog = errorLog;
+exports.logInitialization = logInitialization;
+exports.logExportSuccess = logExportSuccess;
+exports.logExportFailure = logExportFailure;
+exports.logRequest = logRequest;
+exports.logResponse = logResponse;
+exports.logSpan = logSpan;
+/**
+ * Check if debug mode is enabled via environment variable
+ */
+function isDebugEnabled() {
+    return process.env.APM_DEBUG === "true";
+}
+/**
+ * Mask sensitive values in headers and config for logging
+ */
+function maskSensitive(value, key) {
+    const sensitiveKeys = [
+        "authorization",
+        "token",
+        "secret",
+        "password",
+        "apikey",
+        "api-key",
+        "x-api-key",
+    ];
+    const lowerKey = key.toLowerCase();
+    if (sensitiveKeys.some(k => lowerKey.includes(k))) {
+        return "[REDACTED]";
+    }
+    return value;
+}
+/**
+ * Sanitize headers for logging (mask sensitive values)
+ */
+function sanitizeHeaders(headers) {
+    const sanitized = {};
+    for (const [key, value] of Object.entries(headers)) {
+        sanitized[key] = maskSensitive(value, key);
+    }
+    return sanitized;
+}
+/**
+ * Sanitize config object for logging (mask sensitive values)
+ * Handles arrays and circular references safely
+ */
+function sanitizeConfig(config, seen = new WeakMap()) {
+    // Handle primitives and null
+    if (config === null || typeof config !== "object") {
+        return config;
+    }
+    // Handle circular references
+    if (seen.has(config)) {
+        return "[Circular]";
+    }
+    seen.set(config, "[Circular]");
+    // Handle arrays
+    if (Array.isArray(config)) {
+        return config.map(item => {
+            if (typeof item === "string") {
+                return maskSensitive(item, "");
+            }
+            else if (typeof item === "object" && item !== null) {
+                return sanitizeConfig(item, seen);
+            }
+            return item;
+        });
+    }
+    // Handle objects
+    const sanitized = {};
+    for (const [key, value] of Object.entries(config)) {
+        if (typeof value === "string") {
+            sanitized[key] = maskSensitive(value, key);
+        }
+        else if (Array.isArray(value)) {
+            sanitized[key] = value.map(item => {
+                if (typeof item === "string") {
+                    return maskSensitive(item, key);
+                }
+                else if (typeof item === "object" && item !== null) {
+                    return sanitizeConfig(item, seen);
+                }
+                return item;
+            });
+        }
+        else if (typeof value === "object" && value !== null) {
+            sanitized[key] = sanitizeConfig(value, seen);
+        }
+        else {
+            sanitized[key] = value;
+        }
+    }
+    return sanitized;
+}
+/**
+ * Debug log - only outputs when APM_DEBUG=true
+ */
+function debugLog(message, ...args) {
+    if (isDebugEnabled()) {
+        console.log(`[APM-DEBUG] ${message}`, ...args);
+    }
+}
+/**
+ * Info log - always outputs
+ */
+function infoLog(message, ...args) {
+    console.log(`[APM] ${message}`, ...args);
+}
+/**
+ * Error log - always outputs
+ */
+function errorLog(message, ...args) {
+    console.error(`[APM-ERROR] ${message}`, ...args);
+}
+/**
+ * Log initialization details
+ */
+function logInitialization(provider, config) {
+    if (!isDebugEnabled()) {
+        return;
+    }
+    debugLog(`=== ${provider} Initialization ===`);
+    debugLog("Configuration:", sanitizeConfig(config));
+    debugLog("Environment Variables:", {
+        APM_PROVIDER: process.env.APM_PROVIDER,
+        ELASTIC_APM_SERVICE_NAME: process.env.ELASTIC_APM_SERVICE_NAME,
+        ELASTIC_APM_ENVIRONMENT: process.env.ELASTIC_APM_ENVIRONMENT,
+        ELASTIC_OTLP_ENDPOINT: process.env.ELASTIC_OTLP_ENDPOINT,
+        ELASTIC_APM_SERVER_URL: process.env.ELASTIC_APM_SERVER_URL,
+        APM_DEBUG: process.env.APM_DEBUG,
+    });
+    debugLog("System Info:", {
+        nodeVersion: process.version,
+        platform: process.platform,
+        arch: process.arch,
+        pid: process.pid,
+        hostname: require("os").hostname(),
+    });
+}
+/**
+ * Log span export success (debug mode only)
+ */
+function logExportSuccess(provider, spanCount) {
+    if (isDebugEnabled()) {
+        debugLog(`[${provider}] Exported ${spanCount} span(s)`);
+    }
+}
+/**
+ * Log span export failure - ALWAYS logs regardless of debug mode
+ */
+function logExportFailure(provider, error, requestDetails) {
+    // Always log export failures as errors
+    const errorMessage = error instanceof Error ? error.message : String(error);
+    errorLog(`[${provider}] Export failed:`, errorMessage);
+    // Log additional details only in debug mode
+    if (isDebugEnabled() && requestDetails) {
+        debugLog("Request details:", sanitizeConfig(requestDetails));
+    }
+}
+/**
+ * Log outgoing HTTP request (for debugging APM communication)
+ */
+function logRequest(provider, url, headers, body) {
+    if (!isDebugEnabled()) {
+        return;
+    }
+    debugLog(`[${provider}] → Sending request to: ${url}`);
+    debugLog("Headers:", sanitizeHeaders(headers));
+    // Sanitize request body for sensitive data before logging
+    if (body) {
+        // WARNING: Request bodies may contain sensitive data - we sanitize common patterns
+        let sanitizedBody;
+        if (typeof body === "string") {
+            // Redact common auth/token patterns in strings
+            sanitizedBody = body.replace(/"(password|pass|pwd|token|access_token|auth|authorization|cookie|ssn|creditCard|cardNumber|cvv|secret)"\s*:\s*"[^"]*"/gi, '"$1": "[REDACTED]"');
+            sanitizedBody = sanitizedBody.replace(/Bearer\s+[A-Za-z0-9\-._~+/=]*/gi, "Bearer [REDACTED]");
+        }
+        else if (typeof body === "object" && body !== null) {
+            // Deep clone and sanitize object
+            sanitizedBody = sanitizeConfig(body);
+        }
+        else {
+            sanitizedBody = String(body);
+        }
+        debugLog("Body:", typeof sanitizedBody === "string" ? sanitizedBody : JSON.stringify(sanitizedBody, null, 2));
+    }
+}
+/**
+ * Log incoming HTTP response (for debugging APM communication)
+ */
+function logResponse(provider, statusCode, headers, body) {
+    if (!isDebugEnabled()) {
+        return;
+    }
+    debugLog(`[${provider}] ← Received response: ${statusCode}`);
+    debugLog("Response Headers:", sanitizeHeaders(headers));
+    if (body) {
+        debugLog("Response Body:", typeof body === "string" ? body : JSON.stringify(body, null, 2));
+    }
+}
+/**
+ * Log span details (when debug mode is on)
+ */
+function logSpan(provider, span) {
+    if (!isDebugEnabled()) {
+        return;
+    }
+    try {
+        const spanDetails = {
+            name: span.name,
+            kind: span.kind,
+            startTime: span.startTime,
+            endTime: span.endTime,
+            duration: span.endTime - span.startTime,
+            attributes: span.attributes,
+            status: span.status,
+        };
+        debugLog(`[${provider}] Span details:`, JSON.stringify(spanDetails, null, 2));
+    }
+    catch (error) {
+        debugLog(`[${provider}] Could not serialize span:`, error);
+    }
+}

package/dist/utils/tracing.helper.d.ts

@@ -1,4 +1,4 @@
-import { Span, SpanKind } from '@opentelemetry/api';
+import { Span, SpanKind } from "@opentelemetry/api";
 /**
  * TracingHelper - Static utility class for direct OpenTelemetry usage
  *
@@ -37,7 +37,7 @@ export declare class TracingHelper {
      * @param attributes Các attributes metadata
      * @returns Kết quả của function
      */
-    static startSpanWithParent<T>(name: string, fn: (span: Span) => Promise<T>, attributes?: Record<string, string | number>): Promise<T>;
+    static startSpanWithParent<T>(name: string, fn: (span: Span | undefined) => Promise<T>, attributes?: Record<string, string | number>): Promise<T>;
     /**
      * Capture error vào active span hiện tại
      * @param error Error object

package/dist/utils/tracing.helper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tracing.helper.d.ts","sourceRoot":"","sources":["../../src/utils/tracing.helper.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,IAAI,EAAkB,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEpF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAC,MAAM,CAAsC;IAE3D;;;;;;OAMG;IACH,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EAAE,QAAQ,GAAE,QAA4B,GAAG,IAAI;IAa1H;;;;;;OAMG;IACH,MAAM,CAAC,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAiBrI;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAQvC;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAO9D;;;OAGG;IACH,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI;IAOjC;;;OAGG;IACH,MAAM,CAAC,aAAa,IAAI,IAAI,GAAG,SAAS;IAIxC;;;OAGG;IACH,MAAM,CAAC,UAAU,IAAI,MAAM,GAAG,SAAS;CAIxC"}
+{"version":3,"file":"tracing.helper.d.ts","sourceRoot":"","sources":["../../src/utils/tracing.helper.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,IAAI,EAAkB,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEpF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAC,MAAM,CAAsC;IAE3D;;;;;;OAMG;IACH,MAAM,CAAC,SAAS,CACd,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EAC5C,QAAQ,GAAE,QAA4B,GACrC,IAAI;IAaP;;;;;;OAMG;IACH,MAAM,CAAC,mBAAmB,CAAC,CAAC,EAC1B,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,GAAG,SAAS,KAAK,OAAO,CAAC,CAAC,CAAC,EAC1C,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GAC3C,OAAO,CAAC,CAAC,CAAC;IA2Bb;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAQvC;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAO9D;;;OAGG;IACH,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI;IAOjC;;;OAGG;IACH,MAAM,CAAC,aAAa,IAAI,IAAI,GAAG,SAAS;IAIxC;;;OAGG;IACH,MAAM,CAAC,UAAU,IAAI,MAAM,GAAG,SAAS;CAIxC"}

package/dist/utils/tracing.helper.js

@@ -49,17 +49,21 @@ class TracingHelper {
     static startSpanWithParent(name, fn, attributes) {
         return api_1.context.with(api_1.trace.setSpan(api_1.context.active(), TracingHelper.startSpan(name, attributes)), async () => {
             const span = api_1.trace.getActiveSpan();
+            // If no active span, throw an error - this should not happen if the span was just started
+            if (!span) {
+                throw new Error(`Failed to get active span for "${name}". The OpenTelemetry context may not be properly initialized.`);
+            }
             try {
                 const result = await fn(span);
                 return result;
             }
             catch (error) {
-                span?.recordException(error);
-                span?.setStatus({ code: api_1.SpanStatusCode.ERROR, message: error.message });
+                span.recordException(error);
+                span.setStatus({ code: api_1.SpanStatusCode.ERROR, message: error.message });
                 throw error;
             }
             finally {
-                span?.end();
+                span.end();
             }
         });
     }
@@ -112,4 +116,4 @@ class TracingHelper {
     }
 }
 exports.TracingHelper = TracingHelper;
-TracingHelper.tracer = api_1.trace.getTracer('interactive-apm');
+TracingHelper.tracer = api_1.trace.getTracer("interactive-apm");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vtvlive/interactive-apm",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "APM integration package supporting both Elastic APM and OpenTelemetry with NestJS integration",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -28,13 +28,20 @@
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
     "test:unit": "jest __tests__/unit",
-    "test:integration": "jest __tests__/integration"
+    "test:integration": "jest __tests__/integration",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "format:check": "prettier --check \"src/**/*.ts\"",
+    "typecheck": "tsc --noEmit"
   },
   "peerDependencies": {
     "@nestjs/common": "^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0",
     "@nestjs/config": "^1.0.0 || ^2.0.0 || ^3.0.0 || ^4.0.0",
     "@opentelemetry/api": "^1.0.0",
     "@opentelemetry/exporter-trace-otlp-http": ">=0.200.0",
+    "@opentelemetry/exporter-trace-otlp-grpc": ">=0.200.0",
+    "@opentelemetry/exporter-trace-otlp-proto": ">=0.200.0",
     "@opentelemetry/instrumentation-express": ">=0.50.0",
     "@opentelemetry/instrumentation-http": ">=0.200.0",
     "@opentelemetry/resources": ">=1.0.0",
@@ -56,6 +63,12 @@
     "@opentelemetry/exporter-trace-otlp-http": {
       "optional": true
     },
+    "@opentelemetry/exporter-trace-otlp-grpc": {
+      "optional": true
+    },
+    "@opentelemetry/exporter-trace-otlp-proto": {
+      "optional": true
+    },
     "@opentelemetry/instrumentation-express": {
       "optional": true
     },
@@ -83,6 +96,8 @@
     "@nestjs/config": "^4.0.3",
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/exporter-trace-otlp-http": "^0.213.0",
+    "@opentelemetry/exporter-trace-otlp-grpc": "^0.213.0",
+    "@opentelemetry/exporter-trace-otlp-proto": "^0.213.0",
     "@opentelemetry/instrumentation-express": "^0.61.0",
     "@opentelemetry/instrumentation-http": "^0.213.0",
     "@opentelemetry/resources": "^2.6.0",
@@ -92,9 +107,15 @@
     "@types/jest": "^29.5.0",
     "@types/node": "^20.0.0",
     "elastic-apm-node": "^4.15.0",
+    "eslint": "^9.18.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
     "jest": "^29.7.0",
+    "prettier": "^3.4.2",
     "ts-jest": "^29.1.0",
-    "typescript": "^5.3.0"
+    "typescript": "^5.3.0",
+    "@typescript-eslint/eslint-plugin": "^8.19.1",
+    "@typescript-eslint/parser": "^8.19.1"
   },
   "engines": {
     "node": ">=14.0.0"