Supported Metrics

The following tabs represent the Metric Category of Citrix Hypervisor

Tabbed Interface with Table
Availability
Capacity
Performance
Usage
Native TypeMetric NameDisplay NameUnitsApplication VersionDescription
Citrix Hypervisor Poolcitrix_hypervisor_pool_LiveHostCountCitrix Hypervisor Pool Live Hostscount1.0.0The number of hosts in the Citrix hypervisor pool that are active and available for running virtual machines.
citrix_hypervisor_pool_DeadHostCountCitrix Hypervisor Pool Dead Hostscount1.0.0The number of hosts in the Citrix hypervisor pool that are inactive or not currently operational.
citrix_hypervisor_pool_PowerOnVMCountCitrix Hypervisor Pool VM PowerOn Countcount1.0.0The number of virtual machines (VMs) within the Citrix hypervisor pool that are powered on and running.
citrix_hypervisor_pool_PowerOffVMCountCitrix Hypervisor Pool VM PowerOff Countcount1.0.0The number of virtual machines (VMs) within the Citrix hypervisor pool that are powered off and not running.
citrix_hypervisor_pool_SuspendedVMCountCitrix Hypervisor Pool VM Suspended Countcount1.0.0The number of virtual machines (VMs) within the Citrix hypervisor pool that are suspended and not active.
Citrix Hypervisor Hostcitrix_hypervisor_host_PoolTaskCountCitrix Hypervisor Host Pool Task Count1.0.0countThe number of pool tasks in the host.
citrix_hypervisor_host_PoolSessionCountCitrix Hypervisor Host Pool Session Count1.0.0countThe number of active pool sessions in the host.
citrix_hypervisor_host_AvailabilityStatusCitrix Hypervisor Host Availability Status1.0.0Provides the Availability Status of the Host.
citrix_hypervisor_host_LicenseExpiryCitrix Hypervisor Host License Expiry1.0.0DaysProvides the number of days remaining until expiration of the license for the host.
Citrix Hypervisor Storage Repositorycitrix_hypervisor_storageRepository_CacheHitsCitrix Hypervisor Storage Repository Cache Hits1.0.0countProvides the Cache Hits of the IntelliCache Storage Repository.
citrix_hypervisor_storageRepository_CacheMissesCitrix Hypervisor Storage Repository Cache Misses1.0.0countProvides the Cache Misses of the IntelliCache Storage Repository.
Citrix Hypervisor Network Interfacecitrix_hypervisor_networkInterface_ReceivedErrorsCitrix Hypervisor Network Interface Received Errors1.0.0Errors per SecThe number of Transmission errors on a physical network interface.
citrix_hypervisor_networkInterface_TransferErrorsCitrix Hypervisor Network Interface Transfer Errors1.0.0Errors per SecThe number of Received errors on a physical network interface.
Citrix Hypervisor Virtual Interfacecitrix_hypervisor_virtualInterface_ReceivedErrorsCitrix Hypervisor Virtual Interface Received Traffic1.0.0Errors per SecThe number of Received errors on a Virtual network interface.
citrix_hypervisor_virtualInterface_TransferErrorsCitrix Hypervisor Virtual Interface Transfer Errors1.0.0Errors per SecThe number of Transmitted errors on a Virtual Network Interface.
Native TypeMetric NameDisplay NameUnitsApplication VersionDescription
Citrix Hypervisor Hostcitrix_hypervisor_host_MemoryTotalCitrix Hypervisor Host Memory TotalGB1.0.0Total amount of memory in the host.
citrix_hypervisor_host_XapiMemoryAllocationCitrix Hypervisor Host Xapi Memory AllocationGB1.0.0The amount of memory allocated to the XAPI (Xen API) on the host.
Citrix Hypervisor Virtual Diskcitrix_hypervisor_virtualDisk_VirtualSizeCitrix Hypervisor Virtual Disk Virtual SizeGB1.0.0Virtual Size of the Citrix Hypervisor Virtual Disk.
Native TypeMetric NameDisplay NameUnitsApplication VersionDescription
Citrix Hypervisor Hostcitrix_hypervisor_host_CPUTimeCstateCitrix Hypervisor Host CPU Time Cstate1.0.0msThe amount of CPU time spent in various C-states (power-saving states).
citrix_hypervisor_host_CPUTimePstateCitrix Hypervisor Host CPU Time PState1.0.0msThe amount of CPU time spent in various P-states (performance states).
citrix_hypervisor_host_NetworkLatencyCitrix Hypervisor Host Network Latency1.0.0sProvides the Interval between the last two heartbeats transmitted from the host to all online hosts.
citrix_hypervisor_host_StateFileLatencyCitrix Hypervisor Host StateFile Latency1.0.0sProvides the Turn-around time in seconds of the latest State-File access from the host.
citrix_hypervisor_host_XapiHealthCheckLatencyCitrix Hypervisor Host Xapi HealthCheck Latency1.0.0sProvides the Turn-around time of the latest XAPI status monitoring call on the host.
citrix_hypervisor_networkInterface_AggregateReceivedTrafficCitrix Hypervisor Network Interface Aggregate Received Traffic1.0.0BpsThe aggregated received network traffic across all physical network interfaces.
citrix_hypervisor_networkInterface_AggregateTransferTrafficCitrix Hypervisor Network Interface Aggregate Received Traffic1.0.0BpsThe aggregated transmitted network traffic across all physical network interfaces.
citrix_hypervisor_networkInterface_LoopbackTransferTrafficCitrix Hypervisor Network Interface Loopback Transfer Traffic1.0.0BpsThe transmitted network traffic on the loopback interface.
citrix_hypervisor_networkInterface_LoopbackTransferErrrorsCitrix Hypervisor Network Interface LoopBack Transfer Errors1.0.0Errors per SecThe number of Transmission errors on the loopback interface.
citrix_hypervisor_networkInterface_LoopbackReceivedErrorsCitrix Hypervisor Network Interface Loopback Received Errors1.0.0Errors per SecThe number of Received errors on the loopback interface.
citrix_hypervisor_networkInterface_LoopbackReceivedTrafficCitrix Hypervisor Network Interface Loopback Received Traffic1.0.0BpsThe Received network traffic on the loopback interface.
Citrix Hypervisor Storage Repositorycitrix_hypervisor_storageRepository_AverageIOQueueSizeCitrix Hypervisor Storage Repository Average IO Queue Size1.0.0countThe Average size of the Storage Repository I/O queue.
citrix_hypervisor_storageRepository_CurrentIORequestsCitrix Hypervisor Storage Repository Current IO Requests1.0.0countThe current number of I/O requests being processed or waiting to be processed by the storage repository.
citrix_hypervisor_storageRepository_IOThroughputReadCitrix Hypervisor Storage Repository IO Throughput Read1.0.0MiB/sThe amount of data read from the storage repository.
citrix_hypervisor_storageRepository_IOThroughputWriteCitrix Hypervisor Storage Repository IO Throughput Write1.0.0MiB/sThe amount of data written from the Storage Repository.
citrix_hypervisor_storageRepository_IOThroughputTotalCitrix Hypervisor Storage Repository IO Throughput Total1.0.0MiB/sThe total amount of data read from and written to the storage repository.
citrix_hypervisor_storageRepository_ReadIOPSCitrix Hypervisor Storage Repository Read IOPS1.0.0IOPSThe number of read I/O operations per second performed by the storage repository.
citrix_hypervisor_storageRepository_WriteIOPSCitrix Hypervisor Storage Repository Write IOPS1.0.0IOPSThe number of write I/O operations per second performed by the storage repository.
citrix_hypervisor_storageRepository_TotalIOPSCitrix Hypervisor Storage Repository Total IOPS1.0.0IOPSThe total number of I/O operations per second (both read and write) performed by the storage repository.
citrix_hypervisor_storageRepository_LatencyCitrix Hypervisor Storage Repository Latency1.0.0msThe total number of I/O operations per second (both read and write) performed by the storage repository.
citrix_hypervisor_storageRepository_IOWaitCitrix Hypervisor Storage Repository IO Wait1.0.0%The percentage of time waiting for I/O operations to complete on the storage repository.
Citrix Hypervisor Network Interfacecitrix_hypervisor_networkInterface_ReceivedTrafficCitrix Hypervisor Network Interface Received Traffic1.0.0BpsThe amount of data received by the physical network interface.
citrix_hypervisor_networkInterface_TransferTrafficCitrix Hypervisor Network Interface Transfer Traffic1.0.0BpsThe amount of data sent out by the physical Network Interface.
Citrix Hypervisor Virtual Block Devicecitrix_hypervisor_virtualMachine_RunState_FullContentionCitrix Hypervisor VirtualMachine RunState Full Contention1.0.0%Percentage of time that all vCPUs are runnable (that is, waiting for CPU).
citrix_hypervisor_virtualMachine_RunState_FullRunCitrix Hypervisor VirtualMachine RunState Full Run1.0.0%Percentage of time that all vCPUs are running.
citrix_hypervisor_virtualMachine_RunState_ConcurrencyHazardCitrix Hypervisor RunState Concurrency Hazard1.0.0%Percentage of time that some vCPUs are running and some are runnable.
citrix_hypervisor_virtualMachine_RunState_BlockedCitrix Hypervisor VirtualMachine RunState Blocked1.0.0%Percentage of time that all vCPUs are blocked or offline.
citrix_hypervisor_virtualMachine_RunState_PartialRunCitrix Hypervisor VirtualMachine RunState Partial Run1.0.0%Percentage of time that some vCPUs are running, and some are blocked.
citrix_hypervisor_virtualMachine_RunState_PartialContentionCitrix Hypervisor VirtualMachine RunState Partial Contention1.0.0%Percentage of time that some vCPUs are runnable and some are blocked.
Citrix Hypervisor Virtual Interfacecitrix_hypervisor_virtualInterface_ReceivedTrafficCitrix Hypervisor Virtual Interface Received Traffic1.0.0BpsThe amount of incoming network traffic received by a virtual network interface.
citrix_hypervisor_virtualInterface_TransferTrafficCitrix Hypervisor Virtual Interface Transfer Traffic1.0.0BpsThe amount of outgoing network traffic sent by a virtual interface.
Native TypeMetric NameDisplay NameUnitsApplication VersionDescription
Citrix Hypervisor Hostcitrix_hypervisor_host_CPUUsageCitrix Hypervisor Host CPU Usage%1.0.0The percentage of CPU resources currently being used by the host.
citrix_hypervisor_host_AverageCPUUsageCitrix Hypervisor Host Average CPU Usage%1.0.0Provides the average CPU usage of the host.
citrix_hypervisor_host_LoadAverageCitrix Hypervisor Host Load Average%1.0.0Provides the Domain0 load average.
citrix_hypervisor_host_MemoryFreeSpaceCitrix Hypervisor Host Memory Free SpaceGB1.0.0The amount of free memory available on the host.
citrix_hypervisor_host_MemoryReclaimedCitrix Hypervisor Host Memory ReclaimedGB1.0.0Provides the Host memory reclaimed by squeeze.
citrix_hypervisor_host_MemoryMaxReclaimedCitrix Hypervisor Host Memory Max ReclaimedGB1.0.0Provides the Host memory available to reclaim with squeeze.
citrix_hypervisor_host_XapiFreeMemoryCitrix Hypervisor Host Xapi Free MemoryGB1.0.0The amount of free memory available to XAPI.
citrix_hypervisor_host_XapiLiveMemoryCitrix Hypervisor Host Xapi Live MemoryGB1.0.0Provides the Live memory used by XAPI.
citrix_hypervisor_host_XapiMemoryUsageCitrix Hypervisor Host Xapi Memory UsageGB1.0.0Provides the Total memory allocated used by XAPI.
citrix_hypervisor_host_XapiOpenFdsCitrix Hypervisor Host Xapi Open Fdscount1.0.0The number of file descriptors open by XAPI.
citrix_hypervisor_host_TapDisksLowMemoryModeCitrix Hypervisor Host TapDisks Low Memory Modecount1.0.0Provides the tap disks count in low memory mode.
citrix_hypervisor_host_MemoryUtilisationCitrix Hypervisor Host Memory Utilisation%1.0.0Provides the Memory Utilisation of the Host.
citrix_hypervisor_host_FreeMemoryUtilisationCitrix Hypervisor Host Free Memory Utilisation%1.0.0Provides the Free memory Utilisation of the Host.
citrix_hypervisor_host_XapiMemoryUtilisationCitrix Hypervisor Host Xapi Memory Utilisation%1.0.0Provides the XAPI Memory Utilisation of the host.
Citrix Hypervisor Storage Repositorycitrix_hypervisor_storageRepository_CapacityUtilisationCitrix Hypervisor Storage Repository Capacity Utilisation%1.0.0The percentage of total storage capacity currently in use by the storage repository.
citrix_hypervisor_storageRepository_FreeSpaceUtilisationCitrix Hypervisor Storage Repository Free Space Utilisation%1.0.0The percentage of the total capacity of the storage repository that is currently free and available for use.
citrix_hypervisor_storageRepository_FreeSpaceCitrix Hypervisor Storage Repository Free Space%1.0.0Provides the Free space of the Citrix Hypervisor Storage Repository.
citrix_hypervisor_storageRepository_UsedCapacityCitrix Hypervisor Storage Repository Used Capacity%1.0.0Provides the Used Capacity of the Citrix Hypervisor Storage Repository.
citrix_hypervisor_storageRepository_CacheSizeCitrix Hypervisor Storage Repository Cache Size%1.0.0Provides the Cache Size of the IntelliCache Storage Repository.
Citrix Hypervisor Virtual Machinecitrix_hypervisor_virtualMachine_AllocatedMemoryCitrix Hypervisor VirtualMachine Allocated Memory%1.0.0Amount of memory allocated for the VM.
citrix_hypervisor_virtualMachine_MemoryTargetCitrix Hypervisor VirtualMachine Memory Target%1.0.0Memory Target of VM balloon driver.
citrix_hypervisor_virtualmachine_FreeInternalMemoryCitrix Hypervisor VirtualMachine Free Internal Memory%1.0.0Memory used as reported by the guest agent.
Citrix Hypervisor Virtual Diskcitrix_hypervisor_virtualDisk_PhysicalUtilisationCitrix Hypervisor Virtual Disk Physical Utilisation%1.0.0Physical Utilisation of the Citrix Hypervisor Virtual Disk.

Default Monitoring Configurations

Citrix Hypervisor SDK 2.0 App has default Global Device Management Policies, Global Templates, Global Monitors and Global metrics in OpsRamp. User can customize these default monitoring configurations as per their business usecases by cloning respective global templates and global Device Management Policies. OpsRamp recommend to do this activity before installing the app to avoid noise alerts and data.

  1. Default Global Device Management Policies available OpsRamp will have a Global Device Management Policy for each Native Type of Citrix Hypervisor . We can find those Device Management Policies at Setup -> Resources -> Device Management Policies -> Search with suggested names in global scope. Each Device Management Policy follows below naming convention : {appName nativeType - version}

Ex : citrix-hypervisor Citrix Hypervisor Pool - 1 (i.e, appName = citrix-hypervisor , nativeType = Citrix Hypervisor Pool, version = 1)

  1. Default Global Templates available OpsRamp will have a Global template for each Native Type of Citrix Hypervisor. We can find those templates at Setup -> Monitoring -> Templates -> Search with suggested names in global scope. Each template follows below naming convention : {appName nativeType 'Template' - version}

Ex : citrix-hypervisor Citrix Hypervisor Pool Template - 1 (i.e, appName = citrix-hypervisor , nativeType = Citrix Hypervisor Pool, version = 1)

  1. Default Global Monitors available OpsRamp will have a Global Monitors for each Native Type which has monitoring support. We can find those monitors at Setup -> Monitoring -> Monitors -> Search with suggested names in global scope. Each Monitors follows below naming convention : {monitorKey appName nativeType - version}

Ex : 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)