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

Class MicrometerMetricsAutoConfiguration

java.lang.Object

org.axonframework.extension.metrics.micrometer.springboot.MicrometerMetricsAutoConfiguration

@AutoConfiguration
@AutoConfigureBefore(AxonAutoConfiguration.class)
@AutoConfigureAfter(name={"org.springframework.boot.actuate.autoconfigure.metrics.CompositeMeterRegistryAutoConfiguration","org.springframework.boot.actuate.autoconfigure.metrics.export.simple.SimpleMetricsExportAutoConfiguration"})
@ConditionalOnClass(name={"org.axonframework.extension.springboot.autoconfig.AxonAutoConfiguration","io.micrometer.core.instrument.MeterRegistry"})
@EnableConfigurationProperties(MetricsProperties.class)
public class MicrometerMetricsAutoConfiguration
extends Object

Autoconfiguration to set up Micrometer Metrics for the infrastructure components.

Since:

4.1.0

Author:

Steven van Beelen, Marijn van Zelst

Constructor Summary

Constructors

Constructor	Description
MicrometerMetricsAutoConfiguration()

Method Summary

Modifier and Type	Method	Description
ConfigurationEnhancer	disableMetricsConfigurationEnhancer()	Bean creation method constructing a ConfigurationEnhancer that disables MetricsConfigurationEnhancer that is only constructed when axon.metrics.enabled is set to false.
io.micrometer.core.instrument.MeterRegistry	meterRegistry()	Bean creation method constructing a Micrometer MeterRegistry for the MetricsConfigurationEnhancer.
MetricsConfigurationEnhancer	metricsConfigurationEnhancer(io.micrometer.core.instrument.MeterRegistry registry, MetricsProperties properties)	Bean creation method constructing a MetricsConfigurationEnhancer with the given registry, which will attach a default set of MessageMonitors to Axon's infrastructure components.

Methods inherited from class java.lang.Object

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

Constructor Details

MicrometerMetricsAutoConfiguration

public MicrometerMetricsAutoConfiguration()

Method Details

meterRegistry

@Bean
@ConditionalOnMissingBean(io.micrometer.core.instrument.MeterRegistry.class)
@ConditionalOnProperty(value="axon.metrics.enabled",
                       havingValue="true",
                       matchIfMissing=true)
public io.micrometer.core.instrument.MeterRegistry meterRegistry()

Bean creation method constructing a Micrometer MeterRegistry for the MetricsConfigurationEnhancer.

Returns:

a Micrometer MeterRegistry to be used by the MetricsConfigurationEnhancer

metricsConfigurationEnhancer

@Bean
@ConditionalOnMissingBean
@ConditionalOnProperty(value="axon.metrics.enabled",
                       havingValue="true",
                       matchIfMissing=true)
public MetricsConfigurationEnhancer metricsConfigurationEnhancer(io.micrometer.core.instrument.MeterRegistry registry,
 MetricsProperties properties)

Bean creation method constructing a MetricsConfigurationEnhancer with the given registry, which will attach a default set of MessageMonitors to Axon's infrastructure components.

Parameters:

registry - the MeterRegistry to be used by the MetricsConfigurationEnhancer to register metrics with

properties - the MetricsProperties used to configure the MetricsConfigurationEnhancer

Returns:

a MetricsConfigurationEnhancer that will attach a default set of MessageMonitors to Axon's infrastructure components

disableMetricsConfigurationEnhancer

@Bean
@ConditionalOnProperty(name="axon.metrics.enabled",
                       havingValue="false")
public ConfigurationEnhancer disableMetricsConfigurationEnhancer()

Bean creation method constructing a ConfigurationEnhancer that disables MetricsConfigurationEnhancer that is only constructed when axon.metrics.enabled is set to false.

Returns:

a ConfigurationEnhancer MetricsConfigurationEnhancer that is only constructed when axon.metrics.enabled is set to false