org.springframework.analytics.metrics

Interface AggregateCounterReader

All Known Subinterfaces:

AggregateCounterRepository

All Known Implementing Classes:

InMemoryAggregateCounterRepository, RedisAggregateCounterRepository

public interface AggregateCounterReader

Contains operations to find AggreageCounters.

Author:

Luke Taylor, Ilayaperumal Gopinathan

Method Summary

Methods

Modifier and Type	Method and Description
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.
List<String>	list() List the names of all available aggregate counters.

Method Detail

getCounts

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

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

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

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.

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.

getCounts

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). The date may be null to use the current time, thus returning the last nCounts point at the given resolution.

Parameters:

name - the counter to query

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

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 counts .

findOne

AggregateCounter findOne(String name)

Retrieve a single counter by name.

Parameters:

name - the counter to query

Returns:

an object containing an indexed array of the counts .

list

List<String> list()

List the names of all available aggregate counters.

Returns:

the names of all available aggregate counters.