Package org.axonframework.messaging.tracing.attributes

Class AggregateIdentifierSpanAttributesProvider

java.lang.Object

org.axonframework.messaging.tracing.attributes.AggregateIdentifierSpanAttributesProvider

All Implemented Interfaces:

SpanAttributesProvider

public final class AggregateIdentifierSpanAttributesProvider
extends Object
implements SpanAttributesProvider

Adds the aggregate identifier to the span when one is available on the ProcessingContext via LegacyResources.AGGREGATE_IDENTIFIER_KEY. By default the attribute key is DEFAULT_ATTRIBUTE_KEY (axoniq.aggregate.identifier); a different key can be supplied through the constructor.

This is best-effort: the attribute is present only when a legacy aggregate-based event storage engine populated the resource. It is absent for dynamic-consistency-boundary / entity-based operations and whenever no context is available.

Legacy-only. This provider is exclusively for events produced by a legacy, aggregate-based event store. For dynamic-consistency-boundary events, tags are recorded by the axon-eventsourcing module's EventTagsSpanAttributesProvider instead.

Since:

4.6.0

Author:

Mateusz Nowak, Mitchell Herrijgers

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ATTRIBUTE_KEY	Default attribute key under which the aggregate identifier is recorded.

Constructor Summary

Constructors

Constructor	Description
AggregateIdentifierSpanAttributesProvider()	Creates a provider recording the aggregate identifier under the default DEFAULT_ATTRIBUTE_KEY key.
AggregateIdentifierSpanAttributesProvider(String attributeKey)	Creates a provider recording the aggregate identifier under the given attributeKey.

Method Summary

Modifier and Type	Method	Description
Map<String,String>	provideForMessage(Message message, @Nullable ProcessingContext context)	Provides the attributes this provider contributes for the given message and optional context.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_ATTRIBUTE_KEY

public static final String DEFAULT_ATTRIBUTE_KEY

Default attribute key under which the aggregate identifier is recorded.

See Also:

• Constant Field Values

Constructor Details

AggregateIdentifierSpanAttributesProvider

public AggregateIdentifierSpanAttributesProvider()

Creates a provider recording the aggregate identifier under the default DEFAULT_ATTRIBUTE_KEY key.

AggregateIdentifierSpanAttributesProvider

public AggregateIdentifierSpanAttributesProvider(String attributeKey)

Creates a provider recording the aggregate identifier under the given attributeKey.

Parameters:

attributeKey - the span attribute key to record the aggregate identifier under

Method Details

provideForMessage

public Map<String,String> provideForMessage(Message message,
 @Nullable ProcessingContext context)

Description copied from interface: SpanAttributesProvider

Provides the attributes this provider contributes for the given message and optional context.

Specified by:

provideForMessage in interface SpanAttributesProvider

Parameters:

message - the message the span is created for

context - the active processing context, or null when none is available

Returns:

the attributes to add to the span; an empty map when this provider contributes nothing