org.mule.runtime.tracer.api.span

Interface InternalSpan

All Superinterfaces:

org.mule.runtime.api.profiling.tracing.Span

All Known Implementing Classes:

InternalSpan.SpanInternalWrapper

public interface InternalSpan
extends org.mule.runtime.api.profiling.tracing.Span

A InternalSpan used internally by the runtime. It defines an extension of the span contract that is only used internally.

Since:

4.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	InternalSpan.SpanInternalWrapper A wrapper as InternalSpan for other type of Span

Method Summary

Modifier and Type	Method and Description
default void	addAttribute(String key, String value) Add an attribute
void	addError(InternalSpanError error) Adds to the Span the provided InternalSpanError.
void	end() Ends the span.
void	forEachAttribute(BiConsumer<String,String> biConsumer) Performs the operation on each key/value
static InternalSpan	getAsInternalSpan(org.mule.runtime.api.profiling.tracing.Span span)
int	getAttributesCount()
SpanExporter	getSpanExporter() Gets the span exporter
Map<String,String>	serializeAsMap() Serializes the span as a map.
default void	setRootAttribute(String rootAttributeKey, String rootAttributeValue) Sets a root attribute in the local trace for InternalSpan This is useful in case a root element sets an attribute for the flow, and it has to be propagated to the flow span.
default void	updateChildSpanExporter(InternalSpan childInternalSpan) Updates the child InternalSpan.
void	updateName(String name) Updates the name for the current InternalSpan
default void	updateRootName(String rootName) Sets the root name in the local trace for the InternalSpan.

Methods inherited from interface org.mule.runtime.api.profiling.tracing.Span

getDuration, getErrors, getIdentifier, getName, getParent, hasErrors

Method Detail

end

void end()

Ends the span.

addError

void addError(InternalSpanError error)

Adds to the Span the provided InternalSpanError.

Parameters:

error - Error that will be added to the Span.

addAttribute

default void addAttribute(String key,
                          String value)

Add an attribute

Parameters:

key - key for the attribute

value - the value for the attribute added

getAsInternalSpan

static InternalSpan getAsInternalSpan(org.mule.runtime.api.profiling.tracing.Span span)

Parameters:

span - the Span

Returns:

the span as internal.

updateName

void updateName(String name)

Updates the name for the current InternalSpan

Parameters:

name - the name to set to the current span.

getSpanExporter

SpanExporter getSpanExporter()

Gets the span exporter

Returns:

the span exporter.

updateChildSpanExporter

default void updateChildSpanExporter(InternalSpan childInternalSpan)

Updates the child InternalSpan.

Parameters:

childInternalSpan - the child InternalSpan.

forEachAttribute

void forEachAttribute(BiConsumer<String,String> biConsumer)

Performs the operation on each key/value

Parameters:

biConsumer - the operation to apply.

serializeAsMap

Map<String,String> serializeAsMap()

Serializes the span as a map.

Returns:

the serialized span.

updateRootName

default void updateRootName(String rootName)

Sets the root name in the local trace for the InternalSpan. This is useful in case a root element sets a name for the flow, and it has to be propagated to the flow span. This propagation is needed, for example, if a source sets a name for complying with semantic conventions for the flow and there is a policy applied to the source.

Parameters:

rootName - the root name.

setRootAttribute

default void setRootAttribute(String rootAttributeKey,
                              String rootAttributeValue)

Sets a root attribute in the local trace for InternalSpan This is useful in case a root element sets an attribute for the flow, and it has to be propagated to the flow span. This propagation is needed, for example, if a source sets a name for complying with semantic conventions for the flow and there is a policy applied to the source.

Parameters:

rootAttributeKey - the key for root attribute.

rootAttributeValue - the value for the root attribute.

getAttributesCount

int getAttributesCount()

Returns:

the attributes count.