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.UPDATE_INTERVAL_SECONDS
Constructor and Description |
---|
TimerGauge() |
TimerGauge(Clock clock) |
Modifier and Type | Method and Description |
---|---|
long |
getCount() |
Long |
getValue()
Calculates and returns the measured value.
|
boolean |
isMeasuring() |
void |
markEnd() |
void |
markEnd(long absoluteTimeMillis)
Duplicate of
markEnd() with ability passing the time from outside for possible
optimization on calling Clock.absoluteTimeMillis() . |
void |
markStart() |
void |
markStart(long absoluteTimeMillis)
Duplicate of
markStart() with ability passing the time from outside for possible
optimization on calling Clock.absoluteTimeMillis() . |
void |
update()
This method will be called regularly to update the metric.
|
public TimerGauge()
public TimerGauge(Clock clock)
public void markStart()
public void markEnd()
public void markStart(long absoluteTimeMillis)
markStart()
with ability passing the time from outside for possible
optimization on calling Clock.absoluteTimeMillis()
.public void markEnd(long absoluteTimeMillis)
markEnd()
with ability passing the time from outside for possible
optimization on calling Clock.absoluteTimeMillis()
.public void update()
View
public Long getValue()
Gauge
@VisibleForTesting public long getCount()
@VisibleForTesting public boolean isMeasuring()
Copyright © 2014–2023 The Apache Software Foundation. All rights reserved.