Interface LoggerRootModuleConfig

The root logger module configuration.

interface LoggerRootModuleConfig {
    baseLabels?: Record<string | symbol, string>;
    hideLabels?: (string | symbol)[];
    hideSystemLabels?: boolean;
    level?: string;
    loggingPreset?: "simple" | "pretty" | "json" | "none";
    makeChildLogger?: ((rootLogger, module, conf) => winston.Logger);
    makeLogger?: ((conf) => winston.Logger);
    makeWinstonConfig?: ((conf) => LoggerOptions);
    scope?: string;
    winston?: LoggerOptions;
}

Properties

baseLabels? hideLabels? hideSystemLabels? level? loggingPreset? makeChildLogger? makeLogger? makeWinstonConfig? scope? winston?

Properties

Optional baseLabels

baseLabels?: Record<string | symbol, string>

The base labels for the logger. These are added to every log message of all child loggers.

Optional hideLabels

hideLabels?: (string | symbol)[]

The labels to hide from the log payload in simple and pretty presets.

Optional hideSystemLabels

hideSystemLabels?: boolean

Hide the system labels from the log payload in simple and pretty presets. (Because it's appearing in log messages)

Default

[LEVEL, SPLAT, 'timestamp', 'module', 'message', 'level', 'hostname']

Optional level

level?: string

The log level. This is used to filter log messages.

Default

process.env.LOG_LEVEL || 'warning'

Optional loggingPreset

loggingPreset?: "simple" | "pretty" | "json" | "none"

The logging preset. This is a shorthand for configuring the logger. Use 'none' to disable presets and use makeWinstonConfig to manually configure the logger.

Default

process.env.LOG_FORMAT || 'simple'

Optional makeChildLogger

makeChildLogger?: ((rootLogger, module, conf) => winston.Logger)

The child logger factory. This is used to create the child logger.

Type declaration

Optional makeLogger

makeLogger?: ((conf) => winston.Logger)

The logger factory. This is used to create the logger.

Type declaration

Optional makeWinstonConfig

makeWinstonConfig?: ((conf) => LoggerOptions)

The logger configuration. This is used to create the logger's configuration.

Type declaration

Optional scope

scope?: string

The scope of the logger. You can have multiple loggers with different scopes.

Default

'default'

Optional winston

winston?: LoggerOptions

The winston configuration. Used to manually configure edge cases.

See

https://github.com/winstonjs/winston

Settings

Member Visibility

Theme

On This Page

baseLabelshideLabelshideSystemLabelslevelloggingPresetmakeChildLoggermakeLoggermakeWinstonConfigscopewinston