10分钟上手Terminus：Nest.js健康监控快速开始

【免费下载链接】terminus Terminus module for Nest framework (node.js) :robot: 项目地址: https://gitcode.com/gh_mirrors/terminus3/terminus

你是否正在寻找一个简单高效的Nest.js健康监控解决方案？Terminus正是你需要的终极工具！作为Nest框架官方推荐的健康检查模块，Terminus为Node.js应用提供了完整的就绪性和存活性检查功能。无论你是新手开发者还是经验丰富的架构师，都能在10分钟内快速掌握这个强大的健康监控工具。

什么是Terminus健康检查模块？

Terminus是一个专门为Nest.js设计的健康监控模块，它可以帮助你实时监控应用程序的健康状态。通过简单的配置，你就能获得数据库连接状态、内存使用情况、磁盘空间、HTTP服务状态等关键指标。这对于微服务架构、容器化部署和云原生应用来说至关重要！🚀

为什么需要健康检查？

在现代化应用部署中，健康检查扮演着关键角色：

• Kubernetes就绪探针：确保应用完全启动后才接收流量
• 负载均衡器健康检查：自动剔除不健康的实例
• 监控告警：及时发现并处理系统问题
• 优雅停机：在应用关闭前完成待处理请求

快速安装指南

开始使用Terminus非常简单，只需要几个简单的步骤：

1. 安装Terminus包

npm install --save @nestjs/terminus

Terminus采用智能依赖管理，它会根据你的使用场景自动提示需要安装的额外依赖包。比如，如果你要检查数据库健康状态，它会提示你安装相应的数据库驱动。

2. 基本配置示例

让我们创建一个最简单的健康检查控制器。在src/health/health.controller.ts文件中：

import { Controller, Get } from '@nestjs/common';
import {
  HealthCheck,
  HealthCheckService,
  HttpHealthIndicator,
} from '@nestjs/terminus';

@Controller('health')
export class HealthController {
  constructor(
    private health: HealthCheckService,
    private http: HttpHealthIndicator,
  ) {}

  @Get()
  @HealthCheck()
  check() {
    return this.health.check([
      () => this.http.pingCheck('nestjs-docs', 'https://docs.nestjs.com'),
    ]);
  }
}

3. 导入Terminus模块

在你的主模块app.module.ts中：

import { Module } from '@nestjs/common';
import { TerminusModule } from '@nestjs/terminus';
import { HealthController } from './health/health.controller';

@Module({
  imports: [TerminusModule],
  controllers: [HealthController],
})
export class AppModule {}

核心功能详解

Terminus提供了丰富的健康指示器，满足各种监控需求：

数据库健康检查

支持多种数据库的健康监控，包括：

• TypeORM：关系型数据库连接状态检查
• Mongoose：MongoDB数据库连接监控
• Sequelize：SQL数据库健康检查
• Prisma：现代ORM框架的健康监控
• MikroORM：轻量级ORM的健康状态

示例代码：sample/005-typeorm-app/src/health/health.controller.ts

@Get()
@HealthCheck()
check() {
  return this.health.check([
    async () => this.db.pingCheck('typeorm'),
  ]);
}

HTTP服务监控

检查外部HTTP服务的可用性：

return this.health.check([
  () => this.http.pingCheck('api-service', 'https://api.example.com'),
  () => this.http.responseCheck('auth-service', 'https://auth.example.com/health', 
    (res) => res.status === 200),
]);

系统资源监控

监控服务器硬件资源使用情况：

• 内存使用率：防止内存泄漏
• 磁盘空间：避免磁盘写满
• CPU负载：监控系统性能

示例代码：sample/010-disk-app/src/health/health.controller.ts

@Get()
@HealthCheck()
check() {
  return this.health.check([
    () => this.disk.checkStorage('storage', { path: '/', thresholdPercent: 0.9 }),
  ]);
}

微服务健康检查

支持多种微服务通信协议：

• gRPC服务状态检查
• Kafka消息队列健康状态
• RabbitMQ连接监控
• NATS消息系统健康检查
• Redis缓存服务状态

高级配置技巧

自定义健康指示器

你可以轻松创建自定义的健康指示器来监控业务逻辑：

import { Injectable } from '@nestjs/common';
import { HealthIndicator, HealthIndicatorResult } from '@nestjs/terminus';

@Injectable()
export class DogHealthIndicator extends HealthIndicator {
  async isHealthy(key: string): Promise<HealthIndicatorResult> {
    const isHealthy = await this.checkDogHealth();
    return this.getStatus(key, isHealthy, { 
      message: isHealthy ? 'Dog is happy' : 'Dog is sad' 
    });
  }

  private async checkDogHealth(): Promise<boolean> {
    // 你的业务逻辑检查
    return true;
  }
}

查看完整示例：sample/000-dogs-app/src/dog/dog.health.ts

优雅停机配置

Terminus支持优雅停机功能，确保应用在关闭前完成所有待处理请求：

// 在main.ts中配置
const app = await NestFactory.create(AppModule);
app.enableShutdownHooks();

健康检查端点定制

你可以创建多个健康检查端点，满足不同场景需求：

@Controller('health')
export class HealthController {
  constructor(
    private health: HealthCheckService,
    private db: TypeOrmHealthIndicator,
    private http: HttpHealthIndicator,
    private memory: MemoryHealthIndicator,
  ) {}

  @Get('readiness')
  @HealthCheck()
  readiness() {
    // 就绪性检查 - 应用是否准备好接收流量
    return this.health.check([
      async () => this.db.pingCheck('database'),
    ]);
  }

  @Get('liveness')
  @HealthCheck()
  liveness() {
    // 存活性检查 - 应用是否还在运行
    return this.health.check([
      () => this.memory.checkHeap('memory_heap', 150 * 1024 * 1024),
    ]);
  }

  @Get('startup')
  @HealthCheck()
  startup() {
    // 启动检查 - 所有依赖是否就绪
    return this.health.check([
      async () => this.db.pingCheck('database'),
      () => this.http.pingCheck('external-api', 'https://api.example.com'),
    ]);
  }
}

实际应用场景

Kubernetes部署配置

在Kubernetes中配置Terminus健康检查：

apiVersion: apps/v1
kind: Deployment
spec:
  template:
    spec:
      containers:
      - name: my-app
        livenessProbe:
          httpGet:
            path: /health/liveness
            port: 3000
          initialDelaySeconds: 30
          periodSeconds: 10
        readinessProbe:
          httpGet:
            path: /health/readiness
            port: 3000
          initialDelaySeconds: 5
          periodSeconds: 5

Docker健康检查

在Docker Compose中配置：

version: '3.8'
services:
  app:
    build: .
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:3000/health"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 40s

最佳实践建议

1. 分层健康检查策略

建议采用分层检查策略：

• Level 1：基础存活检查（快速响应）
• Level 2：依赖服务检查（数据库、缓存等）
• Level 3：业务逻辑检查（自定义健康指示器）

2. 合理的超时设置

根据不同的检查类型设置合适的超时时间：

return this.health.check([
  async () => this.db.pingCheck('database', { timeout: 3000 }),
  () => this.http.pingCheck('external-api', 'https://api.example.com', { timeout: 5000 }),
]);

3. 监控指标聚合

将健康检查结果集成到监控系统中：

• Prometheus：通过/metrics端点暴露指标
• Grafana：可视化健康状态仪表板
• AlertManager：设置告警规则

常见问题解答

Q: Terminus支持哪些Nest.js版本？

A: Terminus支持Nest.js 10.x和11.x版本，确保与最新框架版本兼容。

Q: 如何添加自定义健康检查逻辑？

A: 继承HealthIndicator类并实现isHealthy方法，然后在控制器中注入使用。

Q: 健康检查会影响应用性能吗？

A: Terminus的设计非常轻量级，健康检查通常很快完成，对应用性能影响极小。

Q: 支持哪些数据库的健康检查？

A: 支持TypeORM、Mongoose、Sequelize、Prisma、MikroORM等多种数据库ORM框架。

总结

Terminus作为Nest.js生态中的健康监控解决方案，为开发者提供了强大而灵活的健康检查功能。通过本文的10分钟快速入门指南，你已经掌握了Terminus的核心概念和基本用法。

记住这些关键点：

• ✅ 简单安装：只需一个npm包
• ✅ 丰富功能：支持多种数据库和外部服务
• ✅ 灵活配置：自定义健康指示器和检查策略
• ✅ 生产就绪：完美支持Kubernetes和Docker

现在就开始使用Terminus，为你的Nest.js应用添加专业的健康监控功能吧！如果你需要更多示例代码，可以查看项目中的sample/目录，那里包含了各种使用场景的完整示例。

健康监控是现代化应用不可或缺的一部分，Terminus让这一切变得简单而高效！🎉

【免费下载链接】terminus Terminus module for Nest framework (node.js) :robot: 项目地址: https://gitcode.com/gh_mirrors/terminus3/terminus