Package org.axonframework.messaging.tracing.configuration

Class MessagingTracingConfigurationEnhancer

java.lang.Object

org.axonframework.messaging.tracing.configuration.MessagingTracingConfigurationEnhancer

All Implemented Interfaces:

ConfigurationEnhancer

@Internal
@RegistrationScope("Register decorators once at the root; do not re-invoke in child module registries (the DecoratorDefinitions are copied down and reach module-built components on their own). Re-invoking per nesting level re-registers the decorators and produces duplicate nested spans.")
public final class MessagingTracingConfigurationEnhancer
extends Object
implements ConfigurationEnhancer

ConfigurationEnhancer that wires tracing into axon-messaging components. Discovered automatically via ServiceLoader, so dropping the axon-messaging module on the classpath is enough to enable messaging tracing.

A component is only decorated when a non-no-op SpanFactory is configured (so component-level tracing imposes no overhead when disabled) and the corresponding toggle in MessagingTracingSettings is enabled. Per-method handler spans (for @CommandHandler / @EventHandler / @QueryHandler) are produced by TracingHandlerEnhancerDefinition, which is contributed via the standard HandlerEnhancerDefinition ServiceLoader entry shipped with this module -- no additional registration is needed here.

Since:

5.3.0

Author:

Mateusz Nowak

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TRACING_DECORATOR_ORDER	Decorator order for the messaging tracing decorators -- see TracingConfigurationOrder.TRACING_DECORATOR_ORDER for the full ordering rationale.

Constructor Summary

Constructors

Constructor	Description
MessagingTracingConfigurationEnhancer()

Method Summary

Modifier and Type	Method	Description
void	enhance(ComponentRegistry registry)	Enhances the given registry with, for example, additional components and decorators.
int	order()	Returns the relative order this enhancer should be invoked in, compared to other instances.

Methods inherited from class java.lang.Object

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

Field Details

TRACING_DECORATOR_ORDER

public static final int TRACING_DECORATOR_ORDER

Decorator order for the messaging tracing decorators -- see TracingConfigurationOrder.TRACING_DECORATOR_ORDER for the full ordering rationale.

See Also:

• Constant Field Values

Constructor Details

MessagingTracingConfigurationEnhancer

public MessagingTracingConfigurationEnhancer()

Method Details

enhance

public void enhance(ComponentRegistry registry)

Description copied from interface: ConfigurationEnhancer

Enhances the given registry with, for example, additional components and decorators.

Specified by:

enhance in interface ConfigurationEnhancer

Parameters:

registry - The registry instance to enhance.

order

public int order()

Description copied from interface: ConfigurationEnhancer

Returns the relative order this enhancer should be invoked in, compared to other instances.

Use lower (negative) values for enhancers providing sensible defaults, and higher values for enhancers that should be able to override values potentially previously set. Defaults to 0 when not set.

Specified by:

order in interface ConfigurationEnhancer

Returns:

The order in which this enhancer should be invoked.