org.springframework.boot.actuate.metrics.reader

Class MetricRegistryMetricReader

java.lang.Object

org.springframework.boot.actuate.metrics.reader.MetricRegistryMetricReader

All Implemented Interfaces:

com.codahale.metrics.MetricRegistryListener, EventListener, MetricReader

public class MetricRegistryMetricReader
extends Object
implements MetricReader, com.codahale.metrics.MetricRegistryListener

A Spring Boot MetricReader that reads metrics from a Codahale MetricRegistry. Gauges and Counters are reflected as a single value. Timers, Meters and Histograms are expanded into sets of metrics containing all the properties of type Number.

Author:

Dave Syer, Andy Wilkinson

Nested Class Summary

Nested classes/interfaces inherited from interface com.codahale.metrics.MetricRegistryListener

com.codahale.metrics.MetricRegistryListener.Base

Constructor Summary

Constructors

Constructor and Description
MetricRegistryMetricReader(com.codahale.metrics.MetricRegistry registry)

Method Summary

Methods

Modifier and Type	Method and Description
long	count() The number of metrics known to this reader.
Iterable<Metric<?>>	findAll() Find all the metrics known to this reader.
Metric<?>	findOne(String metricName) Find an instance of the metric with the given name (usually the latest recorded value).
void	onCounterAdded(String name, com.codahale.metrics.Counter counter)
void	onCounterRemoved(String name)
void	onGaugeAdded(String name, com.codahale.metrics.Gauge<?> gauge)
void	onGaugeRemoved(String name)
void	onHistogramAdded(String name, com.codahale.metrics.Histogram histogram)
void	onHistogramRemoved(String name)
void	onMeterAdded(String name, com.codahale.metrics.Meter meter)
void	onMeterRemoved(String name)
void	onTimerAdded(String name, com.codahale.metrics.Timer timer)
void	onTimerRemoved(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricRegistryMetricReader

public MetricRegistryMetricReader(com.codahale.metrics.MetricRegistry registry)

Method Detail

findOne

public Metric<?> findOne(String metricName)

Description copied from interface: MetricReader

Find an instance of the metric with the given name (usually the latest recorded value).

Specified by:

findOne in interface MetricReader

Parameters:

metricName - the name of the metric to find

Returns:

a metric value or null if there are none with that name

findAll

public Iterable<Metric<?>> findAll()

Description copied from interface: MetricReader

Find all the metrics known to this reader.

Specified by:

findAll in interface MetricReader

Returns:

all instances of metrics known to this reader

count

public long count()

Description copied from interface: MetricReader

The number of metrics known to this reader.

Specified by:

count in interface MetricReader

Returns:

the number of metrics

onGaugeAdded

public void onGaugeAdded(String name,
                com.codahale.metrics.Gauge<?> gauge)

Specified by:

onGaugeAdded in interface com.codahale.metrics.MetricRegistryListener

onGaugeRemoved

public void onGaugeRemoved(String name)

Specified by:

onGaugeRemoved in interface com.codahale.metrics.MetricRegistryListener

onCounterAdded

public void onCounterAdded(String name,
                  com.codahale.metrics.Counter counter)

Specified by:

onCounterAdded in interface com.codahale.metrics.MetricRegistryListener

onCounterRemoved

public void onCounterRemoved(String name)

Specified by:

onCounterRemoved in interface com.codahale.metrics.MetricRegistryListener

onHistogramAdded

public void onHistogramAdded(String name,
                    com.codahale.metrics.Histogram histogram)

Specified by:

onHistogramAdded in interface com.codahale.metrics.MetricRegistryListener

onHistogramRemoved

public void onHistogramRemoved(String name)

Specified by:

onHistogramRemoved in interface com.codahale.metrics.MetricRegistryListener

onMeterAdded

public void onMeterAdded(String name,
                com.codahale.metrics.Meter meter)

Specified by:

onMeterAdded in interface com.codahale.metrics.MetricRegistryListener

onMeterRemoved

public void onMeterRemoved(String name)

Specified by:

onMeterRemoved in interface com.codahale.metrics.MetricRegistryListener

onTimerAdded

public void onTimerAdded(String name,
                com.codahale.metrics.Timer timer)

Specified by:

onTimerAdded in interface com.codahale.metrics.MetricRegistryListener

onTimerRemoved

public void onTimerRemoved(String name)

Specified by:

onTimerRemoved in interface com.codahale.metrics.MetricRegistryListener