Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/roppa/koa-health-report

Koa health report (customisable) middleware
https://github.com/roppa/koa-health-report

health-check health-report healthcheck

Last synced: 29 days ago
JSON representation

Koa health report (customisable) middleware

Awesome Lists containing this project

README

        

[![CircleCI](https://circleci.com/gh/roppa/koa-health-report.svg?style=svg)](https://circleci.com/gh/roppa/koa-health-report)

## Koa Custom Health Report Middleware

Installation:

```javascript
const healthreport = require('koa-health-report');
```

The default path is `/health`:

```javascript
app.use(healthreport());
```

With a custom path:

```javascript
app.use(healthreport({ path: '/custompath' }));
```

With a custom report object (appended):

```javascript
app.use(healthreport({ custom: {
foo: 'bar',
bin: () => 'baz',
} }));
```