Add basic slabinfo metadata. (#15484)
Also adds a new category for Linux kernel metrics that are intrinsic to the kernel itself.
Austin S. Hemmelgarn committed
Jul 21, 2023 at 08:52 UTC
cddd0ac1d8fa44f427cb93c9973f05fe92d1cb08
2 files changed
+53
-32
collectors/slabinfo.plugin/metadata.yaml
+48
-32
@@ -2,30 +2,46 @@ meta:
2
plugin_name: slabinfo.plugin
3
module_name: slabinfo.plugin
4
monitored_instance:
5
- name: slabinfo
5
+ name: Linux kernel SLAB allocator statistics
6
link: ''
7
- categories: []
8
- icon_filename: ''
7
+ categories:
8
+ - data-collection.linux-systems.kernel-metrics
9
+ icon_filename: 'microchip.png'
10
related_resources:
11
integrations:
12
list: []
13
info_provided_to_referring_integrations:
14
description: ''
14
- keywords: []
15
+ keywords:
16
+ - linux kernel
17
+ - slab
18
+ - slub
19
+ - slob
20
+ - slabinfo
21
most_popular: false
22
overview:
23
data_collection:
18
- metrics_description: ''
24
+ metrics_description: >
25
+ Collects metrics on kernel SLAB cache utilization to monitor the low-level performance impact of workloads
26
+ in the kernel.
27
method_description: ''
28
supported_platforms:
21
- include: []
29
+ include:
30
+ - Linux
31
exclude: []
23
- multi_instance: true
32
+ multi_instance: false
33
additional_permissions:
25
- description: ''
34
+ description: >
35
+ This integration requires read access to `/proc/slabinfo`, which is accessible only to the root user by
36
+ default. Netdata uses Linux Capabilities to give the plugin access to this file. `CAP_DAC_READ_SEARCH`
37
+ is added automatically during installation. This capability allows bypassing file read permission checks
38
+ and directory read and execute permission checks. If file capabilities are not usable, then the plugin is
39
+ instead installed with the SUID bit set in permissions sVko that it runs as root.
40
default_behavior:
41
auto_detection:
28
- description: ''
42
+ description: >
43
+ Due to the large number of metrics generated by this integration, it is disabled by default and must be
44
+ manually enabled.
45
limits:
46
description: ''
47
performance_impact:
@@ -56,28 +72,28 @@ metrics:
72
folding:
73
title: Metrics
74
enabled: false
59
- description: ""
75
+ description: "SLAB cache utilization metrics for the whole system."
76
availability: []
77
scopes:
62
- - name: global
63
- description: ""
64
- labels: []
65
- metrics:
66
- - name: mem.slabmemory
67
- description: Memory Usage
68
- unit: "B"
69
- chart_type: line
70
- dimensions:
71
- - name: a dimension per cache
72
- - name: mem.slabfilling
73
- description: Object Filling
74
- unit: "%"
75
- chart_type: line
76
- dimensions:
77
- - name: a dimension per cache
78
- - name: mem.slabwaste
79
- description: Memory waste
80
- unit: "B"
81
- chart_type: line
82
- dimensions:
83
- - name: a dimension per cache
78
+ - name: global
79
+ description: ""
80
+ labels: []
81
+ metrics:
82
+ - name: mem.slabmemory
83
+ description: Memory Usage
84
+ unit: "B"
85
+ chart_type: line
86
+ dimensions:
87
+ - name: a dimension per cache
88
+ - name: mem.slabfilling
89
+ description: Object Filling
90
+ unit: "%"
91
+ chart_type: line
92
+ dimensions:
93
+ - name: a dimension per cache
94
+ - name: mem.slabwaste
95
+ description: Memory waste
96
+ unit: "B"
97
+ chart_type: line
98
+ dimensions:
99
+ - name: a dimension per cache
integrations/categories.yaml
+5
@@ -162,6 +162,11 @@
162
description: ""
163
most_popular: false
164
children: []
165
+ - id: data-collection.linux-systems.kernel-metrics
166
+ name: Kernel Metrics
167
+ description: ""
168
+ most_popular: false
169
+ children: []
170
- id: data-collection.notifications
171
name: Notifications
172
description: ""