@godaddy/terminus
Version:
[](https://travis-ci.org/godaddy/terminus)
80 lines (57 loc) • 1.73 kB
Markdown
[](https://travis-ci.org/godaddy/terminus)
Adds graceful shutdown and Kubernetes readiness / liveness checks for any HTTP applications.
```javascript
const http = require('http');
const terminus = require('@godaddy/terminus');
function onSigterm () {
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 indicating service health
},
// cleanup options
timeout: 1000, // [optional = 5000] number of milliseconds before forcefull exiting
onSigterm, // [optional] clenaup function, returning a promise
onShutdown, // [optional] called right before exiting
// both
logger // [optional] logger function to be called with errors
});
server.listen(PORT);
```
```javascript
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);
```
```javascript
const http = require('http');
const Koa = require('koa');
const app = new Koa();
const server = http.createServer(app.callback());
terminus(server, {
//opts
});
server.listen(3000);
```