Skip to content

vCenter Integration

Use this guide to collect VMware vCenter metrics in KloudMate with the OpenTelemetry vcenter receiver running via the KloudMate Agent.

  1. Run vCenter 7.0 or 8.x.
  2. Create a read-only vSphere user with access to the vCenter server, clusters, and resources you want to monitor.
  3. Identify the vCenter or ESXi endpoint with SDK access enabled.
  4. Install the KloudMate Agent on a host that can reach vCenter.

Add the vcenter receiver to your Agent configuration file (typically /etc/km-agent/config.yaml):

receivers:
  vcenter:
    endpoint: https://vcenter.example.com/sdk
    username: <username>
    password: <password>
    collection_interval: 1m
    initial_delay: 1s
    tls:
      insecure: true

If you need to disable specific metrics, add them under the metrics section of the receiver configuration.

Update the metrics pipeline in the service section to include the vcenter receiver.

service:
  pipelines:
    metrics:
      receivers: [vcenter, hostmetrics] # Add vcenter here
      processors: [resource, batch]
      exporters: [debug, otlphttp]

For Linux:

systemctl restart kmagent
systemctl status kmagent

For Windows, restart the KloudMate Agent service from services.msc.

After the Agent restarts:

  • open Explore
  • query vCenter metrics such as vcenter_host_cpu_utilization or vcenter_vm_memory_usage
  • build dashboards and alerts once the data is visible
MetricsDescription
vcenter_datacenter_cluster_countThe number of clusters in the datacenter.
vcenter_datacenter_host_countThe number of hosts in the datacenter.
vcenter_datacenter_vm_countThe number of VM’s in the datacenter.
vcenter_datacenter_datastore_countThe number of datastores in the datacenter.
vcenter_datacenter_disk_spaceThe amount of available and used disk space in the datacenter.
vcenter_datacenter_cpu_limitThe total amount of CPU available to the datacenter.
vcenter_datacenter_memory_limitThe total amount of memory available to the datacenter.
vcenter_cluster_cpu_limitThe amount of CPU available to the cluster.
vcenter_cluster_cpu_effectiveThe effective CPU available to the cluster. This value excludes CPU from hosts in maintenance mode or are unresponsive.
vcenter_cluster_memory_limitThe available memory of the cluster.
vcenter_cluster_memory_effectiveThe effective available memory of the cluster.
vcenter_cluster_vm_countThe number of virtual machines in the cluster.
vcenter_cluster_vm_template_countThe number of virtual machine templates in the cluster.
vcenter_cluster_host_countThe number of hosts in the cluster.
vcenter_cluster_vsan_throughputThe vSAN throughput of a cluster.
vcenter_cluster_vsan_operationsThe vSAN IOPs of a cluster.
vcenter_cluster_vsan_latency_avgThe overall cluster latency while accessing vSAN storage.
vcenter_cluster_vsan_congestionsThe congestion of IOs generated by all vSAN clients in the cluster.
vcenter_datastore_disk_usageThe amount of space in the datastore.
vcenter_datastore_disk_utilizationThe utilization of the datastore.
vcenter_host_cpu_utilizationThe CPU utilization of the host system.
vcenter_host_cpu_usageThe amount of CPU used by the host.
vcenter_host_cpu_capacityTotal CPU capacity of the host system.
vcenter_host_cpu_reservedThe CPU of the host is reserved for use by virtual machines.
vcenter_host_disk_throughputAverage number of kilobytes read from or written to the disk each second.
vcenter_host_disk_latency_avgThe latency of operations to the host system’s disk.
vcenter_host_disk_latency_maxHighest latency value across all disks used by the host.
vcenter_host_memory_utilizationThe percentage of the host system’s memory capacity that is being utilized.
vcenter_host_memory_usageThe amount of memory the host system is using.
vcenter_host_network_throughputThe amount of data that was transmitted or received over the network by the host.
vcenter_host_network_usageThe sum of the data transmitted and received for all the NIC instances of the host.
vcenter_host_network_packet_error_rateThe rate of packet errors transmitted or received on the host network.
vcenter_host_network_packet_rateThe rate of packets transmitted or received across each physical NIC (network interface controller) instance on the host.
vcenter_host_network_packet_drop_rateThe rate of packets dropped across each physical NIC (network interface controller) instance on the host.
vcenter_host_vsan_throughputThe vSAN throughput of a host.
vcenter_host_vsan_operationsThe vSAN IOPs of a host.
vcenter_host_vsan_latency_avgThe host latency while accessing vSAN storage.
vcenter_host_vsan_congestionsThe congestion of IOs generated by all vSAN clients in the host.
vcenter_host_vsan_cache_hit_rateThe host’s read IOs which could be satisfied by the local client cache.
vcenter_resource_pool_memory_usageThe usage of the memory by the resource pool.
vcenter_resource_pool_memory_sharesThe amount of shares of memory in the resource pool.
vcenter_resource_pool_memory_swappedThe amount of memory that is granted to VMs in the resource pool from the host’s swap space.
vcenter_resource_pool_memory_balloonedThe amount of memory in a resource pool that is ballooned due to virtualization.
vcenter_resource_pool_memory_grantedThe amount of memory that is granted to VMs in the resource pool from shared and non-shared host memory.
vcenter_resource_pool_cpu_usageThe usage of the CPU used by the resource pool.
vcenter_resource_pool_cpu_sharesThe amount of shares of CPU in the resource pool.
vcenter_vm_memory_balloonedThe amount of memory that is ballooned due to virtualization.
vcenter_vm_memory_usageThe amount of memory that is used by the virtual machine.
vcenter_vm_memory_swappedThe portion of memory that is granted to this VM from the host’s swap space.
vcenter_vm_memory_swapped_ssdThe amount of memory swapped to fast disk device such as SSD.
vcenter_vm_disk_usageThe amount of storage space used by the virtual machine.
vcenter_vm_disk_utilizationThe utilization of storage on the virtual machine.
vcenter_vm_disk_latency_avgThe latency of operations to the virtual machine’s disk.
vcenter_vm_disk_latency_maxThe highest reported total latency (device and kernel times) over an interval of 20 seconds.
vcenter_vm_disk_throughputAverage number of kilobytes read from or written to the virtual disk each second.
vcenter_vm_network_throughputThe amount of data that was transmitted or received over the network of the virtual machine.
vcenter_vm_network_packet_rateThe rate of packets transmitted or received by each vNIC (virtual network interface controller) on the virtual machine.
vcenter_vm_network_packet_drop_rateThe rate of transmitted or received packets dropped by each vNIC (virtual network interface controller) on the virtual machine.
vcenter_vm_network_usageThe network utilization combined transmit and receive rates during an interval.
vcenter_vm_cpu_utilizationThe CPU utilization of the VM.
vcenter_vm_cpu_usageThe amount of CPU used by the VM.
vcenter_vm_cpu_readinessPercentage of time that the virtual machine was ready, but could not get scheduled to run on the physical CPU.
vcenter_vm_memory_utilizationThe memory utilization of the VM.
vcenter_vm_vsan_throughputThe vSAN throughput of a virtual machine.
vcenter_vm_vsan_operationsThe vSAN IOPs of a virtual machine.
vcenter_vm_vsan_latency_avgThe virtual machine latency while accessing vSAN storage.

For the complete upstream reference, see the vcenter receiver documentation.