Package org.axonframework.springboot

Class TracingProperties

java.lang.Object

org.axonframework.springboot.TracingProperties

@ConfigurationProperties("axon.tracing")
public class TracingProperties
extends Object

Properties describing the settings for tracing.

Since:

4.6.0

Author:

Mitchell Herrijgers

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TracingProperties.AttributeProviders	Defines which SpanAttributesProviders are enabled.
static class	TracingProperties.CommandBusProperties	Configuration properties for the behavior of creating tracing spans for the CommandBus.
static class	TracingProperties.DeadlineManagerProperties	Configuration properties for the behavior of creating tracing spans for the DeadlineManager.
static class	TracingProperties.EventProcessorProperties	Configuration properties for the behavior of creating tracing spans for the EventProcessor implementations.
static class	TracingProperties.QueryBusProperties	Configuration properties for the behavior of creating tracing spans for the QueryBus.
static class	TracingProperties.RepositoryProperties	Configuration properties for the behavior of creating tracing spans for the Repository.
static class	TracingProperties.SagaManagerProperties	Configuration properties for the behavior of creating tracing spans for the AbstractSagaManager.
static class	TracingProperties.SnapshotterProperties	Configuration properties for the behavior of creating tracing spans for the Snapshotter.

Constructor Summary

Constructors

Constructor	Description
TracingProperties()

Method Summary

Modifier and Type	Method	Description
TracingProperties.AttributeProviders	getAttributeProviders()	The value for which SpanAttributesProviders are enabled.
TracingProperties.CommandBusProperties	getCommandBus()	Returns the properties describing the tracing settings for the CommandBus.
TracingProperties.DeadlineManagerProperties	getDeadlineManager()	Returns the properties describing the tracing settings for the DeadlineManager.
TracingProperties.EventProcessorProperties	getEventProcessor()	Returns the properties describing the tracing settings for the EventProcessor.
Duration	getNestedTimeLimit()	Deprecated. Use TracingProperties.EventProcessorProperties.getDistributedInSameTraceTimeLimit() instead.
TracingProperties.QueryBusProperties	getQueryBus()	Returns the properties describing the tracing settings for the QueryBus.
TracingProperties.RepositoryProperties	getRepository()	Returns the properties describing the tracing settings for the Repository.
TracingProperties.SagaManagerProperties	getSagaManager()	Returns the properties describing the tracing settings for the AbstractSagaManager.
TracingProperties.SnapshotterProperties	getSnapshotter()	Returns the properties describing the tracing settings for the Snapshotter.
boolean	isNestedHandlers()	Deprecated. Use TracingProperties.EventProcessorProperties.isDistributedInSameTrace() instead.
boolean	isShowEventSourcingHandlers()	Getting value for showing event sourcing handlers in traces.
void	setAttributeProviders(TracingProperties.AttributeProviders attributeProviders)	Sets the value for which SpanAttributesProviders are enabled.
void	setCommandBus(TracingProperties.CommandBusProperties commandBus)	Sets the properties describing the tracing settings for the CommandBus.
void	setDeadlineManager(TracingProperties.DeadlineManagerProperties deadlineManager)	Sets the properties describing the tracing settings for the DeadlineManager.
void	setEventProcessor(TracingProperties.EventProcessorProperties eventProcessor)	Sets the properties describing the tracing settings for the EventProcessor.
void	setNestedHandlers(boolean nestedHandlers)	Deprecated. Use TracingProperties.EventProcessorProperties.setDisableBatchTrace(boolean) instead.
void	setNestedTimeLimit(Duration nestedTimeLimit)	Deprecated. Use TracingProperties.EventProcessorProperties.setDistributedInSameTraceTimeLimit(Duration) instead.
void	setQueryBus(TracingProperties.QueryBusProperties queryBus)	Sets the properties describing the tracing settings for the QueryBus.
void	setRepository(TracingProperties.RepositoryProperties repository)	Sets the properties describing the tracing settings for the Repository.
void	setSagaManager(TracingProperties.SagaManagerProperties sagaManager)	Sets the properties describing the tracing settings for the AbstractSagaManager.
void	setShowEventSourcingHandlers(boolean showEventSourcingHandlers)	Setting value for showing event sourcing handlers in traces.
void	setSnapshotter(TracingProperties.SnapshotterProperties snapshotter)	Sets the properties describing the tracing settings for the Snapshotter.

Methods inherited from class java.lang.Object

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

Constructor Details

TracingProperties

public TracingProperties()

Method Details

getSnapshotter

public TracingProperties.SnapshotterProperties getSnapshotter()

Returns the properties describing the tracing settings for the Snapshotter.

Returns:

the properties describing the tracing settings for the Snapshotter.

setSnapshotter

public void setSnapshotter(TracingProperties.SnapshotterProperties snapshotter)

Sets the properties describing the tracing settings for the Snapshotter.

Parameters:

snapshotter - the properties describing the tracing settings for the Snapshotter.

getCommandBus

public TracingProperties.CommandBusProperties getCommandBus()

Returns the properties describing the tracing settings for the CommandBus.

Returns:

The properties describing the tracing settings for the CommandBus.

setCommandBus

public void setCommandBus(TracingProperties.CommandBusProperties commandBus)

Sets the properties describing the tracing settings for the CommandBus.

Parameters:

commandBus - The properties describing the tracing settings for the CommandBus.

getQueryBus

public TracingProperties.QueryBusProperties getQueryBus()

Returns the properties describing the tracing settings for the QueryBus.

Returns:

the properties describing the tracing settings for the QueryBus.

setQueryBus

public void setQueryBus(TracingProperties.QueryBusProperties queryBus)

Sets the properties describing the tracing settings for the QueryBus.

Parameters:

queryBus - the properties describing the tracing settings for the QueryBus.

getDeadlineManager

public TracingProperties.DeadlineManagerProperties getDeadlineManager()

Returns the properties describing the tracing settings for the DeadlineManager.

Returns:

the properties describing the tracing settings for the DeadlineManager.

setDeadlineManager

public void setDeadlineManager(TracingProperties.DeadlineManagerProperties deadlineManager)

Sets the properties describing the tracing settings for the DeadlineManager.

Parameters:

deadlineManager - the properties describing the tracing settings for the DeadlineManager.

getSagaManager

public TracingProperties.SagaManagerProperties getSagaManager()

Returns the properties describing the tracing settings for the AbstractSagaManager.

Returns:

the properties describing the tracing settings for the AbstractSagaManager.

setSagaManager

public void setSagaManager(TracingProperties.SagaManagerProperties sagaManager)

Sets the properties describing the tracing settings for the AbstractSagaManager.

Parameters:

sagaManager - the properties describing the tracing settings for the AbstractSagaManager.

getRepository

public TracingProperties.RepositoryProperties getRepository()

Returns the properties describing the tracing settings for the Repository.

Returns:

the properties describing the tracing settings for the Repository.

setRepository

public void setRepository(TracingProperties.RepositoryProperties repository)

Sets the properties describing the tracing settings for the Repository.

Parameters:

repository - the properties describing the tracing settings for the Repository.

getEventProcessor

public TracingProperties.EventProcessorProperties getEventProcessor()

Returns the properties describing the tracing settings for the EventProcessor.

Returns:

The properties describing the tracing settings for the EventProcessor.

setEventProcessor

public void setEventProcessor(TracingProperties.EventProcessorProperties eventProcessor)

Sets the properties describing the tracing settings for the EventProcessor.

Parameters:

eventProcessor - The properties describing the tracing settings for the EventProcessor.

isShowEventSourcingHandlers

public boolean isShowEventSourcingHandlers()

Getting value for showing event sourcing handlers in traces.

Returns:

Whether event sourcing handlers should show up on traces.

setShowEventSourcingHandlers

public void setShowEventSourcingHandlers(boolean showEventSourcingHandlers)

Setting value for showing event sourcing handlers in traces.

Parameters:

showEventSourcingHandlers - The new value for showing event sourcing handlers.

isNestedHandlers

@Deprecated
public boolean isNestedHandlers()

Deprecated.

Use TracingProperties.EventProcessorProperties.isDistributedInSameTrace() instead.

Getting value for nesting handlers in dispatching traces.

Returns:

Whether handlers should be nested in dispatching traces

setNestedHandlers

@Deprecated
public void setNestedHandlers(boolean nestedHandlers)

Deprecated.

Use TracingProperties.EventProcessorProperties.setDisableBatchTrace(boolean) instead.

Setting value for nesting handlers in dispatching traces.

Parameters:

nestedHandlers - The new value for nesting handlers in dispatching trace.

getNestedTimeLimit

@Deprecated
public Duration getNestedTimeLimit()

Deprecated.

Use TracingProperties.EventProcessorProperties.getDistributedInSameTraceTimeLimit() instead.

The time limit set on nested handlers inside dispatching trace. Only affects events and deadlines, other messages are always nested.

Returns:

For how long event messages should be nested in their dispatching trace.

setNestedTimeLimit

@Deprecated
public void setNestedTimeLimit(Duration nestedTimeLimit)

Deprecated.

Use TracingProperties.EventProcessorProperties.setDistributedInSameTraceTimeLimit(Duration) instead.

Sets the value for the time limit set on nested handlers inside dispatching trace. Only affects events. Commands and queries are always nested.

getAttributeProviders

public TracingProperties.AttributeProviders getAttributeProviders()

The value for which SpanAttributesProviders are enabled.

Returns:

The TracingProperties.AttributeProviders value.

setAttributeProviders

public void setAttributeProviders(TracingProperties.AttributeProviders attributeProviders)

Sets the value for which SpanAttributesProviders are enabled.

Parameters:

attributeProviders - The new list of SpanAttributesProviders.