Update debugfs plugin metadata. (#15463)
* Update debugfs plugin metadata. * Fix chart naming.
Austin S. Hemmelgarn committed
Jul 21, 2023 at 08:17 UTC
720e855ad5a8098fe24c413119f523c671a65f15
1 file changed
+51
-25
collectors/debugfs.plugin/multi_metadata.yaml
+51
-25
@@ -4,30 +4,42 @@ modules:
4
plugin_name: debugfs.plugin
5
module_name: /sys/kernel/debug/extfrag
6
monitored_instance:
7
- name: debugfs /sys/kernel/debug/extfrag
7
+ name: System Memory Fragmentation
8
link: ''
9
- categories: []
10
- icon_filename: ''
9
+ categories:
10
+ - data-collection.linux-systems.memory-metrics
11
+ icon_filename: 'microchip.png'
12
related_resources:
13
integrations:
14
list: []
15
info_provided_to_referring_integrations:
16
description: ''
16
- keywords: []
17
+ keywords:
18
+ - extfrag
19
+ - extfrag_threshold
20
+ - memory fragmentation
21
most_popular: false
22
overview:
23
data_collection:
20
- metrics_description: ''
24
+ metrics_description: 'Collects memory fragmentation statistics from the Linux kernel'
25
method_description: ''
26
supported_platforms:
23
- include: []
27
+ include:
28
+ - Linux
29
exclude: []
25
- multi_instance: true
30
+ multi_instance: false
31
additional_permissions:
27
- description: ''
32
+ description: >
33
+ This integration requires read access to files under `/sys/kernel/debug/extfrag`, which are accessible
34
+ only to the root user by default. Netdata uses Linux Capabilities to give the plugin access to
35
+ debugfs. `CAP_DAC_READ_SEARCH` is added automatically during installation. This capability allows bypassing
36
+ file read permission checks and directory read and execute permission checks. If file capabilities are not
37
+ usable, then the plugin is instead installed with the SUID bit set in permissions so that it runs as root.
38
default_behavior:
39
auto_detection:
30
- description: ''
40
+ description: >
41
+ Assuming that debugfs is mounted and the required permissions are available, this integration will
42
+ automatically run by default.
43
limits:
44
description: ''
45
performance_impact:
@@ -58,14 +70,14 @@ modules:
70
folding:
71
title: Metrics
72
enabled: false
61
- description: ""
73
+ description: "Monitor the overall memory fragmentation of the system."
74
availability: []
75
scopes:
76
- name: node
65
- description: ""
77
+ description: "Memory fragmentation statistics for each NUMA node in the system."
78
labels:
79
- name: numa_node
68
- description: TBD
80
+ description: The NUMA node the metrics are associated with.
81
metrics:
82
- name: mem.fragmentation_index_dma
83
description: Memory fragmentation index for each order
@@ -119,30 +131,44 @@ modules:
131
plugin_name: debugfs.plugin
132
module_name: /sys/kernel/debug/zswap
133
monitored_instance:
122
- name: debugfs /sys/kernel/debug/zswap
123
- link: ''
124
- categories: []
125
- icon_filename: ''
134
+ name: Linux ZSwap
135
+ link: 'https://www.kernel.org/doc/html/latest/admin-guide/mm/zswap.html'
136
+ categories:
137
+ - data-collection.linux-systems.memory-metrics
138
+ icon_filename: 'microchip.png'
139
related_resources:
140
integrations:
141
list: []
142
info_provided_to_referring_integrations:
143
description: ''
131
- keywords: []
144
+ keywords:
145
+ - swap
146
+ - zswap
147
+ - frontswap
148
+ - swap cache
149
most_popular: false
150
overview:
151
data_collection:
135
- metrics_description: ''
152
+ metrics_description: >
153
+ Collects zswap performance metrics on Linux systems.
154
method_description: ''
155
supported_platforms:
138
- include: []
156
+ include:
157
+ - Linux
158
exclude: []
140
- multi_instance: true
159
+ multi_instance: false
160
additional_permissions:
142
- description: ''
161
+ description: >
162
+ This integration requires read access to files under `/sys/kernel/debug/zswap`, which are accessible
163
+ only to the root user by default. Netdata uses Linux Capabilities to give the plugin access to
164
+ debugfs. `CAP_DAC_READ_SEARCH` is added automatically during installation. This capability allows bypassing
165
+ file read permission checks and directory read and execute permission checks. If file capabilities are not
166
+ usable, then the plugin is instead installed with the SUID bit set in permissions so that it runs as root.
167
default_behavior:
168
auto_detection:
145
- description: ''
169
+ description: >
170
+ Assuming that debugfs is mounted and the required permissions are available, this integration will
171
+ automatically detect whether or not the system is using zswap.
172
limits:
173
description: ''
174
performance_impact:
@@ -153,7 +179,7 @@ modules:
179
configuration:
180
file:
181
name: ''
156
- description: ''
182
+ section_name: ''
183
options:
184
description: ''
185
folding:
@@ -173,11 +199,11 @@ modules:
199
folding:
200
title: Metrics
201
enabled: false
176
- description: ""
202
+ description: "Monitor the performance statistics of zswap."
203
availability: []
204
scopes:
205
- name: global
180
- description: ""
206
+ description: "Global zswap performance metrics."
207
labels: []
208
metrics:
209
- name: system.zswap_pool_compression_ratio