| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-zfspool |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: zfspool |
| 7 | monitored_instance: |
| 8 | name: ZFS Pools |
| 9 | link: "" |
| 10 | icon_filename: filesystem.svg |
| 11 | categories: |
| 12 | - data-collection.storage |
| 13 | keywords: |
| 14 | - zfs pools |
| 15 | - pools |
| 16 | - zfs |
| 17 | - filesystem |
| 18 | related_resources: |
| 19 | integrations: |
| 20 | list: [] |
| 21 | info_provided_to_referring_integrations: |
| 22 | description: "" |
| 23 | overview: |
| 24 | data_collection: |
| 25 | metrics_description: > |
| 26 | This collector monitors the health and space usage of ZFS pools using the command line |
| 27 | tool [zpool](https://openzfs.github.io/openzfs-docs/man/master/8/zpool-list.8.html). |
| 28 | method_description: "" |
| 29 | supported_platforms: |
| 30 | include: [Linux, BSD] |
| 31 | exclude: [] |
| 32 | multi_instance: false |
| 33 | additional_permissions: |
| 34 | description: "" |
| 35 | default_behavior: |
| 36 | auto_detection: |
| 37 | description: "" |
| 38 | limits: |
| 39 | description: "" |
| 40 | performance_impact: |
| 41 | description: "" |
| 42 | setup: |
| 43 | prerequisites: |
| 44 | list: [] |
| 45 | configuration: |
| 46 | file: |
| 47 | name: go.d/zfspool.conf |
| 48 | options: |
| 49 | description: | |
| 50 | The following options can be defined globally: update_every. |
| 51 | folding: |
| 52 | title: Config options |
| 53 | enabled: true |
| 54 | list: |
| 55 | - name: update_every |
| 56 | description: Data collection frequency. |
| 57 | default_value: 10 |
| 58 | required: false |
| 59 | - name: binary_path |
| 60 | description: 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. |
| 61 | default_value: /usr/bin/zpool |
| 62 | required: true |
| 63 | - name: timeout |
| 64 | description: Timeout for executing the binary, specified in seconds. |
| 65 | default_value: 2 |
| 66 | required: false |
| 67 | examples: |
| 68 | folding: |
| 69 | title: Config |
| 70 | enabled: true |
| 71 | list: |
| 72 | - name: Custom binary path |
| 73 | description: The executable is not in the directories specified in the PATH environment variable. |
| 74 | config: | |
| 75 | jobs: |
| 76 | - name: zfspool |
| 77 | binary_path: /usr/local/sbin/zpool |
| 78 | troubleshooting: |
| 79 | problems: |
| 80 | list: [] |
| 81 | alerts: |
| 82 | - name: zfs_pool_space_utilization |
| 83 | metric: zfspool.pool_space_utilization |
| 84 | info: "ZFS pool ${label:pool} is nearing capacity. Current space usage is above the threshold." |
| 85 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/zfs.conf |
| 86 | - name: zfs_pool_health_state_warn |
| 87 | metric: zfspool.pool_health_state |
| 88 | info: "ZFS pool ${label:pool} state is degraded" |
| 89 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/zfs.conf |
| 90 | - name: zfs_pool_health_state_crit |
| 91 | metric: zfspool.pool_health_state |
| 92 | info: "ZFS pool ${label:pool} state is faulted or unavail" |
| 93 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/zfs.conf |
| 94 | - name: zfs_vdev_health_state |
| 95 | metric: zfspool.vdev_health_state |
| 96 | info: "ZFS vdev ${label:vdev} state is faulted or degraded" |
| 97 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/zfs.conf |
| 98 | metrics: |
| 99 | folding: |
| 100 | title: Metrics |
| 101 | enabled: false |
| 102 | description: "" |
| 103 | availability: [] |
| 104 | scopes: |
| 105 | - name: zfs pool |
| 106 | description: These metrics refer to the ZFS pool. |
| 107 | labels: |
| 108 | - name: pool |
| 109 | description: Zpool name |
| 110 | metrics: |
| 111 | - name: zfspool.pool_space_utilization |
| 112 | description: Zpool space utilization |
| 113 | unit: '%' |
| 114 | chart_type: area |
| 115 | dimensions: |
| 116 | - name: utilization |
| 117 | - name: zfspool.pool_space_usage |
| 118 | description: Zpool space usage |
| 119 | unit: 'bytes' |
| 120 | chart_type: stacked |
| 121 | dimensions: |
| 122 | - name: free |
| 123 | - name: used |
| 124 | - name: zfspool.pool_fragmentation |
| 125 | description: Zpool fragmentation |
| 126 | unit: '%' |
| 127 | chart_type: line |
| 128 | dimensions: |
| 129 | - name: fragmentation |
| 130 | - name: zfspool.pool_health_state |
| 131 | description: Zpool health state |
| 132 | unit: 'state' |
| 133 | chart_type: line |
| 134 | dimensions: |
| 135 | - name: online |
| 136 | - name: degraded |
| 137 | - name: faulted |
| 138 | - name: offline |
| 139 | - name: unavail |
| 140 | - name: removed |
| 141 | - name: suspended |
| 142 | - name: zfs pool vdev |
| 143 | description: These metrics refer to the ZFS pool virtual device. |
| 144 | labels: |
| 145 | - name: pool |
| 146 | description: Zpool name |
| 147 | - name: vdev |
| 148 | description: Unique identifier for a virtual device (vdev) within a ZFS pool. |
| 149 | metrics: |
| 150 | - name: zfspool.vdev_health_state |
| 151 | description: Zpool Vdev health state |
| 152 | unit: 'state' |
| 153 | chart_type: line |
| 154 | dimensions: |
| 155 | - name: online |
| 156 | - name: degraded |
| 157 | - name: faulted |
| 158 | - name: offline |
| 159 | - name: unavail |
| 160 | - name: removed |
| 161 | - name: suspended |