fix: Add missing trace level

* Add trace to level options/validation
* Lower min level for streams to trace
* add loggerTrace helper logger

Author: FoxxMD

README.md

@@ -75,6 +75,7 @@ These are the loggers that should be used for the majority of your application.
 
 These loggers are pre-defined for specific use cases:
 
+* [`loggerTrace`](https://foxxmd.github.io/logging/variables/index.loggerTrace.html) - Logs to console at the lowest minimum level, `trace`. Can be used during application startup before a logger app configuration has been parsed.
 * [`loggerDebug`](https://foxxmd.github.io/logging/variables/index.loggerDebug.html) - Logs ONLY to console at minimum `debug` level. Can be used during application startup before a logger app configuration has been parsed.
 * [`loggerTest`](https://foxxmd.github.io/logging/variables/index.loggerTest.html) - A noop logger (will not log anywhere) for use in tests/mockups.
 

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@foxxmd/logging",
   "type": "module",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "repository": "https://github.com/foxxmd/logging",
   "description": "A typed, opinionated, batteries-included, Pino-based logging solution for backend TS/JS projects",
   "scripts": {

package.json

@@ -46,7 +46,7 @@ const isFileLogOptions = (obj: any): obj is FileLogOptions => {
  * */
 export const parseLogOptions = (config: LogOptions = {}, options?: FileLogPathOptions): LogOptionsParsed => {
     if (!isLogOptions(config)) {
-        throw new Error(`Logging levels were not valid. Must be one of: 'silent', 'fatal', 'error', 'warn', 'info', 'verbose', 'debug',  -- 'file' may be false.`)
+        throw new Error(`Logging levels were not valid. Must be one of: 'silent', 'fatal', 'error', 'warn', 'info', 'verbose', 'debug', 'trace'  -- 'file' may be false.`)
     }
 
     const {level: configLevel} = config;

src/funcs.ts

@@ -16,7 +16,7 @@ import {
     parseLogOptions,
 } from './funcs.js'
 
-import {childLogger, loggerApp, loggerDebug, loggerTest, loggerAppRolling} from './loggers.js';
+import {childLogger, loggerApp, loggerDebug, loggerTest, loggerTrace, loggerAppRolling} from './loggers.js';
 
 export type {
     FileLogOptions,
@@ -35,6 +35,7 @@ export {
     loggerAppRolling,
     loggerDebug,
     loggerTest,
+    loggerTrace,
     LOG_LEVEL_NAMES,
     childLogger,
     parseLogOptions,

src/index.ts

@@ -20,7 +20,21 @@ import {pino, levels, stdSerializers} from "pino";
  * */
 export const buildLogger = (defaultLevel: LogLevel, streams: LogLevelStreamEntry[], extras: PinoLoggerOptions = {}): Logger => {
     // TODO maybe implement custom levels
-    //const { levels = {} } = extras;
+    //const { levels: extraLevels = {} } = extras;
+    /*
+        pino levels are found at pino/lib/constants.js
+        trace: 10,
+        debug: 20,
+        info: 30,
+        warn: 40,
+        error: 50,
+        fatal: 60
+
+        MS custom levels
+        verbose: 25
+        log: 21
+   */
+    const ms = pino.multistream(streams, {levels: {...levels.values, ...CUSTOM_LEVELS}});
 
     const plogger = pino<"verbose" | "log">({
         // @ts-ignore
@@ -59,7 +73,7 @@ export const buildLogger = (defaultLevel: LogLevel, streams: LogLevelStreamEntry
             },
         },
         ...extras
-    }, pino.multistream(streams, {levels: {...levels.values, ...CUSTOM_LEVELS}})) as Logger;
+    }, ms) as Logger;
     plogger.labels = [];
 
     plogger.addLabel = function (value) {
@@ -96,15 +110,22 @@ export const childLogger = (parent: Logger, labelsVal: any | any[] = [], context
  *
  * @source
  * */
-export const loggerTest = buildLogger('silent', [buildDestinationStdout('debug')]);
+export const loggerTest = buildLogger('silent', [buildDestinationStdout('trace')]);
 
 
 /**
  * A logger that ONLY logs to console at minimum 'debug' level. Useful for logging during startup before a loggerApp has been initialized
  *
  * @source
  * */
-export const loggerDebug = buildLogger('debug', [buildDestinationStdout('debug')]);
+export const loggerDebug = buildLogger('debug', [buildDestinationStdout('trace')]);
+
+/**
+ * A logger that logs to console at the lowest minimum level, 'trace'. Useful for logging during startup before a loggerApp has been initialized
+ *
+ * @source
+ * */
+export const loggerTrace = buildLogger('trace', [buildDestinationStdout('trace')]);
 
 /**
  * A Logger that logs to console and a static file
@@ -135,7 +156,7 @@ export const loggerApp = (config: LogOptions | object = {}, extras?: LoggerAppEx
         }
     }
 
-    const logger = buildLogger('debug' as LogLevel, streams, pino);
+    const logger = buildLogger('trace' as LogLevel, streams, pino);
     if (error !== undefined) {
         logger.warn(error);
     }
@@ -170,7 +191,7 @@ export const loggerAppRolling = async (config: LogOptions | object = {}, extras?
             error = e;
         }
     }
-    const logger = buildLogger('debug' as LogLevel, streams, pino);
+    const logger = buildLogger('trace' as LogLevel, streams, pino);
     if (error !== undefined) {
         logger.warn(error);
     }

src/loggers.ts

@@ -7,6 +7,7 @@ import {MarkRequired} from "ts-essentials";
  *
  * From lowest to highest:
  *
+ * * `trace`
  * * `debug`
  * * `verbose`
  * * `log`
@@ -48,7 +49,7 @@ export const CUSTOM_LEVELS: LoggerOptions<"verbose" | "log">['customLevels'] = {
 
 const CUSTOM_LEVEL_NAMES = Object.keys(CUSTOM_LEVELS);
 
-export const LOG_LEVEL_NAMES= ['silent', 'fatal', 'error', 'warn', 'info', 'log', 'verbose', 'debug'] as const;
+export const LOG_LEVEL_NAMES= ['silent', 'fatal', 'error', 'warn', 'info', 'log', 'verbose', 'debug', 'trace'] as const;
 
 /**
  * Configure log levels and file options for an AppLogger.

src/types.ts

@@ -32,7 +32,7 @@ const testConsoleLogger = (config?: object, colorize = false): [Logger, Transfor
     const opts = parseLogOptions(config, {logBaseDir: process.cwd()});
     const testStream = new PassThrough();
     const rawStream = new PassThrough();
-    const logger = buildLogger('debug', [
+    const logger = buildLogger('trace', [
         buildDestinationStream(
             opts.console,
             {
@@ -53,7 +53,7 @@ const testObjectLogger = (config?: object, object?: boolean): [Logger, Transform
     const opts = parseLogOptions(config, {logBaseDir: process.cwd()});
     const testStream = new PassThrough({objectMode: true});
     const rawStream = new PassThrough();
-    const logger = buildLogger('debug', [
+    const logger = buildLogger('trace', [
         buildDestinationJsonPrettyStream(
             opts.console,
             {