Package org.axonframework.messaging.queryhandling.tracing

Class DefaultQueryBusSpanFactory

java.lang.Object

org.axonframework.messaging.queryhandling.tracing.DefaultQueryBusSpanFactory

All Implemented Interfaces:

QueryBusSpanFactory

public class DefaultQueryBusSpanFactory
extends Object
implements QueryBusSpanFactory

Default implementation of the QueryBusSpanFactory. Can be configured to include the query handling of a distributed query in the same trace or not (true by default).

Since:

4.9.0

Author:

Mitchell Herrijgers

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static DefaultQueryBusSpanFactory.Builder	builder()	Creates a Builder to be able to create a DefaultQueryBusSpanFactory.
Span	createQueryProcessingSpan(QueryMessage queryMessage)	Creates a span for processing a query.
Span	createQuerySpan(QueryMessage queryMessage, boolean distributed)	Creates a span for a query.
Span	createResponseProcessingSpan(QueryMessage queryMessage)	Creates a span for processing a response.
Span	createStreamingQuerySpan(QueryMessage queryMessage, boolean distributed)	Creates a span for a streaming query.
Span	createSubscriptionQueryProcessUpdateSpan(SubscriptionQueryUpdateMessage updateMessage, QueryMessage queryMessage)	Creates a span for processing a subscription query update that has been received from the server.
Span	createSubscriptionQuerySpan(QueryMessage queryMessage, boolean distributed)	Creates a span for a subscription query.
<M extends QueryMessage> M	propagateContext(M queryMessage)	Propagates the context of the current span to the given queryMessage.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultQueryBusSpanFactory

protected DefaultQueryBusSpanFactory(DefaultQueryBusSpanFactory.Builder builder)

Creates a new DefaultQueryBusSpanFactory using the provided builder.

Parameters:

builder - The builder to build the DefaultQueryBusSpanFactory from.

Method Details

createQuerySpan

public Span createQuerySpan(QueryMessage queryMessage,
 boolean distributed)

Description copied from interface: QueryBusSpanFactory

Creates a span for a query.

Specified by:

createQuerySpan in interface QueryBusSpanFactory

Parameters:

queryMessage - The query message being dispatched.

distributed - Whether the query is from a distributed source.

Returns:

The span for the handling of the query.

createSubscriptionQuerySpan

public Span createSubscriptionQuerySpan(QueryMessage queryMessage,
 boolean distributed)

Description copied from interface: QueryBusSpanFactory

Creates a span for a subscription query.

Specified by:

createSubscriptionQuerySpan in interface QueryBusSpanFactory

Parameters:

queryMessage - The subscription query message being dispatched.

distributed - Whether the subscription query is from a distributed source.

Returns:

The span for the handling of the subscription query.

createSubscriptionQueryProcessUpdateSpan

public Span createSubscriptionQueryProcessUpdateSpan(SubscriptionQueryUpdateMessage updateMessage,
 QueryMessage queryMessage)

Description copied from interface: QueryBusSpanFactory

Creates a span for processing a subscription query update that has been received from the server.

Specified by:

createSubscriptionQueryProcessUpdateSpan in interface QueryBusSpanFactory

Parameters:

updateMessage - The update message being handled.

queryMessage - The subscription query message that the update is for.

Returns:

The span for the processing of the subscription query update.

createStreamingQuerySpan

public Span createStreamingQuerySpan(QueryMessage queryMessage,
 boolean distributed)

Description copied from interface: QueryBusSpanFactory

Creates a span for a streaming query.

Specified by:

createStreamingQuerySpan in interface QueryBusSpanFactory

Parameters:

queryMessage - The query message being dispatched.

distributed - Whether the query is from a distributed source.

Returns:

The span for the handling of the streaming query.

createQueryProcessingSpan

public Span createQueryProcessingSpan(QueryMessage queryMessage)

Description copied from interface: QueryBusSpanFactory

Creates a span for processing a query. Distributed implementations can use this to create a span for the entire query processing on the handling side.

Specified by:

createQueryProcessingSpan in interface QueryBusSpanFactory

Parameters:

queryMessage - The query message being handled.

Returns:

The span for the processing of the query.

createResponseProcessingSpan

public Span createResponseProcessingSpan(QueryMessage queryMessage)

Description copied from interface: QueryBusSpanFactory

Creates a span for processing a response. Distributed implementations can use this to create a span for the entire response processing on the sending side.

Specified by:

createResponseProcessingSpan in interface QueryBusSpanFactory

Parameters:

queryMessage - The query message the response is for.

Returns:

The span for the processing of the response.

propagateContext

public <M extends QueryMessage> M propagateContext(M queryMessage)

Description copied from interface: QueryBusSpanFactory

Propagates the context of the current span to the given queryMessage.

Specified by:

propagateContext in interface QueryBusSpanFactory

Type Parameters:

M - The type of the query message.

Parameters:

queryMessage - The query message to propagate the context to.

Returns:

The query message with the context of the current span.

builder

public static DefaultQueryBusSpanFactory.Builder builder()

Creates a Builder to be able to create a DefaultQueryBusSpanFactory. The default values are:

• distributedInSameTrace defaults to true

The spanFactory is a required field and should be provided.

Returns:

a Builder to be able to create a DefaultQueryBusSpanFactory