Supported Metrics
The metrics collected by the Citrix Hypervisor integration are grouped into logical categories based on the monitored component type. Each category is represented as a tabbed table that displays the native type, metric names, display labels, units, supported versions, and descriptions.
Availability
Capacity
Performance
Usage
| Native Type | Metric Name | Display Name | Units | Application Version | Description |
|---|---|---|---|---|---|
| Citrix Hypervisor Pool | citrix_hypervisor_pool_LiveHostCount | Citrix Hypervisor Pool Live Hosts | count | 1.0.0 | The number of hosts in the Citrix hypervisor pool that are active and available for running virtual machines. |
| citrix_hypervisor_pool_DeadHostCount | Citrix Hypervisor Pool Dead Hosts | count | 1.0.0 | The number of hosts in the Citrix hypervisor pool that are inactive or not currently operational. | |
| citrix_hypervisor_pool_PowerOnVMCount | Citrix Hypervisor Pool VM PowerOn Count | count | 1.0.0 | The number of virtual machines (VMs) within the Citrix hypervisor pool that are powered on and running. | |
| citrix_hypervisor_pool_PowerOffVMCount | Citrix Hypervisor Pool VM PowerOff Count | count | 1.0.0 | The number of virtual machines (VMs) within the Citrix hypervisor pool that are powered off and not running. | |
| citrix_hypervisor_pool_SuspendedVMCount | Citrix Hypervisor Pool VM Suspended Count | count | 1.0.0 | The number of virtual machines (VMs) within the Citrix hypervisor pool that are suspended and not active. | |
| Citrix Hypervisor Host | citrix_hypervisor_host_PoolTaskCount | Citrix Hypervisor Host Pool Task Count | 1.0.0 | count | The number of pool tasks in the host. |
| citrix_hypervisor_host_PoolSessionCount | Citrix Hypervisor Host Pool Session Count | 1.0.0 | count | The number of active pool sessions in the host. | |
| citrix_hypervisor_host_AvailabilityStatus | Citrix Hypervisor Host Availability Status | 1.0.0 | Provides the Availability Status of the Host. | ||
| citrix_hypervisor_host_LicenseExpiry | Citrix Hypervisor Host License Expiry | 1.0.0 | Days | Provides the number of days remaining until expiration of the license for the host. | |
| Citrix Hypervisor Storage Repository | citrix_hypervisor_storageRepository_CacheHits | Citrix Hypervisor Storage Repository Cache Hits | 1.0.0 | count | Provides the Cache Hits of the IntelliCache Storage Repository. |
| citrix_hypervisor_storageRepository_CacheMisses | Citrix Hypervisor Storage Repository Cache Misses | 1.0.0 | count | Provides the Cache Misses of the IntelliCache Storage Repository. | |
| Citrix Hypervisor Network Interface | citrix_hypervisor_networkInterface_ReceivedErrors | Citrix Hypervisor Network Interface Received Errors | 1.0.0 | Errors per Sec | The number of Transmission errors on a physical network interface. |
| citrix_hypervisor_networkInterface_TransferErrors | Citrix Hypervisor Network Interface Transfer Errors | 1.0.0 | Errors per Sec | The number of Received errors on a physical network interface. | |
| Citrix Hypervisor Virtual Interface | citrix_hypervisor_virtualInterface_ReceivedErrors | Citrix Hypervisor Virtual Interface Received Traffic | 1.0.0 | Errors per Sec | The number of Received errors on a Virtual network interface. |
| citrix_hypervisor_virtualInterface_TransferErrors | Citrix Hypervisor Virtual Interface Transfer Errors | 1.0.0 | Errors per Sec | The number of Transmitted errors on a Virtual Network Interface. |
| Native Type | Metric Name | Display Name | Units | Application Version | Description |
|---|---|---|---|---|---|
| Citrix Hypervisor Host | citrix_hypervisor_host_MemoryTotal | Citrix Hypervisor Host Memory Total | GB | 1.0.0 | Total amount of memory in the host. |
| citrix_hypervisor_host_XapiMemoryAllocation | Citrix Hypervisor Host Xapi Memory Allocation | GB | 1.0.0 | The amount of memory allocated to the XAPI (Xen API) on the host. | |
| Citrix Hypervisor Virtual Disk | citrix_hypervisor_virtualDisk_VirtualSize | Citrix Hypervisor Virtual Disk Virtual Size | GB | 1.0.0 | Virtual Size of the Citrix Hypervisor Virtual Disk. |
| Native Type | Metric Name | Display Name | Units | Application Version | Description |
|---|---|---|---|---|---|
| Citrix Hypervisor Host | citrix_hypervisor_host_CPUTimeCstate | Citrix Hypervisor Host CPU Time Cstate | 1.0.0 | ms | The amount of CPU time spent in various C-states (power-saving states). |
| citrix_hypervisor_host_CPUTimePstate | Citrix Hypervisor Host CPU Time PState | 1.0.0 | ms | The amount of CPU time spent in various P-states (performance states). | |
| citrix_hypervisor_host_NetworkLatency | Citrix Hypervisor Host Network Latency | 1.0.0 | s | Provides the Interval between the last two heartbeats transmitted from the host to all online hosts. | |
| citrix_hypervisor_host_StateFileLatency | Citrix Hypervisor Host StateFile Latency | 1.0.0 | s | Provides the Turn-around time in seconds of the latest State-File access from the host. | |
| citrix_hypervisor_host_XapiHealthCheckLatency | Citrix Hypervisor Host Xapi HealthCheck Latency | 1.0.0 | s | Provides the Turn-around time of the latest XAPI status monitoring call on the host. | |
| citrix_hypervisor_host_NicAggregateReceiveTraffic | Citrix Hypervisor Network Interface Aggregate Received Traffic | 1.0.0 | Bps | The aggregated received network traffic across all physical network interfaces. | |
| citrix_hypervisor_host_NicAggregateTransferTraffic | Citrix Hypervisor Network Interface Aggregate Transfer Traffic | 1.0.0 | Bps | The aggregated transmitted network traffic across all physical network interfaces. | |
| citrix_hypervisor_networkInterface_LoopbackTransferTraffic | Citrix Hypervisor Network Interface Loopback Transfer Traffic | 1.0.0 | Bps | The transmitted network traffic on the loopback interface. | |
| citrix_hypervisor_networkInterface_LoopbackTransferErrrors | Citrix Hypervisor Network Interface LoopBack Transfer Errors | 1.0.0 | Errors per Sec | The number of Transmission errors on the loopback interface. | |
| citrix_hypervisor_networkInterface_LoopbackReceivedErrors | Citrix Hypervisor Network Interface Loopback Received Errors | 1.0.0 | Errors per Sec | The number of Received errors on the loopback interface. | |
| citrix_hypervisor_networkInterface_LoopbackReceivedTraffic | Citrix Hypervisor Network Interface Loopback Received Traffic | 1.0.0 | Bps | The Received network traffic on the loopback interface. | |
| Citrix Hypervisor Storage Repository | citrix_hypervisor_storageRepository_AverageIOQueueSize | Citrix Hypervisor Storage Repository Average IO Queue Size | 1.0.0 | count | The Average size of the Storage Repository I/O queue. |
| citrix_hypervisor_storageRepository_CurrentIORequests | Citrix Hypervisor Storage Repository Current IO Requests | 1.0.0 | count | The current number of I/O requests being processed or waiting to be processed by the storage repository. | |
| citrix_hypervisor_storageRepository_IOThroughputRead | Citrix Hypervisor Storage Repository IO Throughput Read | 1.0.0 | MiB/s | The amount of data read from the storage repository. | |
| citrix_hypervisor_storageRepository_IOThroughputWrite | Citrix Hypervisor Storage Repository IO Throughput Write | 1.0.0 | MiB/s | The amount of data written from the Storage Repository. | |
| citrix_hypervisor_storageRepository_IOThroughputTotal | Citrix Hypervisor Storage Repository IO Throughput Total | 1.0.0 | MiB/s | The total amount of data read from and written to the storage repository. | |
| citrix_hypervisor_storageRepository_ReadIOPS | Citrix Hypervisor Storage Repository Read IOPS | 1.0.0 | IOPS | The number of read I/O operations per second performed by the storage repository. | |
| citrix_hypervisor_storageRepository_WriteIOPS | Citrix Hypervisor Storage Repository Write IOPS | 1.0.0 | IOPS | The number of write I/O operations per second performed by the storage repository. | |
| citrix_hypervisor_storageRepository_TotalIOPS | Citrix Hypervisor Storage Repository Total IOPS | 1.0.0 | IOPS | The total number of I/O operations per second (both read and write) performed by the storage repository. | |
| citrix_hypervisor_storageRepository_Latency | Citrix Hypervisor Storage Repository Latency | 1.0.0 | ms | The total number of I/O operations per second (both read and write) performed by the storage repository. | |
| citrix_hypervisor_storageRepository_IOWait | Citrix Hypervisor Storage Repository IO Wait | 1.0.0 | % | The percentage of time waiting for I/O operations to complete on the storage repository. | |
| Citrix Hypervisor Network Interface | citrix_hypervisor_networkInterface_ReceivedTraffic | Citrix Hypervisor Network Interface Received Traffic | 1.0.0 | Bps | The amount of data received by the physical network interface. |
| citrix_hypervisor_networkInterface_TransferTraffic | Citrix Hypervisor Network Interface Transfer Traffic | 1.0.0 | Bps | The amount of data sent out by the physical Network Interface. | |
| Citrix Virtual Machine Native Type | citrix_hypervisor_virtualMachine_RunState_FullContention | Citrix Hypervisor VirtualMachine RunState Full Contention | 1.0.0 | % | Percentage of time that all vCPUs are runnable (that is, waiting for CPU). |
| citrix_hypervisor_virtualMachine_RunState_FullRun | Citrix Hypervisor VirtualMachine RunState Full Run | 1.0.0 | % | Percentage of time that all vCPUs are running. | |
| citrix_hypervisor_virtualMachine_RunState_ConcurrencyHazard | Citrix Hypervisor RunState Concurrency Hazard | 1.0.0 | % | Percentage of time that some vCPUs are running and some are runnable. | |
| citrix_hypervisor_virtualMachine_RunState_Blocked | Citrix Hypervisor VirtualMachine RunState Blocked | 1.0.0 | % | Percentage of time that all vCPUs are blocked or offline. | |
| citrix_hypervisor_virtualMachine_RunState_PartialRun | Citrix Hypervisor VirtualMachine RunState Partial Run | 1.0.0 | % | Percentage of time that some vCPUs are running, and some are blocked. | |
| citrix_hypervisor_virtualMachine_RunState_PartialContention | Citrix Hypervisor VirtualMachine RunState Partial Contention | 1.0.0 | % | Percentage of time that some vCPUs are runnable and some are blocked. | |
| Citrix Hypervisor Virtual Interface | citrix_hypervisor_virtualInterface_ReceivedTraffic | Citrix Hypervisor Virtual Interface Received Traffic | 1.0.0 | Bps | The amount of incoming network traffic received by a virtual network interface. |
| citrix_hypervisor_virtualInterface_TransferTraffic | Citrix Hypervisor Virtual Interface Transfer Traffic | 1.0.0 | Bps | The amount of outgoing network traffic sent by a virtual interface. |
| Native Type | Metric Name | Display Name | Units | Application Version | Description |
|---|---|---|---|---|---|
| Citrix Hypervisor Host | citrix_hypervisor_host_CPUUsage | Citrix Hypervisor Host CPU Usage | % | 1.0.0 | The percentage of CPU resources currently being used by the host. |
| citrix_hypervisor_host_AverageCPUUsage | Citrix Hypervisor Host Average CPU Usage | % | 1.0.0 | Provides the average CPU usage of the host. | |
| citrix_hypervisor_host_LoadAverage | Citrix Hypervisor Host Load Average | % | 1.0.0 | Provides the Domain0 load average. | |
| citrix_hypervisor_host_MemoryFreeSpace | Citrix Hypervisor Host Memory Free Space | GB | 1.0.0 | The amount of free memory available on the host. | |
| citrix_hypervisor_host_MemoryReclaimed | Citrix Hypervisor Host Memory Reclaimed | GB | 1.0.0 | Provides the Host memory reclaimed by squeeze. | |
| citrix_hypervisor_host_MemoryMaxReclaimed | Citrix Hypervisor Host Memory Max Reclaimed | GB | 1.0.0 | Provides the Host memory available to reclaim with squeeze. | |
| citrix_hypervisor_host_XapiFreeMemory | Citrix Hypervisor Host Xapi Free Memory | GB | 1.0.0 | The amount of free memory available to XAPI. | |
| citrix_hypervisor_host_XapiLiveMemory | Citrix Hypervisor Host Xapi Live Memory | GB | 1.0.0 | Provides the Live memory used by XAPI. | |
| citrix_hypervisor_host_XapiMemoryUsage | Citrix Hypervisor Host Xapi Memory Usage | GB | 1.0.0 | Provides the Total memory allocated used by XAPI. | |
| citrix_hypervisor_host_XapiOpenFds | Citrix Hypervisor Host Xapi Open Fds | count | 1.0.0 | The number of file descriptors open by XAPI. | |
| citrix_hypervisor_host_TapDisksLowMemoryMode | Citrix Hypervisor Host TapDisks Low Memory Mode | count | 1.0.0 | Provides the tap disks count in low memory mode. | |
| citrix_hypervisor_host_MemoryUtilisation | Citrix Hypervisor Host Memory Utilisation | % | 1.0.0 | Provides the Memory Utilisation of the Host. | |
| citrix_hypervisor_host_FreeMemoryUtilisation | Citrix Hypervisor Host Free Memory Utilisation | % | 1.0.0 | Provides the Free memory Utilisation of the Host. | |
| citrix_hypervisor_host_XapiMemoryUtilisation | Citrix Hypervisor Host Xapi Memory Utilisation | % | 1.0.0 | Provides the XAPI Memory Utilisation of the host. | |
| Citrix Hypervisor Storage Repository | citrix_hypervisor_storageRepository_CapacityUtilisation | Citrix Hypervisor Storage Repository Capacity Utilisation | % | 1.0.0 | The percentage of total storage capacity currently in use by the storage repository. |
| citrix_hypervisor_storageRepository_FreeSpaceUtilisation | Citrix Hypervisor Storage Repository Free Space Utilisation | % | 1.0.0 | The percentage of the total capacity of the storage repository that is currently free and available for use. | |
| citrix_hypervisor_storageRepository_FreeSpace | Citrix Hypervisor Storage Repository Free Space | % | 1.0.0 | Provides the Free space of the Citrix Hypervisor Storage Repository. | |
| citrix_hypervisor_storageRepository_UsedCapacity | Citrix Hypervisor Storage Repository Used Capacity | % | 1.0.0 | Provides the Used Capacity of the Citrix Hypervisor Storage Repository. | |
| citrix_hypervisor_storageRepository_CacheSize | Citrix Hypervisor Storage Repository Cache Size | % | 1.0.0 | Provides the Cache Size of the IntelliCache Storage Repository. | |
| Citrix Hypervisor Virtual Machine | citrix_hypervisor_virtualMachine_AllocatedMemory | Citrix Hypervisor VirtualMachine Allocated Memory | % | 1.0.0 | Amount of memory allocated for the VM. |
| citrix_hypervisor_virtualMachine_MemoryTarget | Citrix Hypervisor VirtualMachine Memory Target | % | 1.0.0 | Memory Target of VM balloon driver. | |
| citrix_hypervisor_virtualmachine_FreeInternalMemory | Citrix Hypervisor VirtualMachine Free Internal Memory | % | 1.0.0 | Memory used as reported by the guest agent. | |
| Citrix Hypervisor Virtual Disk | citrix_hypervisor_virtualDisk_PhysicalUtilisation | Citrix Hypervisor Virtual Disk Physical Utilisation | GB | 1.0.0 | Physical Utilisation of the Citrix Hypervisor Virtual Disk. |
Default Monitoring Configurations
Citrix Hypervisor provides default monitoring components that include:
- Global Device Management Policies
- Global Templates
- Global Monitors
These configurations are applied automatically upon installation. You can customize them for your environment by cloning the global versions and modifying thresholds or alerting behavior.
We recommend this customization before installing the application to avoid unnecessary alerts and noise.
Default Global Device Management Policies
You can find the Device Management Policy for each Native Type at Setup > Resources > Device Management Policies.
Search using the suggested name in global scope.
{appName nativeType - version}
Example: citrix-hypervisor Citrix Hypervisor Pool - 1 (i.e, appName = citrix-hypervisor , nativeType = Citrix Hypervisor Pool, version = 1)
Default Global Templates
Templates are available at Setup > Monitoring > Templates.
Search using the suggested name in global scope.
{appName nativeType 'Template' - version}
Example: citrix-hypervisor Citrix Hypervisor Pool Template - 1 (i.e, appName = citrix-hypervisor , nativeType = Citrix Hypervisor Pool, version = 1)
Default Global Monitors
Monitors can be found at Setup > Monitoring > Monitors.
Search using the suggested name in global scope.
{monitorKey appName nativeType - version}
Example: Citrix Hypervisor Pool Monitor citrix-hypervisor Citrix Hypervisor Pool 1 (i.e, monitorKey = Citrix Hypervisor Pool Monitor, appName = citrix-hypervisor, nativeType = Citrix Hypervisor Pool, version = 1)