Package org.axonframework.messaging.eventhandling.tracing

Class DefaultEventProcessorSpanFactory

java.lang.Object

org.axonframework.messaging.eventhandling.tracing.DefaultEventProcessorSpanFactory

All Implemented Interfaces:

EventProcessorSpanFactory

public class DefaultEventProcessorSpanFactory
extends Object
implements EventProcessorSpanFactory

Default implementation of the EventProcessorSpanFactory.

Creates a root trace for each batch of events and a linked handler span for each event in the batch by default. This behavior can be changed by setting DefaultEventProcessorSpanFactory.Builder.disableBatchTrace(boolean) to true.

If you prefer to have asynchronously handled events in the same trace as the trace that published it, you can set DefaultEventProcessorSpanFactory.Builder.distributedInSameTrace(boolean) to true. If true, this duration defaults to 2 minutes, which you can adjust using DefaultEventProcessorSpanFactory.Builder.distributedInSameTraceTimeLimit(Duration).

Since:

4.9.0

Author:

Mitchell Herrijgers

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultEventProcessorSpanFactory(DefaultEventProcessorSpanFactory.Builder builder)	Creates a new DefaultEventProcessorSpanFactory using the provided builder.

Method Summary

Modifier and Type	Method	Description
static DefaultEventProcessorSpanFactory.Builder	builder()	Creates a new DefaultEventProcessorSpanFactory.Builder to build a DefaultEventProcessorSpanFactory with.
Span	createBatchSpan(boolean streaming, List<? extends EventMessage> eventMessages)	Creates a span for the batch of events that are handled by the event processor.
Span	createProcessEventSpan(boolean streaming, EventMessage eventMessage)	Creates a span for the handling of an event.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultEventProcessorSpanFactory

protected DefaultEventProcessorSpanFactory(DefaultEventProcessorSpanFactory.Builder builder)

Creates a new DefaultEventProcessorSpanFactory using the provided builder.

Parameters:

builder - The builder to build the DefaultEventProcessorSpanFactory from.

Method Details

builder

public static DefaultEventProcessorSpanFactory.Builder builder()

Creates a new DefaultEventProcessorSpanFactory.Builder to build a DefaultEventProcessorSpanFactory with. The default values are:

• disableBatchTrace defaults to false
• distributedInSameTrace defaults to false
• distributedInSameTraceTimeLimit defaults to 2 minutes

The spanFactory is a required field and should be provided.

Returns:

The DefaultEventProcessorSpanFactory.Builder to build a DefaultEventProcessorSpanFactory with.

createBatchSpan

public Span createBatchSpan(boolean streaming,
 List<? extends EventMessage> eventMessages)

Description copied from interface: EventProcessorSpanFactory

Creates a span for the batch of events that are handled by the event processor.

Specified by:

createBatchSpan in interface EventProcessorSpanFactory

Parameters:

streaming - Whether the event is handled by a StreamingEventProcessor.

eventMessages - The event messages that are in the batch.

Returns:

The created span.

createProcessEventSpan

public Span createProcessEventSpan(boolean streaming,
 EventMessage eventMessage)

Description copied from interface: EventProcessorSpanFactory

Creates a span for the handling of an event. This entails the entire interceptor chain and the handler.

Specified by:

createProcessEventSpan in interface EventProcessorSpanFactory

Parameters:

streaming - Whether the event is handled by a StreamingEventProcessor.

eventMessage - The event message that is handled.

Returns:

The created span.