KuzzleLogger #

The main class that provides logging functionality for Kuzzle.

Constructor #

constructor(config: KuzzleLoggerConfig)

Parameters #

config: Configuration object (see KuzzleLoggerConfig)

Properties #

level #

get level(): string
set level(level: string)

Get or set the current logging level. Valid levels are:

'fatal'
'error'
'warn'
'info'
'debug'
'trace'

pino #

get pino(): Logger

Get the underlying Pino logger instance.

Methods #

Logging Methods #

All logging methods share similar signatures:

method(obj: object, msg?: string, ...args: any[]): void
method(obj: unknown, msg?: string, ...args: any[]): void
method(msg: string, ...args: any[]): void

trace(): Log at trace level
debug(): Log at debug level
info(): Log at info level
warn(): Log at warn level
error(): Log at error level
fatal(): Log at fatal level

Each method can be called in multiple ways:

With an object and optional message:

logger.info({ user: 'john' }, 'User logged in');

With just a message:
```
logger.info('System started');
```

With an error object:

logger.error(new Error('Connection failed'));

flush() #

async flush(): Promise<void>

Flushes any buffered logs to their destination.

child(namespace: string) #

child(namespace: string): KuzzleLogger

Creates a child logger with the specified namespace. The child logger inherits all settings from its parent and adds the namespace to the merging object.