@nestingjs/logger-pretty

Pre-configuration of pino-pretty for @nestingjs/logger.

Installation

npm i @nestingjs/logger-pretty

Usage

[!CAUTION]
It is recommended to use prettifier only in development due to performance reasons.

@Module({
  imports: [
    LoggerModule.forRoot({
      transport: {
        target: '@nestingjs/logger-pretty',
        // Customize prettifier options if needed
        options: {
          traceKey: 'trace_id',
          translateTime: 'UTC:mm.dd.yyyy, h:MM:ss TT Z',
        },
      },
    }),
  ],
})
export class AppModule {}

Options

PinoPrettyOptions extends the PrettyOptions pino-pretty.

export type PinoPrettyOptions = PrettyOptions & {
  /**
   * The string key for the Error in the JSON object.
   * @default err
   */
  errorKey?: string;

  /**
   * The string key for the Context in the JSON object.
   * @default context
   */
  contextKey?: string;

  /**
   * The string key for the Tracing ID in the JSON object.
   * @default trace
   */
  traceKey?: string;
};