Package org.axonframework.messaging.tracing

Class TracingHandlerEnhancerDefinition

java.lang.Object

org.axonframework.messaging.tracing.TracingHandlerEnhancerDefinition

All Implemented Interfaces:

HandlerEnhancerDefinition

public class TracingHandlerEnhancerDefinition
extends Object
implements HandlerEnhancerDefinition

Enhances message handlers with the provided SpanFactory, wrapping handling of the message in a Span that is reported to the monitoring tooling.

Since EventSourcingHandlers can be very noisy when loading the aggregate, they can be enabled or disabled separately through constructor configuration.

Since:

4.6.0

Author:

Mitchell Herrijgers

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TracingHandlerEnhancerDefinition.Builder	Builder class to instantiate a TracingHandlerEnhancerDefinition.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TracingHandlerEnhancerDefinition(TracingHandlerEnhancerDefinition.Builder builder)	Creates a new TracingHandlerEnhancerDefinition based on the builder.

Method Summary

Modifier and Type	Method	Description
static TracingHandlerEnhancerDefinition.Builder	builder()	Instantiate a builder to create a TracingHandlerEnhancerDefinition.
<T> MessageHandlingMember<T>	wrapHandler(MessageHandlingMember<T> original)	Enhance the given original handler.

Methods inherited from class java.lang.Object

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

Constructor Details

TracingHandlerEnhancerDefinition

protected TracingHandlerEnhancerDefinition(TracingHandlerEnhancerDefinition.Builder builder)

Creates a new TracingHandlerEnhancerDefinition based on the builder.

Parameters:

builder - The builder to construct the TracingHandlerEnhancerDefinition from.

Method Details

builder

public static TracingHandlerEnhancerDefinition.Builder builder()

Instantiate a builder to create a TracingHandlerEnhancerDefinition.

The showEventSourcingHandlers is defaulted to false. The SpanFactory is a hard requirement and should be provided.

Returns:

The builder to create a TracingHandlerEnhancerDefinition.

wrapHandler

public <T> MessageHandlingMember<T> wrapHandler(@Nonnull
 MessageHandlingMember<T> original)

Description copied from interface: HandlerEnhancerDefinition

Enhance the given original handler. Implementations may return the original message handler.

Specified by:

wrapHandler in interface HandlerEnhancerDefinition

Type Parameters:

T - The type of object that will perform the actual handling of the message

Parameters:

original - The original message handler

Returns:

The enhanced message handler