healthcheck-ping
Version:
Express middleware exposing a health check endpoint
41 lines (29 loc) • 1.34 kB
Markdown
[](https://www.npmjs.org/package/healthcheck-ping)
[](https://travis-ci.org/holidaycheck/healthcheck-ping)
[](https://coveralls.io/r/holidaycheck/healthcheck-ping)
[](https://david-dm.org/holidaycheck/healthcheck-ping)
healthcheck-ping
======================
> :ambulance: Express middleware that exposes the health state.
This middleware can be used in any express application to provide a simple health check endpoint.
The default endpoint is "`_health`" but you can provide a different endpoint name if you want.
The endpoint returns a static json response:
```json
{
"status": "OK"
}
```
## Installation
```
$ npm install healthcheck-ping --save
```
## Usage
```js
var createHealthcheckMiddleware = require('healthcheck-ping');
var server = express();
server.use(createHealthcheckMiddleware()); // mounted as /_health
```
If you want the healthcheck to be available on a custom endpoint you can do so:
```js
server.use(createHealthcheckMiddleware('foobar'));
```