NestJS-Pino 项目常见问题解决方案

NestJS-Pino 项目常见问题解决方案

nestjs-pino Platform agnostic logger for NestJS based on Pino with REQUEST CONTEXT IN EVERY LOG 项目地址: https://gitcode.com/gh_mirrors/ne/nestjs-pino

基础介绍

nestjs-pino 是一个基于 Pino 的平台无关性日志记录器，专门为 NestJS 框架设计。它能够在每个日志中包含请求上下文信息，帮助开发者更好地追踪和分析应用程序的行为。本项目主要使用 TypeScript 编程语言。

新手常见问题及解决步骤

问题一：如何安装和使用 nestjs-pino

问题描述： 新手用户可能不清楚如何正确安装和使用 nestjs-pino。

解决步骤：

1. 首先，通过 npm 安装 nestjs-pino 和 pino-http：

   npm i nestjs-pino pino-http
   

2. 在根模块中导入 LoggerModule 并使用 forRoot 或 forRootAsync 方法：

   import { LoggerModule } from 'nestjs-pino';
   
   @Module({
     imports: [LoggerModule.forRoot()],
   })
   class AppModule {}
   

3. 在应用程序中设置日志器：

   import { Logger } from 'nestjs-pino';
   import { NestFactory } from '@nestjs/core';
   
   const app = await NestFactory.create(AppModule, { bufferLogs: true });
   app.useLogger(app.get(Logger));
   

问题二：如何在服务中使用日志记录

问题描述： 用户可能不知道如何在服务中实现日志记录。

解决步骤：

1. 在服务中导入 Logger 类：

   import { Logger } from '@nestjs/common';
   import { Injectable } from '@nestjs/common';
   
   @Injectable()
   export class MyService {
     private readonly logger = new Logger(MyService.name);
   
     foo() {
       this.logger.verbose('foo: %s', 'bar');
       this.logger.debug('baz: %j', { baz: 'qux' });
       this.logger.log('foo');
     }
   }
   

问题三：如何为日志设置上下文

问题描述： 用户可能不知道如何为日志设置上下文以更好地追踪信息。

解决步骤：

1. 使用 PinoLogger 和 InjectPinoLogger：

   import { PinoLogger, InjectPinoLogger } from 'nestjs-pino';
   import { Injectable } from '@nestjs/common';
   
   @Injectable()
   export class MyService {
     constructor(private readonly logger: PinoLogger) {
       this.logger.setContext(MyService.name);
     }
   
     foo() {
       this.logger.verbose('foo: %s', 'bar');
     }
   }
   

2. 在构造函数中，可以选择设置日志的上下文，这样所有来自该服务的日志都会包含这个上下文信息。

以上是新手在使用 nestjs-pino 时可能遇到的三个常见问题及其解决方案。希望对您有所帮助。

nestjs-pino Platform agnostic logger for NestJS based on Pino with REQUEST CONTEXT IN EVERY LOG 项目地址: https://gitcode.com/gh_mirrors/ne/nestjs-pino