Project: Netdata (Observability and Analysis / Observability)
File: vcenter_server_appliance.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/vcsa/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/vcsa/metadata.yaml" sidebar_label: "vCenter Server Appliance" learn_status: "Published" learnrelpath: "Collecting Metrics/Containers and VMs" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/vmware.svg" width="150"/> Plugin: go.d.plugin Module: vcsa <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> This collector monitors of vCenter Server Appliance servers. This collector is supported on all platforms. This collector supports collecting metrics from multiple instances of this integration, including remote instances. This integration doesn't support auto-detection. The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics refer to the entire monitored application. <details> <summary>See health statuses</summary> Overall System Health: | Status | Description | |:-:|:-| | green | All components in the appliance are healthy. | | yellow | One or more components in the appliance might become overloaded soon. | | orange | One or more components in the appliance might be degraded. | | red | One or more components in the appliance might be in an unusable status and the appliance might become unresponsive soon. | | gray | No health data is available. | | unknown | Collector failed to decode status. | Components Health: | Status | Description | |:-:|:-| | green | The component is healthy. | | yellow | The component is healthy, but may have some problems. | | orange | The component is degraded, and may have serious problems. | | red | The component is unavailable, or will stop functioning soon. | | gray | No health data is available. | | unknown | Collector failed to decode status. | Software Updates Health: | Status | Description | |:-:|:--| | green | No updates available. | | orange | Non-security patches might be available. | | red | Security patches might be available. | | gray | An error retrieving information on software updates. | | unknown | Collector failed to decode status. | </details> This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | vcsa.systemhealthstatus | green, red, yellow, orange, gray, unknown | status | | vcsa.applmgmthealthstatus | green, red, yellow, orange, gray, unknown | status | | vcsa.loadhealthstatus | green, red, yellow, orange, gray, unknown | status | | vcsa.memhealthstatus | green, red, yellow, orange, gray, unknown | status | | vcsa.swaphealthstatus | green, red, yellow, orange, gray, unknown | status | | vcsa.databasestoragehealth_status | green, red, yellow, orange, gray, unknown | status | | vcsa.storagehealthstatus | green, red, yellow, orange, gray, unknown | status | | vcsa.softwarepackageshealth_status | green, red, orange, gray, unknown | status | The following alerts are available: | Alert name | On metric | Description | |:|:-|:| | | vcsa.systemhealthstatus | VCSA overall system status is orange. One or more components are degraded. | | | vcsa.systemhealthstatus | VCSA overall system status is red. One or more components are unavailable or will stop functioning soon. | | | vcsa.applmgmthealthstatus | VCSA ApplMgmt component status is orange. It is degraded, and may have serious problems. | | | vcsa.applmgmthealthstatus | VCSA ApplMgmt component status is red. It is unavailable, or will stop functioning soon. | | | vcsa.loadhealthstatus | VCSA Load component status is orange. It is degraded, and may have serious problems. | | |

| VCSA Load component status is red. It is unavailable, or will stop functioning soon. | | | vcsa.memhealthstatus | VCSA Memory component status is orange. It is degraded, and may have serious problems. | | | vcsa.memhealthstatus | VCSA Memory component status is red. It is unavailable, or will stop functioning soon. | | | vcsa.swaphealthstatus | VCSA Swap component status is orange. It is degraded, and may have serious problems. | | | vcsa.swaphealthstatus | VCSA Swap component status is red. It is unavailable, or will stop functioning soon. | | | vcsa.databasestoragehealth_status | VCSA Database Storage component status is orange. It is degraded, and may have serious problems. | | | vcsa.databasestoragehealth_status | VCSA Database Storage component status is red. It is unavailable, or will stop functioning soon. | | | vcsa.storagehealthstatus | VCSA Storage component status is orange. It is degraded, and may have serious problems. | | | vcsa.storagehealthstatus | VCSA Storage component status is red. It is unavailable, or will stop functioning soon. | | | vcsa.softwarepackageshealth_status | VCSA software packages security updates are available. | No action required. The configuration file name for this integration is `go.d/vcsa.conf`. You can edit the configuration file using the `edit-config` script from the Netdata . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/vcsa.conf ``` The following options can be defined globally: updateevery, autodetectionretry. <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | update_every | Data collection frequency. | 5 | no | | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | | url | Server URL. | | yes | | timeout | HTTP request timeout. | 1 | no | | username | Username for basic HTTP authentication. | | yes | | password | Password for basic HTTP authentication. | | yes | | proxy_url | Proxy URL. | | no | | proxy_username | Username for proxy basic HTTP authentication. | | no | | proxy_password | Password for proxy basic HTTP authentication. | | no | | method | HTTP request method. | GET | no | | body | HTTP request body. | | no | | headers | HTTP request headers. | | no | | notfollowredirects | Redirect handling policy. Controls whether the client follows redirects. | false | no | | tlsskipverify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | false | no | | tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no | | tls_cert | Client TLS certificate. | | no | | tls_key | Client TLS key. | | no | </details> An example configuration. <details><summary>Config</summary> ```yaml jobs: name: vcsa1 url: https://203.0.113.1 username: admin@vsphere.local password: password ``` </details> Note: When you define multiple jobs, their names must be unique. Two instances. <details><summary>Config</summary> ```yaml jobs: name: vcsa1 url: https://203.0.113.1 username: admin@vsphere.local password: password name: vcsa2 url: https://203.0.113.10 username: admin@vsphere.local password: password ``` </details> 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. 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]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m vcsa ```