Adds graceful shutdown and Kubernetes readiness / liveness checks for any HTTP applications.
Install via npm:
$ npm i @godaddy/terminus --saveconst http = require('http');
const terminus = require('@godaddy/terminus');
function onSignal () {
console.log('server is starting cleanup');
return Promise.all([
// your clean logic, like closing database connections
]);
}
function onShutdown () {
console.log('cleanup finished, server is shutting down');
}
const server = http.createServer((request, response) => {
response.end('<html><body><h1>Hello, World!</h1></body></html>');
})
terminus(server, {
// healtcheck options
healthChecks: {
'/healthcheck': check // a promise returning function indicating service health
},
// cleanup options
timeout: 1000, // [optional = 5000] number of milliseconds before forcefull exiting
signal, // [optional = 'SIGTERM'] what signal to listen for relative to shutdown
onSignal, // [optional] cleanup function, returning a promise (used to be onSigterm)
onShutdown, // [optional] called right before exiting
// both
logger // [optional] logger function to be called with errors
});
server.listen(PORT);const http = require('http');
const app = express();
app.get('/', (req, res) => {
res.send('ok');
});
const server = http.createServer(app);
terminus(server, {
// opts
});
server.listen(3000);const http = require('http');
const Koa = require('koa');
const app = new Koa();
const server = http.createServer(app.callback());
terminus(server, {
//opts
});
server.listen(3000);Due to inherent platform limitations, terminus has limited support for Windows.
You can expect SIGINT to work, as well as SIGBREAK and to some extent SIGHUP.
However SIGTERM will never work on Windows because killing a process in the task manager is unconditional, i.e., there's no way for an application to detect or prevent it.
Here's some relevant documentation from libuv to learn more about what SIGINT, SIGBREAK etc. signify and what's supported on Windows - http://docs.libuv.org/en/v1.x/signal.html.
Also see https://nodejs.org/api/process.html#process_signal_events.
![greenkeeper[bot] avatar](https://avatars.githubusercontent.com/in/505?v=4 "greenkeeper[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent