npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

awesome-graceful-cluster

v0.1.3

Published

Gracefully restart node.js http cluster with zero downtime. Shutdown server without active inbound connections reset.

Downloads

7

Readme

Awesome Graceful Cluster

  • This repo is folked from graceful-cluster to add support of graceful server shotdown (if remaing connection, not shutting down soon).
  • This repo is very EXPERIMENTAL and not well documented yet. if you consider to use in production, please be careful.
  • I only change 'graceful-cluster.js' file from original source code;

Install:

npm install awesome-graceful-cluster

How to use

1. Enable graceful server shutdown

This patch will prevent active connections reset when server receives SIGKILL or SIGTERM. Idle (keep-alive) inbound connections without active requests will be destroyed.

Example 'server.js':

// Example server with 'express'.
var express = require('express');
var app = express();
var listener = app.listen(8000);

var GracefulServer = require('awesome-graceful-cluster').GracefulServer;
var gracefulServer = new GracefulServer({
    server: listener,
    shutdownTimeout: 10 * 1000,             // 10 sec.
});

GracefulServer options description:

| option | info | ------------------------ | --- |log | function, custom log function, console.log used by default. |server | required, http server instance. |shutdownTimeout | ms, force worker shutdown on SIGTERM timeout. Defaults to 5000ms.

Also you can initiate graceful shutdown when needed:

gracefulServer.shutdown();

2. Use simplified cluster initialization

This cluster wrapper will send SIGTERM signal to workers and wait till they finished all requests.

Also it can gracefully restart all workers one by one with zero cluster downtime on some conditions:

  1. Worker memory used.
  2. Worker time online.
  3. Your custom condition: just call GracefulCluster.gracefullyRestartCurrentWorker() to restart current worker in serverFunction.
  4. On SIGUSR2 signal to cluster process.

Example 'cluster.js':

var GracefulCluster = require('awesome-graceful-cluster').GracefulCluster;

process.title = '<your-cluster-title>';     // Note, process title must be near filename (cluster.js) length, longer title truncated.

GracefulCluster.start({
    shutdownTimeout: 10 * 1000,             // 10 sec.
    restartOnTimeout: 5 * 3600 * 1000,      // 5 hours.
    restartOnMemory: 150 * 1024 * 1024,     // 150 MB.
    serverFunction: function() {  // Your 'server.js' code module with server logic. you must return [server, app]
        var express = require('express');
        var app = express();
        var server = app.listen(8000);
        return [server, app];
    }         
});

Example 'app.js': (insert kind of below code so that you can close existing connection)

...
    app.use(function(req, res, next){
        if (app.get('graceful_shutdown') === true) {
            console.log('Connection:close header was sent.')
            res.set('Connection', 'close');
        }
        next();
    });
...

GracefulCluster options description:

| option | info | ------------------------ | --- | disableGraceful | disable graceful shutdown for faster debug. | exitFunction | optional, function that is called when the master needs to exit. The default function exits with exit code 0. | log | function, custom log function, console.log used by default. | restartOnMemory | bytes, optional. restart worker on memory usage. | restartOnTimeout | ms, optional. restart worker by timer. | serverFunction | required, function with worker logic. | shutdownTimeout | ms, optional. force worker shutdown on SIGTERM timeout. Defaults to 5000ms. | workersCount | workers count, if not specified os.cpus().length will be used. | minimumWorkerProcessHealthPercent | represents a lower limit on the number of worker servers that must remain in the RUNNING state during restarting, as a percentage of the desired number of servers . | workerProcessDisconnectDelay | worker process graceful showdown delay time. | workerProcessForceShutdownTimeout | worker process force showdown timeout (after workerProcessDisconnectDelay time).

Gracefully restart cluster

Graceful restart performed by USR2 signal:

pkill -USR2 <your-cluster-title>

or

kill -s SIGUSR2 <cluster-pid>

This method is also good if your app is launched with forever:

forever start cluster.js

Using with PM2

If you prefer PM2 you should use 'server.js' patch only. This will force PM2 to wait until active connections are closed when using:

pm2 reload <id>

With PM2 graceful reload don`t forget to set important process parameters:

  • "instances": 0 - use cluster with multiple instances, so one instance will still work when another is reloaded.
  • "kill_timeout": 5000 - wait more time to allow active connections finish their responses.