com.avioconsulting.mule.opentelemetry.api.store

Interface TransactionStore

All Known Implementing Classes:

InMemoryTransactionStore

public interface TransactionStore

Transaction store for managing service transactions.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OTEL_FLOW_CONTEXT_ID
static String	OTEL_FLOW_PREV_CONTEXT_ID
static String	SPAN_ID
static String	TRACE_CONTEXT_MAP_KEY
static String	TRACE_ID
static String	TRACE_PREV_CONTEXT_MAP_KEY
static String	TRACE_TRANSACTION_ID

Method Summary

Modifier and Type	Method and Description
SpanMeta	addProcessorSpan(String containerName, TraceComponent traceComponent, io.opentelemetry.api.trace.SpanBuilder spanBuilder) Add a new processor span under an existing transaction.
void	addTransactionTags(String transactionId, String tagPrefix, Map<String,String> tags) Add custom tags to an existing transaction.
default SpanMeta	endProcessorSpan(String transactionId, TraceComponent traceComponent, Consumer<io.opentelemetry.api.trace.Span> spanUpdater) End an existing span under an existing transaction.
SpanMeta	endProcessorSpan(String transactionId, TraceComponent traceComponent, Consumer<io.opentelemetry.api.trace.Span> spanUpdater, Instant endTime) This overloading allows to end a span at given time.
TransactionMeta	endTransaction(TraceComponent traceComponent, Consumer<io.opentelemetry.api.trace.Span> spanUpdater) End a transaction represented by provided transaction id and rootFlowName, if exists.
TransactionContext	getTransactionContext(String transactionId, String componentLocation) Get the Context of the initiating flow span.
void	startTransaction(TraceComponent traceComponent, String rootFlowName, io.opentelemetry.api.trace.SpanBuilder rootFlowSpan) Start a new transaction.
default String	transactionIdFor(org.mule.runtime.api.event.Event muleEvent) A default implementation to get a mule correlation id as a local transaction id.

Field Detail

TRACE_TRANSACTION_ID

static final String TRACE_TRANSACTION_ID

See Also:

Constant Field Values

TRACE_CONTEXT_MAP_KEY

static final String TRACE_CONTEXT_MAP_KEY

See Also:

Constant Field Values

TRACE_PREV_CONTEXT_MAP_KEY

static final String TRACE_PREV_CONTEXT_MAP_KEY

See Also:

Constant Field Values

TRACE_ID

static final String TRACE_ID

See Also:

Constant Field Values

SPAN_ID

static final String SPAN_ID

See Also:

Constant Field Values

OTEL_FLOW_CONTEXT_ID

static final String OTEL_FLOW_CONTEXT_ID

See Also:

Constant Field Values

OTEL_FLOW_PREV_CONTEXT_ID

static final String OTEL_FLOW_PREV_CONTEXT_ID

See Also:

Constant Field Values

Method Detail

transactionIdFor

default String transactionIdFor(org.mule.runtime.api.event.Event muleEvent)

A default implementation to get a mule correlation id as a local transaction id.

Parameters:

muleEvent - Event

Returns:

String transaction id

startTransaction

void startTransaction(TraceComponent traceComponent,
                      String rootFlowName,
                      io.opentelemetry.api.trace.SpanBuilder rootFlowSpan)

Start a new transaction. This usually happens when a new source flow starts. If the transaction with `transactionId` already exists but for different rootFlowName, then it is possible that new rootFlowSpan is a child flow invocation. In that case, span may be added to an existing transaction as a span.

Parameters:

traceComponent - TraceComponent with tracing information

rootFlowName - Name of the flow requesting to start transaction.

rootFlowSpan - SpanBuilder for building the root span.

addTransactionTags

void addTransactionTags(String transactionId,
                        String tagPrefix,
                        Map<String,String> tags)

Add custom tags to an existing transaction.

Parameters:

transactionId - A unique transaction id within the context of an application. Eg. Correlation id.

tagPrefix - String

tags - Map of String Keys and String Values containing the tags.

getTransactionContext

TransactionContext getTransactionContext(String transactionId,
                                         String componentLocation)

Get the Context of the initiating flow span. This may be required to propagate context for a given transaction.

Parameters:

transactionId - A unique transaction id within the context of an application. Eg. Correlation id.

componentLocation - ComponentLocation

Returns:

Context

endTransaction

TransactionMeta endTransaction(TraceComponent traceComponent,
                               Consumer<io.opentelemetry.api.trace.Span> spanUpdater)

End a transaction represented by provided transaction id and rootFlowName, if exists. Consumer parameter allows updating the Span before ending. This is useful in scenarios like setting processing status code to error.

Here is an example of setting Error when processor execution fails. transactionStore.endTransaction(traceComponent.getTransactionId(), traceComponent.getName(), rootSpan -> { if(notification.getException() != null) { rootSpan.setStatus(StatusCode.ERROR, notification.getException().getMessage()); rootSpan.recordException(notification.getException()); } });

Parameters:

traceComponent - String

spanUpdater - Consumer to allow updating transaction span before ending.

addProcessorSpan

SpanMeta addProcessorSpan(String containerName,
                          TraceComponent traceComponent,
                          io.opentelemetry.api.trace.SpanBuilder spanBuilder)

Add a new processor span under an existing transaction.

Parameters:

containerName - String such as Flow name that contains requested location

traceComponent - TraceComponent for span

spanBuilder - SpanBuilder

endProcessorSpan

default SpanMeta endProcessorSpan(String transactionId,
                                  TraceComponent traceComponent,
                                  Consumer<io.opentelemetry.api.trace.Span> spanUpdater)

End an existing span under an existing transaction. Consumer parameter allows updating the Span before ending. This is useful in scenarios like setting processing status code to error.

Here is an example of setting Error when processor execution fails. transactionStore.endProcessorSpan(traceComponent.getTransactionId(), traceComponent.getLocation(), s -> { if(notification.getEvent().getError().isPresent()) { Error error = notification.getEvent().getError().get(); s.setStatus(StatusCode.ERROR, error.getDescription()); s.recordException(error.getCause()); } });

Parameters:

transactionId - String

traceComponent - TraceComponent

spanUpdater - Consumer to allow updating Span before ending.

endProcessorSpan

SpanMeta endProcessorSpan(String transactionId,
                          TraceComponent traceComponent,
                          Consumer<io.opentelemetry.api.trace.Span> spanUpdater,
                          Instant endTime)

This overloading allows to end a span at given time.

Parameters:

transactionId - String

traceComponent - TraceComponent

spanUpdater - Consumer to allow updating Span before ending.

endTime - Instant of span end

Returns:

SpanMeta