software.amazon.kinesis.worker.metric.impl.container

Class Cgroupv1CpuWorkerMetric

java.lang.Object

software.amazon.kinesis.worker.metric.impl.container.Cgroupv1CpuWorkerMetric

All Implemented Interfaces:

WorkerMetric

public class Cgroupv1CpuWorkerMetric
extends Object
implements WorkerMetric

Utilizes Linux Control Groups by reading cpu time and available cpu from cgroup directory.This works for Elastic Kubernetes Service (EKS) containers running on Linux instances which use cgroupv1. EC2 instances must use a Linux instance that uses cgroupv1. Amazon Linux 2 uses cgroupv1. Fargate versions 1.4.0 and 1.3.0 use Amazon Linux 2 and can use this. CPU time is measured in CPU cores time. A container is limited by amount of CPU core time it is allocated. So if over a second the container uses 0.5 CPU core time and is allocated 2 CPU cores, the cpu utilization would be 25%. When this is invoked for the first time, the value returned is always 0 as the prev values are not available to calculate the diff. In case the file is not present or any other exception occurs, this throws IllegalArgumentException.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.kinesis.worker.metric.WorkerMetric

WorkerMetric.WorkerMetricValue

Constructor Summary

Constructors

Constructor and Description
Cgroupv1CpuWorkerMetric(OperatingRange operatingRange)

Method Summary

Modifier and Type	Method and Description
WorkerMetric.WorkerMetricValue	capture() Current WorkerMetricValue.
OperatingRange	getOperatingRange() Gets the operating range for this workerMetrics
String	getShortName() WorkerMetricStats short name that is used as attribute name for it in storage.
WorkerMetricType	getWorkerMetricType() Type of the current WorkerMetricStats.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Cgroupv1CpuWorkerMetric

public Cgroupv1CpuWorkerMetric(OperatingRange operatingRange)

Method Detail

getShortName

public String getShortName()

Description copied from interface: WorkerMetric

WorkerMetricStats short name that is used as attribute name for it in storage.

Specified by:

getShortName in interface WorkerMetric

Returns:

short name for the WorkerMetricStats

capture

public WorkerMetric.WorkerMetricValue capture()

Description copied from interface: WorkerMetric

Current WorkerMetricValue. WorkerMetricValue is a normalized percentage value to its max configured limits. E.g., if for a worker max network bandwidth is 10Gbps and current used bandwidth is 2Gbps, then WorkerMetricValue for NetworkWorkerMetrics will be 20 (%).

Specified by:

capture in interface WorkerMetric

Returns:

WorkerMetricValue between 0 and 100 (both inclusive)

getOperatingRange

public OperatingRange getOperatingRange()

Description copied from interface: WorkerMetric

Gets the operating range for this workerMetrics

Specified by:

getOperatingRange in interface WorkerMetric

Returns:

Operating range for this workerMetrics

getWorkerMetricType

public WorkerMetricType getWorkerMetricType()

Description copied from interface: WorkerMetric

Type of the current WorkerMetricStats.

Specified by:

getWorkerMetricType in interface WorkerMetric

Returns:

WorkerMetricType