org.springframework.boot.actuate.endpoint

Class MetricsEndpoint

java.lang.Object

org.springframework.boot.actuate.endpoint.AbstractEndpoint<Map<String,Object>>

org.springframework.boot.actuate.endpoint.MetricsEndpoint

All Implemented Interfaces:

Aware, Endpoint<Map<String,Object>>, EnvironmentAware

@ConfigurationProperties(prefix="endpoints.metrics",
                         ignoreUnknownFields=false)
public class MetricsEndpoint
extends AbstractEndpoint<Map<String,Object>>

Endpoint to expose a collection of PublicMetrics.

Author:

Dave Syer

Constructor Summary

Constructors

Constructor and Description
MetricsEndpoint(Collection<PublicMetrics> publicMetrics) Create a new MetricsEndpoint instance.
MetricsEndpoint(PublicMetrics publicMetrics) Create a new MetricsEndpoint instance.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	invoke() Called to invoke the endpoint.
void	registerPublicMetrics(PublicMetrics metrics)
void	unregisterPublicMetrics(PublicMetrics metrics)

Methods inherited from class org.springframework.boot.actuate.endpoint.AbstractEndpoint

getEnvironment, getId, isEnabled, isSensitive, setEnabled, setEnvironment, setId, setSensitive

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsEndpoint

public MetricsEndpoint(PublicMetrics publicMetrics)

Create a new MetricsEndpoint instance.

Parameters:

publicMetrics - the metrics to expose

MetricsEndpoint

public MetricsEndpoint(Collection<PublicMetrics> publicMetrics)

Create a new MetricsEndpoint instance.

Parameters:

publicMetrics - the metrics to expose. The collection will be sorted using the AnnotationAwareOrderComparator.

Method Detail

registerPublicMetrics

public void registerPublicMetrics(PublicMetrics metrics)

unregisterPublicMetrics

public void unregisterPublicMetrics(PublicMetrics metrics)

invoke

public Map<String,Object> invoke()

Description copied from interface: Endpoint

Called to invoke the endpoint.

Returns:

the results of the invocation