org.springframework.boot.actuate.metrics.repository.redis

Class RedisMultiMetricRepository

java.lang.Object

org.springframework.boot.actuate.metrics.repository.redis.RedisMultiMetricRepository

All Implemented Interfaces:

PrefixMetricReader, MultiMetricRepository, PrefixMetricWriter

public class RedisMultiMetricRepository
extends Object
implements MultiMetricRepository

MultiMetricRepository implementation backed by a redis store. Metric values are stored as zset values and the timestamps as regular values, both against a key composed of the group name prefixed with a constant prefix (default "spring.groups."). The group names are stored as a zset under "keys." + [prefix].

Author:

Dave Syer

Constructor Summary

Constructors

Constructor and Description
RedisMultiMetricRepository(RedisConnectionFactory redisConnectionFactory)
RedisMultiMetricRepository(RedisConnectionFactory redisConnectionFactory, String prefix)

Method Summary

Methods

Modifier and Type	Method and Description
long	countGroups()
Iterable<Metric<?>>	findAll(String group) Find all metrics whose name starts with the given prefix.
Iterable<String>	groups() The names of all the groups known to this repository
void	increment(String group, Delta<?> delta) Increment the value of a metric (or decrement if the delta is negative).
void	reset(String group) Rest the values of all metrics in the group.
void	set(String group, Collection<Metric<?>> values) Save some metric values and associate them with a group name.

Methods inherited from class java.lang.Object

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

Constructor Detail

RedisMultiMetricRepository

public RedisMultiMetricRepository(RedisConnectionFactory redisConnectionFactory)

RedisMultiMetricRepository

public RedisMultiMetricRepository(RedisConnectionFactory redisConnectionFactory,
                          String prefix)

Method Detail

findAll

public Iterable<Metric<?>> findAll(String group)

Description copied from interface: PrefixMetricReader

Find all metrics whose name starts with the given prefix.

Specified by:

findAll in interface PrefixMetricReader

Parameters:

group - the prefix for metric names

Returns:

all metrics with names starting with the prefix

set

public void set(String group,
       Collection<Metric<?>> values)

Description copied from interface: PrefixMetricWriter

Save some metric values and associate them with a group name.

Specified by:

set in interface PrefixMetricWriter

Parameters:

group - the name of the group

values - the metric values to save

increment

public void increment(String group,
             Delta<?> delta)

Description copied from interface: PrefixMetricWriter

Increment the value of a metric (or decrement if the delta is negative). The name of the metric to increment is group + "." + delta.name.

Specified by:

increment in interface PrefixMetricWriter

delta - the amount to increment by

groups

public Iterable<String> groups()

Description copied from interface: MultiMetricRepository

The names of all the groups known to this repository

Specified by:

groups in interface MultiMetricRepository

Returns:

all available group names

countGroups

public long countGroups()

Specified by:

countGroups in interface MultiMetricRepository

Returns:

the number of groups available

reset

public void reset(String group)

Description copied from interface: PrefixMetricWriter

Rest the values of all metrics in the group. Implementations may choose to discard the old values.

Specified by:

reset in interface PrefixMetricWriter

Parameters:

group - reset the whole group