Nodejs Nestjs分布式追踪插件nestjs-zipkin的使用

nestjs-zipkin 是一个用于 NestJS 应用程序的分布式追踪插件，它基于 Zipkin 进行工作。Zipkin 是 Twitter 开源的一款分布式追踪系统，可以帮助我们理解大规模分布式系统的时序数据及相关性。

要开始使用 nestjs-zipkin，首先需要安装必要的依赖包：

npm install [@nestjs](/user/nestjs)/zipkin zipkin-instrumentation-http zipkin-transport-http

接下来，你需要配置 Zipkin 的客户端，并将其集成到你的 NestJS 应用中。

以下是一个简单的示例：

1. 创建 Zipkin 配置

   在你的项目中创建一个文件，比如 zipkin.config.ts:

   import { createTracer, Tags } from 'zipkin';
   import { HttpLogger } from 'zipkin-transport-http';
   
   export const zipkinProvider = {
     provide: 'ZIPKIN',
     useFactory: () => {
       return createTracer({
         serviceName: 'your-service-name', // 服务名称
         reporter: new HttpLogger({
           endpoint: 'http://localhost:9411/api/v2/spans', // Zipkin 收集端点
         }),
         // 可选：如果你使用了 HTTP 而不是 thrift
         ctxImpl: require('zipkin-context-cls').CLS,
         localServiceName: 'your-service-name', // 本地服务名
       });
     },
   };
   

2. 将 Zipkin 配置集成到 NestJS

   创建一个模块，例如 zipkin.module.ts，并在此模块中引入 Zipkin 配置：

   import { Module } from '[@nestjs](/user/nestjs)/common';
   import { zipkinProvider } from './zipkin.config';
   
   [@Module](/user/Module)({
     providers: [zipkinProvider],
   })
   export class ZipkinModule {}
   

3. 创建一个拦截器来自动为请求添加追踪

   创建一个文件，如 zipkin.interceptor.ts:

   import { Injectable, NestInterceptor, ExecutionContext, CallHandler } from '[@nestjs](/user/nestjs)/common';
   import { Observable } from 'rxjs';
   import { map } from 'rxjs/operators';
   import { createHttpClient } from 'zipkin-instrumentation-http';
   
   [@Injectable](/user/Injectable)()
   export class ZipkinInterceptor implements NestInterceptor {
     private httpClient;
   
     constructor(private readonly tracer) {
       this.httpClient = createHttpClient({ tracer });
     }
   
     intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
       const req = context.switchToHttp().getRequest();
       const method = req.method;
       const url = req.url;
       
       return this.httpClient.request({method, url})
         .then(response => response.body);
     }
   }
   

4. 在控制器中应用拦截器

   最后，在你的控制器上使用这个拦截器：

   import { Controller, Get } from '[@nestjs](/user/nestjs)/common';
   import { ZipkinInterceptor } from './zipkin.interceptor';
   
   [@Controller](/user/Controller)()
   export class AppController {
     @Get()
     @UseInterceptors(ZipkinInterceptor)
     getHello(): string {
       return 'Hello World!';
     }
   }
   

以上步骤应该能让你在 NestJS 中开始使用 nestjs-zipkin 进行分布式追踪。注意，你需要确保 Zipkin 服务器已经运行，并且监听在指定的地址和端口上。