Nestjs 如何使用日志服务？

在 NestJS 中使用日志服务可以通过多种方式实现，最常见的是使用 NestJS 内置的日志器（Logger）服务，或者集成第三方日志库（如 Winston 或 Pino）。以下是如何在 NestJS 中使用内置的 Logger 服务以及集成 Winston 作为日志服务的基本步骤。

使用 NestJS 内置 Logger 服务

导入 Logger 服务： NestJS 提供了一个内置的 Logger 类，您可以在任何服务或控制器中直接使用它。
```
typescript
import { Logger } from '@nestjs/common';
```
实例化 Logger： 在您的服务或控制器中创建一个 Logger 实例。
```
typescript
private readonly logger = new Logger(MyService.name);
```

使用 Logger： 现在可以在类的任何方法中使用这个 logger 来记录日志。

typescript
someMethod() {
  this.logger.log('Some informative message');
  this.logger.error('An error occurred', error.stack);
  this.logger.warn('A warning message');
  this.logger.debug('Some debug information');
}

自定义 Logger： 如果需要更改日志级别或自定义日志行为，可以通过继承 Logger 类并重写其方法来完成。

typescript
import { Logger, Injectable, Scope } from '@nestjs/common';

@Injectable({ scope: Scope.TRANSIENT })
class MyLogger extends Logger {
  // 自定义日志的逻辑
}

集成第三方日志库（以 Winston 为例）

安装 Winston 相关依赖：

sh
npm install winston @nestjs/common @nestjs/core

创建一个 Winston 模块： 创建一个模块来封装 Winston 的配置和提供器。

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

@Module({
  imports: [
    WinstonModule.forRoot({
      // Winston 的配置
      transports: [
        new winston.transports.Console(),
        // 其他 transports 如文件或远程日志服务
      ],
    }),
  ],
  exports: [WinstonModule],
})
export class LoggerModule {}

在应用中使用 Winston： 在其他模块中导入 LoggerModule 并在服务中注入 WINSTON_MODULE_PROVIDER 作为日志器。

typescript
import { Inject, Injectable } from '@nestjs/common';
import { Logger } from 'winston';
import { WINSTON_MODULE_PROVIDER } from 'nest-winston';

@Injectable()
class MyService {
  constructor(
    @Inject(WINSTON_MODULE_PROVIDER) private readonly logger: Logger
  ) {}

  someMethod() {
    this.logger.info('Some informative message');
    this.logger.error('An error occurred');
  }
}

使用自定义的日志级别和格式

NestJS 的内置日志器或第三方日志库允许您定义自定义的日志级别和格式。这可以通过修改配置来实现，例如，在使用 Winston 时，您可以自定义 transports 和 format 选项以改变日志的输出格式和目的地。

typescript
transports: [
  new winston.transports.Console({
    format: winston.format.combine(
      winston.format.timestamp(),
      winston.format.printf(info => `${info.timestamp} ${info.level}: ${info.message}`)
    ),
  }),
  // 其他 transports
]

在实际生产环境中，您可能还需要考虑日志的持久化存储、日志的分析、监控警报等高级功能，这通常需要与相关的基础设施和服务集成，如 ELK（Elasticsearch, Logstash, Kibana）堆栈、AWS CloudWatch、GCP Stackdriver 等。

以上是在 NestJS 中使用日志服务的一些基础步骤和实践，当然根据具体的业务需求和系统复

2024年6月29日 12:07 回复

首先需要将 Logger 导入到您的 Class 中：

shell
import { Logger } from '@nestjs/common';

然后就可以开始记录日志：

shell
Logger.log('info')
Logger.warn('warning')
Logger.error('something went wrong! ', error)

2024年6月29日 12:07 回复

2个答案

使用 NestJS 内置 Logger 服务

集成第三方日志库（以 Winston 为例）

使用自定义的日志级别和格式

你的答案