ebpf_mount.md · cryptotaxi247/netdata

Code Commits Issues Pulls Sessions CI/CD

master

md 155 lines 5.25 KB

Rendered Raw

1	<!--startmeta
2	custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/ebpf.plugin/integrations/ebpf_mount.md"
3	meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/ebpf.plugin/metadata.yaml"
4	sidebar_label: "eBPF Mount"
5	learn_status: "Published"
6	learn_rel_path: "Collecting Metrics/Collectors/Storage and Filesystems"
7	keywords: ['mount', 'umount', 'device', 'eBPF']
8	message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9	endmeta-->
10
11	# eBPF Mount
12
13
14	<img src="https://netdata.cloud/img/ebpf.jpg" width="150"/>
15
16
17	Plugin: ebpf.plugin
18	Module: mount
19
20	<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
22	## Overview
23
24	Monitor calls for mount and umount syscall.
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, CONFIG_HAVE_SYSCALL_TRACEPOINTS), 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	This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ns per call on kernels that do not have BTF technology.
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	#### Debug Filesystem
73
74	This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).`
75
76
77
78	### Configuration
79
80	#### Options
81
82	All options are defined inside section `[global]`.
83
84
85	<details open><summary>Config options</summary>
86
87
88
89	\| Option \| Description \| Default \| Required \|
90	\|:-----\|:------------\|:--------\|:---------:\|
91	\| update every \| Data collection frequency. \| 10 \| no \|
92	\| ebpf load mode \| Define whether plugin will monitor the call (`entry`) for the functions or it will also monitor the return (`return`). \| entry \| no \|
93	\| ebpf type format \| Define the file type to load an eBPF program. Three options are available: `legacy` (Attach only `kprobe`), `co-re` (Plugin tries to use `trampoline` when available), and `auto` (plugin check OS configuration before to load). \| auto \| no \|
94	\| ebpf co-re tracing \| Select the attach method used by plugin when `co-re` is defined in previous option. Two options are available: `trampoline` (Option with lowest overhead), and `probe` (the same of legacy code). \| trampoline \| no \|
95	\| lifetime \| Set default lifetime for thread when enabled by cloud. \| 300 \| no \|
96
97
98	</details>
99
100
101
102	#### via File
103
104	The configuration file name for this integration is `ebpf.d/mount.conf`.
105
106	The file format is a modified INI syntax. The general structure is:
107
108	```ini
109	[section1]
110	option1 = some value
111	option2 = some other value
112
113	[section2]
114	option3 = some third value
115	```
116	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
117	Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
118
119	```bash
120	cd /etc/netdata 2>/dev/null \|\| cd /opt/netdata/etc/netdata
121	sudo ./edit-config ebpf.d/mount.conf
122	```
123
124	##### Examples
125	There are no configuration examples.
126
127
128
129	## Alerts
130
131	There are no alerts configured by default for this integration.
132
133
134	## Metrics
135
136	Metrics grouped by scope.
137
138	The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
139
140
141
142	### Per eBPF Mount instance
143
144	Calls for syscalls mount an umount.
145
146	This scope has no labels.
147
148	Metrics:
149
150	\| Metric \| Dimensions \| Unit \|
151	\|:------\|:----------\|:----\|
152	\| mount_points.call \| mount, umount \| calls/s \|
153	\| mount_points.error \| mount, umount \| calls/s \|
154
155