smartctl_exporter/README.md

40 lines
1.2 KiB
Markdown
Raw Normal View History

2019-08-16 10:05:30 +02:00
[![CircleCI](https://circleci.com/gh/Sheridan/smartctl_exporter.svg?style=svg)](https://circleci.com/gh/Sheridan/smartctl_exporter)
2019-08-14 22:28:21 +02:00
# smartctl_exporter
Export smartctl statistics to prometheus
2019-08-14 22:34:49 +02:00
2019-08-17 12:24:28 +02:00
Example output you can show in [EXAMPLE.md](EXAMPLE.md)
2019-08-14 22:34:49 +02:00
## Need more?
**If you need additional metrics - contact me :)**
**Create a feature request, describe the metric that you would like to have and attach exported from smartctl json file**
2019-08-26 10:27:28 +02:00
# Requirements
smartmontools >= 7.0, because export to json [released in 7.0](https://www.smartmontools.org/browser/tags/RELEASE_7_0/smartmontools/NEWS#L11)
2019-08-14 22:34:49 +02:00
# Configuration
## Command line options
* `--config=/path/to/file.yaml`: Path to configuration file, defaulr `/etc/smartctl_exporter.yaml`
* `--verbose`: verbosed log, default no
* `--debug`: Debug logging, default no
* `--version`: Show version and exit
## Configuration file
Example content:
```
smartctl_exporter:
bind_to: "[::1]:9633"
2019-08-14 22:34:49 +02:00
url_path: "/metrics"
fake_json: no
smartctl_location: /usr/sbin/smartctl
2019-08-15 23:02:44 +02:00
collect_not_more_than_period: 120s
2019-08-14 22:34:49 +02:00
devices:
- /dev/sda
- /dev/sdb
- /dev/sdc
- /dev/sdd
- /dev/sde
- /dev/sdf
```
`fake_json` used for debugging.