Simple Process Manager (SPaM)
SPAM is a module for simple node.js process management, and wraps the cluster module. It has nothing to do with email spam.
Use
Yarn is recommended as a package manager, but npm can be used as an alternative.
To install:
# install yarn if required npm install -g yarnyarn add spam
To create some processes, using the spawn method. This takes the following parameters:
- Configuration object
- number (number of processes to spawn, e.g. 4)
- timeout (time in milliseconds to allow each spawn to occur, before timing out)
- strategy (either 'series', or 'parallel', to spawn one at a time, or all together)
- readyOn (what signal indicates the script is ready, 'ready' or 'listening' - default)
- Callback when initialization of the module is complete
var spam = ; // to create 4 processes using the myscript.js script - ready on listen(),// created in parallel, with a timeout of 60 secondsspam;spam; // to create 2 processes callback is called when 'ready' message sent, not on 'listen'// created in series, with no timeoutspam;
If you want to log what's going on in SPAM
spam;
If you want to gracefully restart all the processes, by starting a new worker before killing the old worker, do this with the restart method.
// graceful restart of all the processesspam;
To stop all the processes:
// stop allspam;
NOTE: The scripts that are run, either need to run server.listen() or emit a specific 'ready' message. If they do not do this, then SPAM will assume they've not started and time them out. You can emit a 'ready' message using a convenience function or explicitly using process.send();
// using the signal modulevar signal = signal;signal; // using the process.send methodprocess;
Tests
To run the npm unit tests, install development dependencies and run tests with 'npm test' or 'make'.
# clone repo and install dependencies git clone git@github.com:iandotkelly/spam.gitcd spamyarn# run tests yarn test
Coverage can be measured after running the tests, and an html coverage report is written in the coverage/lcov-report
directory:
open coverage/lcov-report/index.html
If you contribute to the project, tests are written in mocha, using should.js or the node.js assert module.