software.amazon.kinesis.worker.metric.impl.linux

Class LinuxNetworkWorkerMetricBase

java.lang.Object

software.amazon.kinesis.worker.metric.impl.linux.LinuxNetworkWorkerMetricBase

All Implemented Interfaces:

WorkerMetric

Direct Known Subclasses:

LinuxNetworkInWorkerMetric, LinuxNetworkOutWorkerMetric

public abstract class LinuxNetworkWorkerMetricBase
extends Object
implements WorkerMetric

Base class for EC2NetworkWorkerMetrics, this reads and parses /proc/net/dev file and look for the specific interface and reads received and transmitted bytes. To get the percentage of bandwidth consumed, the fetch bytes are converted to per second (based on the interval between invocation) and percentage is calculated by dividing it by the maximum bandwidth in MBps. 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 stat 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

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_INTERFACE_NAME
protected static String	DEFAULT_NETWORK_STAT_FILE

Constructor Summary

Constructors

Constructor and Description
LinuxNetworkWorkerMetricBase(OperatingRange operatingRange, String interfaceName, String statFile, double maxBandwidthInMBps, com.google.common.base.Stopwatch stopwatch)

Method Summary

Modifier and Type	Method and Description
WorkerMetric.WorkerMetricValue	capture() Reads the stat file and find the total bytes (in and out) and divide it by the time elapsed since last read to get the bytes per second.
OperatingRange	getOperatingRange() Gets the operating range for this workerMetrics
String	getShortName() WorkerMetricStats short name that is used as attribute name for it in storage.
protected abstract WorkerMetricType	getWorkerMetricsType()
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

Field Detail

DEFAULT_NETWORK_STAT_FILE

protected static final String DEFAULT_NETWORK_STAT_FILE

See Also:

Constant Field Values

DEFAULT_INTERFACE_NAME

protected static final String DEFAULT_INTERFACE_NAME

See Also:

Constant Field Values

Constructor Detail

LinuxNetworkWorkerMetricBase

public LinuxNetworkWorkerMetricBase(OperatingRange operatingRange,
                                    String interfaceName,
                                    String statFile,
                                    double maxBandwidthInMBps,
                                    com.google.common.base.Stopwatch stopwatch)

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

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

capture

public WorkerMetric.WorkerMetricValue capture()

Reads the stat file and find the total bytes (in and out) and divide it by the time elapsed since last read to get the bytes per second. Converts the bytes per second to MBps and then normalizes it to a percentage of the maximum bandwidth.

Specified by:

capture in interface WorkerMetric

Returns:

WorkerMetricValue with the % of network bandwidth consumed.

getWorkerMetricsType

protected abstract WorkerMetricType getWorkerMetricsType()