com.avioconsulting.mule.opentelemetry.internal.store

Class InMemoryTransactionStore

java.lang.Object

com.avioconsulting.mule.opentelemetry.internal.store.InMemoryTransactionStore

All Implemented Interfaces:

TransactionStore

public class InMemoryTransactionStore
extends Object
implements TransactionStore

In-memory TransactionStore. This implementation uses in-memory Map to store transactions and related processor spans. Transactions are kept in memory until they end.

Field Summary

Fields inherited from interface com.avioconsulting.mule.opentelemetry.api.store.TransactionStore

OTEL_FLOW_CONTEXT_ID, OTEL_FLOW_PREV_CONTEXT_ID, SPAN_ID, TRACE_CONTEXT_MAP_KEY, TRACE_ID, TRACE_PREV_CONTEXT_MAP_KEY, TRACE_TRANSACTION_ID

Constructor Summary

Constructors

Constructor and Description
InMemoryTransactionStore()

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.
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.
static TransactionStore	getInstance()
String	getTraceIdForTransaction(String transactionId)
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 rootFlowSpanBuilder) Start a new transaction.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.avioconsulting.mule.opentelemetry.api.store.TransactionStore

endProcessorSpan, transactionIdFor

Constructor Detail

InMemoryTransactionStore

public InMemoryTransactionStore()

Method Detail

getInstance

public static TransactionStore getInstance()

startTransaction

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

Description copied from interface: TransactionStore

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.

Specified by:

startTransaction in interface TransactionStore

Parameters:

traceComponent - TraceComponent with tracing information

rootFlowName - Name of the flow requesting to start transaction.

rootFlowSpanBuilder - SpanBuilder for building the root span.

addTransactionTags

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

Description copied from interface: TransactionStore

Add custom tags to an existing transaction.

Specified by:

addTransactionTags in interface TransactionStore

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

public TransactionContext getTransactionContext(String transactionId,
                                                String componentLocation)

Description copied from interface: TransactionStore

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

Specified by:

getTransactionContext in interface TransactionStore

Parameters:

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

componentLocation - ComponentLocation

Returns:

Context

getTraceIdForTransaction

public String getTraceIdForTransaction(String transactionId)

endTransaction

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

Description copied from interface: TransactionStore

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()); } });

Specified by:

endTransaction in interface TransactionStore

Parameters:

traceComponent - String

spanUpdater - Consumer to allow updating transaction span before ending.

addProcessorSpan

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

Description copied from interface: TransactionStore

Add a new processor span under an existing transaction.

Specified by:

addProcessorSpan in interface TransactionStore

Parameters:

containerName - String such as Flow name that contains requested location

traceComponent - TraceComponent for span

spanBuilder - SpanBuilder

endProcessorSpan

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

Description copied from interface: TransactionStore

This overloading allows to end a span at given time.

Specified by:

endProcessorSpan in interface TransactionStore

Parameters:

transactionId - String

traceComponent - TraceComponent

spanUpdater - Consumer to allow updating Span before ending.

endTime - Instant of span end

Returns:

SpanMeta