org.axonframework.tracing.opentelemetry

Class OpenTelemetrySpan

java.lang.Object

org.axonframework.tracing.opentelemetry.OpenTelemetrySpan

All Implemented Interfaces:

Span

public class OpenTelemetrySpan
extends Object
implements Span

Span implementation that uses OpenTelemetry's Span to provide tracing capabilities to an application.

These traces should always be created using the OpenTelemetrySpanFactory since this will make sure the proper parent context is extracted before creating the Span.

Each start() should result in an end() being called. Only when the last end() is called will the OpenTelemetry span actually be ended. This is because Scopes that are kept active should be closed before ending the span, or memory leaks can occur. This is also the reason the scopes are kept in a Deque.

Since:

4.6.0

Author:

Mitchell Herrijgers

Constructor Summary

Constructors

Constructor and Description
OpenTelemetrySpan(io.opentelemetry.api.trace.SpanBuilder spanBuilder) Creates the span, based on the SpanBuilder provided.

Method Summary

Modifier and Type	Method and Description
void	end() Ends the span.
Span	recordException(Throwable t) Records an exception to the span.
Span	start() Starts the Span.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.tracing.Span

run, runCallable, runSupplier, wrapCallable, wrapRunnable, wrapSupplier

Constructor Detail

OpenTelemetrySpan

public OpenTelemetrySpan(io.opentelemetry.api.trace.SpanBuilder spanBuilder)

Creates the span, based on the SpanBuilder provided. This SpanBuilder will supply the Span when the start() method is invoked.

Parameters:

spanBuilder - The provider of the Span.

Method Detail

start

public Span start()

Description copied from interface: Span

Starts the Span. This means setting this span to the current, taking over from any active span currently present if so.

Specified by:

start in interface Span

Returns:

The span for fluent interfacing.

end

public void end()

Description copied from interface: Span

Ends the span. It restores the original context, often the parent trace, as the current context. No operation on the span is possible after this method.

Specified by:

end in interface Span

recordException

public Span recordException(Throwable t)

Description copied from interface: Span

Records an exception to the span. This will be reported to the APM tooling, which can show more information about the error in the trace. This method does not end the span.

Specified by:

recordException in interface Span

Parameters:

t - The exception to record

Returns:

The span for fluent interfacing.