Class GuestOSProcessorUsage


  • public final class GuestOSProcessorUsage
    extends Object
    This provides a snapshot of the Guest (Virtual Machine(VM)/Logical Partition(LPAR)) Processor usage statistics as seen by the Hypervisor Host. The statistics are an aggregate across all physical CPUs assigned to the Guest by the Hypervisor Host. The supported Operating System and Hypervisor combinations are:
    1. Linux and Windows on VMWare (IBM Java 8 only).
    2. AIX and Linux on PowerVM.
    3. Linux and z/OS on z/VM.
    4. Linux on PowerKVM.
    Since:
    1.7.1
    • Constructor Detail

    • Method Detail

      • getCpuTime

        public long getCpuTime()
        The total used time of the Guest as reported by the Hypervisor in microseconds.
        • z/OS maintains CPU usage history only for the last 4 hours. The value might not be monotonically increasing.
        Returns:
        used time in microseconds or -1 if info not available.
      • getHostCpuClockSpeed

        public long getHostCpuClockSpeed()
        The the clock speed of the Host Processor in platform-dependent units.
        • z/OS: Millions of Service Units (MSUs).
        • Linux, AIX, and Windows: MegaHertz (MHz).
        Returns:
        Host CPU clock speed or -1 if not available.
      • getTimestamp

        public long getTimestamp()
        The timestamp when the usage statistics were last sampled in microseconds.
        Returns:
        The last sampling timestamp in microseconds.
      • getCpuEntitlement

        public float getCpuEntitlement()
        The total CPU Entitlement assigned to this Guest by the Hypervisor. The value is in Processor units and could be a fraction.
        • VMWare: CpuLimitMHz, CpuReservationMHz, CpuShares and HostProcessorSpeed are used to arrive at the Entitlement.
        • PowerVM: entitled_proc_capacity/100 on AIX and partition_entitled_capacity/100 on Linux represents the Entitlement.
        • z/VM: CPU Entitlement is unavailable.
        Returns:
        CPU Entitlement assigned for this Guest or -1 if not available.