org.apache.flink.runtime.metrics

Class TimerGauge

java.lang.Object

org.apache.flink.runtime.metrics.TimerGauge

All Implemented Interfaces:

Gauge<Long>, Metric, View

public class TimerGauge
extends Object
implements Gauge<Long>, View

TimerGauge measures how much time is spent in a given state, with entry into that state being signaled by markStart(). Measuring is stopped by markEnd(). This class in particularly takes care of the case, when update() is called when some measurement started but has not yet finished. For example even if next markEnd() call is expected to happen in a couple of hours, the returned value will account for this ongoing measurement.

Field Summary

Fields inherited from interface org.apache.flink.metrics.View

UPDATE_INTERVAL_SECONDS

Constructor Summary

Constructors

Constructor and Description
TimerGauge()
TimerGauge(Clock clock)
TimerGauge(Clock clock, int timeSpanInSeconds)
TimerGauge(int timeSpanInSeconds)

Method Summary

Modifier and Type	Method and Description
long	getAccumulatedCount()
long	getCount()
long	getMaxSingleMeasurement()
Long	getValue() Calculates and returns the measured value.
boolean	isMeasuring()
void	markEnd()
void	markStart()
void	update() This method will be called regularly to update the metric.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.metrics.Gauge

getMetricType

Constructor Detail

TimerGauge

public TimerGauge()

TimerGauge

public TimerGauge(int timeSpanInSeconds)

TimerGauge

public TimerGauge(Clock clock)

TimerGauge

public TimerGauge(Clock clock,
                  int timeSpanInSeconds)

Method Detail

markStart

public void markStart()

markEnd

public void markEnd()

update

public void update()

Description copied from interface: View

This method will be called regularly to update the metric.

Specified by:

update in interface View

getValue

public Long getValue()

Description copied from interface: Gauge

Calculates and returns the measured value.

Specified by:

getValue in interface Gauge<Long>

Returns:

calculated value

getMaxSingleMeasurement

public long getMaxSingleMeasurement()

Returns:

the longest marked period as measured by the given * TimerGauge. For example the longest consecutive back pressured period.

getAccumulatedCount

public long getAccumulatedCount()

Returns:

the accumulated period by the given * TimerGauge.

getCount

@VisibleForTesting
public long getCount()

isMeasuring

@VisibleForTesting
public boolean isMeasuring()