org.axonframework.micrometer

Class GlobalMetricRegistry

java.lang.Object

org.axonframework.micrometer.GlobalMetricRegistry

public class GlobalMetricRegistry
extends Object

Registry for application metrics with convenient ways to register Axon components.

Since:

4.1

Author:

Rene de Waele, Marijn van Zelst

Constructor Summary

Constructors

Constructor and Description
GlobalMetricRegistry() Initializes a new GlobalMetricRegistry delegating to a new MeterRegistry with default settings.
GlobalMetricRegistry(io.micrometer.core.instrument.MeterRegistry meterRegistry) Initializes a GlobalMetricRegistry delegating to the given meterRegistry.

Method Summary

Modifier and Type	Method and Description
io.micrometer.core.instrument.MeterRegistry	getRegistry() Returns the global MeterRegistry to which components are registered.
MessageMonitor<? super CommandMessage<?>>	registerCommandBus(String name) Registers new metrics to the registry to monitor a CommandBus.
MessageMonitor<? extends Message<?>>	registerComponent(Class<?> componentType, String componentName) Registers new metrics to the registry to monitor a component of given type.
MessageMonitor<? super EventMessage<?>>	registerEventBus(String name) Registers new metrics to the registry to monitor an EventBus.
MessageMonitor<? super EventMessage<?>>	registerEventProcessor(String name) Registers new metrics to the registry to monitor an EventProcessor.
MessageMonitor<? super QueryMessage<?,?>>	registerQueryBus(String name) Registers new metrics to the registry to monitor a QueryBus.
Configurer	registerWithConfigurer(Configurer configurer) Registers the metric registry with the given configurer via Configurer.configureMessageMonitor(Function).

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalMetricRegistry

public GlobalMetricRegistry()

Initializes a new GlobalMetricRegistry delegating to a new MeterRegistry with default settings.

GlobalMetricRegistry

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

Initializes a GlobalMetricRegistry delegating to the given meterRegistry.

Parameters:

meterRegistry - the metric registry which will record the metrics

Method Detail

registerWithConfigurer

public Configurer registerWithConfigurer(Configurer configurer)

Registers the metric registry with the given configurer via Configurer.configureMessageMonitor(Function). Components registered by the configurer will be added by invocation of registerComponent(Class, String).

Parameters:

configurer - the application's configurer

Returns:

configurer with the new registration applied

registerComponent

public MessageMonitor<? extends Message<?>> registerComponent(Class<?> componentType,
                                                              String componentName)

Registers new metrics to the registry to monitor a component of given type. The monitor will be registered with the registry under the given name. The returned MessageMonitor can be installed on the component to initiate the monitoring.

Parameters:

componentType - the type of component to register

componentName - the name under which the component should be registered to the registry

Returns:

MessageMonitor to monitor the behavior of a given type

Throws:

IllegalArgumentException - if the component type is not recognized

registerEventProcessor

public MessageMonitor<? super EventMessage<?>> registerEventProcessor(String name)

Registers new metrics to the registry to monitor an EventProcessor. The monitor will be registered with the registry under the given eventProcessorName. The returned MessageMonitor can be installed on the event processor to initiate the monitoring.

Parameters:

name - the name under which the EventProcessor should be registered to the registry

Returns:

MessageMonitor to monitor the behavior of an EventProcessor

registerEventBus

public MessageMonitor<? super EventMessage<?>> registerEventBus(String name)

Registers new metrics to the registry to monitor an EventBus. The monitor will be registered with the registry under the given name. The returned MessageMonitor can be installed on the event bus to initiate the monitoring.

Parameters:

name - the name under which the eventBus should be registered to the registry

Returns:

MessageMonitor to monitor the behavior of an EventBus

registerCommandBus

public MessageMonitor<? super CommandMessage<?>> registerCommandBus(String name)

Registers new metrics to the registry to monitor a CommandBus. The monitor will be registered with the registry under the given name. The returned MessageMonitor can be installed on the command bus to initiate the monitoring.

Parameters:

name - the name under which the commandBus should be registered to the registry

Returns:

MessageMonitor to monitor the behavior of a CommandBus

registerQueryBus

public MessageMonitor<? super QueryMessage<?,?>> registerQueryBus(String name)

Registers new metrics to the registry to monitor a QueryBus. The monitor will be registered with the registry under the given name. The returned MessageMonitor can be installed on the command bus to initiate the monitoring.

Parameters:

name - the name under which the commandBus should be registered to the registry

Returns:

MessageMonitor to monitor the behavior of a QueryBus

getRegistry

public io.micrometer.core.instrument.MeterRegistry getRegistry()

Returns the global MeterRegistry to which components are registered.

Returns:

the global registry