史上最详细的nestjs log traceId实现方案

2023-12-19 16:11:04

在 NestJS 中记录 TraceId：简化故障排除

概述

在开发过程中，日志记录对于识别和解决问题至关重要。通过关联请求的 TraceId，我们可以轻松追踪属于同一调用链的所有日志，从而简化故障排除过程。NestJS，一个流行的 Node.js 框架，提供了强大的日志记录功能，允许我们实现此功能。

安装和导入 NestJS 日志中间件

首先，我们需要安装 NestJS 日志中间件：

npm install @nestjs/morgan

然后，在我们的 NestJS 模块中导入它：

import { Module } from '@nestjs/common';
import { MorganMiddleware } from '@nestjs/morgan';

@Module({
  imports: [
    MorganMiddleware('combined'),
  ],
})
export class AppModule {}

在日志中间件中添加 TraceId

接下来，我们需要创建一个日志中间件来捕获请求的 TraceId：

import { Injectable, NestMiddleware } from '@nestjs/common';
import { Request, Response, NextFunction } from 'express';

@Injectable()
export class TraceIdMiddleware implements NestMiddleware {
  use(req: Request, res: Response, next: NextFunction) {
    const traceId = req.headers['x-trace-id'];
    if (traceId) {
      req.traceId = traceId;
    }

    next();
  }
}

在这个中间件中，我们从请求头中提取 TraceId，如果存在，则将其附加到请求对象。

在日志格式中包含 TraceId

最后，我们需要修改日志格式以包含 TraceId：

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

@Injectable()
export class AppService {
  private readonly logger = new Logger(AppService.name);

  getHello(): string {
    this.logger.log(`Hello World! ${req.traceId}`);
    return 'Hello World!';
  }
}

现在，每当我们记录日志时，它都会包含关联的 TraceId。

代码示例

以下是一个完整的代码示例，展示了如何在 NestJS 中记录 TraceId：

// app.module.ts
import { Module } from '@nestjs/common';
import { MorganMiddleware } from '@nestjs/morgan';
import { TraceIdMiddleware } from './trace-id.middleware';

@Module({
  imports: [
    MorganMiddleware('combined'),
  ],
  providers: [
    TraceIdMiddleware,
  ],
})
export class AppModule {}

// trace-id.middleware.ts
import { Injectable, NestMiddleware } from '@nestjs/common';
import { Request, Response, NextFunction } from 'express';

@Injectable()
export class TraceIdMiddleware implements NestMiddleware {
  use(req: Request, res: Response, next: NextFunction) {
    const traceId = req.headers['x-trace-id'];
    if (traceId) {
      req.traceId = traceId;
    }

    next();
  }
}

// app.service.ts
import { Injectable, Logger } from '@nestjs/common';

@Injectable()
export class AppService {
  private readonly logger = new Logger(AppService.name);

  getHello(): string {
    this.logger.log(`Hello World! ${req.traceId}`);
    return 'Hello World!';
  }
}