Xen yaml update (#15567)
* xen_yaml: Modify initial format * xen_yaml: Update xen metadata * xen_yaml: Fix trailing space * Update metadata.yaml * Update collectors/xenstat.plugin/metadata.yaml Co-authored-by: Shyam Sreevalsan <shyam@netdata.cloud> --------- Co-authored-by: Fotis Voutsas <fotis@netdata.cloud> Co-authored-by: Shyam Sreevalsan <shyam@netdata.cloud>
thiagoftsm committed
Jul 27, 2023 at 12:48 UTC
959919a1aa90e20d60d074d8d65b48483b71ff24
1 file changed
+150
-136
collectors/xenstat.plugin/metadata.yaml
+150
-136
@@ -1,53 +1,67 @@
1
+# yamllint disable rule:line-length
2
+---
3
meta:
4
plugin_name: xenstat.plugin
5
module_name: xenstat.plugin
6
monitored_instance:
7
name: Xen/XCP-ng
6
- link: ''
8
+ link: "https://xenproject.org/"
9
categories:
8
- - data-collection.containers-and-vms
9
- icon_filename: 'xen.png'
10
+ - data-collection.containers-and-vms
11
+ icon_filename: "xen.png"
12
related_resources:
13
integrations:
14
list: []
15
info_provided_to_referring_integrations:
14
- description: ''
16
+ description: ""
17
keywords: []
18
most_popular: false
19
overview:
20
data_collection:
19
- metrics_description: 'Monitor Xen/XCP-ng with Netdata for streamlined virtual machine performance and resource management. Optimize virtualization operations with real-time insights, built-in alerts, and anomaly advisor.'
20
- method_description: ''
21
+ metrics_description: "This collector monitors XenServer and XCP-ng host and domains statistics."
22
+ method_description: ""
23
supported_platforms:
24
include: []
25
exclude: []
26
multi_instance: true
27
additional_permissions:
26
- description: ''
28
+ description: "The plugin needs setuid."
29
default_behavior:
30
auto_detection:
29
- description: ''
31
+ description: "This plugin requires the `xen-dom0-libs-devel` and `yajl-devel` libraries to be installed."
32
limits:
31
- description: ''
33
+ description: ""
34
performance_impact:
33
- description: ''
35
+ description: ""
36
setup:
37
prerequisites:
36
- list: []
38
+ list:
39
+ - title: Libraries
40
+ description: |
41
+ 1. Install `xen-dom0-libs-devel` and `yajl-devel` using the package manager of your system.
42
+
43
+ Note: On Cent-OS systems you will need `centos-release-xen` repository and the required package for xen is `xen-devel`
44
+
45
+ 2. Re-install Netdata from source. The installer will detect that the required libraries are now available and will also build xenstat.plugin.
46
configuration:
47
file:
39
- name: ''
40
- description: ''
48
+ name: "netdata.conf"
49
+ section_name: "[plugin:xenstat]"
50
+ description: "The netdata main configuration file."
51
options:
42
- description: ''
52
+ description: ""
53
folding:
44
- title: ''
54
+ title: "Config options"
55
enabled: true
46
- list: []
56
+ list:
57
+ - name: update every
58
+ description: Data collection frequency.
59
+ default_value: 1
60
+ required: false
61
examples:
62
folding:
63
enabled: true
50
- title: ''
64
+ title: ""
65
list: []
66
troubleshooting:
67
problems:
@@ -60,122 +74,122 @@ metrics:
74
description: ""
75
availability: []
76
scopes:
63
- - name: global
64
- description: ""
65
- labels: []
66
- metrics:
67
- - name: xenstat.mem
68
- description: Memory Usage
69
- unit: "MiB"
70
- chart_type: stacked
71
- dimensions:
72
- - name: free
73
- - name: used
74
- - name: xenstat.domains
75
- description: Number of Domains
76
- unit: "domains"
77
- chart_type: line
78
- dimensions:
79
- - name: domains
80
- - name: xenstat.cpus
81
- description: Number of CPUs
82
- unit: "cpus"
83
- chart_type: line
84
- dimensions:
85
- - name: cpus
86
- - name: xenstat.cpu_freq
87
- description: CPU Frequency
88
- unit: "MHz"
89
- chart_type: line
90
- dimensions:
91
- - name: frequency
92
- - name: xendomain
93
- description: ""
94
- labels: []
95
- metrics:
96
- - name: xendomain.states
97
- description: Domain States
98
- unit: "boolean"
99
- chart_type: line
100
- dimensions:
101
- - name: running
102
- - name: blocked
103
- - name: paused
104
- - name: shutdown
105
- - name: crashed
106
- - name: dying
107
- - name: xendomain.cpu
108
- description: CPU Usage (100% = 1 core)
109
- unit: "percentage"
110
- chart_type: line
111
- dimensions:
112
- - name: used
113
- - name: xendomain.mem
114
- description: Memory Reservation
115
- unit: "MiB"
116
- chart_type: line
117
- dimensions:
118
- - name: maximum
119
- - name: current
120
- - name: xendomain.vcpu
121
- description: CPU Usage per VCPU
122
- unit: "percentage"
123
- chart_type: line
124
- dimensions:
125
- - name: a dimension per vcpu
126
- - name: xendomain, vbd
127
- description: ""
128
- labels: []
129
- metrics:
130
- - name: xendomain.oo_req_vbd
131
- description: VBD{%u} Out Of Requests
132
- unit: "requests/s"
133
- chart_type: line
134
- dimensions:
135
- - name: requests
136
- - name: xendomain.requests_vbd
137
- description: VBD{%u} Requests
138
- unit: "requests/s"
139
- chart_type: line
140
- dimensions:
141
- - name: read
142
- - name: write
143
- - name: xendomain.sectors_vbd
144
- description: VBD{%u} Read/Written Sectors
145
- unit: "sectors/s"
146
- chart_type: line
147
- dimensions:
148
- - name: read
149
- - name: write
150
- - name: xendomain, network
151
- description: ""
152
- labels: []
153
- metrics:
154
- - name: xendomain.bytes_network
155
- description: Network{%u} Received/Sent Bytes
156
- unit: "kilobits/s"
157
- chart_type: line
158
- dimensions:
159
- - name: received
160
- - name: sent
161
- - name: xendomain.packets_network
162
- description: Network{%u} Received/Sent Packets
163
- unit: "packets/s"
164
- chart_type: line
165
- dimensions:
166
- - name: received
167
- - name: sent
168
- - name: xendomain.errors_network
169
- description: Network{%u} Receive/Transmit Errors
170
- unit: "errors/s"
171
- chart_type: line
172
- dimensions:
173
- - name: received
174
- - name: sent
175
- - name: xendomain.drops_network
176
- description: Network{%u} Receive/Transmit Drops
177
- unit: "drops/s"
178
- chart_type: line
179
- dimensions:
180
- - name: received
181
- - name: sent
77
+ - name: global
78
+ description: "These metrics refer to the entire monitored application."
79
+ labels: []
80
+ metrics:
81
+ - name: xenstat.mem
82
+ description: Memory Usage
83
+ unit: "MiB"
84
+ chart_type: stacked
85
+ dimensions:
86
+ - name: free
87
+ - name: used
88
+ - name: xenstat.domains
89
+ description: Number of Domains
90
+ unit: "domains"
91
+ chart_type: line
92
+ dimensions:
93
+ - name: domains
94
+ - name: xenstat.cpus
95
+ description: Number of CPUs
96
+ unit: "cpus"
97
+ chart_type: line
98
+ dimensions:
99
+ - name: cpus
100
+ - name: xenstat.cpu_freq
101
+ description: CPU Frequency
102
+ unit: "MHz"
103
+ chart_type: line
104
+ dimensions:
105
+ - name: frequency
106
+ - name: xendomain
107
+ description: "Metrics related to Xen domains. Each domain provides its own set of the following metrics."
108
+ labels: []
109
+ metrics:
110
+ - name: xendomain.states
111
+ description: Domain States
112
+ unit: "boolean"
113
+ chart_type: line
114
+ dimensions:
115
+ - name: running
116
+ - name: blocked
117
+ - name: paused
118
+ - name: shutdown
119
+ - name: crashed
120
+ - name: dying
121
+ - name: xendomain.cpu
122
+ description: CPU Usage (100% = 1 core)
123
+ unit: "percentage"
124
+ chart_type: line
125
+ dimensions:
126
+ - name: used
127
+ - name: xendomain.mem
128
+ description: Memory Reservation
129
+ unit: "MiB"
130
+ chart_type: line
131
+ dimensions:
132
+ - name: maximum
133
+ - name: current
134
+ - name: xendomain.vcpu
135
+ description: CPU Usage per VCPU
136
+ unit: "percentage"
137
+ chart_type: line
138
+ dimensions:
139
+ - name: a dimension per vcpu
140
+ - name: xendomain vbd
141
+ description: "Metrics related to Xen domain Virtual Block Device. Each VBD provides its own set of the following metrics."
142
+ labels: []
143
+ metrics:
144
+ - name: xendomain.oo_req_vbd
145
+ description: VBD{%u} Out Of Requests
146
+ unit: "requests/s"
147
+ chart_type: line
148
+ dimensions:
149
+ - name: requests
150
+ - name: xendomain.requests_vbd
151
+ description: VBD{%u} Requests
152
+ unit: "requests/s"
153
+ chart_type: line
154
+ dimensions:
155
+ - name: read
156
+ - name: write
157
+ - name: xendomain.sectors_vbd
158
+ description: VBD{%u} Read/Written Sectors
159
+ unit: "sectors/s"
160
+ chart_type: line
161
+ dimensions:
162
+ - name: read
163
+ - name: write
164
+ - name: xendomain network
165
+ description: "Metrics related to Xen domain network interfaces. Each network interface provides its own set of the following metrics."
166
+ labels: []
167
+ metrics:
168
+ - name: xendomain.bytes_network
169
+ description: Network{%u} Received/Sent Bytes
170
+ unit: "kilobits/s"
171
+ chart_type: line
172
+ dimensions:
173
+ - name: received
174
+ - name: sent
175
+ - name: xendomain.packets_network
176
+ description: Network{%u} Received/Sent Packets
177
+ unit: "packets/s"
178
+ chart_type: line
179
+ dimensions:
180
+ - name: received
181
+ - name: sent
182
+ - name: xendomain.errors_network
183
+ description: Network{%u} Receive/Transmit Errors
184
+ unit: "errors/s"
185
+ chart_type: line
186
+ dimensions:
187
+ - name: received
188
+ - name: sent
189
+ - name: xendomain.drops_network
190
+ description: Network{%u} Receive/Transmit Drops
191
+ unit: "drops/s"
192
+ chart_type: line
193
+ dimensions:
194
+ - name: received
195
+ - name: sent