com.netflix.spectator.controllers

Class MetricsController

java.lang.Object

com.netflix.spectator.controllers.MetricsController

@RequestMapping(value="/spectator/metrics")
 @RestController
 @ConditionalOnExpression(value="${spectator.web-endpoint.enabled:false}")
public class MetricsController
extends Object

Provides an HTTP endpoint for polling spectator metrics.

Field Summary

Fields

Modifier and Type	Field and Description
static Predicate<com.netflix.spectator.api.Measurement>	ALL_MEASUREMENTS_FILTER A measurement filter that accepts all measurements.

Constructor Summary

Constructors

Constructor and Description
MetricsController()

Method Summary

Modifier and Type	Method and Description
Predicate<com.netflix.spectator.api.Measurement>	getDefaultMeasurementFilter() The default measurement filter is configured through properties.
ApplicationRegistry	getMetrics(Map<String,String> filters) Endpoint for querying current metric values.
static String	meterToKind(com.netflix.spectator.api.Registry registry, com.netflix.spectator.api.Meter meter) Determine the type of a meter for reporting purposes.

Methods inherited from class java.lang.Object

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

Field Detail

ALL_MEASUREMENTS_FILTER

public static final Predicate<com.netflix.spectator.api.Measurement> ALL_MEASUREMENTS_FILTER

A measurement filter that accepts all measurements.

Constructor Detail

MetricsController

public MetricsController()

Method Detail

getDefaultMeasurementFilter

public Predicate<com.netflix.spectator.api.Measurement> getDefaultMeasurementFilter()
                                                                             throws IOException

The default measurement filter is configured through properties.

Throws:

IOException

getMetrics

@RequestMapping(method=GET)
public ApplicationRegistry getMetrics(@RequestParam
                                                                  Map<String,String> filters)
                                                           throws IOException

Endpoint for querying current metric values. The result is a JSON document describing the metrics and their values. The result can be filtered using query parameters or configuring the controller instance itself.

Throws:

IOException

meterToKind

public static String meterToKind(com.netflix.spectator.api.Registry registry,
                                 com.netflix.spectator.api.Meter meter)

Determine the type of a meter for reporting purposes.

Parameters:

registry - Used to provide supplemental information (e.g. to search for the meter).

meter - The meters whose kind we want to know.

Returns:

A string such as "Counter". If the type cannot be identified as one of the standard Spectator api interface variants, then the simple class name is returned.