fullstack.org.ua

Terminus у NestJS · fullstack.org.ua

Середній12 хв· Fullstack Team

Terminus у NestJS

Підключите Terminus і реалізуєте health indicators для бази даних, диска та зовнішніх сервісів.

Що таке health check

Health check — це спеціальний endpoint, який повідомляє, чи готовий застосунок обробляти запити.

Зазвичай перевіряють:

доступність бази даних;
наявність вільного місця на диску;
доступність зовнішніх HTTP-сервісів;
інші критичні залежності застосунку.

У NestJS для цього використовується пакет @nestjs/terminus. Він містить готові health indicators — перевірки для типових інфраструктурних компонентів.

Health endpoint часто використовують:

оркестратори контейнерів;
балансувальники навантаження;
системи моніторингу;
CI/CD-процеси;
команди підтримки під час діагностики проблем.

Встановлення Terminus

Для прикладу використаємо TypeORM із SQLite та HTTP-клієнт NestJS:

bash

npm install @nestjs/terminus @nestjs/axios @nestjs/typeorm typeorm sqlite3

typescript

import { Module } from '@nestjs/common';
import { HttpModule } from '@nestjs/axios';
import { TypeOrmModule } from '@nestjs/typeorm';
import { TerminusModule } from '@nestjs/terminus';

import { HealthController } from './health.controller';

@Module({
  imports: [
    TerminusModule,
    HttpModule,
    TypeOrmModule.forRoot({
      type: 'sqlite',
      database: ':memory:',
      autoLoadEntities: true,
      synchronize: true,
    }),
  ],
  controllers: [HealthController],
})
export class AppModule {}

typescript

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

@Controller('health')
export class HealthController {
  constructor(
    private readonly health: HealthCheckService,
    private readonly database: TypeOrmHealthIndicator,
    private readonly disk: DiskHealthIndicator,
    private readonly http: HttpHealthIndicator,
  ) {}

  @Get()
  @HealthCheck()
  check() {
    return this.health.check([
      () => this.database.pingCheck('database'),

      () =>
        this.disk.checkStorage('storage', {
          path: process.cwd(),
          thresholdPercent: 0.9,
        }),

      () =>
        this.http.pingCheck(
          'external-api',
          'https://example.com',
        ),
    ]);
  }
}

json

{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    },
    "storage": {
      "status": "up"
    },
    "external-api": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    },
    "storage": {
      "status": "up"
    },
    "external-api": {
      "status": "up"
    }
  }
}

json

{
  "status": "error",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {
    "external-api": {
      "status": "down",
      "message": "..."
    }
  },
  "details": {
    "database": {
      "status": "up"
    },
    "external-api": {
      "status": "down",
      "message": "..."
    }
  }
}

typescript

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

@Controller('health')
export class HealthController {
  constructor(
    private readonly health: HealthCheckService,
    private readonly database: TypeOrmHealthIndicator,
  ) {}

  @Get('live')
  live() {
    return {
      status: 'ok',
    };
  }

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

typescript

import { Module } from '@nestjs/common';
import { HttpModule } from '@nestjs/axios';
import { TypeOrmModule } from '@nestjs/typeorm';
import { TerminusModule } from '@nestjs/terminus';

import { HealthController } from './health.controller';

@Module({
  imports: [
    TerminusModule,
    HttpModule,
    TypeOrmModule.forRoot({
      type: 'sqlite',
      database: ':memory:',
      autoLoadEntities: true,
      synchronize: true,
    }),
  ],
  controllers: [HealthController],
})
export class AppModule {}

typescript

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

@Controller('health')
export class HealthController {
  constructor(
    private readonly health: HealthCheckService,
    private readonly database: TypeOrmHealthIndicator,
    private readonly disk: DiskHealthIndicator,
    private readonly http: HttpHealthIndicator,
  ) {}

  @Get()
  @HealthCheck()
  check() {
    return this.health.check([
      () => this.database.pingCheck('database'),
      () =>
        this.disk.checkStorage('storage', {
          path: process.cwd(),
          thresholdPercent: 0.9,
        }),
      () =>
        this.http.pingCheck(
          'external-api',
          'https://example.com',
          {
            timeout: 3000,
          },
        ),
    ]);
  }
}