This documentation has an index for AI agents at /llms.txt. A Markdown version of this page is available at https://explorer.opentelemetry.io/collector/components/contrib/vcenterreceiver.md.

vCenter Receiver

OpenTelemetry Collector receiver · contrib distribution

This receiver fetches metrics from a vCenter or ESXi host running VMware vSphere APIs.

  • Component ID: contrib-vcenterreceiver
  • Name: vcenterreceiver
  • Type: receiver
  • Distribution: contrib
  • Repository: opentelemetry-collector-contrib

Stability

LevelSignals
alphametrics

Metrics

MetricTypeValue typeUnitStabilityEnabledAttributesDescription
vcenter.cluster.cpu.effectivesumintMHzdevelopmentyesThe effective CPU available to the cluster. This value excludes CPU from hosts in maintenance mode or are unresponsive.
vcenter.cluster.cpu.limitsumintMHzdevelopmentyesThe amount of CPU available to the cluster.
vcenter.cluster.host.countsumint{hosts}developmentyeshost_effective (bool)The number of hosts in the cluster.
vcenter.cluster.memory.effectivesumintBydevelopmentyesThe effective available memory of the cluster. This value excludes memory from hosts that are either in maintenance mode or are unresponsive. It also excludes memory used by the VMware Service Console.
vcenter.cluster.memory.limitsumintBydevelopmentyesThe available memory of the cluster.
vcenter.cluster.vm.countsumint{virtual_machines}developmentyesvm_count_power_state (string)The number of virtual machines in the cluster.
vcenter.cluster.vm_template.countsumint{virtual_machine_templates}developmentyesThe number of virtual machine templates in the cluster.
vcenter.cluster.vsan.congestionsgaugedouble{congestions/s}developmentyesThe congestions of IOs generated by all vSAN clients in the cluster.
vcenter.cluster.vsan.latency.avggaugeintusdevelopmentyesvsan_latency_type (string)The overall cluster latency while accessing vSAN storage.
vcenter.cluster.vsan.operationsgaugeint{operations/s}developmentyesvsan_operation_type (string)The vSAN IOPs of a cluster.
vcenter.cluster.vsan.throughputgaugedoubleBy/sdevelopmentyesvsan_throughput_direction (string)The vSAN throughput of a cluster.
vcenter.datacenter.cluster.countsumint{clusters}developmentyesentity_status (string)The number of clusters in the datacenter.
vcenter.datacenter.cpu.limitsumintMHzdevelopmentyesThe total amount of CPU available to the datacenter.
vcenter.datacenter.datastore.countsumint{datastores}developmentyesThe number of datastores in the datacenter.
vcenter.datacenter.disk.spacesumintBydevelopmentyesdisk_state (string)The amount of available and used disk space in the datacenter.
vcenter.datacenter.host.countsumint{hosts}developmentyesentity_status (string), host_power_state (string)The number of hosts in the datacenter.
vcenter.datacenter.memory.limitsumintBydevelopmentyesThe total amount of memory available to the datacenter.
vcenter.datacenter.vm.countsumint{virtual_machines}developmentyesentity_status (string), vm_count_power_state (string)The number of VM's in the datacenter.
vcenter.datastore.disk.usagesumintBydevelopmentyesdisk_state (string)The amount of space in the datastore.
vcenter.datastore.disk.utilizationgaugedouble%developmentyesThe utilization of the datastore.
vcenter.host.cpu.capacitysumintMHzdevelopmentyesTotal CPU capacity of the host system.
vcenter.host.cpu.reservedsumintMHzdevelopmentyescpu_reservation_type (string)The CPU of the host reserved for use by virtual machines.
vcenter.host.cpu.usagesumintMHzdevelopmentyesThe amount of CPU used by the host.
vcenter.host.cpu.utilizationgaugedouble%developmentyesThe CPU utilization of the host system.
vcenter.host.disk.latency.avggaugeintmsdevelopmentyesdisk_direction (string), object_name (string)The latency of operations to the host system's disk. This latency is the sum of the device and kernel read and write latencies. Requires Performance Counter level 2 for metric to populate.
vcenter.host.disk.latency.maxgaugeintmsdevelopmentyesobject_name (string)Highest latency value across all disks used by the host. As measured over the most recent 20s interval. Requires Performance Level 3.
vcenter.host.disk.throughputsumint{KiBy/s}developmentyesdisk_direction (string), object_name (string)Average number of kilobytes read from or written to the disk each second. As measured over the most recent 20s interval. Aggregated disk I/O rate. Requires Performance Level 4.
vcenter.host.memory.activesumintMiBydevelopmentnoThe amount of memory the host's powered-on VMs are actively using. As measured over the most recent 20s interval.
vcenter.host.memory.balloonedsumintMiBydevelopmentnoThe amount of guest physical memory reclaimed from the host's VMs via the balloon driver. As measured over the most recent 20s interval.
vcenter.host.memory.capacitysumdoubleMiBydevelopmentnoTotal memory capacity of the host system.
vcenter.host.memory.grantedsumintMiBydevelopmentnoThe amount of machine memory that is granted to the powered-on VMs on the host. As measured over the most recent 20s interval.
vcenter.host.memory.usagesumintMiBydevelopmentyesThe amount of memory the host system is using.
vcenter.host.memory.utilizationgaugedouble%developmentyesThe percentage of the host system's memory capacity that is being utilized.
vcenter.host.network.packet.drop.rategaugedouble{packets/s}developmentyesobject_name (string), throughput_direction (string)The rate of packets dropped across each physical NIC (network interface controller) instance on the host. As measured over the most recent 20s interval.
vcenter.host.network.packet.error.rategaugedouble{errors/s}developmentyesobject_name (string), throughput_direction (string)The rate of packet errors transmitted or received on the host network. As measured over the most recent 20s interval.
vcenter.host.network.packet.rategaugedouble{packets/s}developmentyesobject_name (string), throughput_direction (string)The rate of packets transmitted or received across each physical NIC (network interface controller) instance on the host. As measured over the most recent 20s interval.
vcenter.host.network.throughputsumint{KiBy/s}developmentyesobject_name (string), throughput_direction (string)The amount of data that was transmitted or received over the network by the host. As measured over the most recent 20s interval.
vcenter.host.network.usagesumint{KiBy/s}developmentyesobject_name (string)The sum of the data transmitted and received for all the NIC instances of the host.
vcenter.host.vsan.cache.hit_rategaugeint%developmentyesThe host's read IOs which could be satisfied by the local client cache. As measured over the most recent 5m interval.
vcenter.host.vsan.congestionsgaugedouble{congestions/s}developmentyesThe congestions of IOs generated by all vSAN clients in the host. As measured over the most recent 5m interval.
vcenter.host.vsan.latency.avggaugeintusdevelopmentyesvsan_latency_type (string)The host latency while accessing vSAN storage. As measured over the most recent 5m interval.
vcenter.host.vsan.operationsgaugeint{operations/s}developmentyesvsan_operation_type (string)The vSAN IOPs of a host. As measured over the most recent 5m interval.
vcenter.host.vsan.throughputgaugedoubleBy/sdevelopmentyesvsan_throughput_direction (string)The vSAN throughput of a host. As measured over the most recent 5m interval.
vcenter.resource_pool.cpu.sharessumint{shares}developmentyesThe amount of shares of CPU in the resource pool.
vcenter.resource_pool.cpu.usagesumintMHzdevelopmentyesThe usage of the CPU used by the resource pool.
vcenter.resource_pool.memory.balloonedsumintMiBydevelopmentyesThe amount of memory in a resource pool that is ballooned due to virtualization.
vcenter.resource_pool.memory.grantedsumintMiBydevelopmentyesmemory_granted_type (string)The amount of memory that is granted to VMs in the resource pool from shared and non-shared host memory.
vcenter.resource_pool.memory.sharessumint{shares}developmentyesThe amount of shares of memory in the resource pool.
vcenter.resource_pool.memory.swappedsumintMiBydevelopmentyesThe amount of memory that is granted to VMs in the resource pool from the host's swap space.
vcenter.resource_pool.memory.usagesumintMiBydevelopmentyesmemory_usage_type (string)The usage of the memory by the resource pool.
vcenter.vm.cpu.readinessgaugeint%developmentyesPercentage of time that the virtual machine was ready, but could not get scheduled to run on the physical CPU.
vcenter.vm.cpu.timegaugedouble%developmentnocpu_state (string), object_name (string)CPU time spent in idle, ready or wait state. As measured over the most recent 20s interval.
vcenter.vm.cpu.usagesumintMHzdevelopmentyesThe amount of CPU used by the VM.
vcenter.vm.cpu.utilizationgaugedouble%developmentyesThe CPU utilization of the VM.
vcenter.vm.disk.latency.avggaugeintmsdevelopmentyesdisk_direction (string), disk_type (string), object_name (string)The latency of operations to the virtual machine's disk. Requires Performance Counter level 2 for metric to populate. As measured over the most recent 20s interval.
vcenter.vm.disk.latency.maxgaugeintmsdevelopmentyesobject_name (string)The highest reported total latency (device and kernel times) over an interval of 20 seconds.
vcenter.vm.disk.throughputgaugeint{KiBy/s}developmentyesdisk_direction (string), object_name (string)Average number of kilobytes read from or written to the virtual disk each second. As measured over the most recent 20s interval. Requires Performance Level 2.
vcenter.vm.disk.usagesumintBydevelopmentyesdisk_state (string)The amount of storage space used by the virtual machine.
vcenter.vm.disk.utilizationgaugedouble%developmentyesThe utilization of storage on the virtual machine.
vcenter.vm.memory.balloonedsumintMiBydevelopmentyesThe amount of memory that is ballooned due to virtualization.
vcenter.vm.memory.grantedsumintMiBydevelopmentnoThe amount of memory that is granted to a VM.
vcenter.vm.memory.swappedsumintMiBydevelopmentyesThe portion of memory that is granted to this VM from the host's swap space.
vcenter.vm.memory.swapped_ssdsumintKiBydevelopmentyesThe amount of memory swapped to fast disk device such as SSD.
vcenter.vm.memory.usagesumintMiBydevelopmentyesThe amount of memory that is used by the virtual machine.
vcenter.vm.memory.utilizationgaugedouble%developmentyesThe memory utilization of the VM.
vcenter.vm.network.broadcast.packet.rategaugedouble{packets/s}developmentnoobject_name (string), throughput_direction (string)The rate of broadcast packets transmitted or received by each vNIC (virtual network interface controller) on the virtual machine. As measured over the most recent 20s interval.
vcenter.vm.network.multicast.packet.rategaugedouble{packets/s}developmentnoobject_name (string), throughput_direction (string)The rate of multicast packets transmitted or received by each vNIC (virtual network interface controller) on the virtual machine. As measured over the most recent 20s interval.
vcenter.vm.network.packet.drop.rategaugedouble{packets/s}developmentyesobject_name (string), throughput_direction (string)The rate of transmitted or received packets dropped by each vNIC (virtual network interface controller) on the virtual machine. As measured over the most recent 20s interval.
vcenter.vm.network.packet.rategaugedouble{packets/s}developmentyesobject_name (string), throughput_direction (string)The rate of packets transmitted or received by each vNIC (virtual network interface controller) on the virtual machine. As measured over the most recent 20s interval.
vcenter.vm.network.throughputsumintBy/sdevelopmentyesobject_name (string), throughput_direction (string)The amount of data that was transmitted or received over the network of the virtual machine. As measured over the most recent 20s interval.
vcenter.vm.network.usagesumint{KiBy/s}developmentyesobject_name (string)The network utilization combined transmit and receive rates during an interval. As measured over the most recent 20s interval.
vcenter.vm.vsan.latency.avggaugeintusdevelopmentyesvsan_latency_type (string)The virtual machine latency while accessing vSAN storage.
vcenter.vm.vsan.operationsgaugeint{operations/s}developmentyesvsan_operation_type (string)The vSAN IOPs of a virtual machine.
vcenter.vm.vsan.throughputgaugedoubleBy/sdevelopmentyesvsan_throughput_direction (string)The vSAN throughput of a virtual machine.

Attributes

AttributeTypeDescription
cpu_reservation_typestringThe type of CPU reservation for the host.
cpu_statestringCPU time spent in idle, ready or idle state.
disk_directionstringThe direction of disk latency.
disk_statestringThe state of storage and whether it is already allocated or free.
disk_typestringThe type of storage device that is being recorded.
entity_statusstringThe current status of the managed entity.
host_effectiveboolWhether the host is effective in the vCenter cluster.
host_power_statestringThe current power state of the host.
memory_granted_typestringThe type of memory granted.
memory_usage_typestringThe type of memory usage.
object_namestringThe object on the virtual machine or host that is being reported on.
throughput_directionstringThe direction of network throughput.
vm_count_power_statestringThe current power state of the virtual machine.
vsan_latency_typestringThe type of vSAN latency.
vsan_operation_typestringThe type of vSAN operation.
vsan_throughput_directionstringThe type of vSAN throughput.

Data

  • JSON (latest): /data/collector/components/contrib-vcenterreceiver/latest.json
  • JSON (pinned): /data/collector/components/contrib-vcenterreceiver/contrib-vcenterreceiver-f90837b62b26.json
  • Explore: /collector/components/contrib/vcenterreceiver