@restorecommerce/koa-health-check

Koa 2 middleware for Cloud Health

Usage no npm install needed!

<script type="module">
  import restorecommerceKoaHealthCheck from 'https://cdn.skypack.dev/@restorecommerce/koa-health-check';
</script>

README

Koa Health Check

VersionBuild StatusDependenciesCoverage Status

Cloud Health Connect provides a Koa Middleware based on Cloud Health. The following endpoints are provided to monitor services and applications on Kubernetes:

  • Health Endpoint
  • Liveness Endpoint
  • Readiness Endpoint

Usage

import * as Koa from 'koa';
import * as health from '@cloudnative/health';
import { HealthEndpoint, ReadinessEndpoint, LivenessEndpoint } from 'koa-health-check';

const healthcheck = new health.HealthChecker();
const koa = new Koa();

koa.all('/live', LivenessEndpoint(healthcheck));
koa.all('/ready', ReadinessEndpoint(healthcheck));
koa.all('/health', HealthEndpoint(healthcheck));

Status Responses

Cloud Health Status Readiness Status Code Liveness Status Code Combined Health Status Code
STARTING 503 UNAVAILABLE 200 OK 503 UNAVAILABLE
UP 200 OK 200 OK 200 OK
DOWN 503 UNAVAILABLE 503 UNAVAILABLE 503 UNAVAILABLE
STOPPING 503 UNAVAILABLE 503 UNAVAILABLE 503 UNAVAILABLE
STOPPED 503 UNAVAILABLE 503 UNAVAILABLE 503 UNAVAILABLE
- 500 SERVER ERROR 500 SERVER ERROR 500 SERVER ERROR

Development

To build the library, use npm run build command.

To run the tests, use npm run test command.