alarmist

alarmist

IN DEVELOPMENT - to be released fully functional any minute now :)

Monitor parallel jobs

Install

npm install --save-dev alarmist

CLI

Execute a job

alarmist exec -g group -n name -c my-command

Monitor a group

alarmist monitor -g group

API

var alarmist = require('alarmist');

Custom jobs

Create a job.

alarmist.createJob({
  group: 'group',
  name: 'name'
}).then(function(job) {
  ...
});

The job will expose stdout and stdin write streams that you can use for logging.

job.stdout.write('this gets recorded as stdout');
job.stderr.write('this gets recorded as stderr');

When the job is complete call the complete method to signal success or failure with an exit code.

job.complete({
  exitCode: 0
}).then(function() {
  ...
});

Execute a job

alarmist.exec({
  group: 'group',
  name: 'name',
  command: 'my-command'
}).then(function() {
  ...
});

Monitor a group

Start a monitor

alarmist.createMonitor({
  group: 'group'
}).then(function(monitor) {
  ...
});

Listen for start events

monitor.on('start', function(job) {
  console.log(job.id);
  console.log(job.name);
  console.log(job.startTime);
});

Listen for complete events

monitor.on('complete', function(job) {
  console.log(job.id);
  console.log(job.name);
  console.log(job.startTime);
  console.log(job.endTime);
  console.log(job.exitCode);
  console.log(job.stdout);
  console.log(job.stderr);
  console.log(job.all);
});

Stop a monitor

monitor.close();

Contributing

Run tests, etc before pushing changes/opening a PR

• npm test - lint and test
• npm run build - run tests then build
• npm run watch - watch for changes and run build
• npm run ci - run build and submit coverage to coveralls