@godaddy/terminus

[![Build Status](https://travis-ci.org/godaddy/terminus.svg?branch=master)](https://travis-ci.org/godaddy/terminus)

1.0.0
Source
npm

Version published: 7 years ago

Maintainers: 1

Created: 7 years ago

What is @godaddy/terminus?

@godaddy/terminus is a Node.js package that helps manage graceful shutdowns and health checks for your applications. It ensures that your application can handle termination signals properly, allowing for clean shutdowns and preventing data corruption or loss. It also provides endpoints for health checks to monitor the application's status.

What are @godaddy/terminus's main functionalities?

Graceful Shutdown

This feature allows the application to handle termination signals gracefully. When a termination signal (e.g., SIGINT) is received, the `onSignal` function is called to perform any necessary cleanup before the server shuts down.

const http = require('http');
const { createTerminus } = require('@godaddy/terminus');

const server = http.createServer((req, res) => {
  res.end('Hello world!');
});

function onSignal() {
  console.log('Server is starting cleanup');
  // start cleanup of resource, like databases or file descriptors
  return Promise.resolve();
}

function onShutdown() {
  console.log('Cleanup finished, server is shutting down');
}

createTerminus(server, {
  signal: 'SIGINT',
  onSignal,
  onShutdown
});

server.listen(3000);

Health Checks

This feature provides a health check endpoint that can be used to monitor the application's status. The `onHealthCheck` function can include logic to determine if the application is healthy and return a promise that resolves if it is.

const http = require('http');
const { createTerminus } = require('@godaddy/terminus');

const server = http.createServer((req, res) => {
  res.end('Hello world!');
});

function onHealthCheck() {
  return Promise.resolve(); // optionally include a health check here
}

createTerminus(server, {
  healthChecks: {
    '/healthcheck': onHealthCheck
  }
});

server.listen(3000);

Other packages similar to @godaddy/terminus

terminus

Adds graceful shutdown and Kubernetes readiness / liveness checks for any HTTP applications.

Usage

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);

With express

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);

With koa

const http = require('http');
const Koa = require('koa');
const app = new Koa();

const server = http.createServer(app.callback());

terminus(server, {
  //opts
});

server.listen(3000);

FAQs

What is @godaddy/terminus?

Is @godaddy/terminus well maintained?

Package last updated on 30 Nov 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install