Package Exports

os-monitor

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (os-monitor) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

os-monitor

A very simple monitor around the built-in os module in Node.js.

Allows you to observe some OS parameters, such as free memory available or load average.

Installation

npm install os-monitor

Synopsis

var osm = require("os-monitor");


// basic usage
osm.start();

// more advanced usage with configs.
osm.start({ delay: 3000 // interval in ms between monitor cycles
          , freemem: 1000000000 // amount of memory in bytes under which event 'freemem' is triggered (can also be a percentage of total mem)
          , critical1: 0.7 // value of 1 minute load average over which event 'loadavg1' is triggered
          , critical5: 0.7 // value of 5 minutes load average over which event 'loadavg5' is triggered
          , critical15: 0.7 // value of 15 minutes load average over which event 'loadavg15' is triggered
          });

// define handler for a too high 1-minute load average
osm.on('loadavg1', function(event) {
  console.log(event.type, ' Load average is exceptionally high!');
});

// define handler for a too low free memory
osm.on('freemem', function(event) {
  console.log(event.type, 'Free memory is very low!');
});

// define handler that will always fire every cycle
osm.on('monitor', function(event) {
  console.log(event.type, ' This event always happens on each monitor cycle!');
});

// change config while monitor is running
osm.config({
  freemem: 0.3 // alarm when 30% or less free memory available
});

// stop monitor
osm.stop();

// check either monitor is running or not
osm.isRunning(); // -> true / false

Event object

There is some useful information in the provided event object:

{
  type: 'monitor', // event type
  loadavg: [ 0.4599609375, 0.53076171875, 0.4990234375 ], // load average values for 1, 5, 15 minutes
  uptime: 1614056, // os uptime in seconds
  freemem: 241262592, // free memory available in bytes
  totalmem: 2147483648 // total memory available in bytes
}

All supported events are: 'monitor', 'freemem', 'loadavg1', 'loadavg5', 'loadavg15', 'start', 'stop', 'config'.

Node.js os module

The node os built-in module is also available from the os-monitor object:

var osm = require('os-monitor');

var type = osm.os.type();
var cpus = osm.os.cpus();

Documentation for the os module is available here.