Skip to main content

vCenter Server Appliance monitoring with Netdata

The vCenter Server Appliance using Health API is a preconfigured Linux virtual machine, which is optimized for running VMware vCenter Server® and the associated services on Linux.

This module collects health statistics from one or more vCenter Server Appliance servers, depending on your configuration.

Requirements#

  • vSphere 6.5+

Charts#

  • Overall System Health in status
  • Components Health in status
  • Software Updates Health in status

Health statuses#

Overall System Health:

NumericTextDescription
-1unknownModule failed to decode status.
0greenAll components in the appliance are healthy.
1yellowOne or more components in the appliance might become overloaded soon.
2orangeOne or more components in the appliance might be degraded.
3redOne or more components in the appliance might be in an unusable status and the appliance might become unresponsive soon.
4grayNo health data is available.

Components Health:

NumericTextDescription
-1unknownModule failed to decode status.
0greenThe component is healthy.
1yellowThe component is healthy, but may have some problems.
2orangeThe component is degraded, and may have serious problems.
3redThe component is unavailable, or will stop functioning soon.
4grayNo health data is available.

Software Updates Health:

NumericTextDescription
-1unknownModule failed to decode status.
0greenNo updates available.
2orangeNon-security patches might be available.
3redSecurity patches might be available.
4grayAn error retrieving information on software updates.

Configuration#

Edit the go.d/vcsa.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/vcsa.conf

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

jobs:
- name: vcsa1
url: https://203.0.113.0
username: admin@vsphere.local
password: somepassword
- name: vcsa2
url: https://203.0.113.10
username: admin@vsphere.local
password: somepassword

For all available options please see module configuration file.

Troubleshooting#

To troubleshoot issues with the vcsa 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.

First, navigate to your plugins directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the setting plugins directory. Once you're in the plugin's directory, switch to the netdata user.

cd /usr/libexec/netdata/plugins.d/
sudo -u netdata -s

You can now run the go.d.plugin to debug the collector:

./go.d.plugin -d -m vcsa

Reach out

If you need help after reading this doc, search our community forum for an answer. There's a good chance someone else has already found a solution to the same issue.

Documentation

Community