org.springframework.analytics.metrics.redis

Class RedisAggregateCounterRepository

java.lang.Object

org.springframework.analytics.metrics.redis.RedisAggregateCounterRepository

All Implemented Interfaces:

AggregateCounterReader, AggregateCounterRepository, AggregateCounterWriter

public class RedisAggregateCounterRepository
extends Object
implements AggregateCounterRepository

Redis implementation of AggregateCounterRepository.

Author:

Eric Bottard, Luke Taylor, Ilayaperumal Gopinathan

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.data.redis.core.HashOperations<String,String,Long>	hashOperations
protected org.springframework.data.redis.core.SetOperations<String,String>	setOperations

Constructor Summary

Constructors

Constructor and Description
RedisAggregateCounterRepository(org.springframework.data.redis.connection.RedisConnectionFactory redisConnectionFactory, org.springframework.retry.RetryOperations retryOperations)

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 endDate, 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) For each query, we need to convert the interval into two variations.
protected String	getMetricKey(String metricName) Provides the key for a named metric.
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 id) Reset the given AggregateCounter.

Methods inherited from class java.lang.Object

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

Field Detail

hashOperations

protected org.springframework.data.redis.core.HashOperations<String,String,Long> hashOperations

setOperations

protected org.springframework.data.redis.core.SetOperations<String,String> setOperations

Constructor Detail

RedisAggregateCounterRepository

public RedisAggregateCounterRepository(org.springframework.data.redis.connection.RedisConnectionFactory redisConnectionFactory,
                               org.springframework.retry.RetryOperations retryOperations)

Method Detail

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

getMetricKey

protected String getMetricKey(String metricName)

Provides the key for a named metric. By default this prepends the name to the metricPrefix value.

Parameters:

metricName - the name of the metric

Returns:

the redis key under which the metric is stored

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,
                         int nCounts,
                         org.joda.time.DateTime endDate,
                         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

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

getCounts

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

For each query, we need to convert the interval into two variations. One is the start and end points rounded to the resolution (used to calculate the number of entries to be returned from the query). The second is the start and end buckets we have to retrieve which may contain entries for the interval. For example, when querying at day resolution, the number of entries is the number of Joda time days between the start (rounded down to a day boundary) and the end plus one day (also rounded down). However, we need load the data from the buckets from the month the start day occurs in to the month end day occurs in. These are then concatenated, using the start day as the start index into the first array, and writing the total number of entries in sequence from that point into the combined result counts array.

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.

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.

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 .

reset

public void reset(String id)

Description copied from interface: AggregateCounterWriter

Reset the given AggregateCounter.

Specified by:

reset in interface AggregateCounterWriter

Parameters:

id - the AggregateCounter name