https://github.com/ecto/ekg
advanced process analytics for node.js
https://github.com/ecto/ekg
Last synced: 4 months ago
JSON representation
advanced process analytics for node.js
- Host: GitHub
- URL: https://github.com/ecto/ekg
- Owner: ecto
- Created: 2011-11-01T16:46:16.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2011-11-15T22:41:14.000Z (over 14 years ago)
- Last Synced: 2025-09-30T05:59:17.612Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 104 KB
- Stars: 12
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ekg
advanced process analytics for monitoring node.js runtime health
# install
npm install ekg
# usage
The public ekg object is an EventEmitter. All data will be available through emissions.
Call the ekg.start(interval) function to begin emitting events.
````javascript
var ekg = require('ekg').start(50);
ekg.on('memory', function(memory){
var threshold = memory.total * 0.8;
if (memory.free < threshold) {
console.log('Process is consuming more than 80% of total system memory. Exiting.');
process.exit();
}
});
ekg.on('cpu', function(cpu){
console.log('Processor 1 has idled for ' + cpu[0].idle + ' cycles.');
});
ekg.on('proc', function(proc){
if (proc.cpuPercent > 80) {
console.log('Process is consuming more than 80% of CPU. Exiting.');
process.exit();
}
});
````
To get immediate access to a certain piece of data, call the get() method
````javascript
console.log(
ekg.get('memory')
);
````
Available for `memory`, `cpu`, and `proc`. Any other values will cause get() to throw an error.
# data
##memory
Includes object members `free` and `total`.
##cpu
An array of objects for each CPU, containing `model`, `speed`, `nice`, `sys`, `user`, `irq`, and `idle`
##proc
An object with member `cpuPercent`
# license
(The MIT License)
Copyright (c) 2011 Cam Pedersen
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.