Nomnom Pumpernickle Muffins
    Wondering what’s next for npm?Check out our public roadmap! »

    express-health-route

    1.0.1 • Public • Published

    express-health-route

    Minimal express route that check some remote services status periodically based on ip + port and return their status as JSON

    Usage

     
    var express = require('express');
     
    var getHealthRoute = require('./getHealthRoute');
     
    var services = require('./services.json');
     
    var app = express();
     
    app.get('/', getHealthRoute(services));
     
    var port = 6789;
     
    app.listen(port, function() {
        console.log('Listening on port %d', port);
    });

    Sample services list

    [{
        "id": "some website",
        "ip": "212.27.48.10",
        "port": 80
    },{
        "id": "google DNS",
        "ip": "8.8.8.8",
        "port": 53
    },{
        "id": "invalid service",
        "ip": "1.2.3",
        "port": 9999
    }]

    Sample API output :

    Notice the "up" key

    [{
        "id": "some website",
        "ip": "212.27.48.10",
        "port": 80,
        "up": true
    },{
        "id": "google DNS",
        "ip": "8.8.8.8",
        "port": 53,
        "up": true
    },{
        "id": "invalid service",
        "ip": "1.2.3",
        "port": 9999,
        "up": false
    }]

    Install

    npm i express-health-route

    DownloadsWeekly Downloads

    1

    Version

    1.0.1

    License

    MIT

    Last publish

    Collaborators

    • avatar