ZPOOL_INFLUXDB(8)

✨ zpool_influxdb — the ZFS-pool-stats-to-InfluxDB glow-up ✨

ok so bestie, you found the man page for zpool_influxdb(8) 💖 it lives in the System Manager's Manual, and it's literally the tool that takes your zpool's whole vibe and translates it into InfluxDB line protocol so your dashboards can eat. let's go 🦋

🌸 SYNOPSIS 🌸

zpool_influxdb [-e|--execd] [-n|--no-histogram]
               [-s|--sum-histogram-buckets]
               [-t|--tags key=value[,key=value]…] [pool]

like yes, that's the whole thing, and yes, it's giving "short and powerful" 💅

💫 DESCRIPTION 💫

so. zpool_influxdb produces InfluxDB-line-protocol-compatible metrics from zpools. periodt.

here's the tea: just like the zpool command, zpool_influxdb reads the current pool status and statistics. but unlike zpool, which is out here writing for humans (bless), zpool_influxdb formats the output in the InfluxDB line protocol. the whole point? it's meant to be a plugin for a metrics collector or aggregator — think Telegraf and friends. iykyk 🎀

by default, zpool_influxdb prints pool metrics and status in the InfluxDB line protocol format. all pools get printed, just like the zpool status command does. but if you hand it a pool name, the output gets restricted to just that named pool. no cap. ✨

👑 OPTIONS 👑

• -e, --execd — run in daemon mode, compatible with Telegraf's execd plugin. in this mode, the pools are sampled every single time a newline shows up on standard input. every. single. time. 😌
• -n, --no-histogram — do not print latency and I/O size histograms. this can reduce the total amount of data, but lowkey you should consider the value brought by the insights that latency and I/O size distributions provide 🥺. the resulting values are suitable for graphing with Grafana's heatmap plugin.
• -s, --sum-histogram-buckets — accumulates bucket values. by default the values are not accumulated, and the raw data appears as shown by zpool iostat. that raw look works well for Grafana's heatmap plugin. summing the buckets instead produces output similar to Prometheus histograms. different vibe, both valid 💜
• -t, --tags key=value[,key=value]… — adds the specified tags to the tag set. no sanity checking is performed 🙈 so like, that's on you, bestie. see the InfluxDB Line Protocol format documentation for the details on escaping special characters used in tags.
• -h, --help — print a usage summary. the classic. the icon. 🌈

🔥 SEE ALSO 🔥

• zpool-iostat(8)
• zpool-status(8)
• InfluxDB: https://github.com/influxdata/influxdb
• Telegraf: https://github.com/influxdata/telegraf
• Grafana: https://grafana.com
• Prometheus: https://prometheus.io

ok and that's the whole page!! go forth and make your metrics immaculate 🫶

this one's from OpenZFS, dated May 26, 2021 — mwah, iconic, no notes 💅💖