health-checks

Simplifies the process of implementing server-side health checks in a NodeJS application, ensuring that the test results conform to a standard structure.

Example usage

1import type { HealthCheck, HealthCheckOptions } from '@dts-stn/health-checks';
2import { HealthCheckResponses, execute } from '@dts-stn/health-checks';
3
4import { getSqlClient } from '~/modules';
5
6const healthChecks: HealthCheck[] = [
7  {
8    name: 'db',
9    check: async (signal) => {
10      console.debug('Testing database connectivity');
11      await getSqlClient().sql('SELECT 1', { signal });
12    },
13    metadata: {
14      db: `${sql.getDb()} on ${sql.getHost()}}`,
15    },
16  },
17  {
18    name: 'google',
19    check: async (signal) => {
20      console.debug('Testing google connectivity');
21      await fetch('https://www.google.com/', { signal });
22    },
23    metadata: {
24      url: 'https://www.google.com/',
25    },
26  },
27];
28
29const summary = await execute(healthChecks, {
30  metadata: {
31    version: '1.0.0',
32    buildId: '1.0.0-00000000-00000',
33  },
34  includeDetails: true,
35  timeout: 1000,
36});

1curl http://localhost/health --verbose | jq
2< HTTP/1.1 503 Service Unavailable
3{
4  "status": "UNHEALTHY",
5  "version": "1.0.0",
6  "buildId": "1.0.0-00000000-00000",
7  "responseTime": 399,
8  "components": [
9    {
10      "db": {
11        "status": "UNHEALTHY",
12        "responseTime": 12,
13        "metadata": {
14          "db": "testdb on localhost"
15        },
16        "errorDetails": "Could not connect to postgres://localhost/testdb",
17        "stackTrace": "[...truncated...]"
18      }
19    },
20    {
21      "google": {
22        "status": "HEALTHY",
23        "responseTime": 389,
24        "metadata": {
25          "url": "https://www.google.com/"
26        }
27      }
28    }
29  ]
30}