# monitor-plugin-os

> Middleware plugin which collects OS metrics.

Latest version **1.0.0** (published 2014-10-17) · 0 weekly downloads

## Install

```sh
npm install monitor-plugin-os
pnpm add monitor-plugin-os
yarn add monitor-plugin-os
bun add monitor-plugin-os
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2014-10-17 |
| First published | 2014-10-17 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Athan Reines |
| Maintainers | kgryte |
| Keywords | connect, middleware, express, monitor, application, os, metrics, performance, plugin |

## Links

- npm: https://www.npmjs.com/package/monitor-plugin-os
- Repository: https://github.com/kgryte/monitor-plugin-os
- Issues: https://github.com/kgryte/monitor-plugin-os/issues
- npm.io page: https://npm.io/package/monitor-plugin-os

## Dependencies (1)

- [metrics-os](https://npm.io/package/metrics-os.md) ^1.0.0

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2014-10-17
- 0.0.0 — 2014-10-17

## README

OS Metrics
==========
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Dependencies][dependencies-image]][dependencies-url]

> Middleware plugin which collects OS metrics.


## Installation

``` bash
$ npm install monitor-plugin-os
```

## Usage

To use the module,

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

The module exports the following method...


#### plugin( obj, clbk )

Appends [system metrics](https://github.com/kgryte/node-metrics-os) to an `object` and then invokes the provided callback.

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


## Examples

``` javascript
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,

``` bash
$ 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](http://mochajs.org/) test framework with [Chai](http://chaijs.com) assertions. To run the tests, execute the following command in the top-level application directory:

``` bash
$ make test
```

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


### Test Coverage

This repository uses [Istanbul](https://github.com/gotwarlost/istanbul) as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

``` bash
$ make test-cov
```

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

``` bash
$ make view-cov
```



## License

[MIT license](http://opensource.org/licenses/MIT). 


---
## Copyright

Copyright © 2014. Athan Reines.


[npm-image]: http://img.shields.io/npm/v/monitor-plugin-os.svg
[npm-url]: https://npmjs.org/package/monitor-plugin-os

[travis-image]: http://img.shields.io/travis/kgryte/monitor-plugin-os/master.svg
[travis-url]: https://travis-ci.org/kgryte/monitor-plugin-os

[coveralls-image]: https://img.shields.io/coveralls/kgryte/monitor-plugin-os/master.svg
[coveralls-url]: https://coveralls.io/r/kgryte/monitor-plugin-os?branch=master

[dependencies-image]: http://img.shields.io/david/kgryte/monitor-plugin-os.svg
[dependencies-url]: https://david-dm.org/kgryte/monitor-plugin-os

[dev-dependencies-image]: http://img.shields.io/david/dev/kgryte/monitor-plugin-os.svg
[dev-dependencies-url]: https://david-dm.org/dev/kgryte/monitor-plugin-os

[github-issues-image]: http://img.shields.io/github/issues/kgryte/monitor-plugin-os.svg
[github-issues-url]: https://github.com/kgryte/monitor-plugin-os/issues

---
_Source: https://npm.io/package/monitor-plugin-os · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._