org.springframework.boot.actuate.metrics.startup

Class StartupTimeMetricsListener

java.lang.Object

org.springframework.boot.actuate.metrics.startup.StartupTimeMetricsListener

All Implemented Interfaces:

EventListener, ApplicationListener<ApplicationEvent>, SmartApplicationListener, Ordered

public class StartupTimeMetricsListener
extends Object
implements SmartApplicationListener

Binds application startup metrics in response to ApplicationStartedEvent and ApplicationReadyEvent.

Since:

2.6.0

Author:

Chris Bono, Phillip Webb

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_READY_TIME_METRIC_NAME The default name to use for the application ready time metric.
static String	APPLICATION_STARTED_TIME_METRIC_NAME The default name to use for the application started time metric.

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
StartupTimeMetricsListener(io.micrometer.core.instrument.MeterRegistry meterRegistry) Create a new instance using default metric names.
StartupTimeMetricsListener(io.micrometer.core.instrument.MeterRegistry meterRegistry, String startedTimeMetricName, String readyTimeMetricName, Iterable<io.micrometer.core.instrument.Tag> tags) Create a new instance using the specified options.

Method Summary

Modifier and Type	Method and Description
void	onApplicationEvent(ApplicationEvent event)
boolean	supportsEventType(Class<? extends ApplicationEvent> eventType)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.event.SmartApplicationListener

getListenerId, getOrder, supportsSourceType

Methods inherited from interface org.springframework.context.ApplicationListener

forPayload

Field Detail

APPLICATION_STARTED_TIME_METRIC_NAME

public static final String APPLICATION_STARTED_TIME_METRIC_NAME

The default name to use for the application started time metric.

See Also:

Constant Field Values

APPLICATION_READY_TIME_METRIC_NAME

public static final String APPLICATION_READY_TIME_METRIC_NAME

The default name to use for the application ready time metric.

See Also:

Constant Field Values

Constructor Detail

StartupTimeMetricsListener

public StartupTimeMetricsListener(io.micrometer.core.instrument.MeterRegistry meterRegistry)

Create a new instance using default metric names.

Parameters:

meterRegistry - the registry to use

See Also:

APPLICATION_STARTED_TIME_METRIC_NAME, APPLICATION_READY_TIME_METRIC_NAME

StartupTimeMetricsListener

public StartupTimeMetricsListener(io.micrometer.core.instrument.MeterRegistry meterRegistry,
                                  String startedTimeMetricName,
                                  String readyTimeMetricName,
                                  Iterable<io.micrometer.core.instrument.Tag> tags)

Create a new instance using the specified options.

Parameters:

meterRegistry - the registry to use

startedTimeMetricName - the name to use for the application started time metric

readyTimeMetricName - the name to use for the application ready time metric

tags - the tags to associate to application startup metrics

Method Detail

supportsEventType

public boolean supportsEventType(Class<? extends ApplicationEvent> eventType)

Specified by:

supportsEventType in interface SmartApplicationListener

onApplicationEvent

public void onApplicationEvent(ApplicationEvent event)

Specified by:

onApplicationEvent in interface ApplicationListener<ApplicationEvent>