1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
<!--startmeta
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/freebsd.plugin/integrations/zfs.md"
meta_yaml: "https://github.com/netdata/netdata/edit/master/collectors/freebsd.plugin/metadata.yaml"
sidebar_label: "zfs"
learn_status: "Published"
learn_rel_path: "Data Collection/FreeBSD"
most_popular: False
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
endmeta-->
# zfs
<img src="https://netdata.cloud/img/filesystem.svg" width="150"/>
Plugin: freebsd.plugin
Module: zfs
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
## Overview
Collect metrics for ZFS filesystem
The plugin uses `sysctl` function to collect necessary data.
This collector is supported on all platforms.
This collector supports collecting metrics from multiple instances of this integration, including remote instances.
### 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 instance
These metrics show detailed information about ZFS filesystem.
This scope has no labels.
Metrics:
| Metric | Dimensions | Unit |
|:------|:----------|:----|
| zfs.arc_size | arcsz, target, min, max | MiB |
| zfs.l2_size | actual, size | MiB |
| zfs.reads | arc, demand, prefetch, metadata, l2 | reads/s |
| zfs.bytes | read, write | KiB/s |
| zfs.hits | hits, misses | percentage |
| zfs.hits_rate | hits, misses | events/s |
| zfs.dhits | hits, misses | percentage |
| zfs.dhits_rate | hits, misses | events/s |
| zfs.phits | hits, misses | percentage |
| zfs.phits_rate | hits, misses | events/s |
| zfs.mhits | hits, misses | percentage |
| zfs.mhits_rate | hits, misses | events/s |
| zfs.l2hits | hits, misses | percentage |
| zfs.l2hits_rate | hits, misses | events/s |
| zfs.list_hits | mfu, mfu_ghost, mru, mru_ghost | hits/s |
| zfs.arc_size_breakdown | recent, frequent | percentage |
| zfs.memory_ops | throttled | operations/s |
| zfs.important_ops | evict_skip, deleted, mutex_miss, hash_collisions | operations/s |
| zfs.actual_hits | hits, misses | percentage |
| zfs.actual_hits_rate | hits, misses | events/s |
| zfs.demand_data_hits | hits, misses | percentage |
| zfs.demand_data_hits_rate | hits, misses | events/s |
| zfs.prefetch_data_hits | hits, misses | percentage |
| zfs.prefetch_data_hits_rate | hits, misses | events/s |
| zfs.hash_elements | current, max | elements |
| zfs.hash_chains | current, max | chains |
| zfs.trim_bytes | TRIMmed | bytes |
| zfs.trim_requests | successful, failed, unsupported | requests |
## Alerts
The following alerts are available:
| Alert name | On metric | Description |
|:------------|:----------|:------------|
| [ zfs_memory_throttle ](https://github.com/netdata/netdata/blob/master/health/health.d/zfs.conf) | zfs.memory_ops | number of times ZFS had to limit the ARC growth in the last 10 minutes |
## Setup
### Prerequisites
No action required.
### Configuration
#### File
The configuration file name for this integration is `netdata.conf`.
Configuration for this specific integration is located in the `[plugin:freebsd:zfs_arcstats]` section within that file.
The file format is a modified INI syntax. The general structure is:
```ini
[section1]
option1 = some value
option2 = some other value
[section2]
option3 = some third value
```
You can edit the configuration file using the `edit-config` script from the
Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory).
```bash
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config netdata.conf
```
#### Options
<details><summary>Config options</summary>
| Name | Description | Default | Required |
|:----|:-----------|:-------|:--------:|
| show zero charts | Do not show charts with zero metrics. | no | no |
</details>
#### Examples
There are no configuration examples.
|
