Package org.axonframework.extension.metrics.micrometer.springboot

Class MetricsProperties

java.lang.Object

org.axonframework.extension.metrics.micrometer.springboot.MetricsProperties

@ConfigurationProperties("axon.metrics")
public class MetricsProperties
extends Object

Properties describing the settings for metrics.

Since:

3.2.0

Author:

Steven van Beelen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricsProperties.Micrometer	Properties specific for usage with Micrometer.

Constructor Summary

Constructors

Constructor	Description
MetricsProperties()

Method Summary

Modifier and Type	Method	Description
MetricsProperties.Micrometer	getMicrometer()	Retrieves the Micrometer specific settings for metrics.
boolean	isEnabled()	Indicates whether the auto-configuration of metrics is enabled.
void	setEnabled(boolean enabled)	Enables (if true, default) or disables (if false) the auto-configuration of metrics within the application context.
void	setMicrometer(MetricsProperties.Micrometer micrometer)	Defines the Micrometer settings for metrics.

Methods inherited from class java.lang.Object

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

Constructor Details

MetricsProperties

public MetricsProperties()

Method Details

isEnabled

public boolean isEnabled()

Indicates whether the auto-configuration of metrics is enabled.

Returns:

true if the auto-configuration of metrics is enabled, false if otherwise

setEnabled

public void setEnabled(boolean enabled)

Enables (if true, default) or disables (if false) the auto-configuration of metrics within the application context.

Parameters:

enabled - whether to enable metrics autoconfiguration

getMicrometer

public MetricsProperties.Micrometer getMicrometer()

Retrieves the Micrometer specific settings for metrics.

Returns:

the Micrometer settings for metrics

setMicrometer

public void setMicrometer(MetricsProperties.Micrometer micrometer)

Defines the Micrometer settings for metrics.

Parameters:

micrometer - the Micrometer settings for metrics