Nodejs Nestjs性能监控插件@nestjs/metrics的使用

Nodejs Nestjs性能监控插件@nestjs/metrics的使用
[@nestjs](/user/nestjs)/metrics 是一个用于 NestJS 应用程序的性能监控插件，它可以帮助你收集和监控各种指标（如请求延迟、错误率等）。以下是如何在 NestJS 项目中使用 [@nestjs](/user/nestjs)/metrics 的步骤：

安装依赖

首先，你需要安装 [@nestjs](/user/nestjs)/metrics 和相应的适配器（例如 Prometheus）：

npm install [@nestjs](/user/nestjs)/metrics prom-client

配置 Metrics

在你的 NestJS 应用程序中配置 Metrics。你可以在模块级别或全局级别进行配置。

创建 Metrics 模块

创建一个新的模块来配置 Metrics：

import { Module } from '[@nestjs](/user/nestjs)/common';
import { MetricsModule } from '[@nestjs](/user/nestjs)/metrics';

@Module({
  imports: [
    MetricsModule.register({
      defaultLabels: {
        app: 'your-app-name',
      },
      metricsMethodInterceptor: true,
    }),
  ],
})
export class AppModule {}

配置 Prometheus

如果你打算使用 Prometheus 作为指标导出器，可以添加 Prometheus 模块：

import { Module } from '[@nestjs](/user/nestjs)/common';
import { MetricsModule, PrometheusExporter } from '[@nestjs](/user/nestjs)/metrics';

@Module({
  imports: [
    MetricsModule.register({
      defaultLabels: {
        app: 'your-app-name',
      },
      metricsMethodInterceptor: true,
      exporter: new PrometheusExporter(),
    }),
  ],
})
export class AppModule {}

使用 Metrics

现在你可以在控制器或服务中使用 Metrics。你可以使用装饰器或直接通过注入 MetricsService 来访问 Metrics。

使用装饰器

在控制器方法上使用 @Metric 装饰器来跟踪请求延迟：

import { Controller, Get, Metric } from '[@nestjs](/user/nestjs)/common';
import { MetricsService } from '[@nestjs](/user/nestjs)/metrics';

@Controller('metrics')
export class MetricsController {
  constructor(private readonly metricsService: MetricsService) {}

  @Get()
  @Metric({ name: 'api_requests_total', type: 'counter' })
  getHello(): string {
    this.metricsService.labels({ status: 'success' }).inc();
    return 'Hello World!';
  }
}

直接使用 MetricsService

你也可以直接在服务中使用 MetricsService：

import { Injectable } from '[@nestjs](/user/nestjs)/common';
import { MetricsService } from '[@nestjs](/user/nestjs)/metrics';

@Injectable()
export class AppService {
  constructor(private readonly metricsService: MetricsService) {}

  getHello() {
    this.metricsService.labels({ status: 'success' }).inc();
    return 'Hello World!';
  }
}

导出 Metrics

为了将 Metrics 导出到 Prometheus，你需要启动一个 HTTP 服务器来暴露这些指标。这通常在你的主应用文件中完成：

import { NestFactory } from '[@nestjs](/user/nestjs)/core';
import { AppModule } from './app.module';
import { MetricsService } from '[@nestjs](/user/nestjs)/metrics';
import * as http from 'http';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  const server = http.createServer(app.getHttpServer());
  server.listen(3000);

  // Export metrics to Prometheus
  app.get(MetricsService).exportToPrometheus(server);
}

bootstrap();

这样，你就可以通过访问 http://localhost:3000/metrics 来查看 Prometheus 格式的 Metrics。

总结

以上步骤展示了如何在 NestJS 应用程序中使用 [@nestjs](/user/nestjs)/metrics 插件来监控性能。你可以根据需要调整配置，并选择不同的导出器（如 Prometheus）来收集和展示这些指标。