Metrics exporter for Prometheus. Exposes metrics to help monitor the health of ZFS pools across a proxmox cluster. The default port is set to 9000.
The code was written quickly and needs to be cleaned up but it's functional. Lots of work could be done here and I always welcome contributions.
| Name | Description |
|---|---|
| zfs_zpool_error | Is there a zpool error |
| zfs_zpool_online | Is the zpool online |
| zfs_zpool_free | Free space on zpool |
| zfs_zpool_allocated | Allocated space on zpool |
| zfs_zpool_size | Size of zpool |
| zfs_zpool_dedup | Is dedup enabled on zpool |
| zfs_zpool_last_scrub | Last zpool scrub |
| zfs_zpool_last_scrub_errors | Last scrub total errors on the zpool |
| zfs_zpool_parsing_error | Error when trying to parse the API data. |
You'll need to create a proxmox user that can access the API. You can limit the permissions down to read only. Then create a config file and store it at etc/proxmox-zfs-exporter/config.json with content like:
{
"User": "sampleuser@pve",
"Pass": "samplepassword",
"Host": "192.168.0.20",
"Port": "8006"
}NOTE: The port number is the port number to proxmox NOT the port for the metrics.
Alternatively, you can use the environment variables:
| Name | Default | Usage |
|---|---|---|
| PROX_USER | root |
User to use to login. Remebe to append @pve or @pam for PVE or PAM users. |
| PROX_PASS | password |
The password of the user |
| PROX_HOST | 127.0.0.1 |
Remote host |
| PROX_PORT | 8006 |
Remote port |
| PORT | 9000 |
Listening port of the service |
The Proxmox user needs to have the permission Datastore.Audit on the / path (you will need to create a custom role) (please don't use a full-admin user, and use a pve user).
You can either compile the binary, use the docker image (ghcr.io/pandry/proxmox-zfs-exporter) or download one the releases.
Example install using systemd (Make sure to get the current release from the release page and change the wget command):
#Run this as root or add sudo to the commands
wget https://github.com/zbblanton/proxmox-zfs-exporter/releases/download/v0.1.1/proxmox-zfs-exporter -O /usr/bin/proxmox-zfs-exporter
chmod +x /usr/bin/proxmox-zfs-exporter
cat > /etc/systemd/system/proxmox-zfs-exporter.service <<EOF
[Unit]
Description=Proxmox ZFS Exporter
Documentation=https://github.com/zbblanton/proxmox-zfs-exporter
[Service]
ExecStart=/usr/bin/proxmox-zfs-exporter
Restart=on-failure
RestartSec=5
[Install]
WantedBy=multi-user.target
EOF
systemctl daemon-reload
systemctl enable proxmox-zfs-exporter
systemctl start proxmox-zfs-exporter