software.amazon.kinesis.worker.metric

Interface WorkerMetric

All Known Implementing Classes:

Cgroupv1CpuWorkerMetric, Cgroupv2CpuWorkerMetric, EcsCpuWorkerMetric, HeapMemoryAfterGCWorkerMetric, LinuxCpuWorkerMetric, LinuxNetworkInWorkerMetric, LinuxNetworkOutWorkerMetric, LinuxNetworkWorkerMetricBase

public interface WorkerMetric

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WorkerMetric.WorkerMetricValue WorkerMetricValue model class is used as return type for the capture() method to have a strong checks at the build time of the object itself.

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.

Method Detail

getShortName

String getShortName()

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

Returns:

short name for the WorkerMetricStats

capture

WorkerMetric.WorkerMetricValue capture()

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 (%).

Returns:

WorkerMetricValue between 0 and 100 (both inclusive)

getOperatingRange

OperatingRange getOperatingRange()

Gets the operating range for this workerMetrics

Returns:

Operating range for this workerMetrics

getWorkerMetricType

WorkerMetricType getWorkerMetricType()

Type of the current WorkerMetricStats.

Returns:

WorkerMetricType