A package for creating liveness ping middleware for use with Koa.
A liveness ping is a URL at which your application will respond with a
200 whenever your server is running. It can be used, for example, for liveness checks in Kubernetes deployments.
$ yarn add @shopify/koa-liveness-ping
import Koa from 'koa'; import ping from '@shopify/koa-liveness-ping'; const app = new Koa(); // set up any error or loggin middlewares app.use(ping()); // other routing middlewares should go after the liveness ping
This middleware can also be mounted at any path via
koa-mount (Learn more).
Note: Mount the liveness ping middleware before all other routing-related middleware in order to ensure it can respond quickly and reliably.