139 lines
4.1 KiB
Markdown
139 lines
4.1 KiB
Markdown
# Cluster
|
|
|
|
[Cluster](http://learnboost.github.com/cluster) is an extensible multi-core server manager for [node.js](http://nodejs.org).
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
$ npm install cluster
|
|
```
|
|
|
|
## Features
|
|
|
|
- zero-downtime restart
|
|
- hard shutdown support
|
|
- graceful shutdown support
|
|
- resuscitates workers
|
|
- maintains worker count, even if worker was _SIGKILL_ed.
|
|
- workers commit suicide when master dies
|
|
- spawns one worker per cpu (by default)
|
|
- extensible via plugins
|
|
- bundled plugins
|
|
- [cli](http://learnboost.github.com/cluster/docs/cli.html): provides a command-line interface for your cluster
|
|
- [debug](http://learnboost.github.com/cluster/docs/debug.html): verbose debugging information
|
|
- [logger](http://learnboost.github.com/cluster/docs/logger.html): master / worker logs
|
|
- [pidfiles](http://learnboost.github.com/cluster/docs/pidfiles.html): writes master / worker pidfiles
|
|
- [reload](http://learnboost.github.com/cluster/docs/reload.html): reloads workers when files change
|
|
- [repl](http://learnboost.github.com/cluster/docs/repl.html): perform real-time administration
|
|
- [stats](http://learnboost.github.com/cluster/docs/stats.html): adds real-time statistics to the `repl` plugin
|
|
- supports node 0.2.x
|
|
- supports node 0.4.x
|
|
- supports TCP servers
|
|
|
|
## Example
|
|
|
|
app.js:
|
|
|
|
```javascript
|
|
var http = require('http');
|
|
|
|
module.exports = http.createServer(function(req, res){
|
|
console.log('%s %s', req.method, req.url);
|
|
var body = 'Hello World';
|
|
res.writeHead(200, { 'Content-Length': body.length });
|
|
res.end(body);
|
|
});
|
|
```
|
|
|
|
server.js:
|
|
|
|
```javascript
|
|
var cluster = require('cluster')
|
|
, app = require('./app');
|
|
|
|
cluster(app)
|
|
.use(cluster.logger('logs'))
|
|
.use(cluster.stats())
|
|
.use(cluster.pidfiles('pids'))
|
|
.use(cluster.cli())
|
|
.use(cluster.repl(8888))
|
|
.listen(3000);
|
|
```
|
|
|
|
Note that cluster does _not_ create these directories for you, so you may want to:
|
|
|
|
$ mkdir {logs,pids}
|
|
|
|
recommended usage: passing the path to prevent unnecessary database connections in the master process, as `./app` is only `require()`ed within the workers.
|
|
|
|
```javascript
|
|
var cluster = require('cluster');
|
|
|
|
cluster('./app')
|
|
.use(cluster.logger('logs'))
|
|
.use(cluster.stats())
|
|
.use(cluster.pidfiles('pids'))
|
|
.use(cluster.cli())
|
|
.use(cluster.repl(8888))
|
|
.listen(3000);
|
|
```
|
|
|
|
## Plugins
|
|
|
|
Below are the known 3rd-party plugins for cluster:
|
|
|
|
- [cluster-log](https://github.com/LearnBoost/cluster-log) remote logger powered by redis
|
|
- [cluster-mail](https://github.com/LearnBoost/cluster-mail) email exception notifications
|
|
- [cluster-exception](https://github.com/3rd-eden/cluster.exception) extensive exception notifications
|
|
- [cluster-responsetimes](https://github.com/mnutt/cluster-responsetimes) response time statistics for cluster's REPL
|
|
|
|
## Screencasts
|
|
|
|
- Cluster [Introduction](http://screenr.com/X8v)
|
|
|
|
## Running Tests
|
|
|
|
Install development dependencies:
|
|
|
|
```bash
|
|
$ npm install
|
|
```
|
|
|
|
Then:
|
|
|
|
```bash
|
|
$ make test
|
|
```
|
|
|
|
Actively tested with node:
|
|
|
|
- 0.4.9
|
|
|
|
## Authors
|
|
|
|
* TJ Holowaychuk
|
|
|
|
## License
|
|
|
|
(The MIT License)
|
|
|
|
Copyright (c) 2011 LearnBoost <dev@learnboost.com>
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining
|
|
a copy of this software and associated documentation files (the
|
|
'Software'), to deal in the Software without restriction, including
|
|
without limitation the rights to use, copy, modify, merge, publish,
|
|
distribute, sublicense, and/or sell copies of the Software, and to
|
|
permit persons to whom the Software is furnished to do so, subject to
|
|
the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be
|
|
included in all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |