@athenna/logger 3.0.2 → 3.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/logger",
-  "version": "3.0.2",
+  "version": "3.0.4",
   "description": "The Athenna logging solution. Log in stdout, files and buckets.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -52,13 +52,14 @@
   },
   "devDependencies": {
     "@athenna/common": "3.0.0",
-    "@athenna/config": "3.0.1",
+    "@athenna/config": "3.0.2",
     "@athenna/ioc": "3.0.0",
     "@japa/assert": "1.3.4",
     "@japa/run-failed-tests": "1.0.7",
     "@japa/runner": "2.0.7",
     "@japa/spec-reporter": "1.1.12",
     "c8": "7.11.2",
+    "cls-rtracer": "2.6.2",
     "commitizen": "4.2.5",
     "cross-env": "7.0.3",
     "cz-conventional-changelog": "3.3.0",

package/src/Formatters/Formatter.js

@@ -8,11 +8,12 @@
  */
 
 import { hostname } from 'node:os'
-
 import { Is } from '@athenna/common'
-
+import { createRequire } from 'node:module'
 import { ColorHelper } from '#src/Helpers/ColorHelper'
 
+const require = createRequire(import.meta.url)
+
 export class Formatter {
   /**
    * Holds the configuration object of formatter.
@@ -57,6 +58,30 @@ export class Formatter {
     return hostname()
   }
 
+  /**
+   * Get the level without any color or format.
+   *
+   * @return {string}
+   */
+  level() {
+    return this.configs.level
+  }
+
+  /**
+   * Get the trace id for formatter.
+   *
+   * @return {string | null}
+   */
+  traceId() {
+    try {
+      const rTracer = require('cls-rtracer')
+
+      return rTracer.id()
+    } catch (err) {
+      return null
+    }
+  }
+
   /**
    * Create the timestamp for formatter.
    *
@@ -95,13 +120,16 @@ export class Formatter {
 
   /**
    * Clean the message removing colors if clean
-   * option is true.
+   * option is true. If force is true, then colors
+   * will be removed even if configs clean option
+   * is false.
    *
    * @param message {string}
+   * @param [force] {boolean}
    * @return {string}
    */
-  clean(message) {
-    if (this.configs.clean) {
+  clean(message, force = false) {
+    if (this.configs.clean || force) {
       return ColorHelper.removeColors(message)
     }
 

package/src/Formatters/JsonFormatter.js

@@ -19,10 +19,11 @@ export class JsonFormatter extends Formatter {
    */
   format(message) {
     const base = {
-      level: this.configs.level,
+      level: this.level(),
       time: Date.now(),
       pid: this.pid(),
       hostname: this.hostname(),
+      traceId: this.traceId(),
     }
 
     if (Is.String(message)) {

package/src/Formatters/RequestFormatter.js

@@ -41,6 +41,7 @@ export class RequestFormatter extends Formatter {
       url: ctx.request.hostUrl,
       path: ctx.request.baseUrl,
       createdAt: Date.now(),
+      traceId: this.traceId(),
       data: ctx.data,
     }
 

package/src/Formatters/SimpleFormatter.js

@@ -17,12 +17,11 @@ export class SimpleFormatter extends Formatter {
    * @return {string}
    */
   format(message) {
+    const pid = this.pid()
+    const time = this.timestamp()
     const level = this.simpleLevel()
+    const colorizedMsg = this.applyColors(message)
 
-    return this.clean(
-      `${level} - ${this.timestamp()} - (${this.pid()}) ${this.applyColors(
-        message,
-      )}`,
-    )
+    return this.clean(`${level} - ${time} - (${pid}) ${colorizedMsg}`)
   }
 }

package/src/index.d.ts

@@ -126,6 +126,20 @@ export class Formatter {
    */
   hostname(): string
 
+  /**
+   * Get the level without any color or format.
+   *
+   * @return {string}
+   */
+  level(): string
+
+  /**
+   * Get the trace id for formatter.
+   *
+   * @return {string | null}
+   */
+  traceId(): string | null
+
   /**
    * Create the timestamp for formatter.
    *
@@ -143,12 +157,15 @@ export class Formatter {
 
   /**
    * Clean the message removing colors if clean
-   * option is true.
+   * option is true. If force is true, then colors
+   * will be removed even if configs clean option
+   * is false.
    *
    * @param message {string}
+   * @param [force] {boolean}
    * @return {string}
    */
-  clean(message: string): string
+  clean(message, force?: boolean): string
 
   /**
    * Apply all colors necessary to message.

package/src/index.js

@@ -1,6 +1,6 @@
 import { Chalk } from 'chalk'
-import { Is } from '@athenna/common'
 import { format } from 'node:util'
+import { Is } from '@athenna/common'
 
 import { DriverFactory } from '#src/Factories/DriverFactory'