feat(LogEcs): static methods wrapConsole, wrapDebug on LogEcs

Author: commenthol

src/ecs/LogEcs.js

@@ -1,13 +1,11 @@
 import { Log, stringify } from '../node.js'
 import { ecsSerializers } from './serializers.js'
+import { wrapConsole } from '../wrapConsole.js'
+import { wrapDebug } from '../wrapDebug.js'
 
-/**
- * @typedef {import('../serializers/index.js').Serializer} Serializer
- */
-/**
- * @typedef {import('../node.js').LogOptions & {serializers: Record<string, Serializer>}} LogOptionsEcs
- * @typedef {import('../node.js').LogOptionWrapConsole} LogOptionWrapConsole
- */
+/** @typedef {import('../serializers/index.js').Serializer} Serializer */
+/** @typedef {import('../node.js').LogOptions & {serializers: Record<string, Serializer>}} LogOptionsEcs */
+/** @typedef {import('../node.js').LogOptionWrapConsole} LogOptionWrapConsole */
 
 /**
  * Elastic Common Schema (ECS) compatible logger;
@@ -33,6 +31,24 @@ export class LogEcs extends Log {
     this.toJson = this._toJson
   }
 
+  /**
+   * @param {string} [name]
+   * @param {LogOptionsEcs & LogOptionWrapConsole} [opts]
+   * @returns {() => void} unwrap function
+   */
+  static wrapConsole(name = 'console', opts) {
+    const log = new LogEcs(name, opts)
+    return wrapConsole(log, opts)
+  }
+
+  /**
+   * @param {LogOptionsEcs} [opts]
+   * @returns {() => void} unwrap function
+   */
+  static wrapDebug(opts) {
+    return wrapDebug(LogEcs, opts)
+  }
+
   /* c8 ignore next 18 */
   _applySerializers(obj) {
     const ecsObj = {}

src/wrapDebug.js

@@ -11,7 +11,7 @@ const unwrap = () => {
   }
 }
 
-export function wrapDebug(Log) {
+export function wrapDebug(Log, opts) {
   if (wrapped) return unwrap
   class Loggers {
     constructor() {
@@ -21,7 +21,7 @@ export function wrapDebug(Log) {
     get(namespace) {
       let logger = this.cache[namespace]
       if (!logger) {
-        logger = this.cache[namespace] = new Log(namespace)
+        logger = this.cache[namespace] = new Log(namespace, opts)
       }
       return logger
     }

test/LogEcs.test.js

@@ -1,6 +1,7 @@
 import assert from 'assert'
 import os from 'os'
 import sinon from 'sinon'
+import debug from 'debug'
 import { startTimeKey } from '../src/serializers/res.js'
 import { LogEcs, ecsSerializers } from '../src/ecs/index.js'
 import { httpLogs, logger } from '../src/index.js'
@@ -413,4 +414,50 @@ describe('LogEcs', function () {
       )
     })
   })
+
+  describe('wrap console', function () {
+    let unwrap
+    before(function () {
+      unwrap = LogEcs.wrapConsole('test', {
+        level: 'trace',
+        namespaces: 'test'
+      })
+    })
+    after(function () {
+      unwrap()
+    })
+
+    it('shall wrap console.log', function () {
+      console.log('log %s', 'log')
+      console.trace('trace')
+      console.debug({ debug: true })
+      console.info('log %j', { info: 1 })
+      console.warn('warn')
+      console.error(new Error('Baam'))
+    })
+
+    it('shall not wrap console twice', function () {
+      const unwrap1 = LogEcs.wrapConsole('test1')
+      const unwrap2 = LogEcs.wrapConsole('test2')
+      assert.strictEqual(unwrap1, unwrap)
+      assert.strictEqual(unwrap2, unwrap)
+    })
+  })
+
+  describe('wrap debug', function () {
+    let unwrap
+    before(function () {
+      const options = { level: 'debug', namespaces: '*' }
+      unwrap = LogEcs.wrapDebug(options)
+    })
+    after(function () {
+      unwrap()
+    })
+
+    it('shall wrap debug', function () {
+      const log = debug('namespace')
+      log.enabled = '*'
+      log('hello %s', 'log')
+    })
+  })
 })

types/ecs/LogEcs.d.ts

@@ -1,10 +1,6 @@
-/**
- * @typedef {import('../serializers/index.js').Serializer} Serializer
- */
-/**
- * @typedef {import('../node.js').LogOptions & {serializers: Record<string, Serializer>}} LogOptionsEcs
- * @typedef {import('../node.js').LogOptionWrapConsole} LogOptionWrapConsole
- */
+/** @typedef {import('../serializers/index.js').Serializer} Serializer */
+/** @typedef {import('../node.js').LogOptions & {serializers: Record<string, Serializer>}} LogOptionsEcs */
+/** @typedef {import('../node.js').LogOptionWrapConsole} LogOptionWrapConsole */
 /**
  * Elastic Common Schema (ECS) compatible logger;
  * See [field reference](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html)
@@ -13,6 +9,17 @@
  * (response) keys in objects
  */
 export class LogEcs extends Log {
+    /**
+     * @param {string} [name]
+     * @param {LogOptionsEcs & LogOptionWrapConsole} [opts]
+     * @returns {() => void} unwrap function
+     */
+    static wrapConsole(name?: string, opts?: LogOptionsEcs & LogOptionWrapConsole): () => void;
+    /**
+     * @param {LogOptionsEcs} [opts]
+     * @returns {() => void} unwrap function
+     */
+    static wrapDebug(opts?: LogOptionsEcs): () => void;
     /**
      * @param {string} name logger namespace
      * @param {LogOptionsEcs} [opts]

types/wrapDebug.d.ts

@@ -1 +1 @@
-export function wrapDebug(Log: any): () => void;
+export function wrapDebug(Log: any, opts: any): () => void;