Package io.micronaut.configuration.metrics.management.endpoint

Class MetricsEndpoint

java.lang.Object

io.micronaut.configuration.metrics.management.endpoint.MetricsEndpoint

@Endpoint(value="metrics",
          defaultSensitive=false)
@RequiresMetrics
public class MetricsEndpoint
extends Object

Provides an endpoint to visualize metrics.

Since:

1.0

Author:

Christian Oestreich

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MetricsEndpoint.AvailableTag	A set of tags for further dimensional drilldown and their potential values.
static final class	MetricsEndpoint.MetricDetails	Response payload for a metric name selector.
static final class	MetricsEndpoint.MetricNames	Response payload for a metric name listing.
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 meterRegistry, DataSource[] dataSources)

Method Summary

Modifier and Type	Method	Description
MetricsEndpoint.MetricDetails	getMetricDetails(String name, @Nullable List<String> tag)	Reads individual metric data.
MetricsEndpoint.MetricNames	listNames()	Lists metric names.

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 meterRegistry,
 DataSource[] dataSources)

Parameters:

meterRegistry - The meter registry

dataSources - To ensure data sources are loaded

Method Details

listNames

@Read
public MetricsEndpoint.MetricNames listNames()

Lists metric names. To get the details, invoke the method getMetricDetails(name).

Returns:

single of HTTP response with metric names

getMetricDetails

@Read
public MetricsEndpoint.MetricDetails getMetricDetails(@Selector
 String name,
 @Nullable
 @Nullable List<String> tag)

Reads individual metric data.

After calling the /metrics endpoint, you can pass the name in like /metrics/foo.bar and the details for the metrics and tags will be returned.

Will return a 404 if the metric is not found.

Parameters:

name - the name of the metric to get the details for

tag - The tags

Returns:

single with metric details response