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

Class EcsCpuWorkerMetric

java.lang.Object

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

All Implemented Interfaces:

WorkerMetric

public class EcsCpuWorkerMetric
extends Object
implements WorkerMetric

Queries the Amazon ECS task metadata endpoint version 4 to get CPU metric stats as well as allocated CPU to the ECS task and containers to calculate percent CPU utilization. This works for all ECS containers running on the following platforms: Fargate agent version 1.4.0 EC2 instance running at least 1.39.0 of the Amazon ECS container agent For more information, see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-metadata-endpoint-v4.html

Nested Class Summary

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

WorkerMetric.WorkerMetricValue

Constructor Summary

Constructors

Constructor and Description
EcsCpuWorkerMetric(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

EcsCpuWorkerMetric

public EcsCpuWorkerMetric(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