Perf yaml (#15558)
* perf_yaml: Change quotes * perf_yaml: Update perf.yaml * perf_info: fix yaml parser recomendation * perf_info: Add missing OS * perf_yaml: Add rule to ignore 'error' * Update collectors/perf.plugin/metadata.yaml Co-authored-by: Andrew Maguire <andrewm4894@gmail.com> * Update metadata.yaml * perf_yaml: Address comment --------- Co-authored-by: Andrew Maguire <andrewm4894@gmail.com> Co-authored-by: Fotis Voutsas <fotis@netdata.cloud>
thiagoftsm committed
Jul 27, 2023 at 19:25 UTC
4e75b11b61ac8b0276002f1640ccb238780e4202
1 file changed
+173
-140
collectors/perf.plugin/metadata.yaml
+173
-140
@@ -1,54 +1,87 @@
1
+# yamllint disable rule:line-length
2
+---
3
meta:
4
plugin_name: perf.plugin
5
module_name: perf.plugin
6
monitored_instance:
7
name: CPU performance
6
- link: ''
8
+ link: "https://kernel.org/"
9
categories:
8
- - data-collection.linux-systems
9
- icon_filename: 'bolt.svg'
10
+ - data-collection.linux-systems
11
+ icon_filename: "bolt.svg"
12
related_resources:
13
integrations:
14
list: []
15
info_provided_to_referring_integrations:
14
- description: ''
15
- keywords: []
16
+ description: ""
17
+ keywords:
18
+ - linux
19
+ - cpu performance
20
+ - cpu cache
21
+ - perf.plugin
22
most_popular: false
23
overview:
24
data_collection:
19
- metrics_description: 'Monitor CPU performance to ensure optimal computational operations. Monitor core usage, load averages, and thermal throttling for seamless computation tasks.'
20
- method_description: ''
25
+ metrics_description: "This collector monitors CPU performance metrics about cycles, instructions, migrations, cache operations and more."
26
+ method_description: "It uses syscall (2) to open a file descriptior to monitor the perf events."
27
supported_platforms:
22
- include: []
28
+ include:
29
+ - Linux
30
exclude: []
31
multi_instance: true
32
additional_permissions:
26
- description: ''
33
+ description: "It needs setuid to use necessary syscall to collect perf events. Netada sets the permission during installation time."
34
default_behavior:
35
auto_detection:
29
- description: ''
36
+ description: ""
37
limits:
31
- description: ''
38
+ description: ""
39
performance_impact:
33
- description: ''
40
+ description: ""
41
setup:
42
prerequisites:
43
list: []
44
configuration:
45
file:
39
- name: ''
40
- description: ''
46
+ name: "netdata.conf"
47
+ section_name: "[plugin:perf]"
48
+ description: "The main netdata configuration file."
49
options:
42
- description: ''
50
+ description: |
51
+ You can get the available options running:
52
+
53
+ ```bash
54
+ /usr/libexec/netdata/plugins.d/perf.plugin --help
55
+ ````
56
folding:
44
- title: ''
57
+ title: "Config options"
58
enabled: true
46
- list: []
59
+ list:
60
+ - name: update every
61
+ description: Data collection frequency.
62
+ default_value: 1
63
+ required: false
64
+ - name: command options
65
+ description: Command options that specify charts shown by plugin.
66
+ default_value: 1
67
+ required: true
68
examples:
69
folding:
70
enabled: true
50
- title: ''
51
- list: []
71
+ title: "Config"
72
+ list:
73
+ - name: All metrics
74
+ folding:
75
+ enabled: false
76
+ description: Monitor all metrics available.
77
+ config: |
78
+ [plugin:perf]
79
+ command options = all
80
+ - name: CPU cycles
81
+ description: Monitor CPU cycles.
82
+ config: |
83
+ [plugin:perf]
84
+ command options = cycles
85
troubleshooting:
86
problems:
87
list: []
@@ -60,124 +93,124 @@ metrics:
93
description: ""
94
availability: []
95
scopes:
63
- - name: global
64
- description: ""
65
- labels: []
66
- metrics:
67
- - name: perf.cpu_cycles
68
- description: CPU cycles
69
- unit: "cycles/s"
70
- chart_type: line
71
- dimensions:
72
- - name: cpu
73
- - name: ref_cpu
74
- - name: perf.instructions
75
- description: Instructions
76
- unit: "instructions/s"
77
- chart_type: line
78
- dimensions:
79
- - name: instructions
80
- - name: perf.instructions_per_cycle
81
- description: Instructions per Cycle(IPC)
82
- unit: "instructions/cycle"
83
- chart_type: line
84
- dimensions:
85
- - name: ipc
86
- - name: perf.branch_instructions
87
- description: Branch instructions
88
- unit: "instructions/s"
89
- chart_type: line
90
- dimensions:
91
- - name: instructions
92
- - name: misses
93
- - name: perf.cache
94
- description: Cache operations
95
- unit: "operations/s"
96
- chart_type: line
97
- dimensions:
98
- - name: references
99
- - name: misses
100
- - name: perf.bus_cycles
101
- description: Bus cycles
102
- unit: "cycles/s"
103
- chart_type: line
104
- dimensions:
105
- - name: bus
106
- - name: perf.stalled_cycles
107
- description: Stalled frontend and backend cycles
108
- unit: "cycles/s"
109
- chart_type: line
110
- dimensions:
111
- - name: frontend
112
- - name: backend
113
- - name: perf.migrations
114
- description: CPU migrations
115
- unit: "migrations"
116
- chart_type: line
117
- dimensions:
118
- - name: migrations
119
- - name: perf.alignment_faults
120
- description: Alignment faults
121
- unit: "faults"
122
- chart_type: line
123
- dimensions:
124
- - name: faults
125
- - name: perf.emulation_faults
126
- description: Emulation faults
127
- unit: "faults"
128
- chart_type: line
129
- dimensions:
130
- - name: faults
131
- - name: perf.l1d_cache
132
- description: L1D cache operations
133
- unit: "events/s"
134
- chart_type: line
135
- dimensions:
136
- - name: read_access
137
- - name: read_misses
138
- - name: write_access
139
- - name: write_misses
140
- - name: perf.l1d_cache_prefetch
141
- description: L1D prefetch cache operations
142
- unit: "prefetches/s"
143
- chart_type: line
144
- dimensions:
145
- - name: prefetches
146
- - name: perf.l1i_cache
147
- description: L1I cache operations
148
- unit: "events/s"
149
- chart_type: line
150
- dimensions:
151
- - name: read_access
152
- - name: read_misses
153
- - name: perf.ll_cache
154
- description: LL cache operations
155
- unit: "events/s"
156
- chart_type: line
157
- dimensions:
158
- - name: read_access
159
- - name: read_misses
160
- - name: write_access
161
- - name: write_misses
162
- - name: perf.dtlb_cache
163
- description: DTLB cache operations
164
- unit: "events/s"
165
- chart_type: line
166
- dimensions:
167
- - name: read_access
168
- - name: read_misses
169
- - name: write_access
170
- - name: write_misses
171
- - name: perf.itlb_cache
172
- description: ITLB cache operations
173
- unit: "events/s"
174
- chart_type: line
175
- dimensions:
176
- - name: read_access
177
- - name: read_misses
178
- - name: perf.pbu_cache
179
- description: PBU cache operations
180
- unit: "events/s"
181
- chart_type: line
182
- dimensions:
183
- - name: read_access
96
+ - name: global
97
+ description: "These metrics refer to the entire monitored application."
98
+ labels: []
99
+ metrics:
100
+ - name: perf.cpu_cycles
101
+ description: CPU cycles
102
+ unit: "cycles/s"
103
+ chart_type: line
104
+ dimensions:
105
+ - name: cpu
106
+ - name: ref_cpu
107
+ - name: perf.instructions
108
+ description: Instructions
109
+ unit: "instructions/s"
110
+ chart_type: line
111
+ dimensions:
112
+ - name: instructions
113
+ - name: perf.instructions_per_cycle
114
+ description: Instructions per Cycle(IPC)
115
+ unit: "instructions/cycle"
116
+ chart_type: line
117
+ dimensions:
118
+ - name: ipc
119
+ - name: perf.branch_instructions
120
+ description: Branch instructions
121
+ unit: "instructions/s"
122
+ chart_type: line
123
+ dimensions:
124
+ - name: instructions
125
+ - name: misses
126
+ - name: perf.cache
127
+ description: Cache operations
128
+ unit: "operations/s"
129
+ chart_type: line
130
+ dimensions:
131
+ - name: references
132
+ - name: misses
133
+ - name: perf.bus_cycles
134
+ description: Bus cycles
135
+ unit: "cycles/s"
136
+ chart_type: line
137
+ dimensions:
138
+ - name: bus
139
+ - name: perf.stalled_cycles
140
+ description: Stalled frontend and backend cycles
141
+ unit: "cycles/s"
142
+ chart_type: line
143
+ dimensions:
144
+ - name: frontend
145
+ - name: backend
146
+ - name: perf.migrations
147
+ description: CPU migrations
148
+ unit: "migrations"
149
+ chart_type: line
150
+ dimensions:
151
+ - name: migrations
152
+ - name: perf.alignment_faults
153
+ description: Alignment faults
154
+ unit: "faults"
155
+ chart_type: line
156
+ dimensions:
157
+ - name: faults
158
+ - name: perf.emulation_faults
159
+ description: Emulation faults
160
+ unit: "faults"
161
+ chart_type: line
162
+ dimensions:
163
+ - name: faults
164
+ - name: perf.l1d_cache
165
+ description: L1D cache operations
166
+ unit: "events/s"
167
+ chart_type: line
168
+ dimensions:
169
+ - name: read_access
170
+ - name: read_misses
171
+ - name: write_access
172
+ - name: write_misses
173
+ - name: perf.l1d_cache_prefetch
174
+ description: L1D prefetch cache operations
175
+ unit: "prefetches/s"
176
+ chart_type: line
177
+ dimensions:
178
+ - name: prefetches
179
+ - name: perf.l1i_cache
180
+ description: L1I cache operations
181
+ unit: "events/s"
182
+ chart_type: line
183
+ dimensions:
184
+ - name: read_access
185
+ - name: read_misses
186
+ - name: perf.ll_cache
187
+ description: LL cache operations
188
+ unit: "events/s"
189
+ chart_type: line
190
+ dimensions:
191
+ - name: read_access
192
+ - name: read_misses
193
+ - name: write_access
194
+ - name: write_misses
195
+ - name: perf.dtlb_cache
196
+ description: DTLB cache operations
197
+ unit: "events/s"
198
+ chart_type: line
199
+ dimensions:
200
+ - name: read_access
201
+ - name: read_misses
202
+ - name: write_access
203
+ - name: write_misses
204
+ - name: perf.itlb_cache
205
+ description: ITLB cache operations
206
+ unit: "events/s"
207
+ chart_type: line
208
+ dimensions:
209
+ - name: read_access
210
+ - name: read_misses
211
+ - name: perf.pbu_cache
212
+ description: PBU cache operations
213
+ unit: "events/s"
214
+ chart_type: line
215
+ dimensions:
216
+ - name: read_access