com.netflix.spectator.api

Interface Counter

All Superinterfaces:

Meter

All Known Implementing Classes:

IntervalCounter

public interface Counter
extends Meter

Measures the rate of change based on calls to increment.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Counter.BatchUpdater See batchUpdater(int).

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.
default Counter.BatchUpdater	batchUpdater(int batchSize) Returns a helper that can be used to more efficiently update the counter within a single thread.
default long	count() The cumulative count since this counter was last reset.
default void	increment() Update the counter by one.
default void	increment(long amount) Update the counter by amount.

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

hasExpired, id, measure

Method Detail

increment

default void increment()

Update the counter by one.

increment

default void increment(long amount)

Update the counter by amount.

Parameters:

amount - Amount to add to the counter.

add

void add(double amount)

Update the counter by the specified amount.

count

default long count()

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

actualCount

double actualCount()

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.

batchUpdater

default Counter.BatchUpdater batchUpdater(int batchSize)

Returns a helper that can be used to more efficiently update the counter within a single thread. For example, if you need to update a meter within a loop where the rest of the loop body is fairly cheap, the instrumentation code may add considerable overhead if done in the loop body. A batched updater can offset a fair amount of that cost, but the updates may be delayed a bit in reaching the meter. The updates will only be seen after the updater is explicitly flushed. The caller should ensure that the updater is closed after using to guarantee any resources associated with it are cleaned up. In some cases failure to close the updater could result in a memory leak.

Parameters:

batchSize - Number of updates to batch before forcing a flush to the meter.

Returns:

Batch updater implementation for this meter.