mirror of
https://github.com/pstadler/metrics.sh.git
synced 2025-02-28 13:59:12 -05:00
metrics.sh
metrics.sh is a metrics collection and fowarding daemon implemented in portable shell scripts. A simple interface based on hooks allows for writing custom metrics collectors.
Usage
Usage: ./metrics.sh [-d] [-h] [-v] [-r reporter] [-i interval]
Options:
-r, --reporter <reporter> use specified reporter (default: stdout)
-i, --interval <seconds> collect metrics every n seconds (default: 2)
-v, --verbose enable verbose mode
-d, --docs show documentation
-h, --help show this text
Installation
$ git clone git@github.com:pstadler/metrics.sh.git
TODO: /etc/init.d
Requirements
metrics.sh has been tested on Ubuntu and Mac OS X but is supposed to run on most *NIX-line operating systems. Some of the provided metrics require procfs to be available (check with [ -d /proc ] && echo available || echo not available
).
Metrics
Metric | Description |
---|---|
cpu | CPU usage in % |
memory | Memory usage in % |
swap | Swap usage in % |
network_io | Network I/O in kB/s |
disk_io | Disk I/O in MB/s |
disk_usage | Disk usage in % |
heartbeat | System heartbeat |
ping | Check if remote host is reachable |
TODO: how to write custom metrics
Reporters
TODO: how to write custom reporters
TODO
- README
- config file support
- config file auto-generation
- load custom/contrib metrics and reporters
- same metric multiple times? (e.g. disk_usage for multiple devices)
- allow multiple reporters?
Languages
Shell
100%