Nestjs项目实战 链路追踪与APM工具集成

在Nestjs项目中集成链路追踪和APM工具时，应该如何选择合适的工具？OpenTelemetry和SkyWalking哪个更适合Nestjs的架构？具体的集成步骤有哪些，比如需要配置哪些中间件或模块？在微服务场景下，如何实现跨服务的链路追踪？性能监控数据该如何收集和可视化，是否有推荐的开源面板？集成过程中常见的坑有哪些，比如采样率设置或Span丢失问题该如何解决？

3 回复

在NestJS项目中集成链路追踪和APM（应用性能监控）工具，可以使用开源的Jaeger或商业化的Elastic APM。以下是基本步骤：

  1. 安装依赖：对于Jaeger，安装[@nestjs](/user/nestjs)/zipkin和zipkin-instrumentation-http；对于Elastic APM，安装@elastic/apm-nestjs.

  2. 配置服务：创建一个全局拦截器或中间件来初始化追踪。例如，Jaeger需要配置 tracer，Elastic APM需设置服务名称和环境。

    // 示例代码：Jaeger配置
import { Module, HttpModule } from '[@nestjs](/user/nestjs)/common';
import { APP_INTERCEPTOR } from '[@nestjs](/user/nestjs)/core';
import { ZipkinInterceptor, ZipkinTransport } from '[@nestjs](/user/nestjs)/zipkin';

[@Module](/user/Module)({
  imports: [
    HttpModule.register({
      timeout: 5000,
      maxRedirects: 5,
    }),
  ],
  providers: [
    {
      provide: APP_INTERCEPTOR,
      useClass: ZipkinInterceptor,
    },
  ],
})
export class AppModule {}

  3. 数据上报：确保服务能将追踪数据发送到后端存储，如Jaeger后台或Elasticsearch集群。

  4. 监控与分析：通过UI界面查看调用链路、错误分布及性能瓶颈。Jaeger提供直观的时间轴视图，Elastic APM支持复杂的查询和报警功能。

记住，集成时要根据生产环境调整采样率和传输方式，避免过多消耗系统资源。


在NestJS项目中集成链路追踪和APM（应用性能监控）工具，可以使用开源的Jaeger或Zipkin。以Jaeger为例：

  1. 安装依赖：
npm install --save @nestjs/zipkin opentracing jaeger-client
  1. 配置Jaeger： 创建一个jaeger.provider.ts文件：
import { Module } from '@nestjs/common';
import { JaegerTracerProvider } from './jaeger.provider';

@Module({
  providers: [JaegerTracerProvider],
})
export class JaegerModule {}

然后实现jaeger.provider.ts：

import { Injectable } from '@nestjs/common';
import * as opentracing from 'opentracing';
import * as jaeger from 'jaeger-client';

@Injectable()
export class JaegerTracerProvider {
  constructor() {
    const agent = jaeger.initAgent({
      serviceName: 'your-service-name',
      reporter: {
        logSpans: true,
      },
      sampler: {
        type: 'const',
        param: 1,
      },
    });
    opentracing.globalTracer(agent);
  }
}

  1. 使用Trace装饰器： 在控制器或服务中使用@Trace()装饰器来标记需要追踪的方法。

  2. 查看结果：启动Jaeger UI（http://localhost:16686），即可查看链路追踪数据。

通过这种方式，你可以轻松地为NestJS项目集成APM和链路追踪功能，从而更好地监控和优化应用性能。

在NestJS项目中集成链路追踪和APM(应用性能监控)工具可以通过以下方案实现：

  1. 使用OpenTelemetry进行分布式追踪
// 安装依赖
npm install @opentelemetry/sdk-node @opentelemetry/auto-instrumentations-node

// tracing.ts
import { NodeSDK } from '@opentelemetry/sdk-node';
import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';

const sdk = new NodeSDK({
  traceExporter: new ConsoleSpanExporter(),
  instrumentations: [getNodeAutoInstrumentations()]
});

sdk.start();

// 在main.ts中导入
import './tracing';
  1. 集成Skywalking APM
// 安装skywalking-nodejs
npm install skywalking-backend-js

// skywalking.ts
import agent from 'skywalking-backend-js';

agent.start({
  serviceName: 'nest-service',
  serviceInstance: 'instance-1',
  collectorAddress: '127.0.0.1:11800'
});
  1. 使用Prometheus + Grafana监控
// 安装prom-client
npm install prom-client

// metrics.ts
import { Registry, collectDefaultMetrics } from 'prom-client';

const register = new Registry();
collectDefaultMetrics({ register });

export { register };

// 在Controller中使用
@Get('metrics')
async getMetrics(@Res() res: Response) {
  res.set('Content-Type', register.contentType);
  res.end(await register.metrics());
}
  1. 集成Elastic APM
// 安装elastic-apm-node
npm install elastic-apm-node

// apm.ts
import apm from 'elastic-apm-node';

apm.start({
  serviceName: 'nest-app',
  serverUrl: 'http://localhost:8200'
});

最佳实践：

  1. 在生产环境使用Jaeger或Zipkin作为trace收集器
  2. 结合日志系统(如ELK)实现全栈可观测性
  3. 对关键业务路径添加自定义Span
  4. 设置合理的采样率以平衡性能开销

这些工具可以帮助你监控应用性能、追踪请求链路、发现性能瓶颈，建议根据团队技术栈选择合适的方案组合。

回到顶部