Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
loggerTest - A noop logger (will not log anywhere) for use in tests/mockups.The App Loggers take an optional config object.
-interface LogOptions {
/**
* Specify the minimum log level for all log outputs without their own level specified.
*
* Defaults to env `LOG_LEVEL` or `info` if not specified.
*
* @default 'info'
* */
level?: LogLevel
/**
* Specify the minimum log level streamed to the console (or docker container)
* */
console?: LogLevel
/**
* Specify the minimum log level to output to rotating files. If `false` no log files will be created.
* */
file?: LogLevel | false
/**
* The full path and filename to use for log files
*
* If using rolling files the filename will be appended with `.N` (a number) BEFORE the extension based on rolling status
*
* May also be specified using env LOG_PATH or a function that returns a string
*
* @default 'CWD/logs/app.log
* */
filePath?: string | (() => string)
}
+interface LogOptions {
/**
* Specify the minimum log level for all log outputs without their own level specified.
*
* Defaults to env `LOG_LEVEL` or `info` if not specified.
*
* @default 'info'
* */
level?: LogLevel
/**
* Specify the minimum log level streamed to the console (or docker container)
* */
console?: LogLevel
/**
* Specify the minimum log level to output for files or a log file options object. If `false` no log files will be created.
* */
file?: LogLevel | false | FileLogOptions
}
Available LogLevel levels, from lowest to highest:
@@ -53,6 +53,15 @@
const infoLogger = loggerApp({
level: 'info' // console and file will log any levels `info` and above
});
const logger = loggerApp({
console: 'debug', // console will log `debug` and higher
file: 'warn' // file will log `warn` and higher
});
+File Options
file in LogOptions may be an object that specifies more behavior log files.
+
+
+File Options
+
+export interface FileOptions {
/**
* The path and filename to use for log files.
*
* If using rolling files the filename will be appended with `.N` (a number) BEFORE the extension based on rolling status.
*
* May also be specified using env LOG_PATH or a function that returns a string.
*
* If path is relative the absolute path will be derived from the current working directory.
*
* @default 'CWD/logs/app.log'
* */
path?: string | (() => string)
/**
* For rolling log files
*
* When
* * value passed to rolling destination is a string (`filePath` from LogOptions is a string)
* * `frequency` is defined
*
* This determines the format of the datetime inserted into the log file name:
*
* * `unix` - unix epoch timestamp in milliseconds
* * `iso` - Full [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) datetime IE '2024-03-07T20:11:34Z'
* * `auto`
* * When frequency is `daily` only inserts date IE YYYY-MM-DD
* * Otherwise inserts full ISO8601 datetime
*
* @default 'auto'
* */
timestamp?: 'unix' | 'iso' | 'auto'
/**
* The maximum size of a given rolling log file.
*
* Can be combined with frequency. Use k, m and g to express values in KB, MB or GB.
*
* Numerical values will be considered as MB.
* */
size?: number | string
/**
* The amount of time a given rolling log file is used. Can be combined with size.
*
* Use `daily` or `hourly` to rotate file every day (or every hour). Existing file within the current day (or hour) will be re-used.
*
* Numerical values will be considered as a number of milliseconds. Using a numerical value will always create a new file upon startup.
*
* @default 'daily'
* */
frequency?: 'daily' | 'hourly' | number
}
+
+
+
Usage
Child Loggers
Pino Child loggers can be created using the childLogger function with the added ability to inherit Labels from their parent loggers.
Labels are inserted between the log level and message contents of a log. The child logger inherits all labels from all its parent loggers.
childLogger accepts a single string label or an array of string labels.
@@ -100,4 +109,4 @@
Parsing LogOptions
If you wish to use LogOptions to get default log levels for your destinations use parseLogOptions:
import {parseLogOptions, LogOptions} from '@foxxmd/logging';
const parsedOptions: LogOptions = parseLogOptions(myConfig);
-Generated using TypeDoc