Project: Netdata (Observability and Analysis / Observability)
File: zfs_pools.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/zfspool/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/zfspool/metadata.yaml" sidebar_label: "ZFS Pools" learn_status: "Published" learnrelpath: "Collecting Metrics/Storage, Mount Points and Filesystems" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/filesystem.svg" width="150"/> Plugin: go.d.plugin Module: zfspool <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> This collector monitors the health and space usage of ZFS pools using the command line tool . This collector is supported on all platforms. This collector only supports collecting metrics from a single instance of this integration. This integration doesn't support auto-detection. The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics refer to the ZFS pool. Labels: | Label | Description | |:--|:-| | pool | Zpool name | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | zfspool.poolspaceutilization | utilization | % | | zfspool.poolspaceusage | free, used | bytes | | zfspool.pool_fragmentation | fragmentation | % | | zfspool.poolhealthstate | online, degraded, faulted, offline, unavail, removed, suspended | state | The following alerts are available: | Alert name | On metric | Description | |:|:-|:| | | zfspool.poolspaceutilization | ZFS pool ${label:pool} is nearing capacity. Current space usage is above the threshold. | | | zfspool.poolhealthstate | ZFS pool ${label:pool} state is degraded | | | zfspool.poolhealthstate | ZFS pool ${label:pool} state is faulted or unavail | No action required. The configuration file name for this integration is `go.d/zfspool.conf`. You can edit the configuration file using the `edit-config` script from the Netdata . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/zfspool.conf ``` The following options can be defined globally: update_every. <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | update_every | Data collection frequency. | 10 | no | | binary_path | Path to the `zpool` binary. If an absolute path is provided, the collector will use it directly; otherwise, it will search for the binary in directories specified in the PATH environment variable. | /usr/bin/zpool | yes | | timeout | Timeout for executing the binary, specified in seconds. | 2 | no | </details> The executable is not in the directories specified in the PATH environment variable. <details><summary>Config</summary> ```yaml jobs: name: zfspool binary_path: /usr/local/sbin/zpool ``` </details> To troubleshoot issues with the `zfspool` collector, run the `go.d.plugin` with the debug option enabled. The output should give you clues as to why the collector isn't working. Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m zfspool ```