Skip to content

Commit

Permalink
docs: changes
Browse files Browse the repository at this point in the history
  • Loading branch information
lfortin committed Jan 26, 2015
1 parent ec90168 commit 1f5cbc6
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Expand Up @@ -68,7 +68,7 @@ monitor.config({
monitor.stop();


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


Expand All @@ -95,6 +95,8 @@ Number of seconds over which event 'uptime' is triggered. Default: undefined

Value of 1 minute load average over which event 'loadavg1' is triggered. Default: os.cpus().length

(The load average is a measure of system activity, calculated by the operating system and expressed as a fractional number. As a rule of thumb, the load average should ideally be less than the number of logical CPUs in the system. ref.: [http://nodejs.org/api/os.html#os_os_loadavg](http://nodejs.org/api/os.html#os_os_loadavg "load average"))

### critical5

Value of 5 minutes load average over which event 'loadavg5' is triggered. Default: os.cpus().length
Expand Down Expand Up @@ -128,7 +130,7 @@ Stops the monitor.

### .isRunning( )

Checks either the monitor is running or not; returns a boolean.
Checks whether the monitor is running or not; returns a boolean.

### .config( [options] )

Expand Down

0 comments on commit 1f5cbc6

Please sign in to comment.