Class MetricsEndpoint

java.lang.Object

org.springframework.boot.metrics.actuate.endpoint.MetricsEndpoint

@Endpoint(id="metrics")
public class MetricsEndpoint
extends Object

An @Endpoint for exposing the metrics held by a MeterRegistry.

Since:

4.0.0

Author:

Jon Schneider, Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MetricsEndpoint.AvailableTag	A set of tags for further dimensional drill-down and their potential values.
static final class	MetricsEndpoint.MetricDescriptor	Description of a metric.
static final class	MetricsEndpoint.MetricNamesDescriptor	Description of metric names.
static final class	MetricsEndpoint.Sample	A measurement sample combining a statistic and a value.

Constructor Summary

Constructors

Constructor	Description
MetricsEndpoint(io.micrometer.core.instrument.MeterRegistry registry)

Method Summary

Modifier and Type	Method	Description
MetricsEndpoint.MetricNamesDescriptor	listNames()
MetricsEndpoint.MetricDescriptor	metric(String requiredMetricName, List<String> tag)

Methods inherited from class java.lang.Object

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

Constructor Details

MetricsEndpoint

public MetricsEndpoint(io.micrometer.core.instrument.MeterRegistry registry)

Method Details

listNames

@ReadOperation
public MetricsEndpoint.MetricNamesDescriptor listNames()

metric

@ReadOperation
public MetricsEndpoint.MetricDescriptor metric(@Selector
 String requiredMetricName,
 @OptionalParameter
 List<String> tag)