probiotic v1.0.3

probiotic

The simplified multi-workers daemon

(For a featureful cousin of Probiotic see Progenic)

Table of Contents

• Table of Contents
• Getting Started
• Requirements
• Options

Getting Started

Install the module with: npm install probiotic
Then use it in your code to start a service with as many workers as needed:

const probiotic = require('probiotic');

probiotic.run({
    name:         'myServiceName',
    main:         'path/to/myServiceScript.js',
    logsBasePath: '/mnt/logs-volume',
    workers:      4
});

Requirements

Probiotic requires NodeJS 4.5.0+ and can be istalled via NPM:

npm install probiotic
# or:
npm install --save probiotic

Options

The mandatory name parameter is the name the service will be started with. It affects the process' PID file name (under /var/run) as well as the log files names.

The mandatory main parameter points to the JS file that is actually the service code.
This code will be spawned exactly workers-times in different processes children of the service containing the probiotic code.

The optional workers parameter tells probiotic how many workers ave to be spawn. When omitted probiotic will assume the value 'auto', spawning exactly require('os').cpus().length - 1 workers (i.e. the number of CPUs of the system minus 1).

The optional logsBasePath parameter specifies the path where log files are created. By default your service will have log files created under /var/log.
Probiotic will create one log file for the master process and one for each of the children workers.