public class TimeStampedRollingCounter extends Object implements TimeStampedMetric
Constructor and Description |
---|
TimeStampedRollingCounter(MetricRegistry registry,
RollingCounterDescriptor descriptor)
Constructs a
TimeStampedRollingCounter with the specified
characteristics using the specified MetricRegistry . |
TimeStampedRollingCounter(MetricRegistry registry,
RollingCounterDescriptor descriptor,
String uid)
Constructs a
TimeStampedRollingCounter with the specified UID and
other characteristics using the specified MetricRegistry . |
Modifier and Type | Method and Description |
---|---|
RollingCounterDataPoint |
extractDataPoint()
Extract a
RollingCounterDataPoint from this object. |
long |
getDelta()
Computes and returns the delta between the latest and previous value
snapshots.
|
RollingCounterDescriptor |
getDescriptor()
Gets the
MetricDescriptor that describes this TimeStampedMetric object. |
long |
getLatestSnapshot()
Gets the latest value snapshot for the rolling counter.
|
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 |
getPreviousSnapshot()
Gets the previous value snapshot for the rolling counter.
|
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.
|
boolean |
isValid()
Indicates whether this
TimeStampedMetric 's current value is a
valid one. |
void |
reset()
Prepares the rolling counter for use in a new time period by saving the
most recent value snapshot as the previous snapshot, and saving the most
recent time stamp as the previous time stamp.
|
void |
setDescriptor(RollingCounterDescriptor toSet)
Sets the
RollingCounterDescriptor that specifies characteristics
of this TimeStampedRollingCounter . |
void |
setLatestSnapshot(long toSet)
Sets the latest value snapshot for the rolling counter.
|
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.
|
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 TimeStampedRollingCounter(MetricRegistry registry, RollingCounterDescriptor descriptor)
TimeStampedRollingCounter
with the specified
characteristics using the specified MetricRegistry
.registry
- MetricRegistry
to use for allocating this objectdescriptor
- RollingCounterDescriptor
that specifies various
characteristics of the resulting TimeStampedRollingCounter
public TimeStampedRollingCounter(MetricRegistry registry, RollingCounterDescriptor descriptor, String uid)
TimeStampedRollingCounter
with the specified UID and
other characteristics using the specified MetricRegistry
.registry
- MetricRegistry
to use for allocating this objectdescriptor
- RollingCounterDescriptor
that specifies various
characteristics of the resulting TimeStampedRollingCounter
uid
- UID to assign to the resulting TimeStampedRollingCounter
IllegalArgumentException
- if a null value is supplied for either
the RollingCounterDescriptor
or
MetricRegistry
argumentpublic RollingCounterDataPoint extractDataPoint()
RollingCounterDataPoint
from this object.extractDataPoint
in interface TimeStampedMetric
RollingCounterDataPoint
public long getDelta()
public RollingCounterDescriptor getDescriptor()
TimeStampedMetric
MetricDescriptor
that describes this TimeStampedMetric
object.getDescriptor
in interface TimeStampedMetric
MetricDescriptor
that describes this TimeStampedMetric
public long getLatestSnapshot()
public long getMsSpanned()
TimeStampedMetric
getMsSpanned
in interface TimeStampedMetric
public long getPreviousTimeStamp()
TimeStampedMetric
getPreviousTimeStamp
in interface TimeStampedMetric
public long getPreviousSnapshot()
protected TimeStampManager getTimeStampManager()
TimeStampManager
that this object uses to manage its
associated time stamps.TimeStampManager
for this objectpublic String getUid()
TimeStampedMetric
getUid
in interface TimeStampedMetric
public long getUpdateTimeStamp()
TimeStampedMetric
getUpdateTimeStamp
in interface TimeStampedMetric
public boolean isValid()
TimeStampedMetric
TimeStampedMetric
's current value is a
valid one. For example, it could be a non-numeric value like Double.NaN,
depending upon type and state of the TimeStampedMetric
.isValid
in interface TimeStampedMetric
true
if valid, false
otherwisepublic void reset()
reset
in interface TimeStampedMetric
public void setDescriptor(RollingCounterDescriptor toSet)
RollingCounterDescriptor
that specifies characteristics
of this TimeStampedRollingCounter
.toSet
- the RollingCounterDescriptor
for this objectpublic void setLatestSnapshot(long toSet)
toSet
- latest snapshotpublic void setPreviousTimeStamp(long time)
TimeStampedMetric
setPreviousTimeStamp
in interface TimeStampedMetric
time
- previous time stamppublic void setUid(String toSet)
TimeStampedMetric
setUid
in interface TimeStampedMetric
toSet
- new UID for this objectpublic void setUpdateTimeStamp(long time)
TimeStampedMetric
setUpdateTimeStamp
in interface TimeStampedMetric
time
- update time stamppublic String toDebugString()
public void updateTimeStamp()
TimeStampedMetric
updateTimeStamp
in interface TimeStampedMetric
Copyright © 2015. All Rights Reserved.