public class OpenTelemetrySpanFactory extends Object implements SpanFactory
Span implementations that are compatible with OpenTelemetry java agent instrumentation. OpenTelemetry
is a standard to collect logging, tracing and metrics from applications. This SpanFactory focuses on
supporting the tracing part of the standard.
To get started with OpenTelemetry, check out their documentation. Note
that, even after configuring the correct dependencies, you still need to run the application using the OpenTelemetry
java agent to export data. Without this, it will have the same effect as the
NoOpSpanFactory since the data is not sent anywhere.
When creating a trace, the context of the current trace is used as a parent, instead of the one active at the time of
starting the span (Default OpenTelemetry behavior). This is done using SpanBuilder.setParent(Context).
| Modifier and Type | Class and Description |
|---|---|
static class |
OpenTelemetrySpanFactory.Builder
Builder class to instantiate a
OpenTelemetrySpanFactory. |
| Constructor and Description |
|---|
OpenTelemetrySpanFactory(OpenTelemetrySpanFactory.Builder builder)
Instantiate a
OpenTelemetrySpanFactory based on the fields contained in the OpenTelemetrySpanFactory.Builder. |
| Modifier and Type | Method and Description |
|---|---|
static OpenTelemetrySpanFactory.Builder |
builder()
Instantiate a Builder to create a
OpenTelemetrySpanFactory. |
Span |
createDispatchSpan(Supplier<String> operationNameSupplier,
Message<?> parentMessage,
Message<?>... linkedSiblings)
|
Span |
createHandlerSpan(Supplier<String> operationNameSupplier,
Message<?> parentMessage,
boolean isChildTrace,
Message<?>... linkedParents)
|
Span |
createInternalSpan(Supplier<String> operationNameSupplier)
Creates a new
Span linked to the currently active span. |
Span |
createInternalSpan(Supplier<String> operationNameSupplier,
Message<?> message)
Creates a new
Span linked to the currently active span. |
Span |
createRootTrace(Supplier<String> operationNameSupplier)
Creates a new
Span without any parent trace. |
<M extends Message<?>> |
propagateContext(M message)
Propagates the currently active trace and span to the message.
|
void |
registerSpanAttributeProvider(SpanAttributesProvider provider)
Registers an additional
SpanAttributesProvider to the factory. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateChildHandlerSpan, createLinkedHandlerSpanpublic OpenTelemetrySpanFactory(OpenTelemetrySpanFactory.Builder builder)
OpenTelemetrySpanFactory based on the fields contained in the OpenTelemetrySpanFactory.Builder.builder - the OpenTelemetrySpanFactory.Builder used to instantiate a OpenTelemetrySpanFactory instance.public static OpenTelemetrySpanFactory.Builder builder()
OpenTelemetrySpanFactory.
The SpanAttributeProvieders are defaulted to an empty list, and the Tracer
is defaulted to the tracer defined by GlobalOpenTelemetry.
OpenTelemetrySpanFactory.public <M extends Message<?>> M propagateContext(M message)
SpanFactorySpanFactory.createLinkedHandlerSpan(Supplier, Message, Message[]) method. The most efficient method
currently known is to enhance the message's metadata.
Since messages are immutable, the method returns the enhanced message. This enhanced message should be used during dispatch instead of the original message.
propagateContext in interface SpanFactoryM - The message's type.message - The message to enhance.public Span createRootTrace(Supplier<String> operationNameSupplier)
SpanFactorySpan without any parent trace. This should be used for logical start point of asynchronous
calls that are not related to a message. For example snapshotting an aggregate.
In monitoring systems, this Span will be the root of the trace.
createRootTrace in interface SpanFactoryoperationNameSupplier - Supplier of the operation's name.Span.public Span createHandlerSpan(Supplier<String> operationNameSupplier, Message<?> parentMessage, boolean isChildTrace, Message<?>... linkedParents)
SpanFactorySpan linked to asynchronously handling a Message, for example when handling a
command from Axon Server. The message attributes will be added to the span, based on the provided
SpanAttributesProviders for additional debug information.
In monitoring systems, this Span will be the root of the trace.
The message's name will be concatenated with the operationName, see
SpanUtils.determineMessageName(Message).
createHandlerSpan in interface SpanFactoryoperationNameSupplier - Supplier of the operation's name.parentMessage - The message that is being handled.isChildTrace - Whether to force the span to be a part of the current trace. This means not linking, but
setting a parent.linkedParents - Optional parameter, providing this will link the provided message(s) to the current, in
addition to the original.Span.public Span createDispatchSpan(Supplier<String> operationNameSupplier, Message<?> parentMessage, Message<?>... linkedSiblings)
SpanFactorySpan linked to dispatching a Message, for example when sending a command to Axon
Server. The message attributes will be added to the span, based on the provided
SpanAttributesProviders for additional debug information.
In monitoring systems, this Span will be part of another trace.
Before asynchronously dispatching a message, add the tracing context to the message, using
SpanFactory.propagateContext(Message) to the message's metadata.
The message's name will be concatenated with the operationName, see
SpanUtils.determineMessageName(Message).
createDispatchSpan in interface SpanFactoryoperationNameSupplier - Supplier of the operation's name.parentMessage - The message that is being handled.linkedSiblings - Optional parameter, providing this will link the provided messages to the current.Span.public Span createInternalSpan(Supplier<String> operationNameSupplier)
SpanFactorySpan linked to the currently active span. This is useful for tracing different parts of
framework logic, so we can time what has the most impact.
In monitoring systems, this Span will be part of another trace.
createInternalSpan in interface SpanFactoryoperationNameSupplier - Supplier of the operation's name.Span.public Span createInternalSpan(Supplier<String> operationNameSupplier, Message<?> message)
SpanFactorySpan linked to the currently active span. This is useful for tracing different parts of
framework logic, so we can time what has the most impact.
The message supplied is used to provide a clearer name, based on SpanUtils.determineMessageName(Message),
and to add the message's attributes to the span.
In monitoring systems, this Span will be part of another trace.
createInternalSpan in interface SpanFactoryoperationNameSupplier - Supplier of the operation's name.Span.public void registerSpanAttributeProvider(SpanAttributesProvider provider)
SpanFactorySpanAttributesProvider to the factory.registerSpanAttributeProvider in interface SpanFactoryprovider - The provider to add.Copyright © 2010–2023. All rights reserved.