Windows Plugin metadata (#18599)
thiagoftsm committed
Oct 8, 2024 at 12:54 UTC
b0fc37d0dd5d3d1205442c248f95a9fe2f09c19d
2 files changed
+276
-92
src/collectors/windows.plugin/metadata.yaml
new
+276
@@ -0,0 +1,276 @@
1
+plugin_name: windows.plugin
2
+modules:
3
+ - meta:
4
+ plugin_name: windows.plugin
5
+ module_name: PerflibProcesses
6
+ monitored_instance:
7
+ name: System statistics
8
+ link: "https://learn.microsoft.com/en-us/windows/win32/procthread/processes-and-threads"
9
+ categories:
10
+ - data-collection.windows-systems
11
+ icon_filename: "windows.svg"
12
+ related_resources:
13
+ integrations:
14
+ list: []
15
+ info_provided_to_referring_integrations:
16
+ description: ""
17
+ keywords:
18
+ - process counts
19
+ - threads
20
+ - context switch
21
+ most_popular: false
22
+ overview:
23
+ data_collection:
24
+ metrics_description: |
25
+ This collector monitors the current number of processes, threads, and context switches on Windows systems.
26
+ method_description: |
27
+ It queries the 'System' object from Perflib in order to gather the metrics.
28
+ supported_platforms:
29
+ include: ["windows"]
30
+ exclude: []
31
+ multi_instance: false
32
+ additional_permissions:
33
+ description: ""
34
+ default_behavior:
35
+ auto_detection:
36
+ description: |
37
+ The collector automatically detects all of the metrics, no further configuration is required.
38
+ limits:
39
+ description: ""
40
+ performance_impact:
41
+ description: ""
42
+ setup:
43
+ prerequisites:
44
+ list: []
45
+ configuration:
46
+ file:
47
+ name: "netdata.conf"
48
+ section_name: "[plugin:windows]"
49
+ description: "The Netdata main configuration file"
50
+ options:
51
+ description: ""
52
+ folding:
53
+ title: "Config option"
54
+ enabled: false
55
+ list:
56
+ - name: PerflibProcesses
57
+ description: An option to enable or disable the data collection.
58
+ default_value: yes
59
+ required: false
60
+ examples:
61
+ folding:
62
+ enabled: true
63
+ title: ""
64
+ list: []
65
+ troubleshooting:
66
+ problems:
67
+ list: []
68
+ alerts: []
69
+ metrics:
70
+ folding:
71
+ title: Metrics
72
+ enabled: false
73
+ description: ""
74
+ availability: []
75
+ scopes:
76
+ - name: global
77
+ description: "These metrics refer to the entire monitored instance."
78
+ labels: []
79
+ metrics:
80
+ - name: system.processes
81
+ description: System Processes
82
+ unit: "processes"
83
+ chart_type: line
84
+ dimensions:
85
+ - name: running
86
+ - name: system.threads
87
+ description: System Threads
88
+ unit: "threads"
89
+ chart_type: line
90
+ dimensions:
91
+ - name: threads
92
+ - name: system.ctxt
93
+ description: CPU Context Switches
94
+ unit: "context switches/s"
95
+ chart_type: line
96
+ dimensions:
97
+ - name: switches
98
+ - meta:
99
+ plugin_name: windows.plugin
100
+ module_name: PerflibMemory
101
+ monitored_instance:
102
+ name: Memory statistics
103
+ link: "https://learn.microsoft.com/en-us/windows/win32/Memory/memory-management"
104
+ categories:
105
+ - data-collection.windows-systems
106
+ icon_filename: "windows.svg"
107
+ related_resources:
108
+ integrations:
109
+ list: []
110
+ info_provided_to_referring_integrations:
111
+ description: ""
112
+ keywords:
113
+ - memory
114
+ - swap
115
+ most_popular: false
116
+ overview:
117
+ data_collection:
118
+ metrics_description: |
119
+ This collector monitors swap and memory pool statistics on Windows systems.
120
+ method_description: |
121
+ It queries for the 'Memory' object from Perflib in order to gather the metrics.
122
+ supported_platforms:
123
+ include: ["windows"]
124
+ exclude: []
125
+ multi_instance: false
126
+ additional_permissions:
127
+ description: ""
128
+ default_behavior:
129
+ auto_detection:
130
+ description: |
131
+ The collector automatically detects all of the metrics, no further configuration is required.
132
+ limits:
133
+ description: ""
134
+ performance_impact:
135
+ description: ""
136
+ setup:
137
+ prerequisites:
138
+ list: []
139
+ configuration:
140
+ file:
141
+ name: "netdata.conf"
142
+ section_name: "[plugin:windows]"
143
+ description: "The Netdata main configuration file"
144
+ options:
145
+ description: ""
146
+ folding:
147
+ title: "Config option"
148
+ enabled: false
149
+ list:
150
+ - name: PerflibMemory
151
+ description: An option to enable or disable the data collection.
152
+ default_value: yes
153
+ required: false
154
+ examples:
155
+ folding:
156
+ enabled: true
157
+ title: ""
158
+ list: []
159
+ troubleshooting:
160
+ problems:
161
+ list: []
162
+ alerts: []
163
+ metrics:
164
+ folding:
165
+ title: Metrics
166
+ enabled: false
167
+ description: ""
168
+ availability: []
169
+ scopes:
170
+ - name: global
171
+ description: "These metrics refer to the entire monitored instance"
172
+ labels: []
173
+ metrics:
174
+ - name: mem.swap_iops
175
+ description: Swap Operations
176
+ unit: "operations/s"
177
+ chart_type: stacked
178
+ dimensions:
179
+ - name: read
180
+ - name: write
181
+ - name: mem.swap_pages_io
182
+ description: Swap Pages
183
+ unit: "pages/s"
184
+ chart_type: stacked
185
+ dimensions:
186
+ - name: read
187
+ - name: write
188
+ - name: mem.system_pool_size
189
+ description: System Memory Pool
190
+ unit: "bytes"
191
+ chart_type: stacked
192
+ dimensions:
193
+ - name: paged
194
+ - name: pool-paged
195
+ - meta:
196
+ plugin_name: windows.plugin
197
+ module_name: PerflibThermalZone
198
+ monitored_instance:
199
+ name: System thermal zone
200
+ link: "https://learn.microsoft.com/en-us/windows-hardware/design/device-experiences/design-guide"
201
+ categories:
202
+ - data-collection.windows-systems
203
+ icon_filename: "windows.svg"
204
+ related_resources:
205
+ integrations:
206
+ list: []
207
+ info_provided_to_referring_integrations:
208
+ description: ""
209
+ keywords:
210
+ - thermal
211
+ - temperature
212
+ most_popular: false
213
+ overview:
214
+ data_collection:
215
+ metrics_description: |
216
+ This collector monitors thermal zone statistics on Windows systems.
217
+ method_description: |
218
+ It queries for the 'Thermal Zone Information' object from Perflib in order to gather the metrics.
219
+ supported_platforms:
220
+ include: ["windows"]
221
+ exclude: []
222
+ multi_instance: false
223
+ additional_permissions:
224
+ description: ""
225
+ default_behavior:
226
+ auto_detection:
227
+ description: |
228
+ The collector automatically detects all of the metrics, no further configuration is required.
229
+ limits:
230
+ description: ""
231
+ performance_impact:
232
+ description: ""
233
+ setup:
234
+ prerequisites:
235
+ list: []
236
+ configuration:
237
+ file:
238
+ section_name: "[plugin:windows]"
239
+ name: "netdata.conf"
240
+ description: "The Netdata main configuration file."
241
+ options:
242
+ description: ""
243
+ folding:
244
+ title: "Config Option"
245
+ enabled: false
246
+ list:
247
+ - name: PerflibThermalZone
248
+ description: An option to enable or disable the data collection.
249
+ default_value: yes
250
+ required: false
251
+ examples:
252
+ folding:
253
+ enabled: false
254
+ title: ""
255
+ list: []
256
+ troubleshooting:
257
+ problems:
258
+ list: []
259
+ alerts: []
260
+ metrics:
261
+ folding:
262
+ title: Metrics
263
+ enabled: false
264
+ description: ""
265
+ availability: []
266
+ scopes:
267
+ - name: Thermal zone
268
+ description: "These metrics refer to a Thermal zone"
269
+ labels: []
270
+ metrics:
271
+ - name: system.thermalzone_temperature
272
+ description: Thermal zone temperature
273
+ unit: celsius
274
+ chart_type: line
275
+ dimensions:
276
+ - name: temperature
src/collectors/windows.plugin/metdata.yaml
deleted
-92
@@ -1,92 +0,0 @@
1
-plugin_name: windows.plugin
2
-modules:
3
- - meta:
4
- plugin_name: proc.plugin
5
- module_name: PerflibProcesses
6
- monitored_instance:
7
- name: System statistics
8
- link: ""
9
- categories:
10
- - data-collection.windows-systems
11
- icon_filename: "windows.svg"
12
- related_resources:
13
- integrations:
14
- list: [ ]
15
- info_provided_to_referring_integrations:
16
- description: ""
17
- keywords:
18
- - process counts
19
- - threads
20
- most_popular: false
21
- overview:
22
- data_collection:
23
- metrics_description: |
24
- Perflib provides different statistical methods about Microsoft Windows environment. This collector query for
25
- Object 'System' to show actual number of processes, threads and context switches.
26
- method_description: ""
27
- supported_platforms:
28
- include: [ "windows" ]
29
- exclude: [ ]
30
- multi_instance: false
31
- additional_permissions:
32
- description: ""
33
- default_behavior:
34
- auto_detection:
35
- description: |
36
- The collector auto-detects all metrics. No configuration is needed.
37
- limits:
38
- description: ""
39
- performance_impact:
40
- description: ""
41
- setup:
42
- prerequisites:
43
- list: [ ]
44
- configuration:
45
- file:
46
- section_name: ""
47
- name: ""
48
- description: ""
49
- options:
50
- description: ""
51
- folding:
52
- title: ""
53
- enabled: true
54
- list: [ ]
55
- examples:
56
- folding:
57
- enabled: true
58
- title: ""
59
- list: [ ]
60
- troubleshooting:
61
- problems:
62
- list: [ ]
63
- alerts:
64
- metrics:
65
- folding:
66
- title: Metrics
67
- enabled: false
68
- description: ""
69
- availability: [ ]
70
- scopes:
71
- - name: global
72
- description: ""
73
- labels: [ ]
74
- metrics:
75
- - name: system.processes
76
- description: System Processes
77
- unit: "processes"
78
- chart_type: line
79
- dimensions:
80
- - name: running
81
- - name: system.threads
82
- description: System Threads
83
- unit: "threads"
84
- chart_type: line
85
- dimensions:
86
- - name: threads
87
- - name: system.ctxt
88
- description: CPU Context Switches
89
- unit: "context switches/s"
90
- chart_type: line
91
- dimensions:
92
- - name: switches
\ No newline at end of file