Description

monitor vital signs of your server :

- CPU usage %
- RAM usage %

nodejs-system-info

[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]

Installation

One line installation with npm.

``bash
$ npm i nodejs-system-info --save
`
Then in your code

Example

`js
var systemInformation = require('nodejs-system-info');

const INTERVAL = 500;

const systemMonitor = new systemInformation(INTERVAL);

systemMonitor.log(['cpu', 'ram']);

`




Configuration

require('nodejs-system-info').options

Default settings:

- cpu display CPU usage percentage.
- ram display RAM usage percentage.
- INTERVAL is 500 millisecond. Represents the refresh of the cpu and ram usage.

:warning: If this module uses too much CPU, set the INTERVAL value to 10000 or more.

Info

If you have not supported in some categories, your OS configuration is not supported for this option.

Usage

The following methods are available:

$3

`js
var systemInformation = require('nodejs-system-info');

const INTERVAL = 500;

const systemMonitor = new systemInformation();

setInterval(() => {
console.log(systemMonitor.get(['cpu']));
}, INTERVAL);
`


$3

CPU average

`js
var systemInformation = require('nodejs-system-info');

const INTERVAL = 500;

const systemMonitor = new systemInformation(INTERVAL);

systemMonitor.log(['cpu']);

`
`
Interval: 500
CPU_Usage: 20.65%
`

RAM average

`js
var systemInformation = require('nodejs-system-info');

const INTERVAL = 500;

const systemMonitor = new systemInformation(INTERVAL);

systemMonitor.log(['ram']);

`
`
Interval: 500
RAM_Usage: 77.91%
`

$3


`js
const SystemInformation = require('nodejs-system-info');
const commandLineArgs = require('command-line-args');

const DEFAULT_MONITOR_OPTIONS = ['cpu', 'ram'];

const optionDefinitions = [
{ name: 'interval', alias: 't', type: Number },
{ name: 'params', type: String, multiple: true, defaultOption: true }
];
const options = commandLineArgs(optionDefinitions);

const systemMonitor = new SystemInformation(options.interval);

systemMonitor.log(options.params || DEFAULT_MONITOR_OPTIONS);
`


Terminal Commands


`bash
node monitor.js (Default interval = 500ms, params = ram, cpu)

(Custom set interval ---interval )
node monitor.js --interval 1000

(Custom interval and params default ram and cpu )
node monitor.js --interval 500 --params ram cpu
``

License

MIT. Copyright (c).

[npm-image]: https://img.shields.io/npm/v/node-os-utils.svg
[npm-url]: https://www.npmjs.com/package/node-os-utils
[downloads-image]: https://img.shields.io/npm/dt/node-os-utils.svg
[downloads-url]: https://npmjs.org/package/node-os-utils

Authors

* Donatas Kuskys