Skip to main content

vCenter Server collector

VMware vCenter Server is advanced server management software that provides a centralized platform for controlling your VMware vSphere environments.

This module collects hosts and vms performance statistics from one or more vCenter servers depending on configuration.

Warning: The vsphere collector cannot re-login and continue collecting metrics after a vCenter reboot. go.d.plugin needs to be restarted.


All metrics have "vsphere." prefix.

vm_cpu_usage_totalvirtual machineusedpercentage
vm_mem_usage_percentagevirtual machineusedpercentage
vm_mem_usagevirtual machinegranted, consumed, active, sharedKiB
vm_mem_swap_ratevirtual machinein, outKiB/s
vm_mem_swapvirtual machineswappedKiB
vm_net_bandwidth_totalvirtual machinerx, txKiB/s
vm_net_packets_totalvirtual machinerx, txpackets
vm_net_drops_totalvirtual machinerx, txpackets
vm_disk_usage_totalvirtual machineread, writeKiB/s
vm_disk_max_latencyvirtual machinelatencyms
vm_overall_statusvirtual machinestatusstatus
vm_system_uptimevirtual machinetimeseconds
host_mem_usagehostgranted, consumed, active, shared, sharedcommonKiB
host_mem_swap_ratehostin, outKiB/s
host_net_bandwidth_totalhostrx, txKiB/s
host_net_packets_totalhostrx, txpackets
host_net_drops_totalhostrx, txpackets
host_net_errors_totalhostrx, txerrors
host_disk_usage_totalhostread, writeKiB/s


Edit the go.d/vsphere.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/vsphere.conf

Needs only url, username and password. Here is an example for 2 servers:

- name: vcenter1
username: [email protected]
password: somepassword
host_include: ['/*']
vm_include: ['/*']

- name: vcenter2
username: [email protected]
password: somepassword
host_include: ['/*']
vm_include: ['/*']

For all available options please see module configuration file.

Hosts/vms filtering

Module supports filtering hosts and vms. Filtering options are host_include and vm_include.

  • host_include is a list of match patterns: /Dc pattern[/Cluster pattern/Host pattern].
  • vm_include is a list of match patterns: /Dc pattern[/Cluster pattern/Host pattern/VM name].

Pattern should start with /. It matches name, syntax: simple patterns.


    host_include: # filter all hosts
- '/!*'
vm_include: # allow all vms
- '/*'

host_include: # allow all DC1 datacenter hosts and DC2 datacenter hosts except HOST2
- '/DC1/*'
- '/DC2/*/!HOST2 *'
vm_include: # allow all vms from datacenters whose names starts with DC1 and from all hosts except HOST1 and HOST2
- '/DC1*/*/!HOST1 !HOST2 */*'

Update every

Default update_every is 20 seconds, and it doesn't make sense to decrease the value. VMware real-time statistics are generated at the 20-seconds specificity.

It is likely that 20 seconds is not enough for big installations and the value should be tuned.

To get better view we recommend to run the collector in debug mode and see how much time it will take to collect metrics.

Example (all not related debug lines were removed):

[[email protected]]$ ./go.d.plugin -d -m vsphere
[ DEBUG ] vsphere[vsphere] discover.go:94 discovering : starting resource discovering process
[ DEBUG ] vsphere[vsphere] discover.go:102 discovering : found 3 dcs, process took 49.329656ms
[ DEBUG ] vsphere[vsphere] discover.go:109 discovering : found 12 folders, process took 49.538688ms
[ DEBUG ] vsphere[vsphere] discover.go:116 discovering : found 3 clusters, process took 47.722692ms
[ DEBUG ] vsphere[vsphere] discover.go:123 discovering : found 2 hosts, process took 52.966995ms
[ DEBUG ] vsphere[vsphere] discover.go:130 discovering : found 2 vms, process took 49.832979ms
[ INFO ] vsphere[vsphere] discover.go:140 discovering : found 3 dcs, 12 folders, 3 clusters (2 dummy), 2 hosts, 3 vms, process took 249.655993ms
[ DEBUG ] vsphere[vsphere] build.go:12 discovering : building : starting building resources process
[ 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
[ DEBUG ] vsphere[vsphere] hierarchy.go:10 discovering : hierarchy : start setting resources hierarchy process
[ INFO ] vsphere[vsphere] hierarchy.go:18 discovering : hierarchy : set 3/3 clusters, 2/2 hosts, 3/3 vms, process took 6.522µs
[ DEBUG ] vsphere[vsphere] filter.go:24 discovering : filtering : starting filtering resources process
[ DEBUG ] vsphere[vsphere] filter.go:45 discovering : filtering : removed 0 unmatched hosts
[ DEBUG ] vsphere[vsphere] filter.go:56 discovering : filtering : removed 0 unmatched vms
[ INFO ] vsphere[vsphere] filter.go:29 discovering : filtering : filtered 0/2 hosts, 0/3 vms, process took 42.973µs
[ DEBUG ] vsphere[vsphere] metric_lists.go:14 discovering : metric lists : starting resources metric lists collection process
[ INFO ] vsphere[vsphere] metric_lists.go:30 discovering : metric lists : collected metric lists for 2/2 hosts, 3/3 vms, process took 275.60764ms
[ INFO ] vsphere[vsphere] discover.go:74 discovering : discovered 2/2 hosts, 3/3 vms, the whole process took 525.614041ms
[ INFO ] vsphere[vsphere] discover.go:11 starting discovery process, will do discovery every 5m0s
[ DEBUG ] vsphere[vsphere] collect.go:11 starting collection process
[ DEBUG ] vsphere[vsphere] scrape.go:48 scraping : scraped metrics for 2/2 hosts, process took 96.257374ms
[ DEBUG ] vsphere[vsphere] scrape.go:60 scraping : scraped metrics for 3/3 vms, process took 57.879697ms
[ DEBUG ] vsphere[vsphere] collect.go:23 metrics collected, process took 154.77997ms

There you can see that discovering took 525.614041ms, collecting metrics took 154.77997ms. Discovering is a separate thread, it doesn't affect collecting.

update_every and timeout parameters should be adjusted based on these numbers.


To troubleshoot issues with the vsphere collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m vsphere

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.