github.com/netdata/go.d.plugin@v0.58.1/modules/vsphere/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-vsphere 5 plugin_name: go.d.plugin 6 module_name: vsphere 7 monitored_instance: 8 name: VMware vCenter Server 9 link: https://www.vmware.com/products/vcenter-server.html 10 icon_filename: vmware.svg 11 categories: 12 - data-collection.containers-and-vms 13 keywords: 14 - vmware 15 - esxi 16 - vcenter 17 related_resources: 18 integrations: 19 list: [] 20 info_provided_to_referring_integrations: 21 description: "" 22 most_popular: true 23 overview: 24 data_collection: 25 metrics_description: | 26 This collector monitors hosts and vms performance statistics from `vCenter` servers. 27 28 > **Warning**: The `vsphere` collector cannot re-login and continue collecting metrics after a vCenter reboot. 29 > go.d.plugin needs to be restarted. 30 method_description: "" 31 supported_platforms: 32 include: [] 33 exclude: [] 34 multi_instance: true 35 additional_permissions: 36 description: "" 37 default_behavior: 38 auto_detection: 39 description: "" 40 limits: 41 description: "" 42 performance_impact: 43 description: | 44 The default `update_every` is 20 seconds, and it doesn't make sense to decrease the value. 45 **VMware real-time statistics are generated at the 20-second specificity**. 46 47 It is likely that 20 seconds is not enough for big installations and the value should be tuned. 48 49 To get a better view we recommend running the collector in debug mode and seeing how much time it will take to collect metrics. 50 51 <details> 52 <summary>Example (all not related debug lines were removed)</summary> 53 54 ``` 55 [ilyam@pc]$ ./go.d.plugin -d -m vsphere 56 [ DEBUG ] vsphere[vsphere] discover.go:94 discovering : starting resource discovering process 57 [ DEBUG ] vsphere[vsphere] discover.go:102 discovering : found 3 dcs, process took 49.329656ms 58 [ DEBUG ] vsphere[vsphere] discover.go:109 discovering : found 12 folders, process took 49.538688ms 59 [ DEBUG ] vsphere[vsphere] discover.go:116 discovering : found 3 clusters, process took 47.722692ms 60 [ DEBUG ] vsphere[vsphere] discover.go:123 discovering : found 2 hosts, process took 52.966995ms 61 [ DEBUG ] vsphere[vsphere] discover.go:130 discovering : found 2 vms, process took 49.832979ms 62 [ INFO ] vsphere[vsphere] discover.go:140 discovering : found 3 dcs, 12 folders, 3 clusters (2 dummy), 2 hosts, 3 vms, process took 249.655993ms 63 [ DEBUG ] vsphere[vsphere] build.go:12 discovering : building : starting building resources process 64 [ INFO ] vsphere[vsphere] build.go:23 discovering : building : built 3/3 dcs, 12/12 folders, 3/3 clusters, 2/2 hosts, 3/3 vms, process took 63.3µs 65 [ DEBUG ] vsphere[vsphere] hierarchy.go:10 discovering : hierarchy : start setting resources hierarchy process 66 [ INFO ] vsphere[vsphere] hierarchy.go:18 discovering : hierarchy : set 3/3 clusters, 2/2 hosts, 3/3 vms, process took 6.522µs 67 [ DEBUG ] vsphere[vsphere] filter.go:24 discovering : filtering : starting filtering resources process 68 [ DEBUG ] vsphere[vsphere] filter.go:45 discovering : filtering : removed 0 unmatched hosts 69 [ DEBUG ] vsphere[vsphere] filter.go:56 discovering : filtering : removed 0 unmatched vms 70 [ INFO ] vsphere[vsphere] filter.go:29 discovering : filtering : filtered 0/2 hosts, 0/3 vms, process took 42.973µs 71 [ DEBUG ] vsphere[vsphere] metric_lists.go:14 discovering : metric lists : starting resources metric lists collection process 72 [ INFO ] vsphere[vsphere] metric_lists.go:30 discovering : metric lists : collected metric lists for 2/2 hosts, 3/3 vms, process took 275.60764ms 73 [ INFO ] vsphere[vsphere] discover.go:74 discovering : discovered 2/2 hosts, 3/3 vms, the whole process took 525.614041ms 74 [ INFO ] vsphere[vsphere] discover.go:11 starting discovery process, will do discovery every 5m0s 75 [ DEBUG ] vsphere[vsphere] collect.go:11 starting collection process 76 [ DEBUG ] vsphere[vsphere] scrape.go:48 scraping : scraped metrics for 2/2 hosts, process took 96.257374ms 77 [ DEBUG ] vsphere[vsphere] scrape.go:60 scraping : scraped metrics for 3/3 vms, process took 57.879697ms 78 [ DEBUG ] vsphere[vsphere] collect.go:23 metrics collected, process took 154.77997ms 79 ``` 80 81 </details> 82 83 There you can see that discovering took `525.614041ms`, and collecting metrics took `154.77997ms`. Discovering is a separate thread, it doesn't affect collecting. 84 `update_every` and `timeout` parameters should be adjusted based on these numbers. 85 setup: 86 prerequisites: 87 list: [] 88 configuration: 89 file: 90 name: go.d/vsphere.conf 91 options: 92 description: | 93 The following options can be defined globally: update_every, autodetection_retry. 94 folding: 95 title: Config options 96 enabled: true 97 list: 98 - name: update_every 99 description: Data collection frequency. 100 default_value: 20 101 required: false 102 - name: autodetection_retry 103 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 104 default_value: 0 105 required: false 106 - name: url 107 description: vCenter server URL. 108 default_value: "" 109 required: true 110 - name: host_include 111 description: Hosts selector (filter). 112 default_value: "" 113 required: false 114 detailed_description: | 115 Metrics of hosts matching the selector will be collected. 116 117 - Include pattern syntax: "/Datacenter pattern/Cluster pattern/Host pattern". 118 - Match pattern syntax: [simple patterns](https://github.com/netdata/netdata/blob/master/src/libnetdata/simple_pattern/README.md#simple-patterns). 119 - Syntax: 120 121 ```yaml 122 host_include: 123 - '/DC1/*' # select all hosts from datacenter DC1 124 - '/DC2/*/!Host2 *' # select all hosts from datacenter DC2 except HOST2 125 - '/DC3/Cluster3/*' # select all hosts from datacenter DC3 cluster Cluster3 126 ``` 127 - name: vm_include 128 description: Virtual machines selector (filter). 129 default_value: "" 130 required: false 131 detailed_description: | 132 Metrics of VMs matching the selector will be collected. 133 134 - Include pattern syntax: "/Datacenter pattern/Cluster pattern/Host pattern/VM pattern". 135 - Match pattern syntax: [simple patterns](https://github.com/netdata/netdata/blob/master/src/libnetdata/simple_pattern/README.md#simple-patterns). 136 - Syntax: 137 138 ```yaml 139 vm_include: 140 - '/DC1/*' # select all VMs from datacenter DC 141 - '/DC2/*/*/!VM2 *' # select all VMs from datacenter DC2 except VM2 142 - '/DC3/Cluster3/*' # select all VMs from datacenter DC3 cluster Cluster3 143 ``` 144 - name: discovery_interval 145 description: Hosts and VMs discovery interval. 146 default_value: 300 147 required: false 148 - name: timeout 149 description: HTTP request timeout. 150 default_value: 20 151 required: false 152 - name: username 153 description: Username for basic HTTP authentication. 154 default_value: "" 155 required: false 156 - name: password 157 description: Password for basic HTTP authentication. 158 default_value: "" 159 required: false 160 - name: proxy_url 161 description: Proxy URL. 162 default_value: "" 163 required: false 164 - name: proxy_username 165 description: Username for proxy basic HTTP authentication. 166 default_value: "" 167 required: false 168 - name: proxy_password 169 description: Password for proxy basic HTTP authentication. 170 default_value: "" 171 required: false 172 - name: not_follow_redirects 173 description: Redirect handling policy. Controls whether the client follows redirects. 174 default_value: no 175 required: false 176 - name: tls_skip_verify 177 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 178 default_value: no 179 required: false 180 - name: tls_ca 181 description: Certification authority that the client uses when verifying the server's certificates. 182 default_value: "" 183 required: false 184 - name: tls_cert 185 description: Client TLS certificate. 186 default_value: "" 187 required: false 188 - name: tls_key 189 description: Client TLS key. 190 default_value: "" 191 required: false 192 examples: 193 folding: 194 title: Config 195 enabled: true 196 list: 197 - name: Basic 198 folding: 199 enabled: false 200 description: A basic example configuration. 201 config: | 202 jobs: 203 - name : vcenter1 204 url : https://203.0.113.1 205 username : admin@vsphere.local 206 password : somepassword 207 - name: Multi-instance 208 description: | 209 > **Note**: When you define multiple jobs, their names must be unique. 210 211 Collecting metrics from local and remote instances. 212 config: | 213 jobs: 214 - name : vcenter1 215 url : https://203.0.113.1 216 username : admin@vsphere.local 217 password : somepassword 218 219 - name : vcenter2 220 url : https://203.0.113.10 221 username : admin@vsphere.local 222 password : somepassword 223 troubleshooting: 224 problems: 225 list: [] 226 alerts: 227 - name: vsphere_vm_cpu_utilization 228 metric: vsphere.vm_cpu_utilization 229 info: Virtual Machine CPU utilization 230 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vsphere.conf 231 - name: vsphere_vm_mem_usage 232 metric: vsphere.vm_mem_utilization 233 info: Virtual Machine memory utilization 234 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vsphere.conf 235 - name: vsphere_host_cpu_utilization 236 metric: vsphere.host_cpu_utilization 237 info: ESXi Host CPU utilization 238 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vsphere.conf 239 - name: vsphere_host_mem_utilization 240 metric: vsphere.host_mem_utilization 241 info: ESXi Host memory utilization 242 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vsphere.conf 243 metrics: 244 folding: 245 title: Metrics 246 enabled: false 247 description: "" 248 availability: [] 249 scopes: 250 - name: virtual machine 251 description: These metrics refer to the Virtual Machine. 252 labels: 253 - name: datacenter 254 description: Datacenter name 255 - name: cluster 256 description: Cluster name 257 - name: host 258 description: Host name 259 - name: vm 260 description: Virtual Machine name 261 metrics: 262 - name: vsphere.vm_cpu_utilization 263 description: Virtual Machine CPU utilization 264 unit: percentage 265 chart_type: line 266 dimensions: 267 - name: used 268 - name: vsphere.vm_mem_utilization 269 description: Virtual Machine memory utilization 270 unit: percentage 271 chart_type: line 272 dimensions: 273 - name: used 274 - name: vsphere.vm_mem_usage 275 description: Virtual Machine memory usage 276 unit: KiB 277 chart_type: line 278 dimensions: 279 - name: granted 280 - name: consumed 281 - name: active 282 - name: shared 283 - name: vsphere.vm_mem_swap_usage 284 description: Virtual Machine VMKernel memory swap usage 285 unit: KiB 286 chart_type: line 287 dimensions: 288 - name: swapped 289 - name: vsphere.vm_mem_swap_io 290 description: Virtual Machine VMKernel memory swap IO 291 unit: KiB/s 292 chart_type: area 293 dimensions: 294 - name: in 295 - name: out 296 - name: vsphere.vm_disk_io 297 description: Virtual Machine disk IO 298 unit: KiB/s 299 chart_type: area 300 dimensions: 301 - name: read 302 - name: write 303 - name: vsphere.vm_disk_max_latency 304 description: Virtual Machine disk max latency 305 unit: milliseconds 306 chart_type: line 307 dimensions: 308 - name: latency 309 - name: vsphere.vm_net_traffic 310 description: Virtual Machine network traffic 311 unit: KiB/s 312 chart_type: area 313 dimensions: 314 - name: received 315 - name: sent 316 - name: vsphere.vm_net_packets 317 description: Virtual Machine network packets 318 unit: packets 319 chart_type: line 320 dimensions: 321 - name: received 322 - name: sent 323 - name: vsphere.vm_net_drops 324 description: Virtual Machine network dropped packets 325 unit: packets 326 chart_type: line 327 dimensions: 328 - name: received 329 - name: sent 330 - name: vsphere.vm_overall_status 331 description: Virtual Machine overall alarm status 332 unit: status 333 chart_type: line 334 dimensions: 335 - name: green 336 - name: red 337 - name: yellow 338 - name: gray 339 - name: vsphere.vm_system_uptime 340 description: Virtual Machine system uptime 341 unit: seconds 342 chart_type: line 343 dimensions: 344 - name: uptime 345 - name: host 346 description: These metrics refer to the ESXi host. 347 labels: 348 - name: datacenter 349 description: Datacenter name 350 - name: cluster 351 description: Cluster name 352 - name: host 353 description: Host name 354 metrics: 355 - name: vsphere.host_cpu_utilization 356 description: ESXi Host CPU utilization 357 unit: percentage 358 chart_type: line 359 dimensions: 360 - name: used 361 - name: vsphere.host_mem_utilization 362 description: ESXi Host memory utilization 363 unit: percentage 364 chart_type: line 365 dimensions: 366 - name: used 367 - name: vsphere.host_mem_usage 368 description: ESXi Host memory usage 369 unit: KiB 370 chart_type: line 371 dimensions: 372 - name: granted 373 - name: consumed 374 - name: active 375 - name: shared 376 - name: sharedcommon 377 - name: vsphere.host_mem_swap_io 378 description: ESXi Host VMKernel memory swap IO 379 unit: KiB/s 380 chart_type: area 381 dimensions: 382 - name: in 383 - name: out 384 - name: vsphere.host_disk_io 385 description: ESXi Host disk IO 386 unit: KiB/s 387 chart_type: area 388 dimensions: 389 - name: read 390 - name: write 391 - name: vsphere.host_disk_max_latency 392 description: ESXi Host disk max latency 393 unit: milliseconds 394 chart_type: line 395 dimensions: 396 - name: latency 397 - name: vsphere.host_net_traffic 398 description: ESXi Host network traffic 399 unit: KiB/s 400 chart_type: line 401 dimensions: 402 - name: received 403 - name: sent 404 - name: vsphere.host_net_packets 405 description: ESXi Host network packets 406 unit: packets 407 chart_type: line 408 dimensions: 409 - name: received 410 - name: sent 411 - name: vsphere.host_net_drops 412 description: ESXi Host network drops 413 unit: packets 414 chart_type: line 415 dimensions: 416 - name: received 417 - name: sent 418 - name: vsphere.host_net_errors 419 description: ESXi Host network errors 420 unit: errors 421 chart_type: line 422 dimensions: 423 - name: received 424 - name: sent 425 - name: vsphere.host_overall_status 426 description: ESXi Host overall alarm status 427 unit: status 428 chart_type: line 429 dimensions: 430 - name: green 431 - name: red 432 - name: yellow 433 - name: gray 434 - name: vsphere.host_system_uptime 435 description: ESXi Host system uptime 436 unit: seconds 437 chart_type: line 438 dimensions: 439 - name: uptime