Metrics

All Known Subinterfaces:

CgroupSubsystem, CgroupV1Metrics

All Known Implementing Classes:

CgroupMetrics, CgroupV1MetricsImpl, CgroupV1Subsystem, CgroupV2Subsystem
```
public interface Metrics
```
Operating System Metrics class Implementation note: Some of the APIs within this class return metrics for an "Isolation Group" or "Container". When the term "Isolation Group" is used in the API description, this refers to either:
1. All processes, including the current process within a container.
2. All processes, including the current process running together isolated from other non-isolated processes.
3. All processes running on a host when that there is no isolation in effect.
Since:

11

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`long`	`getBlkIOServiceCount()` Returns the number of block I/O requests to the disk that have been issued by the Isolation Group.
`long`	`getBlkIOServiced()` Returns the number of block I/O bytes that have been transferred to/from the disk by the Isolation Group.
`long`	`getCpuNumPeriods()` Returns the number of time-slice periods that have elapsed if a CPU quota has been setup for the Isolation Group
`long`	`getCpuNumThrottled()` Returns the number of time-slice periods that the group has been throttled or limited due to the group exceeding its quota if a CPU quota has been setup for the Isolation Group.
`long`	`getCpuPeriod()` Returns the length of the scheduling period, in microseconds, for processes within the Isolation Group.
`long`	`getCpuQuota()` Returns the total available run-time allowed, in microseconds, during each scheduling period for all tasks in the Isolation Group.
`int[]`	`getCpuSetCpus()` Returns the CPUS that are available for execution of processes in the current Isolation Group.
`int[]`	`getCpuSetMems()` Returns the memory nodes that are available for use by processes in the current Isolation Group.
`long`	`getCpuShares()` Returns the relative weighting of processes with the Isolation Group used for prioritizing the scheduling of processes across all Isolation Groups running on a host.
`long`	`getCpuSystemUsage()` Returns the aggregate system time, in nanoseconds, consumed by all tasks in the Isolation Group.
`long`	`getCpuThrottledTime()` Returns the total time duration, in nanoseconds, that the group has been throttled or limited due to the group exceeding its quota if a CPU quota has been setup for the Isolation Group.
`long`	`getCpuUsage()` Returns the aggregate time, in nanoseconds, consumed by all tasks in the Isolation Group.
`long`	`getCpuUserUsage()` Returns the aggregate user time, in nanoseconds, consumed by all tasks in the Isolation Group.
`long`	`getEffectiveCpuCount()` Returns the number of effective processors that this Isolation group has available to it.
`int[]`	`getEffectiveCpuSetCpus()` Returns the CPUS that are available and online for execution of processes within the current Isolation Group.
`int[]`	`getEffectiveCpuSetMems()` Returns the memory nodes that are available and online for use by processes within the current Isolation Group.
`long`	`getMemoryAndSwapLimit()` Returns the maximum amount of physical memory and swap space, in bytes, that can be allocated in the Isolation Group.
`long`	`getMemoryAndSwapUsage()` Returns the amount of physical memory and swap space, in bytes, that is currently allocated in the current Isolation Group.
`long`	`getMemoryFailCount()` Returns the number of times that user memory requests in the Isolation Group have exceeded the memory limit.
`long`	`getMemoryLimit()` Returns the maximum amount of physical memory, in bytes, that can be allocated in the Isolation Group.
`long`	`getMemorySoftLimit()` Returns the hint to the operating system that allows groups to specify the minimum amount of physical memory that they need to achieve reasonable performance in low memory systems.
`long`	`getMemoryUsage()` Returns the amount of physical memory, in bytes, that is currently allocated in the current Isolation Group.
`long[]`	`getPerCpuUsage()` Returns the aggregate time, in nanoseconds, consumed by all tasks in the Isolation Group, separated by CPU.
`String`	`getProvider()` Returns the interface responsible for providing the platform metrics.
`long`	`getTcpMemoryUsage()` Returns the amount of networking physical memory, in bytes, that is currently allocated in the current Isolation Group.
`static Metrics`	`systemMetrics()` Returns an instance of the Metrics class.

- Method Detail
  - systemMetrics
```
static Metrics systemMetrics()
```
    Returns an instance of the Metrics class.
    
    Returns:
    
    Metrics object or null if not supported on this platform.
  - getProvider
```
String getProvider()
```
    Returns the interface responsible for providing the platform metrics. Implementation note: Metrics are currently only supported Linux. The provider for Linux is cgroups (version 1 or 2).
    
    Returns:
    
    The name of the provider.
  - getCpuUsage
```
long getCpuUsage()
```
    Returns the aggregate time, in nanoseconds, consumed by all tasks in the Isolation Group.
    
    Returns:
    
    Time in nanoseconds, -1 if unknown or -2 if the metric is not supported.
  - getPerCpuUsage
```
long[] getPerCpuUsage()
```
    Returns the aggregate time, in nanoseconds, consumed by all tasks in the Isolation Group, separated by CPU. If the current process is running within a container, the reported time will only be valid for processes running within the same container. The values are returned in an array, one entry for each physical processor on the system. Time values for processors unavailable to this Group are undefined.
    
    Returns:
    
    long array of time values. The size of the array is equal to the total number of physical processors in the system. If this metric is not supported or not available, null will be returned.
  - getCpuUserUsage
```
long getCpuUserUsage()
```
    Returns the aggregate user time, in nanoseconds, consumed by all tasks in the Isolation Group.
    
    Returns:
    
    User time in nanoseconds, -1 if the metric is not available or -2 if the metric is not supported.
  - getCpuSystemUsage
```
long getCpuSystemUsage()
```
    Returns the aggregate system time, in nanoseconds, consumed by all tasks in the Isolation Group.
    
    Returns:
    
    System time in nanoseconds, -1 if the metric is not available or -2 if the metric is not supported.
  - getCpuPeriod
```
long getCpuPeriod()
```
    Returns the length of the scheduling period, in microseconds, for processes within the Isolation Group.
    
    Returns:
    
    time in microseconds, -1 if the metric is not available or -2 if the metric is not supported.
  - getCpuQuota
```
long getCpuQuota()
```
    Returns the total available run-time allowed, in microseconds, during each scheduling period for all tasks in the Isolation Group.
    
    Returns:
    
    time in microseconds, -1 if the quota is unlimited or -2 if not supported.
  - getCpuShares
```
long getCpuShares()
```
    Returns the relative weighting of processes with the Isolation Group used for prioritizing the scheduling of processes across all Isolation Groups running on a host. Implementation note: Popular container orchestration systems have standardized shares to be multiples of 1024, where 1024 is interpreted as 1 CPU share of execution. Users can distribute CPU resources to multiple Isolation Groups by specifying the CPU share weighting needed by each process. To request 2 CPUS worth of execution time, CPU shares would be set to 2048.
    
    Returns:
    
    shares value, -1 if the metric is not available or -2 if cpu shares are not supported.
  - getCpuNumPeriods
```
long getCpuNumPeriods()
```
    Returns the number of time-slice periods that have elapsed if a CPU quota has been setup for the Isolation Group
    
    Returns:
    
    count of elapsed periods, -1 if the metric is not available or -2 if the metric is not supported.
  - getCpuNumThrottled
```
long getCpuNumThrottled()
```
    Returns the number of time-slice periods that the group has been throttled or limited due to the group exceeding its quota if a CPU quota has been setup for the Isolation Group.
    
    Returns:
    
    count of throttled periods, -1 if the metric is not available or -2 if it is not supported.
  - getCpuThrottledTime
```
long getCpuThrottledTime()
```
    Returns the total time duration, in nanoseconds, that the group has been throttled or limited due to the group exceeding its quota if a CPU quota has been setup for the Isolation Group.
    
    Returns:
    
    Throttled time in nanoseconds, -1 if the metric is not available or -2 if it is not supported.
  - getEffectiveCpuCount
```
long getEffectiveCpuCount()
```
    Returns the number of effective processors that this Isolation group has available to it. This effective processor count is computed based on the number of dedicated CPUs, CPU shares and CPU quotas in effect for this isolation group. This method returns the same value as Runtime.availableProcessors().
    
    Returns:
    
    The number of effective CPUs.
  - getCpuSetCpus
```
int[] getCpuSetCpus()
```
    Returns the CPUS that are available for execution of processes in the current Isolation Group. The size of the array is equal to the total number of CPUs and the elements in the array are the physical CPU numbers that are available. Some of the CPUs returned may be offline. To get the current online CPUs, use Metrics.getEffectiveCpuSetCpus() }.
    
    Returns:
    
    An array of available CPUs. Returns null if the metric is not available or the metric is not supported.
  - getEffectiveCpuSetCpus
```
int[] getEffectiveCpuSetCpus()
```
    Returns the CPUS that are available and online for execution of processes within the current Isolation Group. The size of the array is equal to the total number of CPUs and the elements in the array are the physical CPU numbers.
    
    Returns:
    
    An array of available and online CPUs. Returns null if the metric is not available or the metric is not supported.
  - getCpuSetMems
```
int[] getCpuSetMems()
```
    Returns the memory nodes that are available for use by processes in the current Isolation Group. The size of the array is equal to the total number of nodes and the elements in the array are the physical node numbers that are available. Some of the nodes returned may be offline. To get the current online memory nodes, use Metrics.getEffectiveCpuSetMems().
    
    Returns:
    
    An array of available memory nodes or null if the metric is not available or is not supported.
  - getEffectiveCpuSetMems
```
int[] getEffectiveCpuSetMems()
```
    Returns the memory nodes that are available and online for use by processes within the current Isolation Group. The size of the array is equal to the total number of nodes and the elements in the array are the physical node numbers.
    
    Returns:
    
    An array of available and online nodes or null if the metric is not available or is not supported.
  - getMemoryFailCount
```
long getMemoryFailCount()
```
    Returns the number of times that user memory requests in the Isolation Group have exceeded the memory limit.
    
    Returns:
    
    The number of exceeded requests or -1 if the metric is not available. Returns -2 if the metric is not supported.
  - getMemoryLimit
```
long getMemoryLimit()
```
    Returns the maximum amount of physical memory, in bytes, that can be allocated in the Isolation Group.
    
    Returns:
    
    The maximum amount of memory in bytes or -1 if there is no limit or -2 if this metric is not supported.
  - getMemoryUsage
```
long getMemoryUsage()
```
    Returns the amount of physical memory, in bytes, that is currently allocated in the current Isolation Group.
    
    Returns:
    
    The amount of memory in bytes allocated or -1 if the metric is not available or -2 if the metric is not supported.
  - getTcpMemoryUsage
```
long getTcpMemoryUsage()
```
    Returns the amount of networking physical memory, in bytes, that is currently allocated in the current Isolation Group.
    
    Returns:
    
    The amount of memory in bytes allocated or -1 if the metric is not available. Returns -2 if this metric is not supported.
  - getMemoryAndSwapLimit
```
long getMemoryAndSwapLimit()
```
    Returns the maximum amount of physical memory and swap space, in bytes, that can be allocated in the Isolation Group.
    
    Returns:
    
    The maximum amount of memory in bytes or -1 if there is no limit set or -2 if this metric is not supported.
  - getMemoryAndSwapUsage
```
long getMemoryAndSwapUsage()
```
    Returns the amount of physical memory and swap space, in bytes, that is currently allocated in the current Isolation Group.
    
    Returns:
    
    The amount of memory in bytes allocated or -1 if the metric is not available. Returns -2 if this metric is not supported.
  - getMemorySoftLimit
```
long getMemorySoftLimit()
```
    Returns the hint to the operating system that allows groups to specify the minimum amount of physical memory that they need to achieve reasonable performance in low memory systems. This allows host systems to provide greater sharing of memory.
    
    Returns:
    
    The minimum amount of physical memory, in bytes, that the operating system will try to maintain under low memory conditions. If this metric is not available, -1 will be returned. Returns -2 if the metric is not supported.
  - getBlkIOServiceCount
```
long getBlkIOServiceCount()
```
    Returns the number of block I/O requests to the disk that have been issued by the Isolation Group.
    
    Returns:
    
    The count of requests or -1 if the metric is not available. Returns -2 if this metric is not supported.
  - getBlkIOServiced
```
long getBlkIOServiced()
```
    Returns the number of block I/O bytes that have been transferred to/from the disk by the Isolation Group.
    
    Returns:
    
    The number of bytes transferred or -1 if the metric is not available. Returns -2 if this metric is not supported.

Interface Metrics

Method Summary

Method Detail

systemMetrics

getProvider

getCpuUsage

getPerCpuUsage

getCpuUserUsage

getCpuSystemUsage

getCpuPeriod

getCpuQuota

getCpuShares

getCpuNumPeriods

getCpuNumThrottled

getCpuThrottledTime

getEffectiveCpuCount

getCpuSetCpus

getEffectiveCpuSetCpus

getCpuSetMems

getEffectiveCpuSetMems

getMemoryFailCount

getMemoryLimit

getMemoryUsage

getTcpMemoryUsage

getMemoryAndSwapLimit

getMemoryAndSwapUsage

getMemorySoftLimit

getBlkIOServiceCount

getBlkIOServiced