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