@athenna/logger 5.15.0 → 5.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/logger",
-  "version": "5.15.0",
+  "version": "5.17.0",
   "description": "The Athenna logging solution. Log in stdout, files and buckets.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -63,6 +63,8 @@
   },
   "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"
   },
@@ -72,6 +74,7 @@
     "@athenna/ioc": "^5.2.0",
     "@athenna/test": "^5.5.0",
     "@athenna/tsconfig": "^5.0.0",
+    "@opentelemetry/context-async-hooks": "^2.6.0",
     "@typescript-eslint/eslint-plugin": "^8.38.0",
     "@typescript-eslint/parser": "^8.38.0",
     "commitizen": "^4.3.1",

package/src/drivers/OtelDriver.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @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 { Driver } from '#src/drivers/Driver';
+export declare class OtelDriver extends Driver {
+    transport(level: string, message: any): void;
+    private getBody;
+    private getSeverityNumber;
+}

package/src/drivers/OtelDriver.js

@@ -0,0 +1,51 @@
+/**
+ * @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 { Driver } from '#src/drivers/Driver';
+import { context } from '@opentelemetry/api';
+import { logs, SeverityNumber } from '@opentelemetry/api-logs';
+export class OtelDriver extends Driver {
+    transport(level, message) {
+        if (!this.couldBeTransported(level)) {
+            return;
+        }
+        const logger = logs.getLogger('@athenna/logger');
+        logger.emit({
+            eventName: 'athenna.log',
+            severityNumber: this.getSeverityNumber(level),
+            severityText: level.toUpperCase(),
+            body: this.getBody(level, message),
+            attributes: {
+                'athenna.log.level': level,
+                'athenna.log.stream': this.getStreamTypeFor(level)
+            },
+            context: context.active()
+        });
+    }
+    getBody(level, message) {
+        const formatted = this.format(level, message, true);
+        try {
+            return JSON.parse(formatted);
+        }
+        catch {
+            return formatted;
+        }
+    }
+    getSeverityNumber(level) {
+        const levels = {
+            trace: SeverityNumber.TRACE,
+            debug: SeverityNumber.DEBUG,
+            info: SeverityNumber.INFO,
+            success: SeverityNumber.INFO2,
+            warn: SeverityNumber.WARN,
+            error: SeverityNumber.ERROR,
+            fatal: SeverityNumber.FATAL
+        };
+        return levels[level] || SeverityNumber.INFO;
+    }
+}

package/src/drivers/StackDriver.js

@@ -9,15 +9,22 @@
 import { debug } from '#src/debug';
 import { Json } from '@athenna/common';
 import { Driver } from '#src/drivers/Driver';
+import { FactoryHelper } from '#src/helpers/FactoryHelper';
 import { DriverFactory } from '#src/factories/DriverFactory';
 export class StackDriver extends Driver {
     transport(level, message) {
         const configs = Json.copy(this.configs);
+        const sharedConfigs = Json.copy(this.configs);
         delete configs.driver;
         delete configs.channels;
+        delete sharedConfigs.driver;
+        delete sharedConfigs.channels;
+        this.driverConfig.channels.forEach(channel => {
+            delete sharedConfigs[channel];
+        });
         debug('[%s] Transporting logs in channels: %s.', StackDriver.name, this.driverConfig.channels.join(', '));
         const promises = this.driverConfig.channels.map(channel => {
-            const channelConfig = configs?.[channel];
+            const channelConfig = FactoryHelper.groupConfigs(configs?.[channel] || {}, sharedConfigs);
             return DriverFactory.fabricate(channel, channelConfig).transport(level, message);
         });
         return Promise.all(promises);

package/src/factories/DriverFactory.js

@@ -12,6 +12,7 @@ import { Driver } from '#src/drivers/Driver';
 import { FileDriver } from '#src/drivers/FileDriver';
 import { NullDriver } from '#src/drivers/NullDriver';
 import { LokiDriver } from '#src/drivers/LokiDriver';
+import { OtelDriver } from '#src/drivers/OtelDriver';
 import { SlackDriver } from '#src/drivers/SlackDriver';
 import { StackDriver } from '#src/drivers/StackDriver';
 import { LambdaDriver } from '#src/drivers/LambdaDriver';
@@ -30,6 +31,7 @@ export class DriverFactory {
         .set('file', { Driver: FileDriver })
         .set('null', { Driver: NullDriver })
         .set('loki', { Driver: LokiDriver })
+        .set('otel', { Driver: OtelDriver })
         .set('slack', { Driver: SlackDriver })
         .set('stack', { Driver: StackDriver })
         .set('lambda', { Driver: LambdaDriver })

package/src/formatters/Formatter.d.ts

@@ -35,6 +35,10 @@ export declare abstract class Formatter {
      * Get the trace id for formatter.
      */
     traceId(): string | null;
+    /**
+     * Get the span id for formatter.
+     */
+    spanId(): string | null;
     /**
      * Create the timestamp for formatter.
      */

package/src/formatters/Formatter.js

@@ -8,6 +8,7 @@
  */
 import rTracer from 'cls-rtracer';
 import { hostname } from 'node:os';
+import { trace } from '@opentelemetry/api';
 import { Is, Color } from '@athenna/common';
 export class Formatter {
     constructor() {
@@ -45,7 +46,14 @@ export class Formatter {
      * Get the trace id for formatter.
      */
     traceId() {
-        return (rTracer.id() || null);
+        return (trace.getActiveSpan()?.spanContext().traceId ||
+            (rTracer.id() || null));
+    }
+    /**
+     * Get the span id for formatter.
+     */
+    spanId() {
+        return trace.getActiveSpan()?.spanContext().spanId || null;
     }
     /**
      * Create the timestamp for formatter.

package/src/formatters/JsonFormatter.js

@@ -16,7 +16,8 @@ export class JsonFormatter extends Formatter {
             time: Date.now(),
             pid: this.pid(),
             hostname: this.hostname(),
-            traceId: this.traceId()
+            traceId: this.traceId(),
+            spanId: this.spanId()
         };
         if (Is.String(message)) {
             base.msg = message;

package/src/formatters/RequestFormatter.js

@@ -30,6 +30,7 @@ export class RequestFormatter extends Formatter {
             path: ctx.request.baseUrl,
             createdAt: Date.now(),
             traceId: this.traceId(),
+            spanId: this.spanId(),
             data: ctx.data
         };
         const request = {

package/src/logger/Logger.js

@@ -98,7 +98,10 @@ export class Logger extends Macroable {
             return this;
         }
         configs.forEach(config => {
-            const driver = DriverFactory.fabricateVanilla({ ...config, ...this.runtimeConfigs });
+            const driver = DriverFactory.fabricateVanilla({
+                ...config,
+                ...this.runtimeConfigs
+            });
             this.drivers.push(driver);
         });
         return this;