org.springframework.analytics.metrics.memory

Class InMemoryAggregateCounterRepository

java.lang.Object

org.springframework.analytics.metrics.memory.InMemoryAggregateCounterRepository

All Implemented Interfaces:

AggregateCounterReader, AggregateCounterRepository, AggregateCounterWriter

public class InMemoryAggregateCounterRepository
extends Object
implements AggregateCounterRepository

In-memory aggregate counter with minute resolution. Note that the data is permanently accumulated, so will grow steadily in size until the host process is restarted.

Author:

Luke Taylor, Eric Bottard, Ilayaperumal Gopinathan

Constructor Summary

Constructors

Constructor and Description
InMemoryAggregateCounterRepository()

Method Summary

Methods

Modifier and Type	Method and Description
long	decrement(String name)
AggregateCounter	findOne(String name) Retrieve a single counter by name.
AggregateCounter	getCounts(String name, int nCounts, AggregateCounterResolution resolution) Query function which returns the last 'n' points for a particular resolution.
AggregateCounter	getCounts(String name, int nCounts, org.joda.time.DateTime end, AggregateCounterResolution resolution) Queries by requesting a number of points, ending on the given date (inclusive).
AggregateCounter	getCounts(String name, org.joda.time.Interval interval, AggregateCounterResolution resolution) Query function to allow the counts for a specific interval to be retrieved for the given resolution.
long	increment(String name)
long	increment(String name, long amount, org.joda.time.DateTime dateTime) Increments the named counter by a specific amount for the given instant.
List<String>	list() List the names of all available aggregate counters.
void	reset(String name) Reset the given AggregateCounter.
AggregateCounter	save(AggregateCounter counter)

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryAggregateCounterRepository

public InMemoryAggregateCounterRepository()

Method Detail

increment

public long increment(String name)

decrement

public long decrement(String name)

reset

public void reset(String name)

Description copied from interface: AggregateCounterWriter

Reset the given AggregateCounter.

Specified by:

reset in interface AggregateCounterWriter

Parameters:

name - the AggregateCounter name

increment

public long increment(String name,
             long amount,
             org.joda.time.DateTime dateTime)

Description copied from interface: AggregateCounterWriter

Increments the named counter by a specific amount for the given instant.

Specified by:

increment in interface AggregateCounterWriter

Parameters:

name - the name of the counter

amount - the amount to increment

dateTime - the time of the event

Returns:

the total count

getCounts

public AggregateCounter getCounts(String name,
                         int nCounts,
                         AggregateCounterResolution resolution)

Description copied from interface: AggregateCounterReader

Query function which returns the last 'n' points for a particular resolution.

Specified by:

getCounts in interface AggregateCounterReader

Parameters:

name - the counter to query

nCounts - the number of data points to return

resolution - the resolution at which the data should be returned (minute, hour, day, month)

Returns:

an object containing an indexed array of the aggregate counts for the given query.

getCounts

public AggregateCounter getCounts(String name,
                         org.joda.time.Interval interval,
                         AggregateCounterResolution resolution)

Description copied from interface: AggregateCounterReader

Query function to allow the counts for a specific interval to be retrieved for the given resolution.

Specified by:

getCounts in interface AggregateCounterReader

Parameters:

name - the counter to query

interval - the time interval to return data for. Includes start and end.

resolution - the resolution at which the data should be returned (minute, hour, day, month)

Returns:

an object containing an indexed array of the aggregate counts for the given query.

findOne

public AggregateCounter findOne(String name)

Description copied from interface: AggregateCounterReader

Retrieve a single counter by name.

Specified by:

findOne in interface AggregateCounterReader

Parameters:

name - the counter to query

Returns:

an object containing an indexed array of the counts .

list

public List<String> list()

Description copied from interface: AggregateCounterReader

List the names of all available aggregate counters.

Specified by:

list in interface AggregateCounterReader

Returns:

the names of all available aggregate counters.

getCounts

public AggregateCounter getCounts(String name,
                         int nCounts,
                         org.joda.time.DateTime end,
                         AggregateCounterResolution resolution)

Description copied from interface: AggregateCounterReader

Queries by requesting a number of points, ending on the given date (inclusive). The date may be null to use the current time, thus returning the last nCounts point at the given resolution.

Specified by:

getCounts in interface AggregateCounterReader

Parameters:

name - the counter to query

nCounts - the number of data points to return

end - the end of the query interval (inclusive). Cannot be null.

resolution - the resolution at which the data should be returned (minute, hour, day, month)

Returns:

an object containing an indexed array of the counts .

save

public AggregateCounter save(AggregateCounter counter)