@cryptotaxi247 / netdata
Code Commits Issues Pulls Sessions CI/CD
master
master
md 181 lines 4.6 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/xenstat.plugin/README.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/xenstat.plugin/metadata.yaml"
4 sidebar_label: "Xen XCP-ng"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Collectors/Containers and VMs"
7 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
8 endmeta-->
9
10 # Xen XCP-ng
11
12
13 <img src="https://netdata.cloud/img/xen.png" width="150"/>
14
15
16 Plugin: xenstat.plugin
17 Module: xenstat.plugin
18
19 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
20
21 ## Overview
22
23 This collector monitors XenServer and XCP-ng host and domains statistics.
24
25
26
27 This collector is supported on all platforms.
28
29 This collector supports collecting metrics from multiple instances of this integration, including remote instances.
30
31 The plugin needs setuid.
32
33 ### Default Behavior
34
35 #### Auto-Detection
36
37 This plugin requires the `xen-dom0-libs-devel` and `yajl-devel` libraries to be installed.
38
39 #### Limits
40
41 The default configuration for this integration does not impose any limits on data collection.
42
43 #### Performance Impact
44
45 The default configuration for this integration is not expected to impose a significant performance impact on the system.
46
47 ## Setup
48
49
50 ### Prerequisites
51
52 #### Libraries
53
54 1. Install `xen-dom0-libs-devel` and `yajl-devel` using the package manager of your system.
55
56 Note: On Cent-OS systems you will need `centos-release-xen` repository and the required package for xen is `xen-devel`
57
58 2. Re-install Netdata from source. The installer will detect that the required libraries are now available and will also build xenstat.plugin.
59
60
61
62 ### Configuration
63
64 #### Options
65
66
67
68 <details open><summary>Config options</summary>
69
70
71
72 | Option | Description | Default | Required |
73 |:-----|:------------|:--------|:---------:|
74 | update every | Data collection frequency. | 1 | no |
75
76
77 </details>
78
79
80
81 #### via File
82
83 The configuration file name for this integration is `netdata.conf`.
84 Configuration for this specific integration is located in the `[plugin:xenstat]` section within that file.
85
86 The file format is a modified INI syntax. The general structure is:
87
88 ```ini
89 [section1]
90 option1 = some value
91 option2 = some other value
92
93 [section2]
94 option3 = some third value
95 ```
96 You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
97 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
98
99 ```bash
100 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
101 sudo ./edit-config netdata.conf
102 ```
103
104 ##### Examples
105 There are no configuration examples.
106
107
108
109 ## Alerts
110
111 There are no alerts configured by default for this integration.
112
113
114 ## Metrics
115
116 Metrics grouped by *scope*.
117
118 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
119
120
121
122 ### Per Xen XCP-ng instance
123
124 These metrics refer to the entire monitored application.
125
126 This scope has no labels.
127
128 Metrics:
129
130 | Metric | Dimensions | Unit |
131 |:------|:----------|:----|
132 | xenstat.mem | free, used | MiB |
133 | xenstat.domains | domains | domains |
134 | xenstat.cpus | cpus | cpus |
135 | xenstat.cpu_freq | frequency | MHz |
136
137 ### Per xendomain
138
139 Metrics related to Xen domains. Each domain provides its own set of the following metrics.
140
141 This scope has no labels.
142
143 Metrics:
144
145 | Metric | Dimensions | Unit |
146 |:------|:----------|:----|
147 | xendomain.states | running, blocked, paused, shutdown, crashed, dying | boolean |
148 | xendomain.cpu | used | percentage |
149 | xendomain.mem | maximum, current | MiB |
150 | xendomain.vcpu | a dimension per vcpu | percentage |
151
152 ### Per xendomain vbd
153
154 Metrics related to Xen domain Virtual Block Device. Each VBD provides its own set of the following metrics.
155
156 This scope has no labels.
157
158 Metrics:
159
160 | Metric | Dimensions | Unit |
161 |:------|:----------|:----|
162 | xendomain.oo_req_vbd | requests | requests/s |
163 | xendomain.requests_vbd | read, write | requests/s |
164 | xendomain.sectors_vbd | read, write | sectors/s |
165
166 ### Per xendomain network
167
168 Metrics related to Xen domain network interfaces. Each network interface provides its own set of the following metrics.
169
170 This scope has no labels.
171
172 Metrics:
173
174 | Metric | Dimensions | Unit |
175 |:------|:----------|:----|
176 | xendomain.bytes_network | received, sent | kilobits/s |
177 | xendomain.packets_network | received, sent | packets/s |
178 | xendomain.errors_network | received, sent | errors/s |
179 | xendomain.drops_network | received, sent | drops/s |
180
181