mon

monit

Node interface for Monit

Showing:

Popularity

Downloads/wk

6

GitHub Stars

3

Maintenance

Last Commit

6yrs ago

Contributors

0

Package

Dependencies

4

Size (min+gzip)

257.7KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

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

NameDefaultDescription
hostname'localhost'The host serving the Monit instance
port2812The port used to serve the Monit port
sslfalseWheter monit web is being served under SSL
usernamenullUsername to be used on authentication
passwordnullPassword 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[0].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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100