org.springframework.boot.actuate.metrics.rich

Class InMemoryRichGaugeRepository

java.lang.Object

org.springframework.boot.actuate.metrics.rich.InMemoryRichGaugeRepository

All Implemented Interfaces:

RichGaugeReader, RichGaugeRepository, MetricWriter

public class InMemoryRichGaugeRepository
extends Object
implements RichGaugeRepository

In memory implementation of MetricWriter and RichGaugeReader. When you set a metric value (using MetricWriter.set(Metric)) it is used to update a rich gauge (increment is a no-op). Gauge values can then be read out using the reader operations.

Author:

Dave Syer

Constructor Summary

Constructors

Constructor and Description
InMemoryRichGaugeRepository()

Method Summary

Methods

Modifier and Type	Method and Description
long	count()
Iterable<RichGauge>	findAll() Find all instances of rich gauge known to this reader.
RichGauge	findOne(String metricName) Find a single instance of a rich gauge by name.
void	increment(Delta<?> delta) Increment the value of a metric (or decrement if the delta is negative).
void	reset(String metricName) Reset the value of a metric, usually to zero value.
void	set(Metric<?> metric) Set the value of a metric.

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryRichGaugeRepository

public InMemoryRichGaugeRepository()

Method Detail

increment

public void increment(Delta<?> delta)

Description copied from interface: MetricWriter

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

Specified by:

increment in interface MetricWriter

Parameters:

delta - the amount to increment by

set

public void set(Metric<?> metric)

Description copied from interface: MetricWriter

Set the value of a metric.

Specified by:

set in interface MetricWriter

reset

public void reset(String metricName)

Description copied from interface: MetricWriter

Reset the value of a metric, usually to zero value. Implementations can discard the old values if desired, but may choose not to.

Specified by:

reset in interface MetricWriter

Parameters:

metricName - the name to reset

findOne

public RichGauge findOne(String metricName)

Description copied from interface: RichGaugeReader

Find a single instance of a rich gauge by name.

Specified by:

findOne in interface RichGaugeReader

Parameters:

metricName - the name of the gauge

Returns:

a rich gauge value

findAll

public Iterable<RichGauge> findAll()

Description copied from interface: RichGaugeReader

Find all instances of rich gauge known to this reader.

Specified by:

findAll in interface RichGaugeReader

Returns:

all instances known to this reader

count

public long count()

Specified by:

count in interface RichGaugeReader

Returns:

the number of gauge values available