Description

Nest framework TypeScript starter repository.

Installation

1$ yarn add nestjs-winston-logger

QuickStart

To use it globally and log any response

1import { NestFactory } from "@nestjs/core";
2import { AppModule } from "./app.module";
3import {
4  NestjsWinstonLoggerService,
5  appendRequestIdToLogger,
6  LoggingInterceptor,
7  morganRequestLogger,
8  morganResponseLogger,
9  appendIdToRequest
10} from "nestjs-winston-logger";
11
12import { format, transports } from "winston";
13import * as helmet from "helmet";
14
15async function bootstrap() {
16  const app = await NestFactory.create(AppModule);
17  app.use(helmet());
18
19  const globalLogger = new NestjsWinstonLoggerService({
20    format: format.combine(
21      format.timestamp({ format: "isoDateTime" }),
22      format.json(),
23      format.colorize({ all: true }),
24    ),
25    transports: [
26      new transports.File({ filename: "error.log", level: "error" }),
27      new transports.File({ filename: "combined.log" }),
28      new transports.Console(),
29    ],
30  });
31  app.useLogger(globalLogger);
32
33  // append id to identify request
34  app.use(appendIdToRequest);
35  app.use(appendRequestIdToLogger(globalLogger));
36
37  app.use(morganRequestLogger(globalLogger));
38  app.use(morganResponseLogger(globalLogger));
39
40  app.useGlobalInterceptors(new LoggingInterceptor(globalLogger));
41
42  const port = process.env.PORT || 4000;
43  await app.listen(port).then(() => {
44    console.log(`🚀 Server ready at ${port}`);
45  });
46}
47bootstrap();

To use it inside module

Inside demo.module.ts

1import { Module } from "@nestjs/common";
2import { NestjsWinstonLoggerModule } from "nestjs-winston-logger";
3import { format, transports } from "winston";
4import { DemoService } from "./demo.service";
5
6@Module({
7  imports: [
8    NestjsWinstonLoggerModule.forRoot({
9      format: format.combine(
10        format.timestamp({ format: "isoDateTime" }),
11        format.json(),
12        format.colorize({ all: true }),
13      ),
14      transports: [
15        new transports.File({ filename: "error.log", level: "error" }),
16        new transports.File({ filename: "combined.log" }),
17        new transports.Console(),
18      ],
19    }),
20  ],
21  providers: [DemoService],
22})
23export class DemoModule {}

Inside demo.service.ts

1import { Injectable } from "@nestjs/common";
2import { NestjsWinstonLoggerService, InjectLogger } from "nestjs-winston-logger";
3
4@Injectable()
5export class DemoService {
6  constructor(@InjectLogger(DemoService.name) private logger: NestjsWinstonLoggerService) {}
7}

License

Nest is MIT licensed.