org.mule.runtime.tracer.api.span.exporter

Interface SpanExporter

public interface SpanExporter

An exporter for InternalSpan.

Since:

4.5.0

Field Summary

Fields

Modifier and Type	Field and Description
static SpanExporter	NOOP_EXPORTER

Method Summary

Modifier and Type	Method and Description
void	export() Exports the InternalSpan.
Map<String,String>	exportedSpanAsMap()
InternalSpan	getInternalSpan()
default void	onAdditionalAttribute(String key, String value) Operation to do when an attribute is added.
default void	onError(InternalSpanError error) Operation to do when an attribute an error occurs.
default void	setRootAttribute(String rootAttributeKey, String rootAttributeValue) Sets a root attribute in the local trace for the exporter.
default void	setRootName(String rootName) Sets the root name in the local trace for the exporter.
default void	updateChildSpanExporter(SpanExporter childSpanExporter) Updates the exporter of a child InternalSpan.
void	updateNameForExport(String newName) Indicates that the span should be exported using a new name.
default void	updateParentSpanFrom(Map<String,String> spanSerializedAsMap) Updates parent span from a map

Field Detail

NOOP_EXPORTER

static final SpanExporter NOOP_EXPORTER

Method Detail

export

void export()

Exports the InternalSpan.

updateNameForExport

void updateNameForExport(String newName)

Indicates that the span should be exported using a new name.

Parameters:

newName - the new name.

exportedSpanAsMap

Map<String,String> exportedSpanAsMap()

Returns:

the exported span as a map.

updateChildSpanExporter

default void updateChildSpanExporter(SpanExporter childSpanExporter)

Updates the exporter of a child InternalSpan.

Parameters:

childSpanExporter - the child InternalSpan exporter.

getInternalSpan

InternalSpan getInternalSpan()

Returns:

the InternalSpan to export.

setRootAttribute

default void setRootAttribute(String rootAttributeKey,
                              String rootAttributeValue)

Sets a root attribute in the local trace for the exporter. 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.

setRootName

default void setRootName(String rootName)

Sets the root name in the local trace for the exporter. 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.

onAdditionalAttribute

default void onAdditionalAttribute(String key,
                                   String value)

Operation to do when an attribute is added.

Parameters:

key - the key for the new attribute added

value - the value for the attribute

onError

default void onError(InternalSpanError error)

Operation to do when an attribute an error occurs.

Parameters:

error - the error.

updateParentSpanFrom

default void updateParentSpanFrom(Map<String,String> spanSerializedAsMap)

Updates parent span from a map

Parameters:

spanSerializedAsMap - the serialization map that represents the span in W3C format.