com.hp.sdn.metric

Class TimeStampedCounter

java.lang.Object

com.codahale.metrics.Counter

com.hp.sdn.metric.TimeStampedCounter

All Implemented Interfaces:

com.codahale.metrics.Counting, com.codahale.metrics.Metric, TimeStampedMetric

public class TimeStampedCounter
extends com.codahale.metrics.Counter
implements TimeStampedMetric

Extension of Coda Hale Counter class that provides an association of the Counter value with time stamps.

Author:

Steve Britt

Constructor Summary

Constructors

Constructor and Description
TimeStampedCounter(MetricRegistry registry, CounterDescriptor descriptor) Constructs a TimeStampedCounter with the specified characteristics using the specified MetricRegistry.
TimeStampedCounter(MetricRegistry registry, CounterDescriptor descriptor, String uid) Constructs a TimeStampedCounter with the specified UID and other characteristics using the specified MetricRegistry.

Method Summary

Methods

Modifier and Type	Method and Description
void	dec(long toSubtract)
CounterDataPoint	extractDataPoint() Extract a CounterDataPoint from this object.
CounterDescriptor	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.
void	inc(long toAdd)
boolean	isValid() Indicates whether this TimeStampedMetric's current value is a valid one.
void	reset() Prepares the counter for use in a new time period by resetting its value to zero and saving the most recent update time stamp as the previous time stamp.
void	setDescriptor(CounterDescriptor toSet) Sets the CounterDescriptor that specifies characteristics of this TimeStampedCounter.
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.

Methods inherited from class com.codahale.metrics.Counter

dec, getCount, inc

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeStampedCounter

public TimeStampedCounter(MetricRegistry registry,
                  CounterDescriptor descriptor)

Constructs a TimeStampedCounter with the specified characteristics using the specified MetricRegistry.

Parameters:

registry - MetricRegistry to use for allocating this object

descriptor - CounterDescriptor that specifies various characteristics of the resulting TimeStampedCounter

TimeStampedCounter

public TimeStampedCounter(MetricRegistry registry,
                  CounterDescriptor descriptor,
                  String uid)

Constructs a TimeStampedCounter with the specified UID and other characteristics using the specified MetricRegistry.

Parameters:

registry - MetricRegistry to use for allocating this object

descriptor - CounterDescriptor that specifies various characteristics of the resulting TimeStampedCounter

uid - UID to assign to the resulting TimeStampedCounter

Throws:

IllegalArgumentException - if a null value is supplied for either the CounterDescriptor or MetricRegistry argument

Method Detail

dec

public void dec(long toSubtract)

Overrides:

dec in class com.codahale.metrics.Counter

extractDataPoint

public CounterDataPoint extractDataPoint()

Extract a CounterDataPoint from this object.

Specified by:

extractDataPoint in interface TimeStampedMetric

Returns:

the current value of this object represented as a CounterDataPoint

getDescriptor

public CounterDescriptor getDescriptor()

Description copied from interface: TimeStampedMetric

Gets the MetricDescriptor that describes this TimeStampedMetric object.

Specified by:

getDescriptor in interface TimeStampedMetric

Returns:

MetricDescriptor that describes this TimeStampedMetric

getMsSpanned

public long getMsSpanned()

Description copied from interface: TimeStampedMetric

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.

Specified by:

getMsSpanned in interface TimeStampedMetric

Returns:

milliseconds spanned between the update and previous time stamps

getPreviousTimeStamp

public long getPreviousTimeStamp()

Description copied from interface: TimeStampedMetric

Gets the previous time stamp.

Specified by:

getPreviousTimeStamp in interface TimeStampedMetric

Returns:

previous time stamp

getTimeStampManager

protected TimeStampManager getTimeStampManager()

Gets the TimeStampManager that this object uses to manage its associated time stamps.

Returns:

the TimeStampManager for this object

getUid

public String getUid()

Description copied from interface: TimeStampedMetric

Gets the UID.

Specified by:

getUid in interface TimeStampedMetric

Returns:

the UID

getUpdateTimeStamp

public long getUpdateTimeStamp()

Description copied from interface: TimeStampedMetric

Gets the update time stamp.

Specified by:

getUpdateTimeStamp in interface TimeStampedMetric

Returns:

update time stamp

inc

public void inc(long toAdd)

Overrides:

inc in class com.codahale.metrics.Counter

isValid

public boolean isValid()

Description copied from interface: TimeStampedMetric

Indicates whether this 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.

Specified by:

isValid in interface TimeStampedMetric

Returns:

true if valid, false otherwise

reset

public void reset()

Prepares the counter for use in a new time period by resetting its value to zero and saving the most recent update time stamp as the previous time stamp.

Specified by:

reset in interface TimeStampedMetric

setDescriptor

public void setDescriptor(CounterDescriptor toSet)

Sets the CounterDescriptor that specifies characteristics of this TimeStampedCounter.

Parameters:

toSet - the CounterDescriptor for this object

setPreviousTimeStamp

public void setPreviousTimeStamp(long time)

Description copied from interface: TimeStampedMetric

Sets the previous time stamp.

Specified by:

setPreviousTimeStamp in interface TimeStampedMetric

Parameters:

time - previous time stamp

setUid

public void setUid(String toSet)

Description copied from interface: TimeStampedMetric

Sets the UID of this object.

Specified by:

setUid in interface TimeStampedMetric

Parameters:

toSet - new UID for this object

setUpdateTimeStamp

public void setUpdateTimeStamp(long time)

Description copied from interface: TimeStampedMetric

Sets the update time stamp.

Specified by:

setUpdateTimeStamp in interface TimeStampedMetric

Parameters:

time - update time stamp

toDebugString

public String toDebugString()

Gets a detailed representation of this object to facilitate debugging.

Returns:

debug representation of object

toString

public String toString()

Overrides:

toString in class Object

updateTimeStamp

public void updateTimeStamp()

Description copied from interface: TimeStampedMetric

Convenience method that sets the update time stamp to the current time.

Specified by:

updateTimeStamp in interface TimeStampedMetric