Need help with terminus?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

nestjs
285 Stars 34 Forks MIT License 1.8K Commits 6 Opened issues

Description

Terminus module for Nest framework (node.js) :robot:

Services available

!
?

Need anything else?

Contributors list

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular.

NPM Version Package License NPM Downloads Discord Backers on Open Collective Sponsors on Open Collective

<!--Backers on Open Collective Sponsors on Open Collective-->

Description

This module contains integrated healthchecks for Nest.

Installation

@nestjs/terminus
integrates with a lot of cool technologies, such as
typeorm
,
grpc
,
mongodb
, and many more! In case you have missed a dependency,
@nestjs/terminus
will throw an error and prompt you to install the required dependency. So you will only install what is actually required!
npm install --save @nestjs/terminus

Usage

  1. Import the Terminus module
  2. Make sure the additionally needed modules are available to (e.g.
    TypeOrmModule
    ), in case you want to do Database Health Checks.
// app.module.ts

@Module({ controllers: [HealthController], imports:[ // Make sure TypeOrmModule is available in the module context TypeOrmModule.forRoot({ ... }), TerminusModule ], }) export class HealthModule { }

  1. Setup your
    HealthController
    which executes your Health Check.
// health.controller.ts

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

@Get() @HealthCheck() readiness() { return this.health.check([ async () => this.db.pingCheck('database', { timeout: 300 }), ]); } }

If everything is set up correctly, you can access the healthcheck on

http://localhost:3000/health
.
{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "details": {
    "database": {
      "status": "up"
    }
  }
}

For more information, see docs. You can find more samples in the samples/ folder of this repository.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

License

Nest is MIT licensed.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.