monitor-plugin-os v1.0.0

OS Metrics

Middleware plugin which collects OS metrics.

Installation

$ npm install monitor-plugin-os

Usage

To use the module,

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

The module exports the following method...

plugin( obj, clbk )

Appends system metrics to an object and then invokes the provided callback.

plugin( {}, function next() {});

Examples

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

// Initialize a monitor object:
var monitor = {};

// Run the plugin:
plugin( monitor, function next() {
	console.log( JSON.stringify( monitor ) );
});

To run the example code from the top-level application directory,

$ node ./examples/index.js

Notes

The plugin will append a system property to the provided object. If a system property already exists, the property value will be overwritten.

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

Copyright

Copyright © 2014. Athan Reines.