| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-vcsa |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: vcsa |
| 7 | monitored_instance: |
| 8 | name: vCenter Server Appliance |
| 9 | link: https://docs.vmware.com/en/VMware-vSphere/6.5/com.vmware.vsphere.vcsa.doc/GUID-223C2821-BD98-4C7A-936B-7DBE96291BA4.html |
| 10 | icon_filename: vmware.svg |
| 11 | categories: |
| 12 | - data-collection.containers-and-vms |
| 13 | keywords: |
| 14 | - vmware |
| 15 | related_resources: |
| 16 | integrations: |
| 17 | list: [] |
| 18 | info_provided_to_referring_integrations: |
| 19 | description: "" |
| 20 | overview: |
| 21 | data_collection: |
| 22 | metrics_description: | |
| 23 | This collector monitors [health statistics](https://developer.vmware.com/apis/vsphere-automation/latest/appliance/health/) of vCenter Server Appliance servers. |
| 24 | method_description: "" |
| 25 | supported_platforms: |
| 26 | include: [] |
| 27 | exclude: [] |
| 28 | multi_instance: true |
| 29 | additional_permissions: |
| 30 | description: "" |
| 31 | default_behavior: |
| 32 | auto_detection: |
| 33 | description: "" |
| 34 | limits: |
| 35 | description: "" |
| 36 | performance_impact: |
| 37 | description: "" |
| 38 | setup: |
| 39 | prerequisites: |
| 40 | list: [] |
| 41 | configuration: |
| 42 | file: |
| 43 | name: "go.d/vcsa.conf" |
| 44 | options: |
| 45 | description: | |
| 46 | The following options can be defined globally: update_every, autodetection_retry. |
| 47 | folding: |
| 48 | title: Config options |
| 49 | enabled: true |
| 50 | list: |
| 51 | - name: update_every |
| 52 | description: Data collection interval (seconds). |
| 53 | default_value: 5 |
| 54 | required: false |
| 55 | group: Collection |
| 56 | - name: autodetection_retry |
| 57 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 58 | default_value: 0 |
| 59 | required: false |
| 60 | group: Collection |
| 61 | |
| 62 | - name: url |
| 63 | description: Target endpoint URL. |
| 64 | default_value: "" |
| 65 | required: true |
| 66 | group: Target |
| 67 | - name: timeout |
| 68 | description: HTTP request timeout (seconds). |
| 69 | default_value: 5 |
| 70 | required: false |
| 71 | group: Target |
| 72 | |
| 73 | - name: username |
| 74 | description: Username for Basic HTTP authentication. |
| 75 | default_value: "" |
| 76 | required: true |
| 77 | group: HTTP Auth |
| 78 | - name: password |
| 79 | description: Password for Basic HTTP authentication. |
| 80 | default_value: "" |
| 81 | required: true |
| 82 | group: HTTP Auth |
| 83 | - name: bearer_token_file |
| 84 | description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)." |
| 85 | default_value: "" |
| 86 | required: false |
| 87 | group: HTTP Auth |
| 88 | |
| 89 | - name: tls_skip_verify |
| 90 | description: Skip TLS certificate and hostname verification (insecure). |
| 91 | default_value: no |
| 92 | required: false |
| 93 | group: TLS |
| 94 | - name: tls_ca |
| 95 | description: Path to CA bundle used to validate the server certificate. |
| 96 | default_value: "" |
| 97 | required: false |
| 98 | group: TLS |
| 99 | - name: tls_cert |
| 100 | description: Path to client TLS certificate (for mTLS). |
| 101 | default_value: "" |
| 102 | required: false |
| 103 | group: TLS |
| 104 | - name: tls_key |
| 105 | description: Path to client TLS private key (for mTLS). |
| 106 | default_value: "" |
| 107 | required: false |
| 108 | group: TLS |
| 109 | |
| 110 | - name: proxy_url |
| 111 | description: HTTP proxy URL. |
| 112 | default_value: "" |
| 113 | required: false |
| 114 | group: Proxy |
| 115 | - name: proxy_username |
| 116 | description: Username for proxy Basic HTTP authentication. |
| 117 | default_value: "" |
| 118 | required: false |
| 119 | group: Proxy |
| 120 | - name: proxy_password |
| 121 | description: Password for proxy Basic HTTP authentication. |
| 122 | default_value: "" |
| 123 | required: false |
| 124 | group: Proxy |
| 125 | |
| 126 | - name: method |
| 127 | description: HTTP method to use. |
| 128 | default_value: "GET" |
| 129 | required: false |
| 130 | group: Request |
| 131 | - name: body |
| 132 | description: Request body (e.g., for POST/PUT). |
| 133 | default_value: "" |
| 134 | required: false |
| 135 | group: Request |
| 136 | - name: headers |
| 137 | description: "Additional HTTP headers (one per line as key: value)." |
| 138 | default_value: "" |
| 139 | required: false |
| 140 | group: Request |
| 141 | - name: not_follow_redirects |
| 142 | description: Do not follow HTTP redirects. |
| 143 | default_value: no |
| 144 | required: false |
| 145 | group: Request |
| 146 | - name: force_http2 |
| 147 | description: Force HTTP/2 (including h2c over TCP). |
| 148 | default_value: no |
| 149 | required: false |
| 150 | group: Request |
| 151 | |
| 152 | - name: vnode |
| 153 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 154 | default_value: "" |
| 155 | required: false |
| 156 | group: Virtual Node |
| 157 | examples: |
| 158 | folding: |
| 159 | title: Config |
| 160 | enabled: true |
| 161 | list: |
| 162 | - name: Basic |
| 163 | description: An example configuration. |
| 164 | config: | |
| 165 | jobs: |
| 166 | - name: vcsa1 |
| 167 | url: https://203.0.113.1 |
| 168 | username: admin@vsphere.local |
| 169 | password: password |
| 170 | - name: Multi-instance |
| 171 | description: | |
| 172 | > **Note**: When you define multiple jobs, their names must be unique. |
| 173 | |
| 174 | Two instances. |
| 175 | config: | |
| 176 | jobs: |
| 177 | - name: vcsa1 |
| 178 | url: https://203.0.113.1 |
| 179 | username: admin@vsphere.local |
| 180 | password: password |
| 181 | |
| 182 | - name: vcsa2 |
| 183 | url: https://203.0.113.10 |
| 184 | username: admin@vsphere.local |
| 185 | password: password |
| 186 | troubleshooting: |
| 187 | problems: |
| 188 | list: [] |
| 189 | alerts: |
| 190 | - name: vcsa_system_health_warn |
| 191 | metric: vcsa.system_health_status |
| 192 | info: VCSA overall system status is orange. One or more components are degraded. |
| 193 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf |
| 194 | - name: vcsa_system_health_crit |
| 195 | metric: vcsa.system_health_status |
| 196 | info: VCSA overall system status is red. One or more components are unavailable or will stop functioning soon. |
| 197 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf |
| 198 | - name: vcsa_applmgmt_health_warn |
| 199 | metric: vcsa.applmgmt_health_status |
| 200 | info: VCSA ApplMgmt component status is orange. It is degraded, and may have serious problems. |
| 201 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf |
| 202 | - name: vcsa_applmgmt_health_crit |
| 203 | metric: vcsa.applmgmt_health_status |
| 204 | info: VCSA ApplMgmt component status is red. It is unavailable, or will stop functioning soon. |
| 205 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf |
| 206 | - name: vcsa_load_health_warn |
| 207 | metric: vcsa.load_health_status |
| 208 | info: VCSA Load component status is orange. It is degraded, and may have serious problems. |
| 209 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf |
| 210 | - name: vcsa_load_health_crit |
| 211 | metric: vcsa.load_health_status |
| 212 | info: VCSA Load component status is red. It is unavailable, or will stop functioning soon. |
| 213 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf |
| 214 | - name: vcsa_mem_health_warn |
| 215 | metric: vcsa.mem_health_status |
| 216 | info: VCSA Memory component status is orange. It is degraded, and may have serious problems. |
| 217 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf |
| 218 | - name: vcsa_mem_health_crit |
| 219 | metric: vcsa.mem_health_status |
| 220 | info: VCSA Memory component status is red. It is unavailable, or will stop functioning soon. |
| 221 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf |
| 222 | - name: vcsa_swap_health_warn |
| 223 | metric: vcsa.swap_health_status |
| 224 | info: VCSA Swap component status is orange. It is degraded, and may have serious problems. |
| 225 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf |
| 226 | - name: vcsa_swap_health_crit |
| 227 | metric: vcsa.swap_health_status |
| 228 | info: VCSA Swap component status is red. It is unavailable, or will stop functioning soon. |
| 229 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf |
| 230 | - name: vcsa_database_storage_health_warn |
| 231 | metric: vcsa.database_storage_health_status |
| 232 | info: VCSA Database Storage component status is orange. It is degraded, and may have serious problems. |
| 233 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf |
| 234 | - name: vcsa_database_storage_health_crit |
| 235 | metric: vcsa.database_storage_health_status |
| 236 | info: VCSA Database Storage component status is red. It is unavailable, or will stop functioning soon. |
| 237 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf |
| 238 | - name: vcsa_storage_health_warn |
| 239 | metric: vcsa.storage_health_status |
| 240 | info: VCSA Storage component status is orange. It is degraded, and may have serious problems. |
| 241 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf |
| 242 | - name: vcsa_storage_health_crit |
| 243 | metric: vcsa.storage_health_status |
| 244 | info: VCSA Storage component status is red. It is unavailable, or will stop functioning soon. |
| 245 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf |
| 246 | - name: vcsa_software_packages_health_warn |
| 247 | metric: vcsa.software_packages_health_status |
| 248 | info: VCSA software packages security updates are available. |
| 249 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf |
| 250 | metrics: |
| 251 | folding: |
| 252 | title: Metrics |
| 253 | enabled: false |
| 254 | description: "" |
| 255 | availability: [] |
| 256 | scopes: |
| 257 | - name: global |
| 258 | description: | |
| 259 | These metrics refer to the entire monitored application. |
| 260 | <details> |
| 261 | <summary>See health statuses</summary> |
| 262 | Overall System Health: |
| 263 | |
| 264 | | Status | Description | |
| 265 | |:-------:|:-------------------------------------------------------------------------------------------------------------------------| |
| 266 | | green | All components in the appliance are healthy. | |
| 267 | | yellow | One or more components in the appliance might become overloaded soon. | |
| 268 | | orange | One or more components in the appliance might be degraded. | |
| 269 | | red | One or more components in the appliance might be in an unusable status and the appliance might become unresponsive soon. | |
| 270 | | gray | No health data is available. | |
| 271 | | unknown | Collector failed to decode status. | |
| 272 | |
| 273 | Components Health: |
| 274 | |
| 275 | | Status | Description | |
| 276 | |:-------:|:-------------------------------------------------------------| |
| 277 | | green | The component is healthy. | |
| 278 | | yellow | The component is healthy, but may have some problems. | |
| 279 | | orange | The component is degraded, and may have serious problems. | |
| 280 | | red | The component is unavailable, or will stop functioning soon. | |
| 281 | | gray | No health data is available. | |
| 282 | | unknown | Collector failed to decode status. | |
| 283 | |
| 284 | Software Updates Health: |
| 285 | |
| 286 | | Status | Description | |
| 287 | |:-------:|:-----------------------------------------------------| |
| 288 | | green | No updates available. | |
| 289 | | orange | Non-security patches might be available. | |
| 290 | | red | Security patches might be available. | |
| 291 | | gray | An error retrieving information on software updates. | |
| 292 | | unknown | Collector failed to decode status. | |
| 293 | |
| 294 | </details> |
| 295 | labels: [] |
| 296 | metrics: |
| 297 | - name: vcsa.system_health_status |
| 298 | description: VCSA Overall System health status |
| 299 | unit: status |
| 300 | chart_type: line |
| 301 | dimensions: |
| 302 | - name: green |
| 303 | - name: red |
| 304 | - name: yellow |
| 305 | - name: orange |
| 306 | - name: gray |
| 307 | - name: unknown |
| 308 | - name: vcsa.applmgmt_health_status |
| 309 | description: VCSA ApplMgmt health status |
| 310 | unit: status |
| 311 | chart_type: line |
| 312 | dimensions: |
| 313 | - name: green |
| 314 | - name: red |
| 315 | - name: yellow |
| 316 | - name: orange |
| 317 | - name: gray |
| 318 | - name: unknown |
| 319 | - name: vcsa.load_health_status |
| 320 | description: VCSA Load health status |
| 321 | unit: status |
| 322 | chart_type: line |
| 323 | dimensions: |
| 324 | - name: green |
| 325 | - name: red |
| 326 | - name: yellow |
| 327 | - name: orange |
| 328 | - name: gray |
| 329 | - name: unknown |
| 330 | - name: vcsa.mem_health_status |
| 331 | description: VCSA Memory health status |
| 332 | unit: status |
| 333 | chart_type: line |
| 334 | dimensions: |
| 335 | - name: green |
| 336 | - name: red |
| 337 | - name: yellow |
| 338 | - name: orange |
| 339 | - name: gray |
| 340 | - name: unknown |
| 341 | - name: vcsa.swap_health_status |
| 342 | description: VCSA Swap health status |
| 343 | unit: status |
| 344 | chart_type: line |
| 345 | dimensions: |
| 346 | - name: green |
| 347 | - name: red |
| 348 | - name: yellow |
| 349 | - name: orange |
| 350 | - name: gray |
| 351 | - name: unknown |
| 352 | - name: vcsa.database_storage_health_status |
| 353 | description: VCSA Database Storage health status |
| 354 | unit: status |
| 355 | chart_type: line |
| 356 | dimensions: |
| 357 | - name: green |
| 358 | - name: red |
| 359 | - name: yellow |
| 360 | - name: orange |
| 361 | - name: gray |
| 362 | - name: unknown |
| 363 | - name: vcsa.storage_health_status |
| 364 | description: VCSA Storage health status |
| 365 | unit: status |
| 366 | chart_type: line |
| 367 | dimensions: |
| 368 | - name: green |
| 369 | - name: red |
| 370 | - name: yellow |
| 371 | - name: orange |
| 372 | - name: gray |
| 373 | - name: unknown |
| 374 | - name: vcsa.software_packages_health_status |
| 375 | description: VCSA Software Updates health status |
| 376 | unit: status |
| 377 | chart_type: line |
| 378 | dimensions: |
| 379 | - name: green |
| 380 | - name: red |
| 381 | - name: orange |
| 382 | - name: gray |
| 383 | - name: unknown |