diff options
Diffstat (limited to 'src/go/collectors/go.d.plugin/modules/zfspool/integrations/zfs_pools.md')
| -rw-r--r-- | src/go/collectors/go.d.plugin/modules/zfspool/integrations/zfs_pools.md | 169 |
1 files changed, 0 insertions, 169 deletions
diff --git a/src/go/collectors/go.d.plugin/modules/zfspool/integrations/zfs_pools.md b/src/go/collectors/go.d.plugin/modules/zfspool/integrations/zfs_pools.md deleted file mode 100644 index 827ae9111..000000000 --- a/src/go/collectors/go.d.plugin/modules/zfspool/integrations/zfs_pools.md +++ /dev/null @@ -1,169 +0,0 @@ -<!--startmeta -custom_edit_url: "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" -learn_rel_path: "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--> - -# ZFS Pools - - -<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" /> - -## Overview - -This collector monitors the health and space usage of ZFS pools using the command line tool [zpool](https://openzfs.github.io/openzfs-docs/man/master/8/zpool-list.8.html). - - - - -This collector is supported on all platforms. - -This collector only supports collecting metrics from a single instance of this integration. - - -### Default Behavior - -#### Auto-Detection - -This integration doesn't support auto-detection. - -#### Limits - -The default configuration for this integration does not impose any limits on data collection. - -#### Performance Impact - -The default configuration for this integration is not expected to impose a significant performance impact on the system. - - -## Metrics - -Metrics grouped by *scope*. - -The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. - - - -### Per zfs pool - -These metrics refer to the ZFS pool. - -Labels: - -| Label | Description | -|:-----------|:----------------| -| pool | Zpool name | - -Metrics: - -| Metric | Dimensions | Unit | -|:------|:----------|:----| -| zfspool.pool_space_utilization | utilization | % | -| zfspool.pool_space_usage | free, used | bytes | -| zfspool.pool_fragmentation | fragmentation | % | -| zfspool.pool_health_state | online, degraded, faulted, offline, unavail, removed, suspended | state | - - - -## Alerts - - -The following alerts are available: - -| Alert name | On metric | Description | -|:------------|:----------|:------------| -| [ zfs_pool_space_utilization ](https://github.com/netdata/netdata/blob/master/src/health/health.d/zfs.conf) | zfspool.pool_space_utilization | ZFS pool ${label:pool} is nearing capacity. Current space usage is above the threshold. | -| [ zfs_pool_health_state_warn ](https://github.com/netdata/netdata/blob/master/src/health/health.d/zfs.conf) | zfspool.pool_health_state | ZFS pool ${label:pool} state is degraded | -| [ zfs_pool_health_state_crit ](https://github.com/netdata/netdata/blob/master/src/health/health.d/zfs.conf) | zfspool.pool_health_state | ZFS pool ${label:pool} state is faulted or unavail | - - -## Setup - -### Prerequisites - -No action required. - -### Configuration - -#### File - -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 [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). - -```bash -cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata -sudo ./edit-config go.d/zfspool.conf -``` -#### Options - -The following options can be defined globally: update_every. - - -<details open><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> - -#### Examples - -##### Custom binary path - -The executable is not in the directories specified in the PATH environment variable. - -<details open><summary>Config</summary> - -```yaml -jobs: - - name: zfspool - binary_path: /usr/local/sbin/zpool - -``` -</details> - - - -## Troubleshooting - -### Debug Mode - -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 - ``` - - |