MyFavMirrors/metrics.sh
1
0
Fork 0
mirror of https://github.com/pstadler/metrics.sh.git synced 2025-02-28 13:59:12 -05:00
Code Issues Packages Projects Releases Wiki Activity

tweak README

Browse Source
This commit is contained in:
Patrick Stadler 2015-03-22 10:40:00 +01:00
parent cec756f07f
commit f61ca57450
1 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -22,7 +22,7 @@ $ ./metrics.sh --help
## Installation ## Installation
```bash ```sh
$ git clone git@github.com:pstadler/metrics.sh.git $ git clone git@github.com:pstadler/metrics.sh.git
``` ```
@ -57,22 +57,20 @@ Reporter | Description
A first step of configuration can be done by passing options to metrics.sh: A first step of configuration can be done by passing options to metrics.sh:
``` ```sh
$ ./metrics.sh --help $ ./metrics.sh --help # print help
... $ ./metrics.sh -m cpu,memory -i 1 # report cpu and memory usage every second
$ ./metrics.sh -m cpu,memory -i 1
# reports cpu and memory every second
``` ```
Some of the metrics and reporters are configurable. Documentation is available from within metrics.sh and can be printed with `--docs`: Some of the metrics and reporters are configurable. Documentation is available from within metrics.sh and can be printed with `--docs`:
``` ```sh
$ ./metrics.sh --docs | less $ ./metrics.sh --docs | less
``` ```
For example, the `disk_usage` metric has a configuration variable `DISK_USAGE_MOUNTPOINT` which set to a default depending on the operating system metrics.sh is running on. Setting the variable before starting will overwrite it: As an example, the `disk_usage` metric has a configuration variable `DISK_USAGE_MOUNTPOINT` which is set to a default value depending on the operating system metrics.sh is running on. Setting the variable before starting will overwrite it:
``` ```sh
$ DISK_USAGE_MOUNTPOINT=/dev/vdb ./metrics.sh -m disk_usage $ DISK_USAGE_MOUNTPOINT=/dev/vdb ./metrics.sh -m disk_usage
# reports disk usage of /dev/vdb # reports disk usage of /dev/vdb
``` ```
@ -81,7 +79,7 @@ $ DISK_USAGE_MOUNTPOINT=/dev/vdb ./metrics.sh -m disk_usage
As maintaing all these options can become a cumbersome job, metrics.sh has support for configuration files. As maintaing all these options can become a cumbersome job, metrics.sh has support for configuration files.
``` ```sh
$ ./metrics.sh -C > metrics.ini # write configuration to metrics.ini $ ./metrics.sh -C > metrics.ini # write configuration to metrics.ini
$ ./metrics.sh -c metrics.ini # load configuration from metrics.ini $ ./metrics.sh -c metrics.ini # load configuration from metrics.ini
``` ```
@ -124,7 +122,7 @@ network_eth1.out: 0.03
... ...
``` ```
### Daemonize / init.d/ upstart ### Daemonize / init.d / upstart
TODO TODO