github.com/netdata/go.d.plugin@v0.58.1/modules/vcsa/metadata.yaml (about) 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 most_popular: false 21 overview: 22 data_collection: 23 metrics_description: | 24 This collector monitors [health statistics](https://developer.vmware.com/apis/vsphere-automation/latest/appliance/health/) of vCenter Server Appliance servers. 25 method_description: "" 26 supported_platforms: 27 include: [] 28 exclude: [] 29 multi_instance: true 30 additional_permissions: 31 description: "" 32 default_behavior: 33 auto_detection: 34 description: "" 35 limits: 36 description: "" 37 performance_impact: 38 description: "" 39 setup: 40 prerequisites: 41 list: [] 42 configuration: 43 file: 44 name: "go.d/vcsa.conf" 45 options: 46 description: | 47 The following options can be defined globally: update_every, autodetection_retry. 48 folding: 49 title: Config options 50 enabled: true 51 list: 52 - name: update_every 53 description: Data collection frequency. 54 default_value: "5" 55 required: false 56 - name: autodetection_retry 57 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 58 default_value: "0" 59 required: false 60 - name: url 61 description: Server URL. 62 default_value: "" 63 required: true 64 - name: timeout 65 description: HTTP request timeout. 66 default_value: "1" 67 required: false 68 - name: username 69 description: Username for basic HTTP authentication. 70 default_value: "" 71 required: true 72 - name: password 73 description: Password for basic HTTP authentication. 74 default_value: "" 75 required: true 76 - name: proxy_url 77 description: Proxy URL. 78 default_value: "" 79 required: false 80 - name: proxy_username 81 description: Username for proxy basic HTTP authentication. 82 default_value: "" 83 required: false 84 - name: proxy_password 85 description: Password for proxy basic HTTP authentication. 86 default_value: "" 87 required: false 88 - name: method 89 description: HTTP request method. 90 default_value: "GET" 91 required: false 92 - name: body 93 description: HTTP request body. 94 default_value: "" 95 required: false 96 - name: headers 97 description: HTTP request headers. 98 default_value: "" 99 required: false 100 - name: not_follow_redirects 101 description: Redirect handling policy. Controls whether the client follows redirects. 102 default_value: "false" 103 required: false 104 - name: tls_skip_verify 105 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 106 default_value: "false" 107 required: false 108 - name: tls_ca 109 description: Certification authority that the client uses when verifying the server's certificates. 110 default_value: "" 111 required: false 112 - name: tls_cert 113 description: Client TLS certificate. 114 default_value: "" 115 required: false 116 - name: tls_key 117 description: Client TLS key. 118 default_value: "" 119 required: false 120 examples: 121 folding: 122 title: Config 123 enabled: true 124 list: 125 - name: Basic 126 description: An example configuration. 127 config: | 128 jobs: 129 - name: vcsa1 130 url: https://203.0.113.1 131 username: admin@vsphere.local 132 password: password 133 - name: Multi-instance 134 description: | 135 > **Note**: When you define multiple jobs, their names must be unique. 136 137 Two instances. 138 config: | 139 jobs: 140 - name: vcsa1 141 url: https://203.0.113.1 142 username: admin@vsphere.local 143 password: password 144 145 - name: vcsa2 146 url: https://203.0.113.10 147 username: admin@vsphere.local 148 password: password 149 troubleshooting: 150 problems: 151 list: [] 152 alerts: 153 - name: vcsa_system_health_warn 154 metric: vcsa.system_health_status 155 info: VCSA overall system status is orange. One or more components are degraded. 156 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf 157 - name: vcsa_system_health_crit 158 metric: vcsa.system_health_status 159 info: VCSA overall system status is red. One or more components are unavailable or will stop functioning soon. 160 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf 161 - name: vcsa_applmgmt_health_warn 162 metric: vcsa.applmgmt_health_status 163 info: VCSA ApplMgmt component status is orange. It is degraded, and may have serious problems. 164 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf 165 - name: vcsa_applmgmt_health_crit 166 metric: vcsa.applmgmt_health_status 167 info: VCSA ApplMgmt component status is red. It is unavailable, or will stop functioning soon. 168 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf 169 - name: vcsa_load_health_warn 170 metric: vcsa.load_health_status 171 info: VCSA Load component status is orange. It is degraded, and may have serious problems. 172 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf 173 - name: vcsa_load_health_crit 174 metric: vcsa.load_health_status 175 info: VCSA Load component status is red. It is unavailable, or will stop functioning soon. 176 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf 177 - name: vcsa_mem_health_warn 178 metric: vcsa.mem_health_status 179 info: VCSA Memory component status is orange. It is degraded, and may have serious problems. 180 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf 181 - name: vcsa_mem_health_crit 182 metric: vcsa.mem_health_status 183 info: VCSA Memory component status is red. It is unavailable, or will stop functioning soon. 184 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf 185 - name: vcsa_swap_health_warn 186 metric: vcsa.swap_health_status 187 info: VCSA Swap component status is orange. It is degraded, and may have serious problems. 188 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf 189 - name: vcsa_swap_health_crit 190 metric: vcsa.swap_health_status 191 info: VCSA Swap component status is red. It is unavailable, or will stop functioning soon. 192 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf 193 - name: vcsa_database_storage_health_warn 194 metric: vcsa.database_storage_health_status 195 info: VCSA Database Storage component status is orange. It is degraded, and may have serious problems. 196 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf 197 - name: vcsa_database_storage_health_crit 198 metric: vcsa.database_storage_health_status 199 info: VCSA Database Storage component status is red. It is unavailable, or will stop functioning soon. 200 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf 201 - name: vcsa_storage_health_warn 202 metric: vcsa.storage_health_status 203 info: VCSA Storage component status is orange. It is degraded, and may have serious problems. 204 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf 205 - name: vcsa_storage_health_crit 206 metric: vcsa.storage_health_status 207 info: VCSA Storage component status is red. It is unavailable, or will stop functioning soon. 208 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf 209 - name: vcsa_software_packages_health_warn 210 metric: vcsa.software_packages_health_status 211 info: VCSA software packages security updates are available. 212 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vcsa.conf 213 metrics: 214 folding: 215 title: Metrics 216 enabled: false 217 description: "" 218 availability: [] 219 scopes: 220 - name: global 221 description: | 222 These metrics refer to the entire monitored application. 223 <details> 224 <summary>See health statuses</summary> 225 Overall System Health: 226 227 | Status | Description | 228 |:-------:|:-------------------------------------------------------------------------------------------------------------------------| 229 | green | All components in the appliance are healthy. | 230 | yellow | One or more components in the appliance might become overloaded soon. | 231 | orange | One or more components in the appliance might be degraded. | 232 | red | One or more components in the appliance might be in an unusable status and the appliance might become unresponsive soon. | 233 | gray | No health data is available. | 234 | unknown | Collector failed to decode status. | 235 236 Components Health: 237 238 | Status | Description | 239 |:-------:|:-------------------------------------------------------------| 240 | green | The component is healthy. | 241 | yellow | The component is healthy, but may have some problems. | 242 | orange | The component is degraded, and may have serious problems. | 243 | red | The component is unavailable, or will stop functioning soon. | 244 | gray | No health data is available. | 245 | unknown | Collector failed to decode status. | 246 247 Software Updates Health: 248 249 | Status | Description | 250 |:-------:|:-----------------------------------------------------| 251 | green | No updates available. | 252 | orange | Non-security patches might be available. | 253 | red | Security patches might be available. | 254 | gray | An error retrieving information on software updates. | 255 | unknown | Collector failed to decode status. | 256 257 </details> 258 labels: [] 259 metrics: 260 - name: vcsa.system_health_status 261 description: VCSA Overall System health status 262 unit: status 263 chart_type: line 264 dimensions: 265 - name: green 266 - name: red 267 - name: yellow 268 - name: orange 269 - name: gray 270 - name: unknown 271 - name: vcsa.applmgmt_health_status 272 description: VCSA ApplMgmt health status 273 unit: status 274 chart_type: line 275 dimensions: 276 - name: green 277 - name: red 278 - name: yellow 279 - name: orange 280 - name: gray 281 - name: unknown 282 - name: vcsa.load_health_status 283 description: VCSA Load health status 284 unit: status 285 chart_type: line 286 dimensions: 287 - name: green 288 - name: red 289 - name: yellow 290 - name: orange 291 - name: gray 292 - name: unknown 293 - name: vcsa.mem_health_status 294 description: VCSA Memory health status 295 unit: status 296 chart_type: line 297 dimensions: 298 - name: green 299 - name: red 300 - name: yellow 301 - name: orange 302 - name: gray 303 - name: unknown 304 - name: vcsa.swap_health_status 305 description: VCSA Swap health status 306 unit: status 307 chart_type: line 308 dimensions: 309 - name: green 310 - name: red 311 - name: yellow 312 - name: orange 313 - name: gray 314 - name: unknown 315 - name: vcsa.database_storage_health_status 316 description: VCSA Database Storage health status 317 unit: status 318 chart_type: line 319 dimensions: 320 - name: green 321 - name: red 322 - name: yellow 323 - name: orange 324 - name: gray 325 - name: unknown 326 - name: vcsa.storage_health_status 327 description: VCSA Storage health status 328 unit: status 329 chart_type: line 330 dimensions: 331 - name: green 332 - name: red 333 - name: yellow 334 - name: orange 335 - name: gray 336 - name: unknown 337 - name: vcsa.software_packages_health_status 338 description: VCSA Software Updates health status 339 unit: status 340 chart_type: line 341 dimensions: 342 - name: green 343 - name: red 344 - name: orange 345 - name: gray 346 - name: unknown