Terminus integration provides readiness/liveness health checks for NestJS.
npm install @nestjs/terminus
A progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular.
This module contains integrated healthchecks for Nest.
@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!
``bash
npm install --save @nestjs/terminus
`
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.
`typescript
// app.module.ts
@Module({
controllers: [HealthController],
imports:[
// Make sure TypeOrmModule is available in the module context
TypeOrmModule.forRoot({ ... }),
TerminusModule
],
})
export class HealthModule { }
`
3. Setup your HealthController which executes your Health Check.
`typescript
// 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.
`json`
{
"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.
In order to get started, first read through our Contributing guidelines.
Setup the development environment by following these instructions:
1. Fork & Clone the repository
2. Install the dependencies
`bash`
pnpm i
pnpm dev
In order to test the library against a sample, simply go to a sample and run
pnpm start:dev
`typescript`
cd sample/000-dogs-app
pnpm start:dev
> [!NOTE]
> Once the library is rebuilt, the pnpm start:dev within a sample
> needs to be restarted in order to pick up the changes.
For unit testing run the following command:
`bash`
pnpm test
For e2e testing, a Docker Compose stack is required. Make sure
Docker is installed on your machine and run the following command.
`bash``
docker compose up -d
pnpm test:e2e
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.
- Author - Kamil MyĆliwiec and Livio Brunner
- Website - https://nestjs.com
- Twitter - @nestframework
Nest is MIT licensed.