@contrail/telemetry 2.0.3 → 2.0.4-alpha-formatted-logs.1

package/CHANGELOG.md

@@ -7,6 +7,12 @@ Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [2.0.4] - 2026-04-16
+
+### Added
+
+- **Duplicate module detection** — logs a `stderr` warning at cold start if two copies of `@contrail/telemetry` are loaded, so silent log loss and broken context propagation are immediately visible.
+
 ## [2.0.3] - 2026-04-15
 
 ### Changed

package/lib/logger/index.js

@@ -32,6 +32,31 @@ Object.defineProperty(exports, "ATTR_LOG_PAYLOAD", { enumerable: true, get: func
 var log_context_1 = require("./log-context");
 Object.defineProperty(exports, "loggerStorage", { enumerable: true, get: function () { return log_context_1.loggerStorage; } });
 Object.defineProperty(exports, "withLogAttributes", { enumerable: true, get: function () { return log_context_1.withLogAttributes; } });
+// --- Singleton Guard ---
+// The logger uses AsyncLocalStorage for request context propagation. If two copies
+// of this module are loaded (e.g. due to a version mismatch causing npm to install
+// a nested duplicate), each copy has its own AsyncLocalStorage instance and its own
+// OTel LoggerProvider. Context set in one copy won't be visible in the other, and
+// flushLogs() will only flush the provider it closes over — silently dropping logs.
+//
+// Symbol.for uses the global symbol registry, which is shared across all module
+// instances, so this check fires correctly even when two copies are loaded.
+//
+// Local dev note: running `npm i` inside a lib package directory causes npm v7+ to
+// auto-install peer deps locally. If that package is then symlinked into a service,
+// the nested node_modules travels with it and re-creates the duplicate. Published
+// tarballs don't ship node_modules, so this is local-only.
+const TELEMETRY_SINGLETON_KEY = Symbol.for('@contrail/telemetry/logger-initialized');
+const globalRecord = globalThis;
+if (globalRecord[TELEMETRY_SINGLETON_KEY]) {
+    process.stderr.write('[WARN] @contrail/telemetry loaded twice — duplicate module instance detected. ' +
+        'flushLogs() will only flush one provider and log context may not propagate correctly. ' +
+        'Ensure @contrail/telemetry is listed as a peerDependency in any library that re-exports ' +
+        'it, and that the host service lists it in its own package.json.\n');
+}
+else {
+    globalRecord[TELEMETRY_SINGLETON_KEY] = true;
+}
 // --- Environment & Resource Setup ---
 const semantic_conventions_4 = require("../semantic-conventions");
 const LAMBDA_ENV_OTEL_ATTRIBUTES = getLambdaEnvAttributes();
@@ -57,6 +82,18 @@ const otelLoggerProvider = new sdk_logs_1.LoggerProvider({
 });
 const otelLogger = otelLoggerProvider.getLogger(serviceName);
 // --- Pino Stream Destinations ---
+// Capture the original console.log before app-framework's hijackConsole() replaces it.
+// Lambda treats each console.log() call as a single CloudWatch log event (even with
+// embedded newlines), unlike process.stdout.write() which splits on \n. Using the
+// original lets us pretty-print objects without them scattering across log events.
+//
+// Guard: if telemetry is imported after hijackConsole(), the captured function would be
+// the hijacked one (named "overridenLog"), creating an infinite loop. Fall back to
+// process.stdout.write in that case — loses single-event grouping but stays safe.
+const _capturedConsoleLog = console.log;
+const originalConsoleLog = _capturedConsoleLog.name === 'overridenLog'
+    ? (...args) => process.stdout.write(args.map(String).join(' ') + '\n')
+    : _capturedConsoleLog;
 function isPinoPrettyInstalled() {
     try {
         require.resolve('pino-pretty');
@@ -92,14 +129,14 @@ function createStdoutStream() {
                     const requestId = (_d = getLambdaRequestId()) !== null && _d !== void 0 ? _d : '-';
                     const payload = logRecord[semantic_conventions_2.ATTR_LOG_PAYLOAD];
                     const payloadLine = payload && typeof payload === 'object' && Object.keys(payload).length > 0
-                        ? `${JSON.stringify(payload, null, 2)}\n`
+                        ? `\n${JSON.stringify(payload, null, 2)}`
                         : '';
-                    line = `${time}\t${requestId}\t${level}\t${message}\n${payloadLine}`;
+                    line = `${time}\t${requestId}\t${level}\t${message}${payloadLine}`;
                 }
                 catch {
                     line = chunk.toString();
                 }
-                process.stdout.write(line);
+                originalConsoleLog(line);
                 callback();
             },
         }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/telemetry",
-  "version": "2.0.3",
+  "version": "2.0.4-alpha-formatted-logs.1",
   "description": "Telemetry and monitoring utilities for contrail services",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",