org.springframework.boot.actuate.metrics.writer

Interface PrefixMetricWriter

All Known Subinterfaces:

MultiMetricRepository

All Known Implementing Classes:

InMemoryMultiMetricRepository, RedisMultiMetricRepository

public interface PrefixMetricWriter

A writer for metrics that allows efficient storage of groups of metrics with a common name prefix (their group name).

Since:

1.1.0

Author:

Dave Syer

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

set

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

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

Parameters:

group - the name of the group

values - the metric values to save

increment

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

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

Parameters:

group - the name of the group

delta - the amount to increment by

reset

void reset(String group)

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

Parameters:

group - reset the whole group