Package org.axonframework.messaging.tracing.attributes

Class DefaultSpanAttributesProviderRegistry

java.lang.Object
org.axonframework.messaging.tracing.attributes.DefaultSpanAttributesProviderRegistry
All Implemented Interfaces:
DescribableComponent, SpanAttributesProviderRegistry
@Internal public final class DefaultSpanAttributesProviderRegistry extends Object implements SpanAttributesProviderRegistry
Default implementation of the SpanAttributesProviderRegistry, maintaining a list of SpanAttributesProvider builders resolved on providers(Configuration).

Registered as the default SpanAttributesProviderRegistry component by

invalid reference 
TracingConfigurationDefaults
.
Since:
5.3.0
Author:
Mateusz Nowak

  • Constructor Details

    • DefaultSpanAttributesProviderRegistry

      public DefaultSpanAttributesProviderRegistry()

  • Method Details

    • registerProvider

      public SpanAttributesProviderRegistry registerProvider(ComponentBuilder<SpanAttributesProvider> providerBuilder)
      Description copied from interface: SpanAttributesProviderRegistry
      Registers the given providerBuilder constructing a SpanAttributesProvider to include in the SpanFactory built from this registry.
      Specified by:
      registerProvider in interface SpanAttributesProviderRegistry
      Parameters:
      providerBuilder - the SpanAttributesProvider builder to register
      Returns:
      this SpanAttributesProviderRegistry, for fluent interfacing

    • providers

      public List<SpanAttributesProvider> providers(Configuration config)
      Description copied from interface: SpanAttributesProviderRegistry
      Returns the list of SpanAttributesProviders registered in this registry, in registration order.
      Specified by:
      providers in interface SpanAttributesProviderRegistry
      Parameters:
      config - the configuration to build all SpanAttributesProviders with
      Returns:
      the list of SpanAttributesProviders

    • describeTo

      public void describeTo(ComponentDescriptor descriptor)
      Description copied from interface: DescribableComponent
      Describe the properties of this DescribableComponent with the given descriptor.

      Components should call the appropriate describeProperty methods on the descriptor to register their properties. The descriptor is responsible for determining how these properties are formatted and structured in the final output.

      Best Practices: As a general rule, all relevant fields of a DescribableComponent implementation should be described in this method. However, developers have discretion to include only the fields that make sense in the context. Not every field may be meaningful for description purposes, especially internal implementation details. Furthermore, components might want to expose different information based on their current state. The final decision on what properties to include lies with the person implementing the describeTo method, who should focus on providing information that is useful for understanding the component's configuration and state.

      Example implementation: 

       public void describeTo(ComponentDescriptor descriptor) {
     descriptor.describeProperty("name", this.name);
     descriptor.describeProperty("enabled", this.enabled);
     descriptor.describeProperty("configuration", this.configuration); // A nested component
     descriptor.describeProperty("handlers", this.eventHandlers);      // A collection
 }
      Specified by:
      describeTo in interface DescribableComponent
      Parameters:
      descriptor - The component descriptor to describe this DescribableComponentn its properties in.