com.netflix.spectator.api.patterns

Class IntervalCounter

java.lang.Object

com.netflix.spectator.api.patterns.IntervalCounter

All Implemented Interfaces:

Counter, Meter

public final class IntervalCounter
extends java.lang.Object
implements Counter

A counter that also keeps track of the time since last update.

Method Summary

Modifier and Type	Method and Description
double	actualCount() The cumulative count as a floating point value since this counter was last reset.
void	add(double amount) Update the counter by the specified amount.
static IntervalCounter	get(Registry registry, Id id) Create a new instance.
boolean	hasExpired() Indicates whether the meter is expired.
Id	id() Identifier used to lookup this meter in the registry.
java.lang.Iterable<Measurement>	measure() Get the set of measurements for this meter.
double	secondsSinceLastUpdate() Return the number of seconds since the last time the counter was incremented.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.netflix.spectator.api.Counter

count, increment, increment

Method Detail

get

public static IntervalCounter get(Registry registry,
                                  Id id)

Create a new instance.

Parameters:

registry - Registry to use.

id - Identifier for the metric being registered.

Returns:

Counter instance.

add

public void add(double amount)

Description copied from interface: Counter

Update the counter by the specified amount.

Specified by:

add in interface Counter

actualCount

public double actualCount()

Description copied from interface: Counter

The cumulative count as a floating point value since this counter was last reset. How often a counter is reset depends on the underlying registry implementation.

Specified by:

actualCount in interface Counter

id

public Id id()

Description copied from interface: Meter

Identifier used to lookup this meter in the registry.

Specified by:

id in interface Meter

secondsSinceLastUpdate

public double secondsSinceLastUpdate()

Return the number of seconds since the last time the counter was incremented.

measure

public java.lang.Iterable<Measurement> measure()

Description copied from interface: Meter

Get the set of measurements for this meter.

Specified by:

measure in interface Meter

hasExpired

public boolean hasExpired()

Description copied from interface: Meter

Indicates whether the meter is expired. For example, a counter might expire if there is no activity within a given time frame.

Specified by:

hasExpired in interface Meter