health-middleware

RFC-compliant Health Middleware for HTTP APIs written in Node

Usage no npm install needed!

<script type="module">
  import healthMiddleware from 'https://cdn.skypack.dev/health-middleware';
</script>

README

Node Health Middleware

Implementation Status

Express/Connect
Sails.js
Restify

Installation

> npm i -S health-middleware

Usage

const healthcheck = require('health-middleware');

// If you need/want to add custom health checker functions:
healthcheck.addCheck('cassandra', 'timeout', async() => {
    // Faking data here, for brevity
    return {
        status : 'pass',
        metricValue: 250,
        metricUnit: "ms"
    };
});

// Add middleware to your Express app:
app.use(healthcheck());

License