| 1 | <!--startmeta |
| 2 | custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/ebpf.plugin/integrations/ebpf_filesystem.md" |
| 3 | meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/ebpf.plugin/metadata.yaml" |
| 4 | sidebar_label: "eBPF Filesystem" |
| 5 | learn_status: "Published" |
| 6 | learn_rel_path: "Collecting Metrics/Collectors/Storage and Filesystems" |
| 7 | keywords: ['Filesystem', 'ext4', 'btrfs', 'nfs', 'xfs', 'zfs', 'eBPF', 'latency', 'I/O'] |
| 8 | message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" |
| 9 | endmeta--> |
| 10 | |
| 11 | # eBPF Filesystem |
| 12 | |
| 13 | |
| 14 | <img src="https://netdata.cloud/img/ebpf.jpg" width="150"/> |
| 15 | |
| 16 | |
| 17 | Plugin: ebpf.plugin |
| 18 | Module: filesystem |
| 19 | |
| 20 | <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> |
| 21 | |
| 22 | ## Overview |
| 23 | |
| 24 | Monitor latency for main actions on filesystem like I/O events. |
| 25 | |
| 26 | Attach tracing (kprobe, trampoline) to internal kernel functions according options used to compile kernel. |
| 27 | |
| 28 | This collector is only supported on the following platforms: |
| 29 | |
| 30 | - Linux |
| 31 | |
| 32 | This collector supports collecting metrics from multiple instances of this integration, including remote instances. |
| 33 | |
| 34 | The plugin needs setuid because it loads data inside kernel. Netada sets necessary permission during installation time. |
| 35 | |
| 36 | ### Default Behavior |
| 37 | |
| 38 | #### Auto-Detection |
| 39 | |
| 40 | The plugin checks kernel compilation flags (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT), files inside debugfs, and presence of BTF files to decide which eBPF program will be attached. |
| 41 | |
| 42 | #### Limits |
| 43 | |
| 44 | The default configuration for this integration does not impose any limits on data collection. |
| 45 | |
| 46 | #### Performance Impact |
| 47 | |
| 48 | The default configuration for this integration is not expected to impose a significant performance impact on the system. |
| 49 | |
| 50 | ## Setup |
| 51 | |
| 52 | |
| 53 | ### Prerequisites |
| 54 | |
| 55 | #### Compile kernel |
| 56 | |
| 57 | Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions. |
| 58 | When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files |
| 59 | with different names. |
| 60 | |
| 61 | Now follow steps: |
| 62 | 1. Copy the configuration file to /usr/src/linux/.config. |
| 63 | 2. Select the necessary options: make oldconfig |
| 64 | 3. Compile your kernel image: make bzImage |
| 65 | 4. Compile your modules: make modules |
| 66 | 5. Copy your new kernel image for boot loader directory |
| 67 | 6. Install the new modules: make modules_install |
| 68 | 7. Generate an initial ramdisk image (`initrd`) if it is necessary. |
| 69 | 8. Update your boot loader |
| 70 | |
| 71 | |
| 72 | |
| 73 | ### Configuration |
| 74 | |
| 75 | #### Options |
| 76 | |
| 77 | This configuration file have two different sections. The `[global]` overwrites default options, while `[filesystem]` allow user to select the filesystems to monitor. |
| 78 | |
| 79 | |
| 80 | <details open><summary>Config options</summary> |
| 81 | |
| 82 | |
| 83 | |
| 84 | | Option | Description | Default | Required | |
| 85 | |:-----|:------------|:--------|:---------:| |
| 86 | | update every | Data collection frequency. | 10 | no | |
| 87 | | ebpf load mode | Define whether plugin will monitor the call (`entry`) for the functions or it will also monitor the return (`return`). | entry | no | |
| 88 | | lifetime | Set default lifetime for thread when enabled by cloud. | 300 | no | |
| 89 | | btrfsdist | Enable or disable latency monitoring for functions associated with btrfs filesystem. | yes | no | |
| 90 | | ext4dist | Enable or disable latency monitoring for functions associated with ext4 filesystem. | yes | no | |
| 91 | | nfsdist | Enable or disable latency monitoring for functions associated with nfs filesystem. | yes | no | |
| 92 | | xfsdist | Enable or disable latency monitoring for functions associated with xfs filesystem. | yes | no | |
| 93 | | zfsdist | Enable or disable latency monitoring for functions associated with zfs filesystem. | yes | no | |
| 94 | |
| 95 | |
| 96 | </details> |
| 97 | |
| 98 | |
| 99 | |
| 100 | #### via File |
| 101 | |
| 102 | The configuration file name for this integration is `ebpf.d/filesystem.conf`. |
| 103 | |
| 104 | The file format is a modified INI syntax. The general structure is: |
| 105 | |
| 106 | ```ini |
| 107 | [section1] |
| 108 | option1 = some value |
| 109 | option2 = some other value |
| 110 | |
| 111 | [section2] |
| 112 | option3 = some third value |
| 113 | ``` |
| 114 | You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the |
| 115 | Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory). |
| 116 | |
| 117 | ```bash |
| 118 | cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata |
| 119 | sudo ./edit-config ebpf.d/filesystem.conf |
| 120 | ``` |
| 121 | |
| 122 | ##### Examples |
| 123 | There are no configuration examples. |
| 124 | |
| 125 | |
| 126 | |
| 127 | ## Alerts |
| 128 | |
| 129 | There are no alerts configured by default for this integration. |
| 130 | |
| 131 | |
| 132 | ## Metrics |
| 133 | |
| 134 | Metrics grouped by *scope*. |
| 135 | |
| 136 | The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. |
| 137 | |
| 138 | |
| 139 | |
| 140 | ### Per filesystem |
| 141 | |
| 142 | Latency charts associate with filesystem actions. |
| 143 | |
| 144 | This scope has no labels. |
| 145 | |
| 146 | Metrics: |
| 147 | |
| 148 | | Metric | Dimensions | Unit | |
| 149 | |:------|:----------|:----| |
| 150 | | filesystem.read_latency | latency period | calls/s | |
| 151 | | filesystem.open_latency | latency period | calls/s | |
| 152 | | filesystem.sync_latency | latency period | calls/s | |
| 153 | |
| 154 | ### Per iilesystem |
| 155 | |
| 156 | |
| 157 | |
| 158 | This scope has no labels. |
| 159 | |
| 160 | Metrics: |
| 161 | |
| 162 | | Metric | Dimensions | Unit | |
| 163 | |:------|:----------|:----| |
| 164 | | filesystem.write_latency | latency period | calls/s | |
| 165 | |
| 166 | ### Per eBPF Filesystem instance |
| 167 | |
| 168 | |
| 169 | |
| 170 | This scope has no labels. |
| 171 | |
| 172 | Metrics: |
| 173 | |
| 174 | | Metric | Dimensions | Unit | |
| 175 | |:------|:----------|:----| |
| 176 | | filesystem.attributte_latency | latency period | calls/s | |
| 177 | |
| 178 |