NestJS 应用日志记录深度指南：从入门到高级技巧

在 NestJS 项目中，日志记录是至关重要的。它不仅能帮助我们追踪应用运行状态，快速定位问题，还能为性能分析提供数据支撑。 尤其是在面对高并发场景，例如使用了 Nginx 反向代理，需要进行负载均衡，或是接入了宝塔面板进行统一管理时，高效的日志系统能够大幅提升问题排查效率。然而，很多开发者在初期往往忽视日志的重要性，或者简单地使用 console.log 打印日志，导致后期维护困难。本文将深入探讨 NestJS 中日志记录的最佳实践，助你构建健壮的应用。

为什么选择专业的日志记录方案？

直接使用 console.log 的局限性在于：

• 缺乏结构化： 所有日志都以字符串形式输出，难以分析和过滤。
• 缺乏可配置性： 无法根据环境调整日志级别。
• 性能问题： 在生产环境中，大量的 console.log 输出会影响应用性能。

而专业的日志记录方案，例如使用 winston 或 morgan 等库，可以解决这些问题。

NestJS 集成 Winston 进行高级日志记录

Winston 是一个流行的 Node.js 日志库，它具有强大的可配置性和扩展性。下面演示如何在 NestJS 中集成 Winston：

1. 安装 Winston 和 NestJS 的 Winston 模块

npm install --save nest-winston winston

2. 创建 Winston 日志模块

创建一个 winston.module.ts 文件：

import { Module } from '@nestjs/common';
import { WinstonModule } from 'nest-winston';
import * as winston from 'winston';
import 'winston-daily-rotate-file';

@Module({
  imports: [
    WinstonModule.forRoot({
      transports: [
        new winston.transports.Console({
          format: winston.format.combine(
            winston.format.timestamp(),
            winston.format.ms(),
            winston.format.colorize({
              all: true,
            }),
            winston.format.printf(
              (info) =>
                `${info.timestamp} [${info.context}] ${info.level}: ${info.message} ${info.ms}`
            )
          ),
        }),
        // 文件输出，每天创建一个新的日志文件
        new winston.transports.DailyRotateFile({
          filename: `logs/application-%DATE%.log`, //日志文件目录和文件名
          datePattern: 'YYYY-MM-DD-HH', //日期格式
          zippedArchive: true, //是否gzip压缩
          maxSize: '20m', //单个日志文件大小
          maxFiles: '14d', //保留多少天的日志
          format: winston.format.combine(
            winston.format.timestamp(),
            winston.format.ms(),
            winston.format.printf(
              (info) =>
                `${info.timestamp} [${info.context}] ${info.level}: ${info.message} ${info.ms}`
            )
          ),
        }),
      ],
      // Optionally pass meta to all loggers.
      meta: true,
      // Use sane defaults for production and development.
      level: process.env.NODE_ENV === 'production' ? 'info' : 'silly',
    }),
  ],
  exports: [WinstonModule],
})
export class WinstonLoggerModule {}

3. 在 App 模块中引入 Winston 模块

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { WinstonLoggerModule } from './winston.module';

@Module({
  imports: [WinstonLoggerModule],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

4. 在 Controller 或 Service 中使用 Logger

import { Controller, Get, Logger } from '@nestjs/common';
import { AppService } from './app.service';

@Controller()
export class AppController {
  private readonly logger = new Logger(AppController.name);

  constructor(private readonly appService: AppService) {}

  @Get()
  getHello(): string {
    this.logger.log('Calling getHello endpoint');
    return this.appService.getHello();
  }
}

NestJS 日志记录的实战避坑经验

• 日志级别选择： 谨慎选择日志级别。debug 级别用于开发环境，info 级别用于记录关键事件，warn 级别用于记录潜在问题，error 级别用于记录错误信息，fatal 级别用于记录严重错误。
• 避免在生产环境中输出过多日志： 过多的日志会影响性能，并且难以分析。
• 使用结构化日志： 使用 JSON 格式或其他结构化格式，方便日志分析工具进行处理。
• 日志切割： 定期切割日志，避免单个日志文件过大。可以使用 winston-daily-rotate-file 等工具进行日志切割。
• 日志集中管理： 将日志集中存储到 ElasticSearch, Graylog 等日志管理平台，方便统一查询和分析。特别是当应用部署在多个服务器上时，集中管理日志尤为重要。
• 记录关键信息： 在日志中记录足够的信息，例如用户 ID、请求 ID、时间戳等，方便问题追踪。
• 防止敏感信息泄露： 避免在日志中记录敏感信息，例如密码、信用卡号等。可以采用脱敏处理。
• 利用 NestJS 拦截器： 可以使用拦截器来记录请求的入参、出参和执行时间，方便性能分析和问题排查。

总结

通过以上步骤，我们可以在 NestJS 项目中集成 Winston，实现高级日志记录。记住，良好的日志记录习惯是构建健壮应用的基础。希望本文能帮助你更好地理解 NestJS 日志记录，并在实际项目中应用起来。在面对 Nginx + NestJS 高并发场景时，精心设计的日志系统将成为你的得力助手，能够快速定位性能瓶颈，保障应用稳定运行。同时，结合宝塔面板等工具，可以更方便地管理和监控日志。