hapi-lbstatus
v3.0.4
Published
lbstatus plugin for hapi
Downloads
5
Readme
Shared code for the _lbstatus
endpoint. Essentially a poor-man's service discovery, will be used until the front-door service is ready.
Reads the specified file and looks for the value 'ON' or 'OFF' and returns ON or OFF from the endpoint.
If the file is missing, or empty, or an exception occurs, then default value is OFF.
Also performs a liveness check by injecting a request to a specified endpoint (using server.inject). If the response is an error (or times out) it returns "OFF".
Installation:
npm install hapi-lbsstatus
Usage:
var server = hapi.createServer();
server.pack.require("hapi-lbstatus",
{
file: '/etc/lbstatus/myappname',
liveness: '/my/api/123',
headers: {
// optional headers to apply when making the liveness check
'accept-language': 'en-US'
},
on: "MYAPP_ON", // override the default return value of 'ON'
off: "MYAPP_OFF" // override the default return value of 'OFF'
},
function (err){
if(err){
throw err;
}
}
);
// also exposes the lbstatus function
server.plugins['hapi-lbstatus'].lbstatus(function(on){
// returns true if ON, false if OFF
});
Response Codes:
- ON: 200
- OFF: 503
Notes:
- Supports pack servers as well as single instances
- Supports hapi v5+