Skip to content

Latest commit

 

History

History
72 lines (53 loc) · 2.06 KB

README.markdown

File metadata and controls

72 lines (53 loc) · 2.06 KB

monit

npm version Build Status Coverage Status Dependencies Status

The monit module provides a Node interface to interact with Monit management utility.

Instalation

npm install monit

Usage

Client

The Client class allows you to make requests to the Monit instance.

var Client = require('monit').Client;

var client = new Client({
  hostname: 'monit.myapp.com',
  username: 'admin',
  password: 'monit'
});

Options available

Name Default Description
hostname 'localhost' The host serving the Monit instance
port 2812 The port used to serve the Monit port
ssl false Wheter monit web is being served under SSL
username null Username to be used on authentication
password null Password to be used on authentication

Client.status

Retrieves the current status data from the Monit instance.

client.status()
  .then(function(result) {
    console.log(result.monit.server.localhostname);
  }).catch(function(err) {
    throw err;
  });

Client.action

Allows you to perform one of the Monit supported actions on a service. The supported actions are 'start', 'stop', 'restart', 'monitor' and 'unmonitor'. Both options service and action are required.

client.action({
  service: 'nginx',
  action: 'monitor'
}).then(function(response) {
  console.log('nginx monitoring was enabled!');
}).catch(function(err) {
  throw err;
});

MIT Licensed

See the LICENSE file for details.


Adones Cunha