github.com/netdata/go.d.plugin@v0.58.1/modules/vcsa/integrations/vcenter_server_appliance.md (about) 1 <!--startmeta 2 custom_edit_url: "https://github.com/netdata/go.d.plugin/edit/master/modules/vcsa/README.md" 3 meta_yaml: "https://github.com/netdata/go.d.plugin/edit/master/modules/vcsa/metadata.yaml" 4 sidebar_label: "vCenter Server Appliance" 5 learn_status: "Published" 6 learn_rel_path: "Data Collection/Containers and VMs" 7 most_popular: False 8 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" 9 endmeta--> 10 11 # vCenter Server Appliance 12 13 14 <img src="https://netdata.cloud/img/vmware.svg" width="150"/> 15 16 17 Plugin: go.d.plugin 18 Module: vcsa 19 20 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> 21 22 ## Overview 23 24 This collector monitors [health statistics](https://developer.vmware.com/apis/vsphere-automation/latest/appliance/health/) of vCenter Server Appliance servers. 25 26 27 28 29 This collector is supported on all platforms. 30 31 This collector supports collecting metrics from multiple instances of this integration, including remote instances. 32 33 34 ### Default Behavior 35 36 #### Auto-Detection 37 38 This integration doesn't support auto-detection. 39 40 #### Limits 41 42 The default configuration for this integration does not impose any limits on data collection. 43 44 #### Performance Impact 45 46 The default configuration for this integration is not expected to impose a significant performance impact on the system. 47 48 49 ## Metrics 50 51 Metrics grouped by *scope*. 52 53 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. 54 55 56 57 ### Per vCenter Server Appliance instance 58 59 These metrics refer to the entire monitored application. 60 <details> 61 <summary>See health statuses</summary> 62 Overall System Health: 63 64 | Status | Description | 65 |:-------:|:-------------------------------------------------------------------------------------------------------------------------| 66 | green | All components in the appliance are healthy. | 67 | yellow | One or more components in the appliance might become overloaded soon. | 68 | orange | One or more components in the appliance might be degraded. | 69 | red | One or more components in the appliance might be in an unusable status and the appliance might become unresponsive soon. | 70 | gray | No health data is available. | 71 | unknown | Collector failed to decode status. | 72 73 Components Health: 74 75 | Status | Description | 76 |:-------:|:-------------------------------------------------------------| 77 | green | The component is healthy. | 78 | yellow | The component is healthy, but may have some problems. | 79 | orange | The component is degraded, and may have serious problems. | 80 | red | The component is unavailable, or will stop functioning soon. | 81 | gray | No health data is available. | 82 | unknown | Collector failed to decode status. | 83 84 Software Updates Health: 85 86 | Status | Description | 87 |:-------:|:-----------------------------------------------------| 88 | green | No updates available. | 89 | orange | Non-security patches might be available. | 90 | red | Security patches might be available. | 91 | gray | An error retrieving information on software updates. | 92 | unknown | Collector failed to decode status. | 93 94 </details> 95 96 97 This scope has no labels. 98 99 Metrics: 100 101 | Metric | Dimensions | Unit | 102 |:------|:----------|:----| 103 | vcsa.system_health_status | green, red, yellow, orange, gray, unknown | status | 104 | vcsa.applmgmt_health_status | green, red, yellow, orange, gray, unknown | status | 105 | vcsa.load_health_status | green, red, yellow, orange, gray, unknown | status | 106 | vcsa.mem_health_status | green, red, yellow, orange, gray, unknown | status | 107 | vcsa.swap_health_status | green, red, yellow, orange, gray, unknown | status | 108 | vcsa.database_storage_health_status | green, red, yellow, orange, gray, unknown | status | 109 | vcsa.storage_health_status | green, red, yellow, orange, gray, unknown | status | 110 | vcsa.software_packages_health_status | green, red, orange, gray, unknown | status | 111 112 113 114 ## Alerts 115 116 117 The following alerts are available: 118 119 | Alert name | On metric | Description | 120 |:------------|:----------|:------------| 121 | [ vcsa_system_health_warn ](https://github.com/netdata/netdata/blob/master/health/health.d/vcsa.conf) | vcsa.system_health_status | VCSA overall system status is orange. One or more components are degraded. | 122 | [ vcsa_system_health_crit ](https://github.com/netdata/netdata/blob/master/health/health.d/vcsa.conf) | vcsa.system_health_status | VCSA overall system status is red. One or more components are unavailable or will stop functioning soon. | 123 | [ vcsa_applmgmt_health_warn ](https://github.com/netdata/netdata/blob/master/health/health.d/vcsa.conf) | vcsa.applmgmt_health_status | VCSA ApplMgmt component status is orange. It is degraded, and may have serious problems. | 124 | [ vcsa_applmgmt_health_crit ](https://github.com/netdata/netdata/blob/master/health/health.d/vcsa.conf) | vcsa.applmgmt_health_status | VCSA ApplMgmt component status is red. It is unavailable, or will stop functioning soon. | 125 | [ vcsa_load_health_warn ](https://github.com/netdata/netdata/blob/master/health/health.d/vcsa.conf) | vcsa.load_health_status | VCSA Load component status is orange. It is degraded, and may have serious problems. | 126 | [ vcsa_load_health_crit ](https://github.com/netdata/netdata/blob/master/health/health.d/vcsa.conf) | vcsa.load_health_status | VCSA Load component status is red. It is unavailable, or will stop functioning soon. | 127 | [ vcsa_mem_health_warn ](https://github.com/netdata/netdata/blob/master/health/health.d/vcsa.conf) | vcsa.mem_health_status | VCSA Memory component status is orange. It is degraded, and may have serious problems. | 128 | [ vcsa_mem_health_crit ](https://github.com/netdata/netdata/blob/master/health/health.d/vcsa.conf) | vcsa.mem_health_status | VCSA Memory component status is red. It is unavailable, or will stop functioning soon. | 129 | [ vcsa_swap_health_warn ](https://github.com/netdata/netdata/blob/master/health/health.d/vcsa.conf) | vcsa.swap_health_status | VCSA Swap component status is orange. It is degraded, and may have serious problems. | 130 | [ vcsa_swap_health_crit ](https://github.com/netdata/netdata/blob/master/health/health.d/vcsa.conf) | vcsa.swap_health_status | VCSA Swap component status is red. It is unavailable, or will stop functioning soon. | 131 | [ vcsa_database_storage_health_warn ](https://github.com/netdata/netdata/blob/master/health/health.d/vcsa.conf) | vcsa.database_storage_health_status | VCSA Database Storage component status is orange. It is degraded, and may have serious problems. | 132 | [ vcsa_database_storage_health_crit ](https://github.com/netdata/netdata/blob/master/health/health.d/vcsa.conf) | vcsa.database_storage_health_status | VCSA Database Storage component status is red. It is unavailable, or will stop functioning soon. | 133 | [ vcsa_storage_health_warn ](https://github.com/netdata/netdata/blob/master/health/health.d/vcsa.conf) | vcsa.storage_health_status | VCSA Storage component status is orange. It is degraded, and may have serious problems. | 134 | [ vcsa_storage_health_crit ](https://github.com/netdata/netdata/blob/master/health/health.d/vcsa.conf) | vcsa.storage_health_status | VCSA Storage component status is red. It is unavailable, or will stop functioning soon. | 135 | [ vcsa_software_packages_health_warn ](https://github.com/netdata/netdata/blob/master/health/health.d/vcsa.conf) | vcsa.software_packages_health_status | VCSA software packages security updates are available. | 136 137 138 ## Setup 139 140 ### Prerequisites 141 142 No action required. 143 144 ### Configuration 145 146 #### File 147 148 The configuration file name for this integration is `go.d/vcsa.conf`. 149 150 151 You can edit the configuration file using the `edit-config` script from the 152 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory). 153 154 ```bash 155 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata 156 sudo ./edit-config go.d/vcsa.conf 157 ``` 158 #### Options 159 160 The following options can be defined globally: update_every, autodetection_retry. 161 162 163 <details><summary>Config options</summary> 164 165 | Name | Description | Default | Required | 166 |:----|:-----------|:-------|:--------:| 167 | update_every | Data collection frequency. | 5 | no | 168 | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | 169 | url | Server URL. | | yes | 170 | timeout | HTTP request timeout. | 1 | no | 171 | username | Username for basic HTTP authentication. | | yes | 172 | password | Password for basic HTTP authentication. | | yes | 173 | proxy_url | Proxy URL. | | no | 174 | proxy_username | Username for proxy basic HTTP authentication. | | no | 175 | proxy_password | Password for proxy basic HTTP authentication. | | no | 176 | method | HTTP request method. | GET | no | 177 | body | HTTP request body. | | no | 178 | headers | HTTP request headers. | | no | 179 | not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | false | no | 180 | tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | false | no | 181 | tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no | 182 | tls_cert | Client TLS certificate. | | no | 183 | tls_key | Client TLS key. | | no | 184 185 </details> 186 187 #### Examples 188 189 ##### Basic 190 191 An example configuration. 192 193 <details><summary>Config</summary> 194 195 ```yaml 196 jobs: 197 - name: vcsa1 198 url: https://203.0.113.1 199 username: admin@vsphere.local 200 password: password 201 202 ``` 203 </details> 204 205 ##### Multi-instance 206 207 > **Note**: When you define multiple jobs, their names must be unique. 208 209 Two instances. 210 211 212 <details><summary>Config</summary> 213 214 ```yaml 215 jobs: 216 - name: vcsa1 217 url: https://203.0.113.1 218 username: admin@vsphere.local 219 password: password 220 221 - name: vcsa2 222 url: https://203.0.113.10 223 username: admin@vsphere.local 224 password: password 225 226 ``` 227 </details> 228 229 230 231 ## Troubleshooting 232 233 ### Debug Mode 234 235 To troubleshoot issues with the `vcsa` collector, run the `go.d.plugin` with the debug option enabled. The output 236 should give you clues as to why the collector isn't working. 237 238 - Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on 239 your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. 240 241 ```bash 242 cd /usr/libexec/netdata/plugins.d/ 243 ``` 244 245 - Switch to the `netdata` user. 246 247 ```bash 248 sudo -u netdata -s 249 ``` 250 251 - Run the `go.d.plugin` to debug the collector: 252 253 ```bash 254 ./go.d.plugin -d -m vcsa 255 ``` 256 257