nest-logger-daily-rotate

Enhance nest's default logger with winston-daily-rotate-file

Quick start

Import LoggerModule into AppModule

1import { Module } from '@nestjs/common';
2import { LoggerModule } from 'nest-logger-daily-rotate';
3
4@Module({
5  imports: [
6    LoggerModule.forRoot({
7      context(request) {
8        return {
9          url: request.originalUrl,
10        };
11      },
12      level: 'log',
13      dirname: './logs',
14      filename: 'application-%DATE%.log',
15    }),
16  ],
17})
18export class AppModule {}

Inject into controllers

1import { Controller } from '@nestjs/common';
2import { LoggerService } from 'nest-logger-daily-rotate';
3
4@Controller('cats')
5export class CatsController {
6  constructor(private logger: LoggerService) {}
7
8  @Get()
9  findAll(): string {
10    // {..., "level":"log","message":"moe","timestamp":"","context":"Context"}
11    this.logger.log('moe', 'Context');
12
13    // {..., "level":"log","message":"moe","timestamp":"","context":"CatsController","ext":1}
14    this.logger.log('moe', { ext: 1 });
15
16    return 'This action returns all cats';
17  }
18}

Inject into exception filters

1import {
2  Catch,
3  ArgumentsHost,
4  HttpException,
5  HttpStatus,
6} from '@nestjs/common';
7import { Response } from 'express';
8import { Logger } from 'nest-logger-daily-rotate';
9
10@Catch()
11export class ExceptionFilter {
12  // `LoggerService` is not available, use `Logger` instead
13  constructor(private logger: Logger) {}
14  catch(e: Error, host: ArgumentsHost) {
15    const ctx = host.switchToHttp();
16
17    this.logger.error(
18      e.message,
19      e.stack,
20      // Pass full context manually
21      this.logger.getContext('Context', ctx.getRequest()),
22    );
23
24    // ...
25  }
26}

Work with middlewares

1import { NestModule } from '@nestjs/common';
2import { LoggerModule } from 'nest-logger-daily-rotate';
3
4@Module()
5export class AppModule implements NestModule {
6  constructor(private logger: Logger) {}
7  configure(consumer: MiddlewareConsumer) {
8    consumer
9      .apply((request, response, next) => {
10        this.logger.log(req.url, this.logger.getContext('Request', request));
11        next();
12      })
13      .forRoutes('*');
14  }
15}

Options

1import * as DailyRotateFile from 'winston-daily-rotate-file';
2
3type ConstructOptions = DailyRotateFile.DailyRotateFileTransportOptions & {
4  context?: string | ((request: Request) => object);
5  level?: 'log' | 'error' | 'warn' | 'debug' | 'verbose';
6  http?: {
7    url: string;
8    auth?: {
9      username?: string | undefined;
10      password?: string | undefined;
11      bearer?: string | undefined;
12    };
13    headers?: Record<string, any>;
14    payload?: (payload: { context?: string; [name: string]: any }) => any;
15  };
16};

License

MIT