SeanOMik
/
ZFS-PrometheusExporter
mirror of https://github.com/SeanOMik/ZFS-PrometheusExporter.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: update readme, add dashboard

This commit is contained in:
SeanOMik 2023-08-06 19:12:40 -04:00
parent 6e79f8965d
commit 6b076b2e1d
Signed by: SeanOMik
GPG Key ID: 568F326C7EB33ACB
3 changed files with 1354 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -25,23 +25,28 @@ $ docker run --rm -d --privileged -p 8080:8080 --name zfs_exporter ghcr.io/seano
## What Metrics Are Exported? ## What Metrics Are Exported?
* `zfs_health` (`enum`): Represents the device's health, can be `online`, `degraded`, `faulted`, `offline`, `available`, `unavailable` and `removed`. The state is stored in the `state` label, and the value is `0` for not-in-state, and `1` for in-state. * `zfs_health` (`enum`): Represents the device's health, can be `online`, `degraded`, `faulted`, `offline`, `available`, `unavailable` and `removed`. The state is stored in the `state` label, and the value is `0` for not-in-state, and `1` for in-state.
* `zfs_read_errors` (int counter): The amount of read errors for this device. * `zfs_read_errors` (int gauge): The amount of read errors for this device.
* `zfs_write_errors` (int counter): The amount of write errors for this device. * `zfs_write_errors` (int gauge): The amount of write errors for this device.
* `zfs_checksum_errors` (int counter): The amount of checksum errors for this device. * `zfs_checksum_errors` (int gauge): The amount of checksum errors for this device.
* `zfs_disk_count` (int counter): The amount of disks in this pool or vdev. * `zfs_disk_count` (int gauge): The amount of disks in this pool or vdev.
* `zfs_vdev_count` (int counter): The amount of vdevs in the pool. * `zfs_vdev_count` (int gauge): The amount of vdevs in the pool.
* `zfs_spare_count` (int counter): The spare amount in the pool. * `zfs_spare_count` (int gauge): The spare amount in the pool.
* `zfs_raw_size` (int counter): The raw size (in bytes) of the device. This is not the actual capacity. * `zfs_raw_size` (int gauge): The raw size (in bytes) of the device. This is not the actual capacity.
* `zfs_capacity` (int counter): The capacity (in bytes) of the device. * `zfs_capacity` (int gauge): The capacity (in bytes) of the device.
* `zfs_available` (int counter): The available bytes of the device. * `zfs_available` (int gauge): The available bytes of the device.
* `zfs_read_operations` (int counter): The amount of read operations on this device. * `zfs_read_operations` (int gauge): The amount of read operations on this device.
* `zfs_write_operations` (int counter): The amount of write operations on this device. * `zfs_write_operations` (int gauge): The amount of write operations on this device.
* `zfs_read_bandwidth` (int counter): The read bandwidth for this device in bytes per second. * `zfs_read_bandwidth` (int gauge): The read bandwidth for this device in bytes per second.
* `zfs_write_bandwidth` (int counter): The write bandwidth for this device in bytes per second. * `zfs_write_bandwidth` (int gauge): The write bandwidth for this device in bytes per second.
* `zfs_fragmentation` (int gauge): The percentage (0-100) of fragmentation of the device.
**Note: the `zpool status` commands use 1024, not 1000.** **Note: Sizes output from `zpool status` are in TiB/GiB (1024), not TB/GB (1000).**
There are some common labels for the metrics: There are some common labels for the metrics:
* `device_name`: The name of the device that this metric is related to. * `device_name`: The name of the device that this metric is related to.
* `device_type`: The type of the device. Can be `pool`, `vdev` or `disk`. * `device_type`: The type of the device. Can be `pool`, `vdev` or `disk`.
* `pool`: The ZFS pool that this device (`vdev` or `disk`) is a part of. * `pool`: The ZFS pool that this device (`vdev` or `disk`) is a part of.
## Grafana Dashboard
Import from json: [dashboard.json](./dashboard.json)
![dashboard screenshot](assets/dashboard.png)

BIN
assets/dashboard.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 271 KiB

1334
dashboard.json Normal file
View File

File diff suppressed because it is too large Load Diff