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