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 a metrics endpoint to visualize metrics.

Since:

1.0

Author:

Christian Oestreich

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricsEndpoint.AvailableTag A set of tags for further dimensional drilldown and their potential values.
static class	MetricsEndpoint.MetricDetails Response payload for a metric name selector.
static class	MetricsEndpoint.MetricNames Response payload for a metric name listing.
static class	MetricsEndpoint.Sample A measurement sample combining a statistic and a value.

Constructor Summary

Constructors

Constructor and Description
MetricsEndpoint(Collection<io.micrometer.core.instrument.MeterRegistry> meterRegistries, ApplicationContext applicationContext) Constructor for metrics endpoint.

Method Summary

Modifier and Type	Method and Description
MetricsEndpoint.MetricDetails	getMetricDetails(String name, List<String> tag) Method to read individual metric data.
MetricsEndpoint.MetricNames	listNames() Read operation to list metric names.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsEndpoint

public MetricsEndpoint(Collection<io.micrometer.core.instrument.MeterRegistry> meterRegistries,
                       ApplicationContext applicationContext)

Constructor for metrics endpoint.

Parameters:

meterRegistries - Meter Registries

applicationContext - Application Context for looking up beans

Method Detail

listNames

@Read
public MetricsEndpoint.MetricNames listNames()

Read operation to list metric names. To get the details the method getMetricDetails(name) should be invoked.

Returns:

single of http response with list of metric names

getMetricDetails

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

Method to read 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