@athenna/logger 5.12.0 → 5.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/logger",
-  "version": "5.12.0",
+  "version": "5.14.0",
   "description": "The Athenna logging solution. Log in stdout, files and buckets.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",

package/src/formatters/JsonFormatter.js

@@ -11,6 +11,7 @@ import { Formatter } from '#src/formatters/Formatter';
 export class JsonFormatter extends Formatter {
     format(message) {
         const base = {
+            ...(this.configs.defaults || {}),
             level: this.level(),
             time: Date.now(),
             pid: this.pid(),

package/src/formatters/NoneFormatter.js

@@ -9,6 +9,9 @@
 import { Formatter } from '#src/formatters/Formatter';
 export class NoneFormatter extends Formatter {
     format(message) {
+        if (this.configs.withoutParsers) {
+            return message;
+        }
         return this.clean(this.applyColorsByChalk(this.toString(message)));
     }
 }

package/src/logger/Logger.d.ts

@@ -16,6 +16,16 @@ export declare class Logger extends Macroable {
      * Runtime configurations to be used inside the Drivers and Formatters.
      */
     private runtimeConfigs;
+    /**
+     * Default message content that should be included
+     * in every structured log emitted by this instance.
+     */
+    private messageDefaults;
+    /**
+     * Store the current logger strategy so create()
+     * can clone the logger preserving its behavior.
+     */
+    private selection;
     constructor();
     /**
      * Create a new standalone logger instance. Very
@@ -28,6 +38,11 @@ export declare class Logger extends Macroable {
      * formatters.
      */
     config(runtimeConfigs: any): Logger;
+    /**
+     * Create a new logger instance inheriting the current
+     * configuration and adding default message content.
+     */
+    create(defaults?: any): Logger;
     /**
      * Change the log channel.
      */
@@ -81,4 +96,9 @@ export declare class Logger extends Macroable {
      * Call drivers to transport the log.
      */
     private log;
+    /**
+     * Attach message defaults to formatter configs so
+     * structured formatters can enrich the output.
+     */
+    private withDefaultFormatterConfig;
 }

package/src/logger/Logger.js

@@ -8,7 +8,7 @@
  */
 import { Config } from '@athenna/config';
 import { Driver } from '#src/drivers/Driver';
-import { Color, Macroable } from '@athenna/common';
+import { Color, Json, Macroable } from '@athenna/common';
 import { DriverFactory } from '#src/factories/DriverFactory';
 import { VANILLA_CHANNELS } from '#src/constants/VanillaChannels';
 export class Logger extends Macroable {
@@ -22,6 +22,19 @@ export class Logger extends Macroable {
          * Runtime configurations to be used inside the Drivers and Formatters.
          */
         this.runtimeConfigs = {};
+        /**
+         * Default message content that should be included
+         * in every structured log emitted by this instance.
+         */
+        this.messageDefaults = {};
+        /**
+         * Store the current logger strategy so create()
+         * can clone the logger preserving its behavior.
+         */
+        this.selection = {
+            type: 'vanilla',
+            values: []
+        };
         this.channelOrVanilla(Config.get('logging.default'));
     }
     /**
@@ -42,13 +55,31 @@ export class Logger extends Macroable {
         this.runtimeConfigs = runtimeConfigs;
         return this;
     }
+    /**
+     * Create a new logger instance inheriting the current
+     * configuration and adding default message content.
+     */
+    create(defaults = {}) {
+        const logger = new Logger();
+        logger.runtimeConfigs = Json.copy(this.runtimeConfigs);
+        logger.messageDefaults = {
+            ...Json.copy(this.messageDefaults),
+            ...Json.copy(defaults || {})
+        };
+        return logger[this.selection.type](...Json.copy(this.selection.values));
+    }
     /**
      * Change the log channel.
      */
     channel(...channels) {
         this.drivers = [];
+        this.selection = {
+            type: 'channel',
+            values: [...channels]
+        };
+        const runtimeConfigs = this.withDefaultFormatterConfig(this.runtimeConfigs);
         channels.forEach(channel => {
-            this.drivers.push(DriverFactory.fabricate(channel, this.runtimeConfigs));
+            this.drivers.push(DriverFactory.fabricate(channel, runtimeConfigs));
         });
         return this;
     }
@@ -59,12 +90,16 @@ export class Logger extends Macroable {
      */
     vanilla(...configs) {
         this.drivers = [];
+        this.selection = {
+            type: 'vanilla',
+            values: Json.copy(configs)
+        };
         if (!configs.length) {
-            this.drivers.push(DriverFactory.fabricateVanilla());
+            this.drivers.push(DriverFactory.fabricateVanilla(this.withDefaultFormatterConfig()));
             return this;
         }
         configs.forEach(config => {
-            this.drivers.push(DriverFactory.fabricateVanilla(config));
+            this.drivers.push(DriverFactory.fabricateVanilla(this.withDefaultFormatterConfig(config)));
         });
         return this;
     }
@@ -139,4 +174,23 @@ export class Logger extends Macroable {
         const promises = this.drivers.map((driver) => driver.transport(level, message));
         return Promise.all(promises);
     }
+    /**
+     * Attach message defaults to formatter configs so
+     * structured formatters can enrich the output.
+     */
+    withDefaultFormatterConfig(configs = {}) {
+        if (!Object.keys(this.messageDefaults).length) {
+            return configs;
+        }
+        return {
+            ...configs,
+            formatterConfig: {
+                ...(configs.formatterConfig || {}),
+                defaults: {
+                    ...((configs.formatterConfig || {}).defaults || {}),
+                    ...this.messageDefaults
+                }
+            }
+        };
+    }
 }