Debugfs yaml update (#15633)
* debufs_yaml: Initial code for debugs. * debufs_yaml: Update second module for debugfs * debufs_yaml: Add missing module
thiagoftsm committed
Jul 28, 2023 at 18:44 UTC
0f8e4d4eb698a7cea8990dd90d87792515aebbf1
1 file changed
+149
-13
collectors/debugfs.plugin/multi_metadata.yaml
+149
-13
@@ -5,7 +5,7 @@ modules:
5
module_name: /sys/kernel/debug/extfrag
6
monitored_instance:
7
name: System Memory Fragmentation
8
- link: ''
8
+ link: 'https://www.kernel.org/doc/html/next/admin-guide/sysctl/vm.html'
9
categories:
10
- data-collection.linux-systems.memory-metrics
11
icon_filename: 'microchip.png'
@@ -22,7 +22,7 @@ modules:
22
overview:
23
data_collection:
24
metrics_description: 'Collects memory fragmentation statistics from the Linux kernel'
25
- method_description: ''
25
+ method_description: 'Parse data from `debugfs` file'
26
supported_platforms:
27
include:
28
- Linux
@@ -46,17 +46,32 @@ modules:
46
description: ''
47
setup:
48
prerequisites:
49
- list: []
49
+ list:
50
+ - title: 'filesystem'
51
+ description: >
52
+ The debugfs filesystem must be mounted on your host for plugin to collect data.
53
+ You can run the command-line (`sudo mount -t debugfs none /sys/kernel/debug/`) to mount it locally.
54
+ It is also recommended to modify your fstab (5) avoiding necessity to mount the filesystem
55
+ before starting netdata.
56
configuration:
57
file:
52
- name: ''
53
- description: ''
58
+ name: 'netdata.conf'
59
+ section_name: '[plugin:debugfs]'
60
+ description: 'This is netdata main configuration file.'
61
options:
62
description: ''
63
folding:
57
- title: ''
64
+ title: 'Config options'
65
enabled: true
59
- list: []
66
+ list:
67
+ - name: update every
68
+ description: Data collection frequency.
69
+ default_value: 1
70
+ required: false
71
+ - name: command options
72
+ description: Additinal parameters for collector
73
+ default_value: ""
74
+ required: false
75
examples:
76
folding:
77
enabled: true
@@ -151,7 +166,7 @@ modules:
166
data_collection:
167
metrics_description: >
168
Collects zswap performance metrics on Linux systems.
154
- method_description: ''
169
+ method_description: 'Parse data from `debugfs file.'
170
supported_platforms:
171
include:
172
- Linux
@@ -175,17 +190,32 @@ modules:
190
description: ''
191
setup:
192
prerequisites:
178
- list: []
193
+ list:
194
+ - title: 'filesystem'
195
+ description: >
196
+ The debugfs filesystem must be mounted on your host for plugin to collect data.
197
+ You can run the command-line (`sudo mount -t debugfs none /sys/kernel/debug/`) to mount it locally.
198
+ It is also recommended to modify your fstab (5) avoiding necessity to mount the filesystem
199
+ before starting netdata.
200
configuration:
201
file:
181
- name: ''
182
- section_name: ''
202
+ name: 'netdata.conf'
203
+ section_name: '[plugin:debugfs]'
204
+ description: 'This is netdata main configuration file.'
205
options:
206
description: ''
207
folding:
186
- title: ''
208
+ title: 'Config options'
209
enabled: true
188
- list: []
210
+ list:
211
+ - name: update every
212
+ description: Data collection frequency.
213
+ default_value: 1
214
+ required: false
215
+ - name: command options
216
+ description: Additinal parameters for collector
217
+ default_value: ""
218
+ required: false
219
examples:
220
folding:
221
enabled: true
@@ -257,3 +287,109 @@ modules:
287
chart_type: line
288
dimensions:
289
- name: duplicate
290
+ - meta:
291
+ plugin_name: debugfs.plugin
292
+ module_name: intel_rapl
293
+ monitored_instance:
294
+ name: Power Capping
295
+ link: 'https://www.kernel.org/doc/html/next/power/powercap/powercap.html'
296
+ categories:
297
+ - data-collection.linux-systems.kernel-metrics
298
+ icon_filename: 'powersupply.svg'
299
+ related_resources:
300
+ integrations:
301
+ list: []
302
+ info_provided_to_referring_integrations:
303
+ description: ''
304
+ keywords:
305
+ - power capping
306
+ - energy
307
+ most_popular: false
308
+ overview:
309
+ data_collection:
310
+ metrics_description: >
311
+ Collects power capping performance metrics on Linux systems.
312
+ method_description: 'Parse data from `debugfs file.'
313
+ supported_platforms:
314
+ include:
315
+ - Linux
316
+ exclude: []
317
+ multi_instance: false
318
+ additional_permissions:
319
+ description: >
320
+ This integration requires read access to files under `/sys/devices/virtual/powercap`, which are accessible
321
+ only to the root user by default. Netdata uses Linux Capabilities to give the plugin access to
322
+ debugfs. `CAP_DAC_READ_SEARCH` is added automatically during installation. This capability allows bypassing
323
+ file read permission checks and directory read and execute permission checks. If file capabilities are not
324
+ usable, then the plugin is instead installed with the SUID bit set in permissions so that it runs as root.
325
+ default_behavior:
326
+ auto_detection:
327
+ description: >
328
+ Assuming that debugfs is mounted and the required permissions are available, this integration will
329
+ automatically detect whether or not the system is using zswap.
330
+ limits:
331
+ description: ''
332
+ performance_impact:
333
+ description: ''
334
+ setup:
335
+ prerequisites:
336
+ list:
337
+ - title: 'filesystem'
338
+ description: >
339
+ The debugfs filesystem must be mounted on your host for plugin to collect data.
340
+ You can run the command-line (`sudo mount -t debugfs none /sys/kernel/debug/`) to mount it locally.
341
+ It is also recommended to modify your fstab (5) avoiding necessity to mount the filesystem
342
+ before starting netdata.
343
+ configuration:
344
+ file:
345
+ name: 'netdata.conf'
346
+ section_name: '[plugin:debugfs]'
347
+ description: 'This is netdata main configuration file.'
348
+ options:
349
+ description: ''
350
+ folding:
351
+ title: 'Config options'
352
+ enabled: true
353
+ list:
354
+ - name: update every
355
+ description: Data collection frequency.
356
+ default_value: 1
357
+ required: false
358
+ - name: command options
359
+ description: Additinal parameters for collector
360
+ default_value: ""
361
+ required: false
362
+ examples:
363
+ folding:
364
+ enabled: true
365
+ title: ''
366
+ list: []
367
+ troubleshooting:
368
+ problems:
369
+ list: []
370
+ alerts: []
371
+ metrics:
372
+ folding:
373
+ title: Metrics
374
+ enabled: false
375
+ description: "Monitor the Intel RAPL zones Consumption."
376
+ availability: []
377
+ scopes:
378
+ - name: global
379
+ description: "Global Intel RAPL zones."
380
+ labels: []
381
+ metrics:
382
+ - name: cpu.powercap_intel_rapl_zone
383
+ description: Intel RAPL Zone Power Consumption
384
+ unit: "Watts"
385
+ chart_type: line
386
+ dimensions:
387
+ - name: Power
388
+ - name: cpu.powercap_intel_rapl_subzones
389
+ description: Intel RAPL Subzones Power Consumption
390
+ unit: "Watts"
391
+ chart_type: line
392
+ dimensions:
393
+ - name: dram
394
+ - name: core
395
+ - name: uncore