| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-vsphere |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: vsphere |
| 7 | monitored_instance: |
| 8 | name: VMware vCenter Server |
| 9 | link: https://www.vmware.com/products/vcenter-server.html |
| 10 | icon_filename: vmware.svg |
| 11 | categories: |
| 12 | - data-collection.containers-and-vms |
| 13 | keywords: |
| 14 | - vmware |
| 15 | - esxi |
| 16 | - vcenter |
| 17 | related_resources: |
| 18 | integrations: |
| 19 | list: [] |
| 20 | info_provided_to_referring_integrations: |
| 21 | description: "" |
| 22 | overview: |
| 23 | data_collection: |
| 24 | metrics_description: | |
| 25 | Monitors vSphere resources from `vCenter` servers. |
| 26 | |
| 27 | Includes hosts, VMs, datastores, clusters, resource pools, |
| 28 | and inventory counts. |
| 29 | |
| 30 | Use the `vcsa` collector for vCenter Server Appliance health. |
| 31 | |
| 32 | Use the `snmp` collector with the `vmware-esx` profile for |
| 33 | ESXi hardware, HBA, and environment sensors. |
| 34 | |
| 35 | Those surfaces are intentionally not duplicated here by default. |
| 36 | |
| 37 | > **Warning**: The `vsphere` collector cannot re-login and continue collecting metrics after a vCenter reboot. |
| 38 | > go.d.plugin needs to be restarted. |
| 39 | method_description: "" |
| 40 | supported_platforms: |
| 41 | include: [] |
| 42 | exclude: [] |
| 43 | multi_instance: true |
| 44 | additional_permissions: |
| 45 | description: "" |
| 46 | default_behavior: |
| 47 | auto_detection: |
| 48 | description: "" |
| 49 | limits: |
| 50 | description: "" |
| 51 | performance_impact: |
| 52 | description: | |
| 53 | The default `update_every` is 20 seconds, and it doesn't make sense to decrease the value. |
| 54 | **VMware real-time statistics are generated at the 20-second specificity**. |
| 55 | |
| 56 | **Note**: Datastore and cluster performance metrics use 300-second (5-minute) historical intervals because VMware does not support real-time statistics for these entity types. Datastore capacity/status, cluster properties, and resource pool statistics are updated every collection cycle. Host and VM metrics use real-time 20-second intervals. |
| 57 | |
| 58 | It is likely that 20 seconds is not enough for big installations and the value should be tuned. |
| 59 | |
| 60 | To size a job, run the collector in debug mode and compare the discovery and collection timing lines. Discovery runs in a separate goroutine, while collection timing must stay comfortably below `update_every`. |
| 61 | |
| 62 | Useful log lines include: |
| 63 | |
| 64 | - `discovering : discovered ... the whole process took ...` |
| 65 | - `scraping : scraped metrics for ... hosts, process took ...` |
| 66 | - `scraping : scraped metrics for ... vms, process took ...` |
| 67 | - `metrics collected, process took ...` |
| 68 | |
| 69 | Adjust `update_every` and `timeout` based on those timings and on the number of enabled optional surfaces. |
| 70 | setup: |
| 71 | prerequisites: |
| 72 | list: |
| 73 | - title: vCenter read-only access |
| 74 | description: | |
| 75 | Configure a vCenter account that can read inventory objects, properties, and performance counters for the datacenters, clusters, ESXi hosts, VMs, datastores, and resource pools selected by the include filters. |
| 76 | - title: Optional vSphere metadata permissions |
| 77 | description: | |
| 78 | `tag_categories` requires access to the vSphere Automation/CIS tagging APIs for the selected categories. `custom_attributes` requires access to custom field definitions and values for the selected inventory objects. |
| 79 | - title: Optional datastore cluster, vSAN, and network data |
| 80 | description: | |
| 81 | `collect_datastore_clusters` requires read access to StoragePod objects. `collect_vsan` requires vSAN Management API access and the vSAN Performance Service on the target clusters. `collect_network_topology` requires read access to Network and Distributed Virtual Port Group inventory objects. |
| 82 | configuration: |
| 83 | file: |
| 84 | name: go.d/vsphere.conf |
| 85 | options: |
| 86 | description: | |
| 87 | The following options can be defined globally: update_every, autodetection_retry. |
| 88 | folding: |
| 89 | title: Config options |
| 90 | enabled: true |
| 91 | list: |
| 92 | - name: update_every |
| 93 | description: Data collection interval (seconds). |
| 94 | default_value: 20 |
| 95 | required: false |
| 96 | group: Collection |
| 97 | |
| 98 | - name: autodetection_retry |
| 99 | description: Autodetection retry interval (seconds). |
| 100 | default_value: 60 |
| 101 | required: false |
| 102 | group: Collection |
| 103 | |
| 104 | - name: url |
| 105 | description: Target endpoint URL. |
| 106 | default_value: https://vcenter.local |
| 107 | required: true |
| 108 | group: Target |
| 109 | - name: timeout |
| 110 | description: HTTP request timeout (seconds). |
| 111 | default_value: 20 |
| 112 | required: false |
| 113 | group: Target |
| 114 | |
| 115 | - name: discovery_interval |
| 116 | description: Hosts, VMs, datastores, clusters, and resource pools discovery interval (seconds). |
| 117 | default_value: 300 |
| 118 | required: false |
| 119 | group: Discovery |
| 120 | - name: tag_categories |
| 121 | description: vSphere tag category allowlist. |
| 122 | default_value: "" |
| 123 | required: false |
| 124 | group: Labels |
| 125 | detailed_description: | |
| 126 | Disabled by default because vSphere tags are user-defined metadata |
| 127 | and can expose internal names, ownership, business unit, or |
| 128 | environment details. Each list item is one glob pattern matching |
| 129 | vSphere tag category names, so names with spaces are supported. |
| 130 | Use `*` only when every tag category is intentional. |
| 131 | |
| 132 | Matching categories are exposed as labels named |
| 133 | `vsphere_tag_<sanitized_category>`. When a resource has multiple |
| 134 | tags in the same category, values are sorted and joined with the |
| 135 | pipe character. |
| 136 | |
| 137 | ```yaml |
| 138 | tag_categories: |
| 139 | - "Environment" |
| 140 | - "Business Unit" |
| 141 | ``` |
| 142 | - name: custom_attributes |
| 143 | description: vSphere custom attribute allowlist. |
| 144 | default_value: "" |
| 145 | required: false |
| 146 | group: Labels |
| 147 | detailed_description: | |
| 148 | Disabled by default because vSphere custom attributes are |
| 149 | user-defined metadata and can expose internal names, ownership, |
| 150 | business unit, operational data, or secrets stored by administrators. |
| 151 | Custom attribute values are sent verbatim as labels. Each list |
| 152 | item is one glob pattern matching custom attribute names, so names |
| 153 | with spaces are supported. Use `*` only when every custom attribute |
| 154 | is intentional and none of the matched values contain secrets. |
| 155 | |
| 156 | Matching attributes are exposed as labels named |
| 157 | `vsphere_custom_attribute_<sanitized_name>`. |
| 158 | |
| 159 | ```yaml |
| 160 | custom_attributes: |
| 161 | - "Owner" |
| 162 | - "Cost Center" |
| 163 | ``` |
| 164 | - name: collect_datastore_clusters |
| 165 | description: Collect datastore cluster capacity and Storage DRS status. |
| 166 | default_value: no |
| 167 | required: false |
| 168 | group: High Cardinality |
| 169 | detailed_description: | |
| 170 | Disabled by default because it adds a separate vSphere resource |
| 171 | class (`StoragePod`) to the collector output. When enabled, the |
| 172 | collector emits aggregate datastore-cluster capacity, utilization, |
| 173 | and Storage DRS status. |
| 174 | - name: datastore_cluster_include |
| 175 | description: Datastore cluster selector. |
| 176 | default_value: "/*" |
| 177 | required: false |
| 178 | group: High Cardinality |
| 179 | detailed_description: | |
| 180 | Applies only when `collect_datastore_clusters` is enabled. Values |
| 181 | use Netdata simple patterns and match |
| 182 | `/Datacenter/DatastoreCluster`, the datastore-cluster name, or |
| 183 | the vSphere managed object ID. Matching datastore clusters are |
| 184 | included in metrics, labels, cached discovery state, and topology |
| 185 | function output. |
| 186 | |
| 187 | ```yaml |
| 188 | datastore_cluster_include: |
| 189 | - "/*" |
| 190 | ``` |
| 191 | - name: collect_vsan |
| 192 | description: Collect vSAN metrics. |
| 193 | default_value: no |
| 194 | required: false |
| 195 | group: High Cardinality |
| 196 | detailed_description: | |
| 197 | Disabled by default because it uses the vSAN Management API and |
| 198 | vSAN Performance Service, and adds extra vCenter queries. When |
| 199 | enabled, it emits vSAN cluster capacity, vSAN cluster health, and |
| 200 | vSAN cluster, host, and VM performance metrics for discovered |
| 201 | vSAN-enabled clusters. Use the vSAN selectors below to choose the |
| 202 | concrete vSAN performance entity refs queried. vSAN events are |
| 203 | not collected by this option. |
| 204 | - name: vsan_cluster_include |
| 205 | description: vSAN cluster selector. |
| 206 | default_value: "/*" |
| 207 | required: false |
| 208 | group: High Cardinality |
| 209 | detailed_description: | |
| 210 | Applies only when `collect_vsan` is enabled. Values use Netdata |
| 211 | simple patterns and match `/Datacenter/Cluster`, the cluster |
| 212 | name, the vSphere managed object ID, or `vsan_uuid:<uuid>`. |
| 213 | |
| 214 | ```yaml |
| 215 | vsan_cluster_include: |
| 216 | - "/*" |
| 217 | - "vsan_uuid:52b..." |
| 218 | ``` |
| 219 | - name: vsan_host_include |
| 220 | description: vSAN host selector. |
| 221 | default_value: "/*" |
| 222 | required: false |
| 223 | group: High Cardinality |
| 224 | detailed_description: | |
| 225 | Applies only when `collect_vsan` is enabled. Values use Netdata |
| 226 | simple patterns and match `/Datacenter/Cluster/Host`, the host |
| 227 | name, the vSphere managed object ID, or |
| 228 | `vsan_node_uuid:<uuid>`. |
| 229 | |
| 230 | ```yaml |
| 231 | vsan_host_include: |
| 232 | - "/*" |
| 233 | - "vsan_node_uuid:52b..." |
| 234 | ``` |
| 235 | - name: vsan_vm_include |
| 236 | description: vSAN VM selector. |
| 237 | default_value: "/*" |
| 238 | required: false |
| 239 | group: High Cardinality |
| 240 | detailed_description: | |
| 241 | Applies only when `collect_vsan` is enabled. Values use Netdata |
| 242 | simple patterns and match `/Datacenter/Cluster/Host/VM`, the VM |
| 243 | name, the vSphere managed object ID, or |
| 244 | `instance_uuid:<uuid>`. |
| 245 | |
| 246 | ```yaml |
| 247 | vsan_vm_include: |
| 248 | - "/*" |
| 249 | - "instance_uuid:52b..." |
| 250 | ``` |
| 251 | - name: collect_network_topology |
| 252 | description: Discover networks for the vSphere Topology function. |
| 253 | default_value: no |
| 254 | required: false |
| 255 | group: Collection |
| 256 | detailed_description: | |
| 257 | Disabled by default to avoid extra vCenter discovery calls for |
| 258 | existing users. When enabled, the collector discovers vSphere |
| 259 | Network and Distributed Virtual Port Group objects and includes |
| 260 | their cached accessibility/status and host/VM relationships in |
| 261 | the vSphere Topology function. It does not create charts or |
| 262 | metrics. |
| 263 | |
| 264 | - name: host_include |
| 265 | description: Hosts selector (filter). |
| 266 | default_value: "/*" |
| 267 | required: false |
| 268 | group: Filters |
| 269 | detailed_description: | |
| 270 | Metrics of hosts matching the selector will be collected. |
| 271 | |
| 272 | - Include pattern syntax: "/Datacenter pattern/Cluster pattern/Host pattern". |
| 273 | - Match pattern syntax: [simple patterns](/src/libnetdata/simple_pattern/README.md#simple-patterns). |
| 274 | - Syntax: |
| 275 | |
| 276 | ```yaml |
| 277 | host_include: |
| 278 | - '/DC1/*' # all hosts from datacenter DC1 |
| 279 | - '/DC2/*/!Host2 *' # all hosts from datacenter DC2 except HOST2 |
| 280 | - '/DC3/Cluster3/*' # all hosts from DC3, cluster Cluster3 |
| 281 | ``` |
| 282 | - name: vm_include |
| 283 | description: VM selector (filter). |
| 284 | default_value: "/*" |
| 285 | required: false |
| 286 | group: Filters |
| 287 | detailed_description: | |
| 288 | Metrics of VMs matching the selector will be collected. |
| 289 | |
| 290 | - Include pattern syntax: "/Datacenter pattern/Cluster pattern/Host pattern/VM pattern". |
| 291 | - Match pattern syntax: [simple patterns](/src/libnetdata/simple_pattern/README.md#simple-patterns). |
| 292 | - Syntax: |
| 293 | |
| 294 | ```yaml |
| 295 | vm_include: |
| 296 | - '/DC1/*' # all VMs from datacenter DC1 |
| 297 | - '/DC2/*/*/!VM2 *' # all VMs from DC2 except VM2 |
| 298 | - '/DC3/Cluster3/*' # all VMs from DC3, cluster Cluster3 |
| 299 | ``` |
| 300 | - name: datastore_include |
| 301 | description: Datastore selector (filter). |
| 302 | default_value: "/*" |
| 303 | required: false |
| 304 | group: Filters |
| 305 | detailed_description: | |
| 306 | Metrics of datastores matching the selector will be collected. |
| 307 | |
| 308 | - Include pattern syntax: "/Datacenter pattern/Datastore pattern". |
| 309 | - Match pattern syntax: [simple patterns](/src/libnetdata/simple_pattern/README.md#simple-patterns). |
| 310 | - Syntax: |
| 311 | |
| 312 | ```yaml |
| 313 | datastore_include: |
| 314 | - '/DC1/*' # all datastores from datacenter DC1 |
| 315 | - '/DC2/!DS2 *' # all datastores from DC2 except DS2 |
| 316 | ``` |
| 317 | - name: cluster_include |
| 318 | description: Cluster selector (filter). Resource pools follow their owning cluster. |
| 319 | default_value: "/*" |
| 320 | required: false |
| 321 | group: Filters |
| 322 | detailed_description: | |
| 323 | Metrics of clusters and their resource pools matching the selector will be collected. |
| 324 | |
| 325 | - Include pattern syntax: "/Datacenter pattern/Cluster pattern". |
| 326 | - Match pattern syntax: [simple patterns](/src/libnetdata/simple_pattern/README.md#simple-patterns). |
| 327 | - Syntax: |
| 328 | |
| 329 | ```yaml |
| 330 | cluster_include: |
| 331 | - '/DC1/*' # all clusters from datacenter DC1 |
| 332 | - '/DC2/!Cluster2 *' # all clusters from DC2 except Cluster2 |
| 333 | ``` |
| 334 | |
| 335 | - name: username |
| 336 | description: Username for Basic HTTP authentication. |
| 337 | default_value: "" |
| 338 | required: true |
| 339 | group: HTTP Auth |
| 340 | - name: password |
| 341 | description: Password for Basic HTTP authentication. |
| 342 | default_value: "" |
| 343 | required: true |
| 344 | group: HTTP Auth |
| 345 | |
| 346 | - name: tls_skip_verify |
| 347 | description: Skip TLS certificate and hostname verification (insecure). |
| 348 | default_value: no |
| 349 | required: false |
| 350 | group: TLS |
| 351 | - name: tls_ca |
| 352 | description: Path to CA bundle used to validate the server certificate. |
| 353 | default_value: "" |
| 354 | required: false |
| 355 | group: TLS |
| 356 | - name: tls_cert |
| 357 | description: Path to client TLS certificate (for mTLS). |
| 358 | default_value: "" |
| 359 | required: false |
| 360 | group: TLS |
| 361 | - name: tls_key |
| 362 | description: Path to client TLS private key (for mTLS). |
| 363 | default_value: "" |
| 364 | required: false |
| 365 | group: TLS |
| 366 | |
| 367 | - name: vnode |
| 368 | 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). |
| 369 | default_value: "" |
| 370 | required: false |
| 371 | group: Virtual Node |
| 372 | examples: |
| 373 | folding: |
| 374 | title: Config |
| 375 | enabled: true |
| 376 | list: |
| 377 | - name: Basic |
| 378 | folding: |
| 379 | enabled: false |
| 380 | description: A basic example configuration. |
| 381 | config: | |
| 382 | jobs: |
| 383 | - name : vcenter1 |
| 384 | url : https://203.0.113.1 |
| 385 | username : admin@vsphere.local |
| 386 | password : somepassword |
| 387 | - name: Multi-instance |
| 388 | description: | |
| 389 | > **Note**: When you define multiple jobs, their names must be unique. |
| 390 | |
| 391 | Collecting metrics from local and remote instances. |
| 392 | config: | |
| 393 | jobs: |
| 394 | - name : vcenter1 |
| 395 | url : https://203.0.113.1 |
| 396 | username : admin@vsphere.local |
| 397 | password : somepassword |
| 398 | |
| 399 | - name : vcenter2 |
| 400 | url : https://203.0.113.10 |
| 401 | username : admin@vsphere.local |
| 402 | password : somepassword |
| 403 | troubleshooting: |
| 404 | problems: |
| 405 | list: |
| 406 | - name: Missing performance samples |
| 407 | description: | |
| 408 | If the logs show `vsphere:host-no-perf-samples` or `vsphere:vm-no-perf-samples`, verify that the configured account can read vCenter performance counters for the selected hosts and VMs, and that the entities are powered on when performance metrics are expected. |
| 409 | - name: Periodic discovery errors |
| 410 | description: | |
| 411 | If the logs show `vsphere:periodic-discovery-error`, check vCenter reachability, account permissions for the enabled optional surfaces, and whether the configured `timeout` is large enough for the inventory size. |
| 412 | - name: vCenter reboot recovery |
| 413 | description: | |
| 414 | The collector cannot always recover an existing session after a vCenter reboot. Restart `go.d.plugin` if collection does not resume after vCenter becomes available again. |
| 415 | alerts: |
| 416 | - name: vsphere_vm_cpu_utilization |
| 417 | metric: vsphere.vm_cpu_utilization |
| 418 | info: Virtual Machine CPU utilization |
| 419 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vsphere.conf |
| 420 | - name: vsphere_vm_mem_utilization |
| 421 | metric: vsphere.vm_mem_utilization |
| 422 | info: Virtual Machine memory utilization |
| 423 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vsphere.conf |
| 424 | - name: vsphere_vm_snapshot_chain_depth |
| 425 | metric: vsphere.vm_snapshot_max_chain_depth |
| 426 | info: Virtual Machine snapshot maximum chain depth |
| 427 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vsphere.conf |
| 428 | - name: vsphere_vm_snapshot_age |
| 429 | metric: vsphere.vm_snapshot_max_age |
| 430 | info: Virtual Machine oldest snapshot age |
| 431 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vsphere.conf |
| 432 | - name: vsphere_host_cpu_utilization |
| 433 | metric: vsphere.host_cpu_utilization |
| 434 | info: ESXi Host CPU utilization |
| 435 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vsphere.conf |
| 436 | - name: vsphere_host_mem_utilization |
| 437 | metric: vsphere.host_mem_utilization |
| 438 | info: ESXi Host memory utilization |
| 439 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/vsphere.conf |
| 440 | functions: |
| 441 | description: | |
| 442 | This collector exposes read-only readiness and topology functions for interactive troubleshooting in the Live tab. Both functions require selecting a configured vSphere collector job. |
| 443 | list: |
| 444 | - id: readiness |
| 445 | name: vSphere Readiness |
| 446 | description: | |
| 447 | Reports the collector's current readiness from cached local state: |
| 448 | |
| 449 | - the selected vSphere collector job |
| 450 | - whether the target URL and credentials are configured |
| 451 | - whether the vSphere client, discovery cache, and performance-counter lists are initialized |
| 452 | - discovered inventory counts |
| 453 | - enabled or disabled optional metric, label, and vSAN groups |
| 454 | - cached vSAN result counts when `collect_vsan` is enabled |
| 455 | |
| 456 | The function does not expose the configured vCenter URL or credentials, and it does not issue extra vCenter API calls. |
| 457 | parameters: |
| 458 | - id: __job |
| 459 | name: Job |
| 460 | description: Select which configured vSphere collector job to inspect. |
| 461 | type: select |
| 462 | required: true |
| 463 | default: "" |
| 464 | options: [] |
| 465 | returns: |
| 466 | description: Collector readiness checks from cached local state. Each row represents one target, discovery, label, scope, metric, or vSAN readiness check. |
| 467 | columns: |
| 468 | - name: check |
| 469 | type: string |
| 470 | unit: "" |
| 471 | description: Stable readiness check identifier. |
| 472 | - name: scope |
| 473 | type: string |
| 474 | unit: "" |
| 475 | description: Area covered by the check, such as target, discovery, labels, scope, or metrics. |
| 476 | - name: status |
| 477 | type: string |
| 478 | unit: "" |
| 479 | description: Readiness status. Possible values are ok, warning, disabled, and not_ready. |
| 480 | - name: details |
| 481 | type: string |
| 482 | unit: "" |
| 483 | description: Human-readable explanation of the current cached state for the check. |
| 484 | performance: | |
| 485 | Uses cached collector state only:<br/>• No additional vCenter or ESXi API requests are triggered<br/>• Response size is bounded by the number of configured optional groups and cached inventory summary rows |
| 486 | security: | |
| 487 | Does not expose the configured vCenter URL, username, password, or per-object inventory names:<br/>• Shows only configuration presence, resource counts, enabled feature flags, include pattern counts, and cached vSAN result counts<br/>• Access should still be restricted to authorized operators because it reveals enabled collection surfaces |
| 488 | availability: | |
| 489 | Available when:<br/>• The vSphere collector job is running<br/>• Returns not_ready rows while the collector is not initialized or discovery has not completed<br/>• Uses the last cached discovery and vSAN scrape state |
| 490 | require_cloud: true |
| 491 | - id: topology:vsphere |
| 492 | name: vSphere Topology |
| 493 | description: | |
| 494 | Reports cached vSphere inventory topology for datacenters, clusters, ESXi hosts, VMs, datastores, networks, datastore clusters, and resource pools. |
| 495 | |
| 496 | The public topology function is `topology:vsphere`. The function builds actors and links from the selected job's cached discovery state. It does not issue extra vCenter API calls. vSphere Network and Distributed Virtual Port Group actors are included only when `collect_network_topology` is enabled. |
| 497 | parameters: |
| 498 | - id: __job |
| 499 | name: Job |
| 500 | description: Select which configured vSphere collector job provides the cached topology. |
| 501 | type: select |
| 502 | required: true |
| 503 | default: "" |
| 504 | options: [] |
| 505 | returns: |
| 506 | description: Cached vSphere inventory topology payload using the netdata.topology.v1 schema. Actors represent discovered inventory objects, links represent inventory ownership, VM-to-host runtime placement, and host/VM network attachment relationships, and overlays expose refreshable datastore utilization metrics. |
| 507 | columns: |
| 508 | - name: schema_version |
| 509 | type: string |
| 510 | unit: "" |
| 511 | description: Topology payload schema version. |
| 512 | - name: producer |
| 513 | type: object |
| 514 | unit: "" |
| 515 | description: Producer metadata identifying the vSphere topology source, selected collector job, plugin, and local node when available. |
| 516 | - name: collected_at |
| 517 | type: datetime |
| 518 | unit: "" |
| 519 | description: Time when the cached topology response was built. |
| 520 | - name: view |
| 521 | type: object |
| 522 | unit: "" |
| 523 | description: Topology view metadata. |
| 524 | - name: dictionaries |
| 525 | type: object |
| 526 | unit: "" |
| 527 | description: Compact-table dictionaries used by actors, links, evidence, and detail tables. |
| 528 | - name: types |
| 529 | type: object |
| 530 | unit: "" |
| 531 | description: Actor, link, evidence, table, and presentation type registry. |
| 532 | - name: presentation |
| 533 | type: object |
| 534 | unit: "" |
| 535 | description: Graph-level presentation metadata. |
| 536 | - name: actors |
| 537 | type: object |
| 538 | unit: "" |
| 539 | description: Compact actor table for vSphere inventory objects, including datacenters, clusters, ESXi hosts, VMs, datastores, optional networks, datastore clusters, and resource pools. |
| 540 | - name: links |
| 541 | type: object |
| 542 | unit: "" |
| 543 | description: Compact link table for relationships between vSphere inventory actors. |
| 544 | - name: evidence |
| 545 | type: object |
| 546 | unit: "" |
| 547 | description: Relationship evidence tables backing the rendered links. |
| 548 | - name: tables |
| 549 | type: object |
| 550 | unit: "" |
| 551 | description: Actor detail and label tables used by topology modals. |
| 552 | - name: overlays |
| 553 | type: object |
| 554 | unit: "" |
| 555 | description: Telemetry overlay refs for refreshable metrics, including datastore used-space utilization selected by collector job and vSphere managed object ID. |
| 556 | - name: stats |
| 557 | type: object |
| 558 | unit: "" |
| 559 | description: Counts of discovered inventory objects, actors, links, and overlay refs included in the response. |
| 560 | performance: | |
| 561 | Uses cached collector state only:<br/>• No additional vCenter or ESXi API requests are triggered by the function<br/>• Response size grows with discovered inventory object count<br/>• `collect_network_topology` adds Network discovery during normal collector discovery cycles when enabled |
| 562 | security: | |
| 563 | Exposes discovered inventory object names and status attributes already visible through vSphere chart labels and metrics:<br/>• Does not expose the configured vCenter URL, username, or password |
| 564 | availability: | |
| 565 | Available when:<br/>• The vSphere collector job is running<br/>• Initial discovery has completed successfully<br/>• Returns HTTP 503 while topology data is not cached yet |
| 566 | require_cloud: true |
| 567 | metrics: |
| 568 | folding: |
| 569 | title: Metrics |
| 570 | enabled: false |
| 571 | description: "" |
| 572 | availability: [] |
| 573 | scopes: |
| 574 | - name: inventory |
| 575 | description: These metrics refer to the discovered vSphere inventory for this collector job. |
| 576 | labels: |
| 577 | - name: id |
| 578 | description: Static inventory instance ID |
| 579 | metrics: |
| 580 | - name: vsphere.inventory_objects |
| 581 | description: vSphere inventory object count after include filters are applied |
| 582 | unit: objects |
| 583 | chart_type: line |
| 584 | dimensions: |
| 585 | - name: datacenters |
| 586 | - name: folders |
| 587 | - name: clusters |
| 588 | - name: hosts |
| 589 | - name: vms |
| 590 | - name: datastores |
| 591 | - name: resource_pools |
| 592 | - name: virtual machine |
| 593 | description: These metrics refer to the Virtual Machine. |
| 594 | labels: |
| 595 | - name: id |
| 596 | description: vSphere managed object reference ID |
| 597 | - name: datacenter |
| 598 | description: Datacenter name |
| 599 | - name: cluster |
| 600 | description: Cluster name |
| 601 | - name: host |
| 602 | description: Host name |
| 603 | - name: vm |
| 604 | description: Virtual Machine name |
| 605 | - name: vsphere_tag_\<category> |
| 606 | description: vSphere tag label; present only for categories matched by `tag_categories`; category names are sanitized for label keys and multiple tags in one category are sorted and joined with the pipe character |
| 607 | - name: vsphere_custom_attribute_\<name> |
| 608 | description: vSphere custom attribute label; present only for attributes matched by `custom_attributes`; attribute names are sanitized for label keys |
| 609 | metrics: |
| 610 | - name: vsphere.vm_cpu_utilization |
| 611 | description: Virtual Machine CPU utilization |
| 612 | unit: percentage |
| 613 | chart_type: line |
| 614 | dimensions: |
| 615 | - name: used |
| 616 | - name: vsphere.vm_mem_utilization |
| 617 | description: Virtual Machine memory utilization |
| 618 | unit: percentage |
| 619 | chart_type: line |
| 620 | dimensions: |
| 621 | - name: used |
| 622 | - name: vsphere.vm_mem_usage |
| 623 | description: Virtual Machine memory usage |
| 624 | unit: KiB |
| 625 | chart_type: line |
| 626 | dimensions: |
| 627 | - name: granted |
| 628 | - name: consumed |
| 629 | - name: active |
| 630 | - name: shared |
| 631 | - name: vsphere.vm_mem_swap_usage |
| 632 | description: Virtual Machine VMKernel memory swap usage |
| 633 | unit: KiB |
| 634 | chart_type: line |
| 635 | dimensions: |
| 636 | - name: swapped |
| 637 | - name: vsphere.vm_mem_swap_io |
| 638 | description: Virtual Machine VMKernel memory swap IO |
| 639 | unit: KiB/s |
| 640 | chart_type: area |
| 641 | dimensions: |
| 642 | - name: in |
| 643 | - name: out |
| 644 | - name: vsphere.vm_disk_io |
| 645 | description: Virtual Machine disk IO |
| 646 | unit: KiB/s |
| 647 | chart_type: area |
| 648 | dimensions: |
| 649 | - name: read |
| 650 | - name: write |
| 651 | - name: vsphere.vm_disk_max_latency |
| 652 | description: Virtual Machine disk max latency |
| 653 | unit: milliseconds |
| 654 | chart_type: line |
| 655 | dimensions: |
| 656 | - name: latency |
| 657 | - name: vsphere.vm_net_traffic |
| 658 | description: Virtual Machine network traffic |
| 659 | unit: KiB/s |
| 660 | chart_type: area |
| 661 | dimensions: |
| 662 | - name: received |
| 663 | - name: sent |
| 664 | - name: vsphere.vm_net_packets |
| 665 | description: Virtual Machine network packets |
| 666 | unit: packets |
| 667 | chart_type: line |
| 668 | dimensions: |
| 669 | - name: received |
| 670 | - name: sent |
| 671 | - name: vsphere.vm_net_drops |
| 672 | description: Virtual Machine network dropped packets |
| 673 | unit: drops |
| 674 | chart_type: line |
| 675 | dimensions: |
| 676 | - name: received |
| 677 | - name: sent |
| 678 | - name: vsphere.vm_overall_status |
| 679 | description: Virtual Machine overall alarm status |
| 680 | unit: status |
| 681 | chart_type: line |
| 682 | dimensions: |
| 683 | - name: green |
| 684 | - name: red |
| 685 | - name: yellow |
| 686 | - name: gray |
| 687 | - name: vsphere.vm_power_state |
| 688 | description: Virtual Machine power state |
| 689 | unit: status |
| 690 | chart_type: line |
| 691 | dimensions: |
| 692 | - name: powered_on |
| 693 | - name: powered_off |
| 694 | - name: suspended |
| 695 | - name: vsphere.vm_connection_state |
| 696 | description: Virtual Machine connection state |
| 697 | unit: status |
| 698 | chart_type: line |
| 699 | dimensions: |
| 700 | - name: connected |
| 701 | - name: disconnected |
| 702 | - name: orphaned |
| 703 | - name: inaccessible |
| 704 | - name: invalid |
| 705 | - name: vsphere.vm_tools_running_status |
| 706 | description: Virtual Machine VMware Tools running status |
| 707 | unit: status |
| 708 | chart_type: line |
| 709 | dimensions: |
| 710 | - name: running |
| 711 | - name: not_running |
| 712 | - name: executing_scripts |
| 713 | - name: unknown |
| 714 | - name: vsphere.vm_tools_version_status |
| 715 | description: Virtual Machine VMware Tools version status |
| 716 | unit: status |
| 717 | chart_type: line |
| 718 | dimensions: |
| 719 | - name: current |
| 720 | - name: need_upgrade |
| 721 | - name: not_installed |
| 722 | - name: unmanaged |
| 723 | - name: too_old |
| 724 | - name: supported_old |
| 725 | - name: supported_new |
| 726 | - name: too_new |
| 727 | - name: blacklisted |
| 728 | - name: unknown |
| 729 | - name: vsphere.vm_consolidation_needed |
| 730 | description: Virtual Machine disk consolidation status |
| 731 | unit: status |
| 732 | chart_type: line |
| 733 | dimensions: |
| 734 | - name: needed |
| 735 | - name: not_needed |
| 736 | - name: vsphere.vm_system_uptime |
| 737 | description: Virtual Machine system uptime |
| 738 | unit: seconds |
| 739 | chart_type: line |
| 740 | dimensions: |
| 741 | - name: uptime |
| 742 | - name: vsphere.vm_config_cpu |
| 743 | description: Virtual Machine configured CPU |
| 744 | unit: vCPUs |
| 745 | chart_type: line |
| 746 | dimensions: |
| 747 | - name: vcpus |
| 748 | - name: vsphere.vm_config_memory |
| 749 | description: Virtual Machine configured memory |
| 750 | unit: MiB |
| 751 | chart_type: line |
| 752 | dimensions: |
| 753 | - name: memory |
| 754 | - name: vsphere.vm_config_devices |
| 755 | description: Virtual Machine configured devices |
| 756 | unit: devices |
| 757 | chart_type: line |
| 758 | dimensions: |
| 759 | - name: disks |
| 760 | - name: nics |
| 761 | - name: vsphere.vm_storage_usage |
| 762 | description: Virtual Machine storage usage |
| 763 | unit: bytes |
| 764 | chart_type: line |
| 765 | dimensions: |
| 766 | - name: committed |
| 767 | - name: uncommitted |
| 768 | - name: unshared |
| 769 | - name: vsphere.vm_snapshot_count |
| 770 | description: Virtual Machine snapshot count |
| 771 | unit: snapshots |
| 772 | chart_type: line |
| 773 | dimensions: |
| 774 | - name: count |
| 775 | - name: vsphere.vm_snapshot_max_age |
| 776 | description: Virtual Machine oldest snapshot age; zero means no snapshots |
| 777 | unit: seconds |
| 778 | chart_type: line |
| 779 | dimensions: |
| 780 | - name: age |
| 781 | - name: vsphere.vm_snapshot_max_chain_depth |
| 782 | description: Virtual Machine maximum snapshot chain depth; zero means no snapshots |
| 783 | unit: snapshots |
| 784 | chart_type: line |
| 785 | dimensions: |
| 786 | - name: depth |
| 787 | - name: virtual machine power |
| 788 | description: These aggregate metrics refer to VM power and energy and are collected for discovered powered-on VMs when vSphere exposes the corresponding power counters. |
| 789 | labels: |
| 790 | - name: id |
| 791 | description: vSphere managed object reference ID of the VM |
| 792 | - name: datacenter |
| 793 | description: Datacenter name |
| 794 | - name: cluster |
| 795 | description: Cluster name |
| 796 | - name: host |
| 797 | description: Host name |
| 798 | - name: vm |
| 799 | description: Virtual Machine name |
| 800 | - name: vsphere_tag_\<category> |
| 801 | description: vSphere tag label; present only for categories matched by `tag_categories`; category names are sanitized for label keys and multiple tags in one category are sorted and joined with the pipe character |
| 802 | - name: vsphere_custom_attribute_\<name> |
| 803 | description: vSphere custom attribute label; present only for attributes matched by `custom_attributes`; attribute names are sanitized for label keys |
| 804 | metrics: |
| 805 | - name: vsphere.vm_power_usage |
| 806 | description: Virtual Machine power usage |
| 807 | unit: watts |
| 808 | chart_type: line |
| 809 | dimensions: |
| 810 | - name: power |
| 811 | - name: vsphere.vm_energy_usage |
| 812 | description: Virtual Machine energy usage |
| 813 | unit: joules |
| 814 | chart_type: line |
| 815 | dimensions: |
| 816 | - name: energy |
| 817 | - name: vSAN virtual machine |
| 818 | description: These optional metrics refer to VM vSAN performance and are collected only when `collect_vsan` is enabled. |
| 819 | labels: |
| 820 | - name: id |
| 821 | description: vSphere managed object reference ID of the VM |
| 822 | - name: datacenter |
| 823 | description: Datacenter name |
| 824 | - name: cluster |
| 825 | description: Cluster name |
| 826 | - name: host |
| 827 | description: Host name |
| 828 | - name: vm |
| 829 | description: Virtual Machine name |
| 830 | - name: vm_instance_uuid |
| 831 | description: VM instance UUID used by vSAN performance entity references |
| 832 | - name: vsphere_tag_\<category> |
| 833 | description: vSphere tag label; present only for categories matched by `tag_categories`; category names are sanitized for label keys and multiple tags in one category are sorted and joined with the pipe character |
| 834 | - name: vsphere_custom_attribute_\<name> |
| 835 | description: vSphere custom attribute label; present only for attributes matched by `custom_attributes`; attribute names are sanitized for label keys |
| 836 | metrics: |
| 837 | - name: vsphere.vsan_vm_operations |
| 838 | description: vSAN Virtual Machine operations |
| 839 | unit: operations/s |
| 840 | chart_type: line |
| 841 | dimensions: |
| 842 | - name: read |
| 843 | - name: write |
| 844 | - name: vsphere.vsan_vm_throughput |
| 845 | description: vSAN Virtual Machine throughput |
| 846 | unit: bytes/s |
| 847 | chart_type: area |
| 848 | dimensions: |
| 849 | - name: read |
| 850 | - name: write |
| 851 | - name: vsphere.vsan_vm_latency |
| 852 | description: vSAN Virtual Machine latency |
| 853 | unit: microseconds |
| 854 | chart_type: line |
| 855 | dimensions: |
| 856 | - name: read |
| 857 | - name: write |
| 858 | - name: host power |
| 859 | description: These aggregate metrics refer to ESXi host power, energy, and power capacity and are collected for discovered powered-on hosts when vSphere exposes the corresponding power counters. |
| 860 | labels: |
| 861 | - name: id |
| 862 | description: vSphere managed object reference ID of the host |
| 863 | - name: datacenter |
| 864 | description: Datacenter name |
| 865 | - name: cluster |
| 866 | description: Cluster name |
| 867 | - name: host |
| 868 | description: Host name |
| 869 | - name: vsphere_tag_\<category> |
| 870 | description: vSphere tag label; present only for categories matched by `tag_categories`; category names are sanitized for label keys and multiple tags in one category are sorted and joined with the pipe character |
| 871 | - name: vsphere_custom_attribute_\<name> |
| 872 | description: vSphere custom attribute label; present only for attributes matched by `custom_attributes`; attribute names are sanitized for label keys |
| 873 | metrics: |
| 874 | - name: vsphere.host_power_usage |
| 875 | description: ESXi Host power usage |
| 876 | unit: watts |
| 877 | chart_type: line |
| 878 | dimensions: |
| 879 | - name: power |
| 880 | - name: cap |
| 881 | - name: vsphere.host_power_capacity_usage |
| 882 | description: ESXi Host power capacity usage |
| 883 | unit: watts |
| 884 | chart_type: line |
| 885 | dimensions: |
| 886 | - name: used |
| 887 | - name: usable |
| 888 | - name: idle |
| 889 | - name: system |
| 890 | - name: vm |
| 891 | - name: vsphere.host_power_capacity_utilization |
| 892 | description: ESXi Host power capacity utilization |
| 893 | unit: percentage |
| 894 | chart_type: line |
| 895 | dimensions: |
| 896 | - name: used |
| 897 | - name: vsphere.host_energy_usage |
| 898 | description: ESXi Host energy usage |
| 899 | unit: joules |
| 900 | chart_type: line |
| 901 | dimensions: |
| 902 | - name: energy |
| 903 | - name: vSAN host |
| 904 | description: These optional metrics refer to ESXi host vSAN performance and are collected only when `collect_vsan` is enabled. |
| 905 | labels: |
| 906 | - name: id |
| 907 | description: vSphere managed object reference ID of the host |
| 908 | - name: datacenter |
| 909 | description: Datacenter name |
| 910 | - name: cluster |
| 911 | description: Cluster name |
| 912 | - name: host |
| 913 | description: Host name |
| 914 | - name: vsan_node_uuid |
| 915 | description: vSAN host node UUID used by vSAN performance entity references |
| 916 | - name: vsphere_tag_\<category> |
| 917 | description: vSphere tag label; present only for categories matched by `tag_categories`; category names are sanitized for label keys and multiple tags in one category are sorted and joined with the pipe character |
| 918 | - name: vsphere_custom_attribute_\<name> |
| 919 | description: vSphere custom attribute label; present only for attributes matched by `custom_attributes`; attribute names are sanitized for label keys |
| 920 | metrics: |
| 921 | - name: vsphere.vsan_host_operations |
| 922 | description: vSAN Host operations |
| 923 | unit: operations/s |
| 924 | chart_type: line |
| 925 | dimensions: |
| 926 | - name: read |
| 927 | - name: write |
| 928 | - name: vsphere.vsan_host_throughput |
| 929 | description: vSAN Host throughput |
| 930 | unit: bytes/s |
| 931 | chart_type: area |
| 932 | dimensions: |
| 933 | - name: read |
| 934 | - name: write |
| 935 | - name: vsphere.vsan_host_latency |
| 936 | description: vSAN Host latency |
| 937 | unit: microseconds |
| 938 | chart_type: line |
| 939 | dimensions: |
| 940 | - name: read |
| 941 | - name: write |
| 942 | - name: vsphere.vsan_host_congestions |
| 943 | description: vSAN Host congestion events |
| 944 | unit: congestions/s |
| 945 | chart_type: line |
| 946 | dimensions: |
| 947 | - name: congestions |
| 948 | - name: vsphere.vsan_host_cache_hit_rate |
| 949 | description: vSAN Host client cache hit rate |
| 950 | unit: percentage |
| 951 | chart_type: line |
| 952 | dimensions: |
| 953 | - name: hit_rate |
| 954 | - name: host |
| 955 | description: These metrics refer to the ESXi host. |
| 956 | labels: |
| 957 | - name: id |
| 958 | description: vSphere managed object reference ID |
| 959 | - name: datacenter |
| 960 | description: Datacenter name |
| 961 | - name: cluster |
| 962 | description: Cluster name |
| 963 | - name: host |
| 964 | description: Host name |
| 965 | - name: vsphere_tag_\<category> |
| 966 | description: vSphere tag label; present only for categories matched by `tag_categories`; category names are sanitized for label keys and multiple tags in one category are sorted and joined with the pipe character |
| 967 | - name: vsphere_custom_attribute_\<name> |
| 968 | description: vSphere custom attribute label; present only for attributes matched by `custom_attributes`; attribute names are sanitized for label keys |
| 969 | metrics: |
| 970 | - name: vsphere.host_cpu_utilization |
| 971 | description: ESXi Host CPU utilization |
| 972 | unit: percentage |
| 973 | chart_type: line |
| 974 | dimensions: |
| 975 | - name: used |
| 976 | - name: vsphere.host_mem_utilization |
| 977 | description: ESXi Host memory utilization |
| 978 | unit: percentage |
| 979 | chart_type: line |
| 980 | dimensions: |
| 981 | - name: used |
| 982 | - name: vsphere.host_mem_usage |
| 983 | description: ESXi Host memory usage |
| 984 | unit: KiB |
| 985 | chart_type: line |
| 986 | dimensions: |
| 987 | - name: granted |
| 988 | - name: consumed |
| 989 | - name: active |
| 990 | - name: shared |
| 991 | - name: sharedcommon |
| 992 | - name: vsphere.host_mem_swap_io |
| 993 | description: ESXi Host VMKernel memory swap IO |
| 994 | unit: KiB/s |
| 995 | chart_type: area |
| 996 | dimensions: |
| 997 | - name: in |
| 998 | - name: out |
| 999 | - name: vsphere.host_disk_io |
| 1000 | description: ESXi Host disk IO |
| 1001 | unit: KiB/s |
| 1002 | chart_type: area |
| 1003 | dimensions: |
| 1004 | - name: read |
| 1005 | - name: write |
| 1006 | - name: vsphere.host_disk_max_latency |
| 1007 | description: ESXi Host disk max latency |
| 1008 | unit: milliseconds |
| 1009 | chart_type: line |
| 1010 | dimensions: |
| 1011 | - name: latency |
| 1012 | - name: vsphere.host_net_traffic |
| 1013 | description: ESXi Host network traffic |
| 1014 | unit: KiB/s |
| 1015 | chart_type: area |
| 1016 | dimensions: |
| 1017 | - name: received |
| 1018 | - name: sent |
| 1019 | - name: vsphere.host_net_packets |
| 1020 | description: ESXi Host network packets |
| 1021 | unit: packets |
| 1022 | chart_type: line |
| 1023 | dimensions: |
| 1024 | - name: received |
| 1025 | - name: sent |
| 1026 | - name: vsphere.host_net_drops |
| 1027 | description: ESXi Host network drops |
| 1028 | unit: drops |
| 1029 | chart_type: line |
| 1030 | dimensions: |
| 1031 | - name: received |
| 1032 | - name: sent |
| 1033 | - name: vsphere.host_net_errors |
| 1034 | description: ESXi Host network errors |
| 1035 | unit: errors |
| 1036 | chart_type: line |
| 1037 | dimensions: |
| 1038 | - name: received |
| 1039 | - name: sent |
| 1040 | - name: vsphere.host_overall_status |
| 1041 | description: ESXi Host overall alarm status |
| 1042 | unit: status |
| 1043 | chart_type: line |
| 1044 | dimensions: |
| 1045 | - name: green |
| 1046 | - name: red |
| 1047 | - name: yellow |
| 1048 | - name: gray |
| 1049 | - name: vsphere.host_power_state |
| 1050 | description: ESXi Host power state |
| 1051 | unit: status |
| 1052 | chart_type: line |
| 1053 | dimensions: |
| 1054 | - name: powered_on |
| 1055 | - name: powered_off |
| 1056 | - name: standby |
| 1057 | - name: unknown |
| 1058 | - name: vsphere.host_connection_state |
| 1059 | description: ESXi Host connection state |
| 1060 | unit: status |
| 1061 | chart_type: line |
| 1062 | dimensions: |
| 1063 | - name: connected |
| 1064 | - name: not_responding |
| 1065 | - name: disconnected |
| 1066 | - name: vsphere.host_maintenance_status |
| 1067 | description: ESXi Host maintenance status |
| 1068 | unit: status |
| 1069 | chart_type: line |
| 1070 | dimensions: |
| 1071 | - name: normal |
| 1072 | - name: in_maintenance |
| 1073 | - name: vsphere.host_system_uptime |
| 1074 | description: ESXi Host system uptime |
| 1075 | unit: seconds |
| 1076 | chart_type: line |
| 1077 | dimensions: |
| 1078 | - name: uptime |
| 1079 | - name: datastore |
| 1080 | description: These metrics refer to the Datastore. |
| 1081 | labels: |
| 1082 | - name: id |
| 1083 | description: vSphere managed object reference ID |
| 1084 | - name: datacenter |
| 1085 | description: Datacenter name |
| 1086 | - name: datastore |
| 1087 | description: Datastore name |
| 1088 | - name: type |
| 1089 | description: "Datastore type (VMFS, NFS, NFS41, vsan, VVOL, PMEM)" |
| 1090 | - name: vsphere_tag_\<category> |
| 1091 | description: vSphere tag label; present only for categories matched by `tag_categories`; category names are sanitized for label keys and multiple tags in one category are sorted and joined with the pipe character |
| 1092 | - name: vsphere_custom_attribute_\<name> |
| 1093 | description: vSphere custom attribute label; present only for attributes matched by `custom_attributes`; attribute names are sanitized for label keys |
| 1094 | metrics: |
| 1095 | - name: vsphere.datastore_disk_io |
| 1096 | description: Datastore disk IO |
| 1097 | unit: KiB/s |
| 1098 | chart_type: area |
| 1099 | dimensions: |
| 1100 | - name: read |
| 1101 | - name: write |
| 1102 | - name: vsphere.datastore_disk_iops |
| 1103 | description: Datastore disk IOPS |
| 1104 | unit: operations/s |
| 1105 | chart_type: line |
| 1106 | dimensions: |
| 1107 | - name: reads |
| 1108 | - name: writes |
| 1109 | - name: vsphere.datastore_disk_latency |
| 1110 | description: Datastore disk latency |
| 1111 | unit: milliseconds |
| 1112 | chart_type: line |
| 1113 | dimensions: |
| 1114 | - name: read |
| 1115 | - name: write |
| 1116 | - name: vsphere.datastore_space_utilization |
| 1117 | description: Datastore space utilization |
| 1118 | unit: percentage |
| 1119 | chart_type: line |
| 1120 | dimensions: |
| 1121 | - name: used |
| 1122 | - name: vsphere.datastore_space_usage |
| 1123 | description: Datastore space usage; capacity, free, used, and uncommitted are zero when the datastore is inaccessible |
| 1124 | unit: bytes |
| 1125 | chart_type: line |
| 1126 | dimensions: |
| 1127 | - name: capacity |
| 1128 | - name: free |
| 1129 | - name: used |
| 1130 | - name: uncommitted |
| 1131 | - name: vsphere.datastore_overall_status |
| 1132 | description: Datastore overall alarm status |
| 1133 | unit: status |
| 1134 | chart_type: line |
| 1135 | dimensions: |
| 1136 | - name: green |
| 1137 | - name: red |
| 1138 | - name: yellow |
| 1139 | - name: gray |
| 1140 | - name: vsphere.datastore_accessibility_status |
| 1141 | description: Datastore accessibility status |
| 1142 | unit: status |
| 1143 | chart_type: line |
| 1144 | dimensions: |
| 1145 | - name: accessible |
| 1146 | - name: inaccessible |
| 1147 | - name: vsphere.datastore_maintenance_status |
| 1148 | description: Datastore maintenance mode status |
| 1149 | unit: status |
| 1150 | chart_type: line |
| 1151 | dimensions: |
| 1152 | - name: normal |
| 1153 | - name: entering_maintenance |
| 1154 | - name: in_maintenance |
| 1155 | - name: unknown |
| 1156 | - name: vsphere.datastore_multiple_host_access |
| 1157 | description: Datastore multi-host access status |
| 1158 | unit: status |
| 1159 | chart_type: line |
| 1160 | dimensions: |
| 1161 | - name: enabled |
| 1162 | - name: disabled |
| 1163 | - name: unknown |
| 1164 | - name: datastore cluster |
| 1165 | description: These optional metrics refer to datastore clusters (StoragePod objects) and are collected only when `collect_datastore_clusters` is enabled. |
| 1166 | labels: |
| 1167 | - name: id |
| 1168 | description: vSphere managed object reference ID |
| 1169 | - name: datacenter |
| 1170 | description: Datacenter name |
| 1171 | - name: datastore_cluster |
| 1172 | description: Datastore cluster name |
| 1173 | - name: vsphere_tag_\<category> |
| 1174 | description: vSphere tag label; present only for categories matched by `tag_categories`; category names are sanitized for label keys and multiple tags in one category are sorted and joined with the pipe character |
| 1175 | - name: vsphere_custom_attribute_\<name> |
| 1176 | description: vSphere custom attribute label; present only for attributes matched by `custom_attributes`; attribute names are sanitized for label keys |
| 1177 | metrics: |
| 1178 | - name: vsphere.datastore_cluster_space_utilization |
| 1179 | description: Datastore Cluster space utilization |
| 1180 | unit: percentage |
| 1181 | chart_type: line |
| 1182 | dimensions: |
| 1183 | - name: used |
| 1184 | - name: vsphere.datastore_cluster_space_usage |
| 1185 | description: Datastore Cluster space usage |
| 1186 | unit: bytes |
| 1187 | chart_type: line |
| 1188 | dimensions: |
| 1189 | - name: capacity |
| 1190 | - name: free |
| 1191 | - name: used |
| 1192 | - name: vsphere.datastore_cluster_storage_drs_status |
| 1193 | description: Datastore Cluster Storage DRS status |
| 1194 | unit: status |
| 1195 | chart_type: line |
| 1196 | dimensions: |
| 1197 | - name: enabled |
| 1198 | - name: disabled |
| 1199 | - name: vsphere.datastore_cluster_overall_status |
| 1200 | description: Datastore Cluster overall status |
| 1201 | unit: status |
| 1202 | chart_type: line |
| 1203 | dimensions: |
| 1204 | - name: green |
| 1205 | - name: red |
| 1206 | - name: yellow |
| 1207 | - name: gray |
| 1208 | - name: vSAN cluster |
| 1209 | description: These optional metrics refer to vSAN cluster capacity, health, and performance and are collected only when `collect_vsan` is enabled. |
| 1210 | labels: |
| 1211 | - name: id |
| 1212 | description: vSphere managed object reference ID of the cluster |
| 1213 | - name: datacenter |
| 1214 | description: Datacenter name |
| 1215 | - name: cluster |
| 1216 | description: Cluster name |
| 1217 | - name: vsan_uuid |
| 1218 | description: vSAN cluster UUID used by vSAN performance entity references |
| 1219 | - name: vsphere_tag_\<category> |
| 1220 | description: vSphere tag label; present only for categories matched by `tag_categories`; category names are sanitized for label keys and multiple tags in one category are sorted and joined with the pipe character |
| 1221 | - name: vsphere_custom_attribute_\<name> |
| 1222 | description: vSphere custom attribute label; present only for attributes matched by `custom_attributes`; attribute names are sanitized for label keys |
| 1223 | metrics: |
| 1224 | - name: vsphere.vsan_cluster_space_usage |
| 1225 | description: vSAN Cluster space usage |
| 1226 | unit: bytes |
| 1227 | chart_type: stacked |
| 1228 | dimensions: |
| 1229 | - name: used |
| 1230 | - name: free |
| 1231 | - name: total |
| 1232 | - name: vsphere.vsan_cluster_space_utilization |
| 1233 | description: vSAN Cluster space utilization |
| 1234 | unit: percentage |
| 1235 | chart_type: line |
| 1236 | dimensions: |
| 1237 | - name: used |
| 1238 | - name: vsphere.vsan_cluster_health_status |
| 1239 | description: vSAN Cluster health status |
| 1240 | unit: status |
| 1241 | chart_type: line |
| 1242 | dimensions: |
| 1243 | - name: green |
| 1244 | - name: yellow |
| 1245 | - name: red |
| 1246 | - name: unknown |
| 1247 | - name: vsphere.vsan_cluster_operations |
| 1248 | description: vSAN Cluster operations |
| 1249 | unit: operations/s |
| 1250 | chart_type: line |
| 1251 | dimensions: |
| 1252 | - name: read |
| 1253 | - name: write |
| 1254 | - name: vsphere.vsan_cluster_throughput |
| 1255 | description: vSAN Cluster throughput |
| 1256 | unit: bytes/s |
| 1257 | chart_type: area |
| 1258 | dimensions: |
| 1259 | - name: read |
| 1260 | - name: write |
| 1261 | - name: vsphere.vsan_cluster_latency |
| 1262 | description: vSAN Cluster latency |
| 1263 | unit: microseconds |
| 1264 | chart_type: line |
| 1265 | dimensions: |
| 1266 | - name: read |
| 1267 | - name: write |
| 1268 | - name: vsphere.vsan_cluster_congestions |
| 1269 | description: vSAN Cluster congestion events |
| 1270 | unit: congestions/s |
| 1271 | chart_type: line |
| 1272 | dimensions: |
| 1273 | - name: congestions |
| 1274 | - name: cluster |
| 1275 | description: These metrics refer to the vSphere Cluster. |
| 1276 | labels: |
| 1277 | - name: id |
| 1278 | description: vSphere managed object reference ID |
| 1279 | - name: datacenter |
| 1280 | description: Datacenter name |
| 1281 | - name: cluster |
| 1282 | description: Cluster name |
| 1283 | - name: vsphere_tag_\<category> |
| 1284 | description: vSphere tag label; present only for categories matched by `tag_categories`; category names are sanitized for label keys and multiple tags in one category are sorted and joined with the pipe character |
| 1285 | - name: vsphere_custom_attribute_\<name> |
| 1286 | description: vSphere custom attribute label; present only for attributes matched by `custom_attributes`; attribute names are sanitized for label keys |
| 1287 | metrics: |
| 1288 | - name: vsphere.cluster_hosts |
| 1289 | description: Cluster host count |
| 1290 | unit: hosts |
| 1291 | chart_type: line |
| 1292 | dimensions: |
| 1293 | - name: total |
| 1294 | - name: effective |
| 1295 | - name: vsphere.cluster_cpu_capacity |
| 1296 | description: Cluster CPU capacity |
| 1297 | unit: MHz |
| 1298 | chart_type: line |
| 1299 | dimensions: |
| 1300 | - name: total |
| 1301 | - name: effective |
| 1302 | - name: vsphere.cluster_mem_capacity |
| 1303 | description: Cluster memory capacity |
| 1304 | unit: bytes |
| 1305 | chart_type: line |
| 1306 | dimensions: |
| 1307 | - name: total |
| 1308 | - name: effective |
| 1309 | - name: vsphere.cluster_cpu_topology |
| 1310 | description: Cluster CPU topology |
| 1311 | unit: count |
| 1312 | chart_type: line |
| 1313 | dimensions: |
| 1314 | - name: cores |
| 1315 | - name: threads |
| 1316 | - name: vsphere.cluster_drs_config |
| 1317 | description: Cluster DRS enabled |
| 1318 | unit: status |
| 1319 | chart_type: line |
| 1320 | dimensions: |
| 1321 | - name: enabled |
| 1322 | - name: vsphere.cluster_drs_mode |
| 1323 | description: Cluster DRS automation mode |
| 1324 | unit: status |
| 1325 | chart_type: line |
| 1326 | dimensions: |
| 1327 | - name: manual |
| 1328 | - name: partially_automated |
| 1329 | - name: fully_automated |
| 1330 | - name: unknown |
| 1331 | - name: vsphere.cluster_drs_vmotion_rate |
| 1332 | description: Cluster DRS vMotion recommendation threshold |
| 1333 | unit: level |
| 1334 | chart_type: line |
| 1335 | dimensions: |
| 1336 | - name: rate |
| 1337 | - name: vsphere.cluster_ha_config |
| 1338 | description: Cluster HA configuration |
| 1339 | unit: status |
| 1340 | chart_type: line |
| 1341 | dimensions: |
| 1342 | - name: enabled |
| 1343 | - name: admission_control |
| 1344 | - name: vsphere.cluster_ha_host_monitoring |
| 1345 | description: Cluster HA host monitoring |
| 1346 | unit: status |
| 1347 | chart_type: line |
| 1348 | dimensions: |
| 1349 | - name: enabled |
| 1350 | - name: disabled |
| 1351 | - name: unknown |
| 1352 | - name: vsphere.cluster_ha_vm_monitoring |
| 1353 | description: Cluster HA VM monitoring |
| 1354 | unit: status |
| 1355 | chart_type: line |
| 1356 | dimensions: |
| 1357 | - name: disabled |
| 1358 | - name: vm_monitoring_only |
| 1359 | - name: vm_and_app_monitoring |
| 1360 | - name: unknown |
| 1361 | - name: vsphere.cluster_ha_vm_component_protection |
| 1362 | description: Cluster HA VM component protection |
| 1363 | unit: status |
| 1364 | chart_type: line |
| 1365 | dimensions: |
| 1366 | - name: enabled |
| 1367 | - name: disabled |
| 1368 | - name: unknown |
| 1369 | - name: vsphere.cluster_overall_status |
| 1370 | description: Cluster overall alarm status |
| 1371 | unit: status |
| 1372 | chart_type: line |
| 1373 | dimensions: |
| 1374 | - name: green |
| 1375 | - name: red |
| 1376 | - name: yellow |
| 1377 | - name: gray |
| 1378 | - name: vsphere.cluster_vmotions |
| 1379 | description: Cluster cumulative vMotion count |
| 1380 | unit: migrations |
| 1381 | chart_type: line |
| 1382 | dimensions: |
| 1383 | - name: vmotions |
| 1384 | - name: vsphere.cluster_drs_score |
| 1385 | description: Cluster DRS score |
| 1386 | unit: percentage |
| 1387 | chart_type: line |
| 1388 | dimensions: |
| 1389 | - name: score |
| 1390 | - name: vsphere.cluster_drs_balance |
| 1391 | description: Cluster DRS load balance |
| 1392 | unit: score |
| 1393 | chart_type: line |
| 1394 | dimensions: |
| 1395 | - name: current |
| 1396 | - name: target |
| 1397 | - name: vsphere.cluster_vm_count |
| 1398 | description: Cluster VM count |
| 1399 | unit: VMs |
| 1400 | chart_type: line |
| 1401 | dimensions: |
| 1402 | - name: total |
| 1403 | - name: powered_off |
| 1404 | - name: vsphere.cluster_usage_cpu |
| 1405 | description: Cluster DRS CPU usage summary |
| 1406 | unit: MHz |
| 1407 | chart_type: line |
| 1408 | dimensions: |
| 1409 | - name: demand |
| 1410 | - name: entitled |
| 1411 | - name: reserved |
| 1412 | - name: vsphere.cluster_usage_mem |
| 1413 | description: Cluster DRS memory usage summary |
| 1414 | unit: MB |
| 1415 | chart_type: line |
| 1416 | dimensions: |
| 1417 | - name: demand |
| 1418 | - name: entitled |
| 1419 | - name: reserved |
| 1420 | - name: vsphere.cluster_cpu_utilization |
| 1421 | description: Cluster CPU utilization |
| 1422 | unit: percentage |
| 1423 | chart_type: line |
| 1424 | dimensions: |
| 1425 | - name: used |
| 1426 | - name: vsphere.cluster_cpu_usage |
| 1427 | description: Cluster CPU usage |
| 1428 | unit: MHz |
| 1429 | chart_type: line |
| 1430 | dimensions: |
| 1431 | - name: used |
| 1432 | - name: total |
| 1433 | - name: vsphere.cluster_mem_utilization |
| 1434 | description: Cluster memory utilization |
| 1435 | unit: percentage |
| 1436 | chart_type: line |
| 1437 | dimensions: |
| 1438 | - name: used |
| 1439 | - name: vsphere.cluster_mem_usage |
| 1440 | description: Cluster memory usage |
| 1441 | unit: KiB |
| 1442 | chart_type: line |
| 1443 | dimensions: |
| 1444 | - name: consumed |
| 1445 | - name: active |
| 1446 | - name: granted |
| 1447 | - name: shared |
| 1448 | - name: overhead |
| 1449 | - name: swap_used |
| 1450 | - name: vsphere.cluster_services_fairness |
| 1451 | description: Cluster DRS resource distribution fairness |
| 1452 | unit: score |
| 1453 | chart_type: line |
| 1454 | dimensions: |
| 1455 | - name: cpu |
| 1456 | - name: memory |
| 1457 | - name: vsphere.cluster_services_effective_cpu |
| 1458 | description: Cluster effective CPU capacity |
| 1459 | unit: MHz |
| 1460 | chart_type: line |
| 1461 | dimensions: |
| 1462 | - name: effective_cpu |
| 1463 | - name: vsphere.cluster_services_effective_mem |
| 1464 | description: Cluster effective memory capacity |
| 1465 | unit: MB |
| 1466 | chart_type: line |
| 1467 | dimensions: |
| 1468 | - name: effective_mem |
| 1469 | - name: vsphere.cluster_services_failover |
| 1470 | description: Cluster HA failover capacity |
| 1471 | unit: failures |
| 1472 | chart_type: line |
| 1473 | dimensions: |
| 1474 | - name: failures_tolerable |
| 1475 | - name: vsphere.cluster_vm_migrations |
| 1476 | description: Cluster VM migration operations |
| 1477 | unit: operations |
| 1478 | chart_type: line |
| 1479 | dimensions: |
| 1480 | - name: vmotion |
| 1481 | - name: svmotion |
| 1482 | - name: xvmotion |
| 1483 | - name: vsphere.cluster_vm_lifecycle |
| 1484 | description: Cluster VM lifecycle operations |
| 1485 | unit: operations |
| 1486 | chart_type: line |
| 1487 | dimensions: |
| 1488 | - name: poweron |
| 1489 | - name: poweroff |
| 1490 | - name: create |
| 1491 | - name: destroy |
| 1492 | - name: clone |
| 1493 | - name: deploy |
| 1494 | - name: vsphere.cluster_vm_management |
| 1495 | description: Cluster VM management operations |
| 1496 | unit: operations |
| 1497 | chart_type: line |
| 1498 | dimensions: |
| 1499 | - name: reconfigure |
| 1500 | - name: reset |
| 1501 | - name: suspend |
| 1502 | - name: register |
| 1503 | - name: unregister |
| 1504 | - name: vsphere.cluster_vm_guest_ops |
| 1505 | description: Cluster VM guest operations |
| 1506 | unit: operations |
| 1507 | chart_type: line |
| 1508 | dimensions: |
| 1509 | - name: reboot |
| 1510 | - name: shutdown |
| 1511 | - name: standby |
| 1512 | - name: vsphere.cluster_vm_cold_migrations |
| 1513 | description: Cluster VM cold migration operations |
| 1514 | unit: operations |
| 1515 | chart_type: line |
| 1516 | dimensions: |
| 1517 | - name: change_ds |
| 1518 | - name: change_host |
| 1519 | - name: change_host_ds |
| 1520 | - name: resource pool |
| 1521 | description: These metrics refer to the vSphere Resource Pool. |
| 1522 | labels: |
| 1523 | - name: id |
| 1524 | description: vSphere managed object reference ID |
| 1525 | - name: datacenter |
| 1526 | description: Datacenter name |
| 1527 | - name: cluster |
| 1528 | description: Cluster name |
| 1529 | - name: resource_pool |
| 1530 | description: Resource Pool name |
| 1531 | - name: vsphere_tag_\<category> |
| 1532 | description: vSphere tag label; present only for categories matched by `tag_categories`; category names are sanitized for label keys and multiple tags in one category are sorted and joined with the pipe character |
| 1533 | - name: vsphere_custom_attribute_\<name> |
| 1534 | description: vSphere custom attribute label; present only for attributes matched by `custom_attributes`; attribute names are sanitized for label keys |
| 1535 | metrics: |
| 1536 | - name: vsphere.resource_pool_cpu_usage |
| 1537 | description: Resource Pool CPU usage vs demand |
| 1538 | unit: MHz |
| 1539 | chart_type: line |
| 1540 | dimensions: |
| 1541 | - name: usage |
| 1542 | - name: demand |
| 1543 | - name: vsphere.resource_pool_cpu_entitlement |
| 1544 | description: Resource Pool CPU entitlement |
| 1545 | unit: MHz |
| 1546 | chart_type: line |
| 1547 | dimensions: |
| 1548 | - name: distributed |
| 1549 | - name: vsphere.resource_pool_cpu_allocation |
| 1550 | description: Resource Pool CPU allocation |
| 1551 | unit: MHz |
| 1552 | chart_type: line |
| 1553 | dimensions: |
| 1554 | - name: reservation_used |
| 1555 | - name: unreserved_for_vm |
| 1556 | - name: max_usage |
| 1557 | - name: vsphere.resource_pool_mem_usage |
| 1558 | description: Resource Pool memory usage |
| 1559 | unit: MB |
| 1560 | chart_type: line |
| 1561 | dimensions: |
| 1562 | - name: host |
| 1563 | - name: guest |
| 1564 | - name: vsphere.resource_pool_mem_entitlement |
| 1565 | description: Resource Pool memory entitlement |
| 1566 | unit: MB |
| 1567 | chart_type: line |
| 1568 | dimensions: |
| 1569 | - name: distributed |
| 1570 | - name: vsphere.resource_pool_mem_allocation |
| 1571 | description: Resource Pool memory allocation |
| 1572 | unit: bytes |
| 1573 | chart_type: line |
| 1574 | dimensions: |
| 1575 | - name: reservation_used |
| 1576 | - name: unreserved_for_vm |
| 1577 | - name: max_usage |
| 1578 | - name: vsphere.resource_pool_mem_breakdown |
| 1579 | description: Resource Pool memory state breakdown |
| 1580 | unit: MB |
| 1581 | chart_type: line |
| 1582 | dimensions: |
| 1583 | - name: private |
| 1584 | - name: shared |
| 1585 | - name: swapped |
| 1586 | - name: ballooned |
| 1587 | - name: overhead |
| 1588 | - name: consumed_overhead |
| 1589 | - name: compressed |
| 1590 | - name: vsphere.resource_pool_cpu_config |
| 1591 | description: Resource Pool CPU configured reservation and limit |
| 1592 | unit: MHz |
| 1593 | chart_type: line |
| 1594 | dimensions: |
| 1595 | - name: reservation |
| 1596 | - name: limit |
| 1597 | - name: vsphere.resource_pool_mem_config |
| 1598 | description: Resource Pool memory configured reservation and limit |
| 1599 | unit: MB |
| 1600 | chart_type: line |
| 1601 | dimensions: |
| 1602 | - name: reservation |
| 1603 | - name: limit |
| 1604 | - name: vsphere.resource_pool_overall_status |
| 1605 | description: Resource Pool overall alarm status |
| 1606 | unit: status |
| 1607 | chart_type: line |
| 1608 | dimensions: |
| 1609 | - name: green |
| 1610 | - name: red |
| 1611 | - name: yellow |
| 1612 | - name: gray |