@athenna/logger 5.17.0 → 5.19.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/logger",
-  "version": "5.17.0",
+  "version": "5.19.0",
   "description": "The Athenna logging solution. Log in stdout, files and buckets.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -63,7 +63,6 @@
   },
   "dependencies": {
     "@aws-lambda-powertools/logger": "^1.18.1",
-    "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/api-logs": "^0.213.0",
     "cls-rtracer": "^2.6.3",
     "telegraf": "^4.16.3"
@@ -74,7 +73,8 @@
     "@athenna/ioc": "^5.2.0",
     "@athenna/test": "^5.5.0",
     "@athenna/tsconfig": "^5.0.0",
-    "@opentelemetry/context-async-hooks": "^2.6.0",
+    "@opentelemetry/api": "^1.9.1",
+    "@opentelemetry/context-async-hooks": "^2.7.0",
     "@typescript-eslint/eslint-plugin": "^8.38.0",
     "@typescript-eslint/parser": "^8.38.0",
     "commitizen": "^4.3.1",

package/src/formatters/Formatter.d.ts

@@ -6,6 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+import type { Context as OtelContext } from '@opentelemetry/api';
 export declare abstract class Formatter {
     /**
      * Holds the configuration object of formatter.
@@ -39,6 +40,10 @@ export declare abstract class Formatter {
      * Get the span id for formatter.
      */
     spanId(): string | null;
+    /**
+     * Resolve configured context bindings using the active OpenTelemetry context.
+     */
+    contextBindings(activeContext?: OtelContext): Record<string, any>;
     /**
      * Create the timestamp for formatter.
      */

package/src/formatters/Formatter.js

@@ -8,8 +8,8 @@
  */
 import rTracer from 'cls-rtracer';
 import { hostname } from 'node:os';
-import { trace } from '@opentelemetry/api';
-import { Is, Color } from '@athenna/common';
+import { Is, Color, Module } from '@athenna/common';
+const otelApi = await Module.safeImport('@opentelemetry/api');
 export class Formatter {
     constructor() {
         /**
@@ -46,14 +46,37 @@ export class Formatter {
      * Get the trace id for formatter.
      */
     traceId() {
-        return (trace.getActiveSpan()?.spanContext().traceId ||
-            (rTracer.id() || null));
+        if (otelApi?.trace?.getActiveSpan()?.spanContext().traceId) {
+            return otelApi?.trace?.getActiveSpan()?.spanContext().traceId;
+        }
+        return (rTracer.id() || null);
     }
     /**
      * Get the span id for formatter.
      */
     spanId() {
-        return trace.getActiveSpan()?.spanContext().spanId || null;
+        return otelApi?.trace?.getActiveSpan()?.spanContext().spanId || null;
+    }
+    /**
+     * Resolve configured context bindings using the active OpenTelemetry context.
+     */
+    contextBindings(activeContext) {
+        if (!otelApi) {
+            throw new Error('The package @opentelemetry/api is not installed');
+        }
+        if (!activeContext) {
+            activeContext = otelApi.context.active();
+        }
+        const contextBindings = this.configs.contextBindings || [];
+        const resolved = {};
+        for (const binding of contextBindings) {
+            const value = binding.resolve(activeContext);
+            if (Is.Undefined(value)) {
+                continue;
+            }
+            resolved[binding.field] = value;
+        }
+        return resolved;
     }
     /**
      * Create the timestamp for formatter.

package/src/formatters/JsonFormatter.js

@@ -13,11 +13,13 @@ export class JsonFormatter extends Formatter {
         const base = {
             ...(this.configs.defaults || {}),
             level: this.level(),
-            time: Date.now(),
+            date: new Date().toISOString(),
+            timestamp: Date.now(),
             pid: this.pid(),
             hostname: this.hostname(),
             traceId: this.traceId(),
-            spanId: this.spanId()
+            spanId: this.spanId(),
+            ...this.contextBindings(),
         };
         if (Is.String(message)) {
             base.msg = message;

package/src/formatters/RequestFormatter.js

@@ -21,6 +21,17 @@ export class RequestFormatter extends Formatter {
         if (!this.configs.asJson) {
             return this.clean(`${method}${status} ${ctx.request.baseUrl} - ${date} - ${responseTimeMs}`);
         }
+        const base = {
+            ...(this.configs.defaults || {}),
+            level: this.level(),
+            date,
+            timestamp: Date.now(),
+            pid: this.pid(),
+            hostname: this.hostname(),
+            traceId: this.traceId(),
+            spanId: this.spanId(),
+            ...this.contextBindings()
+        };
         const metadata = {
             method: ctx.request.method,
             duration: responseTimeMs,
@@ -28,9 +39,6 @@ export class RequestFormatter extends Formatter {
             statusCode,
             url: ctx.request.hostUrl,
             path: ctx.request.baseUrl,
-            createdAt: Date.now(),
-            traceId: this.traceId(),
-            spanId: this.spanId(),
             data: ctx.data
         };
         const request = {
@@ -45,6 +53,6 @@ export class RequestFormatter extends Formatter {
             body: ctx.response.body,
             headers: ctx.response.headers
         };
-        return JSON.stringify({ request, response, metadata }, this.getCircularReplacer());
+        return JSON.stringify({ ...base, request, response, metadata }, this.getCircularReplacer());
     }
 }

package/src/types/ContextBinding.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @athenna/logger
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import type { Context } from '@opentelemetry/api';
+export type ContextBinding = {
+    field: string;
+    resolve: (activeContext: Context) => any;
+};

package/src/types/ContextBinding.js

@@ -0,0 +1,9 @@
+/**
+ * @athenna/logger
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export {};

package/src/types/index.d.ts

@@ -7,3 +7,4 @@
  * file that was distributed with this source code.
  */
 export * from '#src/types/Level';
+export * from '#src/types/ContextBinding';

package/src/types/index.js

@@ -7,3 +7,4 @@
  * file that was distributed with this source code.
  */
 export * from '#src/types/Level';
+export * from '#src/types/ContextBinding';