Health Checks

1import { Module } from "canxjs";
2import { HealthModule } from "canxjs/health";
3
4@Module({
5  imports: [HealthModule],
6  controllers: [HealthController],
7})
8export class AppModule {}

1import { Controller, Get, Inject } from "canxjs";
2import { HealthCheckService, DatabaseHealthIndicator, DiskHealthIndicator } from "canxjs/health";
3
4@Controller('health')
5export class HealthController {
6  constructor(
7    private health: HealthCheckService,
8    private db: DatabaseHealthIndicator,
9    private disk: DiskHealthIndicator,
10  ) {}
11
12  @Get()
13  check() {
14    return this.health.check([
15      () => this.db.pingCheck('database'),
16      () => this.disk.checkStorage('storage', { path: '/', thresholdPercent: 0.9 })
17    ]);
18  }
19}

1{
2  "status": "ok",
3  "info": {
4    "database": {
5      "status": "up"
6    },
7    "storage": {
8      "status": "up"
9    }
10  },
11  "error": {},
12  "details": {
13    "database": {
14      "status": "up"
15    },
16    "storage": {
17      "status": "up"
18    }
19  }
20}