@nestjs-mod/terminus

Terminus integration provides readiness/liveness health checks for NestJS-mod (Wrapper for https://www.npmjs.com/package/@nestjs/terminus)

Installation

1npm i --save @nestjs/terminus @nestjs-mod/terminus

Modules

Link	Category	Description
TerminusHealthCheckModule	system	Terminus integration provides readiness/liveness health checks for NestJS-mod (Wrapper for https://www.npmjs.com/package/@nestjs/terminus)

Modules descriptions

TerminusHealthCheckModule

Terminus integration provides readiness/liveness health checks for NestJS-mod (Wrapper for https://www.npmjs.com/package/@nestjs/terminus)

Use in NestJS

Example of use feature configurations and use standardHealthIndicators.

1import { TerminusHealthCheckModule, TerminusHealthCheckFeatureConfiguration } from '@nestjs-mod/terminus';
2import { NestFactory } from '@nestjs/core';
3
4import { Module } from '@nestjs/common';
5import { HealthIndicatorStatus, MemoryHealthIndicator } from '@nestjs/terminus';
6
7export class FeatureTerminusHealthCheckFeatureConfiguration implements TerminusHealthCheckFeatureConfiguration {
8  name = 'Feature';
9  async isHealthy() {
10    return {
11      feature: {
12        status: 'up' as HealthIndicatorStatus,
13      },
14    };
15  }
16}
17
18@Module({
19  imports: [
20    TerminusHealthCheckModule.forFeature({
21      featureModuleName: 'feature',
22      featureConfiguration: new FeatureTerminusHealthCheckFeatureConfiguration(),
23    }),
24  ],
25})
26export class FeatureModule {}
27
28@Module({
29  imports: [
30    TerminusHealthCheckModule.forRootAsync({
31      configurationFactory: (memoryHealthIndicator: MemoryHealthIndicator) => ({
32        standardHealthIndicators: [
33          { name: 'memory_heap', check: () => memoryHealthIndicator.checkHeap('memory_heap', 150 * 1024 * 1024) },
34        ],
35      }),
36      inject: [MemoryHealthIndicator],
37    }),
38    FeatureModule,
39  ],
40})
41export class AppModule {}
42
43async function bootstrap() {
44  const app = await NestFactory.create(AppModule);
45  await app.listen(3000);
46}
47
48bootstrap();

Use in NestJS-mod

An example of using forRoot with parameters and use feature configurations with use standardHealthIndicators, you can see the full example here https://github.com/nestjs-mod/nestjs-mod-contrib/tree/master/apps/example-terminus.

1import {
2  DefaultNestApplicationInitializer,
3  DefaultNestApplicationListener,
4  bootstrapNestApplication,
5  createNestModule,
6} from '@nestjs-mod/common';
7import { TerminusHealthCheckModule, TerminusHealthCheckFeatureConfiguration } from '@nestjs-mod/terminus';
8import { HealthIndicatorStatus, MemoryHealthIndicator } from '@nestjs/terminus';
9
10export class FeatureTerminusHealthCheckFeatureConfiguration implements TerminusHealthCheckFeatureConfiguration {
11  name = 'Feature';
12  async isHealthy() {
13    return {
14      feature: {
15        status: 'up' as HealthIndicatorStatus,
16      },
17    };
18  }
19}
20
21export const { FeatureModule } = createNestModule({
22  moduleName: 'FeatureModule',
23  imports: [
24    TerminusHealthCheck.forFeature({
25      featureModuleName: 'feature',
26      featureConfiguration: new FeatureTerminusHealthCheckFeatureConfiguration(),
27    }),
28  ],
29});
30
31bootstrapNestApplication({
32  modules: {
33    system: [
34      DefaultNestApplicationInitializer.forRoot(),
35      TerminusHealthCheckModule.forRootAsync({
36        configurationFactory: (memoryHealthIndicator: MemoryHealthIndicator) => ({
37          standardHealthIndicators: [
38            { name: 'memory_heap', check: () => memoryHealthIndicator.checkHeap('memory_heap', 150 * 1024 * 1024) },
39          ],
40        }),
41        inject: [MemoryHealthIndicator],
42      }),
43      DefaultNestApplicationListener.forRoot({ staticEnvironments: { port: 3000 } }),
44    ],
45    feature: [FeatureModule.forRoot()],
46  },
47});

Shared providers

TerminusHealthCheckService

Shared imports

TerminusModule

Configuration

Key	Description	Constraints	Default	Value
standardHealthIndicators	Standard health indicators @see https://docs.nestjs.com/recipes/terminus#setting-up-a-healthcheck	optional	-	-

Static configuration

Key	Description	Constraints	Default	Value
endpoint	Rest endpoint for health check	optional	health	-
errorLogStyle	The style of the error logger @default 'json'	optional	-	-
logger	The logger to use. Either default logger or your own.	optional	-	-
gracefulShutdownTimeoutMs	The timeout to wait in ms before the application shuts down @default 0	optional	-	-

Feature configuration

Key	Description	Constraints	Default	Value
name	Name of health check	isNotEmpty (name should not be empty)	-	-
isHealthy	Logic for health check	isNotEmpty (isHealthy should not be empty)	-	-

Back to Top

Links

• https://github.com/nestjs-mod/nestjs-mod - A collection of utilities for unifying NestJS applications and modules
• https://github.com/nestjs-mod/nestjs-mod-contrib - Contrib repository for the NestJS-mod
• https://github.com/nestjs-mod/nestjs-mod-example - Example application built with @nestjs-mod/schematics
• https://github.com/nestjs-mod/nestjs-mod/blob/master/apps/example-basic/INFRASTRUCTURE.MD - A simple example of infrastructure documentation.
• https://github.com/nestjs-mod/nestjs-mod-contrib/blob/master/apps/example-prisma/INFRASTRUCTURE.MD - An extended example of infrastructure documentation with a docker-compose file and a data base.
• https://dev.to/endykaufman/collection-of-nestjs-mod-utilities-for-unifying-applications-and-modules-on-nestjs-5256 - Article about the project NestJS-mod
• https://habr.com/ru/articles/788916 - Коллекция утилит NestJS-mod для унификации приложений и модулей на NestJS

License

MIT