org.springframework.boot.actuate.endpoint

Class MetricsEndpointMetricReader

java.lang.Object

org.springframework.boot.actuate.endpoint.MetricsEndpointMetricReader

All Implemented Interfaces:

MetricReader

public class MetricsEndpointMetricReader
extends Object
implements MetricReader

MetricReader that pulls all current values out of the MetricsEndpoint. No timestamp information is available, so there is no way to check if the values are recent, and they all come out with the default (current time).

Since:

1.3.0

Author:

Dave Syer

Constructor Summary

Constructors

Constructor and Description
MetricsEndpointMetricReader(MetricsEndpoint endpoint)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsEndpointMetricReader

public MetricsEndpointMetricReader(MetricsEndpoint endpoint)

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