public class TimeStampedGauge extends Object implements com.codahale.metrics.Gauge<Long>, TimeStampedMetric
Gauge interface that provides an
association of the Gauge value with time stamps.| Modifier and Type | Field and Description |
|---|---|
static long |
UNINITIALIZED |
| Constructor and Description |
|---|
TimeStampedGauge(MetricRegistry registry,
GaugeDescriptor descriptor)
Constructs a
TimeStampedGauge with the specified characteristics
using the specified MetricRegistry. |
TimeStampedGauge(MetricRegistry registry,
GaugeDescriptor descriptor,
String uid)
Constructs a
TimeStampedGauge with the specified UID and other
characteristics using the specified MetricRegistry. |
| Modifier and Type | Method and Description |
|---|---|
GaugeDataPoint |
extractDataPoint()
Extract a
GaugeDataPoint from this object. |
GaugeDescriptor |
getDescriptor()
Gets the
MetricDescriptor that describes this TimeStampedMetric object. |
long |
getMsSpanned()
Determines the number of milliseconds spanned between the latest (update)
time stamp and the oldest (previous) time stamp, accounting for roll-over
of the time stamp.
|
long |
getPreviousTimeStamp()
Gets the previous time stamp.
|
protected TimeStampManager |
getTimeStampManager()
Gets the
TimeStampManager that this object uses to manage its
associated time stamps. |
String |
getUid()
Gets the UID.
|
long |
getUpdateTimeStamp()
Gets the update time stamp.
|
Long |
getValue() |
void |
reset()
Prepares the gauge for use in a new time period by saving the most recent
update time stamp as the previous time stamp.
|
void |
setDescriptor(GaugeDescriptor toSet)
Sets the
GaugeDescriptor that specifies characteristics of this
TimeStampedGauge. |
void |
setPreviousTimeStamp(long time)
Sets the previous time stamp.
|
void |
setUid(String toSet)
Sets the UID of this object.
|
void |
setUpdateTimeStamp(long time)
Sets the update time stamp.
|
void |
setValue(long toSet)
Sets the value of this
TimeStampedGauge. |
String |
toDebugString()
Gets a detailed representation of this object to facilitate debugging.
|
String |
toString() |
void |
updateTimeStamp()
Convenience method that sets the update time stamp to the current time.
|
public static final long UNINITIALIZED
public TimeStampedGauge(MetricRegistry registry, GaugeDescriptor descriptor)
TimeStampedGauge with the specified characteristics
using the specified MetricRegistry.registry - MetricRegistry to use for allocating this objectdescriptor - GaugeDescriptor that specifies various
characteristics of the resulting TimeStampedGaugepublic TimeStampedGauge(MetricRegistry registry, GaugeDescriptor descriptor, String uid)
TimeStampedGauge with the specified UID and other
characteristics using the specified MetricRegistry.registry - MetricRegistry to use for allocating this objectdescriptor - GaugeDescriptor that specifies various
characteristics of the resulting TimeStampedGaugeuid - UID to assign to the resulting TimeStampedGaugeIllegalArgumentException - if a null value is supplied for either
the GaugeDescriptor or MetricRegistry argumentpublic GaugeDataPoint extractDataPoint()
GaugeDataPoint from this object.extractDataPoint in interface TimeStampedMetricGaugeDataPointpublic GaugeDescriptor getDescriptor()
TimeStampedMetricMetricDescriptor that describes this TimeStampedMetric object.getDescriptor in interface TimeStampedMetricMetricDescriptor that describes this TimeStampedMetricpublic long getMsSpanned()
TimeStampedMetricgetMsSpanned in interface TimeStampedMetricpublic long getPreviousTimeStamp()
TimeStampedMetricgetPreviousTimeStamp in interface TimeStampedMetricprotected TimeStampManager getTimeStampManager()
TimeStampManager that this object uses to manage its
associated time stamps.TimeStampManager for this objectpublic String getUid()
TimeStampedMetricgetUid in interface TimeStampedMetricpublic long getUpdateTimeStamp()
TimeStampedMetricgetUpdateTimeStamp in interface TimeStampedMetricpublic Long getValue()
getValue in interface com.codahale.metrics.Gauge<Long>public void reset()
reset in interface TimeStampedMetricpublic void setDescriptor(GaugeDescriptor toSet)
GaugeDescriptor that specifies characteristics of this
TimeStampedGauge.toSet - the GaugeDescriptor for this objectpublic void setPreviousTimeStamp(long time)
TimeStampedMetricsetPreviousTimeStamp in interface TimeStampedMetrictime - previous time stamppublic void setUid(String toSet)
TimeStampedMetricsetUid in interface TimeStampedMetrictoSet - new UID for this objectpublic void setUpdateTimeStamp(long time)
TimeStampedMetricsetUpdateTimeStamp in interface TimeStampedMetrictime - update time stamppublic void setValue(long toSet)
TimeStampedGauge.toSet - the value for this objectpublic String toDebugString()
public void updateTimeStamp()
TimeStampedMetricupdateTimeStamp in interface TimeStampedMetricCopyright © 2014. All Rights Reserved.