• Stars
    star
    156
  • Rank 234,889 (Top 5 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created almost 10 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

cluster fork and restart easy way

cfork

NPM version build status Test coverage Known Vulnerabilities npm download

cluster fork and restart easy way.

  • Easy fork with worker file path
  • Handle worker restart, even it was exit unexpected.
  • Auto error log process uncaughtException event

Install

$ npm install cfork --save

Usage

Example

const cfork = require('cfork');
const util = require('util');

cfork({
  exec: '/your/app/worker.js',
  // slaves: ['/your/app/slave.js'],
  // count: require('os').cpus().length,
})
.on('fork', worker => {
  console.warn('[%s] [worker:%d] new worker start', Date(), worker.process.pid);
})
.on('disconnect', worker => {
  console.warn('[%s] [master:%s] wroker:%s disconnect, exitedAfterDisconnect: %s, state: %s.',
    Date(), process.pid, worker.process.pid, worker.exitedAfterDisconnect, worker.state);
})
.on('exit', (worker, code, signal) => {
  const exitCode = worker.process.exitCode;
  const err = new Error(util.format('worker %s died (code: %s, signal: %s, exitedAfterDisconnect: %s, state: %s)',
    worker.process.pid, exitCode, signal, worker.exitedAfterDisconnect, worker.state));
  err.name = 'WorkerDiedError';
  console.error('[%s] [master:%s] wroker exit: %s', Date(), process.pid, err.stack);
})

// if you do not listen to this event
// cfork will output this message to stderr
.on('unexpectedExit', (worker, code, signal) => {
  // logger what you want
});

// emit when reach refork times limit
.on('reachReforkLimit', () => {
  // do what you want
});

// if you do not listen to this event
// cfork will listen it and output the error message to stderr
process.on('uncaughtException', err => {
  // do what you want
});

Options

  • exec : exec file path
  • slaves : slave process config
  • args : exec arguments
  • count : fork worker nums, default is os.cpus().length
  • refork : refork when worker disconnect or unexpected exit, default is true
  • limit: limit refork times within the duration, default is 60
  • duration: default is 60000, one minute (so, the refork times < limit / duration)
  • autoCoverage: auto fork with istanbul when running_under_istanbul env set, default is false
  • env: attach some environment variable key-value pairs to the worker / slave process, default to an empty object.
  • windowsHide: Hide the forked processes console window that would normally be created on Windows systems, default to false.
  • serialization: Specify the kind of serialization used for sending messages between processes. Possible values are 'json' and 'advanced'. See Advanced serialization for child_process for more details. Default: false.

License

(The MIT License)

Copyright (c) 2014 - 2017 node-modules and other contributors

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.

Contributors


fengmk2


greenkeeperio-bot


dead-horse


JacksonTian


luckydrq


XadillaX


popomore


hemanth


qingdengyue


jpuncle


hustxiaoc


nightink


paranoidjk


sinkhaha

This project follows the git-contributor spec, auto updated at Sat May 06 2023 00:30:47 GMT+0800.

More Repositories

1

utility

A collection of useful utilities.
TypeScript
1,239
star
2

parameter

A parameter verify tools.
JavaScript
727
star
3

urllib

Request HTTP(s) URLs in a complex world.
TypeScript
725
star
4

agentkeepalive

Support keepalive http agent.
JavaScript
571
star
5

emoji

emoji: This library allows the handling and conversion of Emoji in Javascript.
HTML
502
star
6

weibo

weibo nodejs sdk
JavaScript
489
star
7

compressing

Everything you need for compressing and uncompressing
JavaScript
424
star
8

detect-port

Node.js module to detect available ports of the system.
JavaScript
376
star
9

qn

Another qiniu http://docs.qiniu.com/api/ API client for Node.js.
JavaScript
274
star
10

graceful

Graceful exit when `uncaughtException` emit, base on `process.on('uncaughtException')`.
JavaScript
249
star
11

address

Get current machine IP and MAC address.
TypeScript
228
star
12

autod

Auto generate dependencies and devDependencies by parse the project file.
JavaScript
205
star
13

js-to-java

easy way to wrap js object to java object
JavaScript
201
star
14

common-bin

Abstraction bin tool
JavaScript
189
star
15

hessian.js

js hessian binary web service protocol, support communicate with java
JavaScript
183
star
16

mm

An simple but flexible mock(or say stub) package, mock mate
JavaScript
158
star
17

formstream

multipart/form-data encoded stream, helper for file upload.
JavaScript
145
star
18

urlencode

encodeURIComponent with charset
TypeScript
142
star
19

cluster-client

Sharing Connection among Multi-Process Nodejs
JavaScript
131
star
20

webcamera

网页截图工具 (by phantomjs)
JavaScript
124
star
21

is-type-of

complete type checking for node
TypeScript
122
star
22

coffee

Test command line on Node.js
JavaScript
97
star
23

clet

Command Line E2E Testing
JavaScript
76
star
24

byte

Input Buffer and Output Buffer, just like Java ByteBuffer
JavaScript
76
star
25

sdk-base

a base class for sdk with default error handler
JavaScript
62
star
26

china-mobile-phone-regexp

The regular expressions for China mobile phone number.
JavaScript
60
star
27

mz-modules

Same as `mz`, but wrap modules in the world rather than core API.
JavaScript
56
star
28

thunkify-wrap

a more powerful thunkify
JavaScript
55
star
29

ots

This project no longer maintained, please use https://github.com/ali-sdk/ots2 instead.
JavaScript
48
star
30

urllib-sync

sync http request
JavaScript
44
star
31

stream-wormhole

Pipe ReadStream to a wormhole
TypeScript
42
star
32

copy-to

copy an object's properties to another one
JavaScript
41
star
33

optimized

Detect a function can be optimized or not.
JavaScript
41
star
34

runscript

Run script easy!
JavaScript
41
star
35

await-stream-ready

a promise waiting stream ready
JavaScript
34
star
36

charset

Get the content charset from header and html content-type.
JavaScript
34
star
37

ab

A benchmark tool.
JavaScript
33
star
38

npm-updater

Prompt update of npm package
JavaScript
32
star
39

java.io

A Node.js implement of "java.io.InputObjectStream.readObject()" and "java.io.OutputObjectStream.writeObject()"
JavaScript
31
star
40

humanize-ms

transform humanize time to ms
JavaScript
30
star
41

graceful-process

graceful exit process even parent exit on SIGKILL.
JavaScript
29
star
42

node-murmurhash

murmurhash, support utf8 Buffer
JavaScript
27
star
43

sendmessage

Send a cross process message if message channel is connected.
JavaScript
27
star
44

shameimaru

Shameimaru Aya likes to traverse node_modules and capture the tree.
JavaScript
26
star
45

ready-callback

Launch server after all async task ready
TypeScript
26
star
46

tcp-base

TCP client base
JavaScript
25
star
47

serialize-json

A serialize algorithm for JSON
JavaScript
23
star
48

js-remoting-for-apache-dubbo

dubbo protocol implement
JavaScript
22
star
49

loading

loading dir files as module to an object
JavaScript
20
star
50

zookeeper-cluster-client

Sharing one zookeeper connection among Multi-Process on Node.js
JavaScript
20
star
51

tnpm

JavaScript
19
star
52

enable

Detect es6 features enable or not.
JavaScript
19
star
53

last-commit-log

Node.js module to get the last git commit information - mostly to be used by CI/CD and building phase.
JavaScript
19
star
54

jdwp

Java Debug Wire Protocol
JavaScript
18
star
55

time-profile

Measuring execution time of functions
JavaScript
16
star
56

qps

High performance qps counter
JavaScript
15
star
57

cluster-reload

Easy and safe reload your workers.
JavaScript
14
star
58

await-first

Wait the first event in a set of event pairs, then clean up after itself.
JavaScript
14
star
59

buffer-type

Detect content-type from Buffer data.
JavaScript
14
star
60

pedding

Just pedding for callback.
JavaScript
13
star
61

should2assert

A tool to help you migrating from should to assert
JavaScript
13
star
62

save-file-atomic

Save anything to file atomic
JavaScript
13
star
63

wt

wt: Simple dir watcher, support events
JavaScript
13
star
64

zlogger

The last console logger
JavaScript
12
star
65

logfilestream

Log stream, including auto rolling feature, support multiprocess `append` write at the same time.
JavaScript
12
star
66

dns-hijacking

JavaScript
11
star
67

default-user-agent

Default user agent string for Node.js http request
JavaScript
11
star
68

jsonp-body

Helper to create more safe jsonp response body for koa and other web framework.
JavaScript
10
star
69

zookeeper-watcher

Extend node-zookeeper-client, let zookeeper client support `watch(path)` method.
JavaScript
10
star
70

weibo-mid

Convert Weibo Open API mid to base62 hash string.
JavaScript
10
star
71

connection

JavaScript
10
star
72

enums

JavaScript
9
star
73

node-homedir

Get the effective user's homedir
TypeScript
9
star
74

rid

Request Unique ID, base on current server `ip`, `process.pid` and auto increase id, like `$ip,$pid,$id`
JavaScript
9
star
75

error-formatter

format an error into string or json for log
JavaScript
8
star
76

auto-correct

auto correct for command line tools
JavaScript
8
star
77

install-node

Install node into node_modules
JavaScript
8
star
78

digest-header

Digest access authentication header helper
JavaScript
8
star
79

http-doctor

HTTP doctor
JavaScript
7
star
80

vmto

velocity(vm) to any other templates.
JavaScript
7
star
81

restful-client

RESTFul api client base object. Usually use by some api client implementation.
JavaScript
6
star
82

diskstore

a local cache implement
JavaScript
6
star
83

koa-override

method override middleware for koa
JavaScript
6
star
84

memory-tripwire

suicide when memory over the limit
JavaScript
5
star
85

urlmock

Easy load mock data from a specify url.
JavaScript
5
star
86

performance-ms

performance timer in ms
TypeScript
4
star
87

common-bin-plus

advanced common-bin for cli usage
JavaScript
4
star
88

aggregate-base

Base class for aggregate operation
JavaScript
4
star
89

watch-files

watch files by polling
JavaScript
3
star
90

oss-syncer

synchronization all files from this bucket to another bucket
JavaScript
3
star
91

common-boilerplate

base class for boilerplate
JavaScript
3
star
92

fileloader

more stable file loader for nunjucks, and support charsets like `gbk`.
JavaScript
3
star
93

assert-file

assert file utilities
JavaScript
3
star
94

changing

Watching `file`, `dir` or `link` changing, using interval timer.
JavaScript
3
star
95

speeds

Speeds controllable stream. You can control the downstream speed on your own.
JavaScript
3
star
96

cov

Mocha Coverage report store on CDN.
JavaScript
3
star
97

onelogger

The only ONE logger
TypeScript
3
star
98

sse-decoder

SSE decoder for nodejs
TypeScript
3
star
99

fast-ua-parser

A Fast JavaScript library to detect user's Browser, Engine, OS, CPU, and Device type/model
2
star
100

get-ready

NodeJS mixin to add one-time ready event
TypeScript
2
star