org.apache.camel.opentracing

Interface SpanDecorator

All Known Implementing Classes:

AbstractHttpSpanDecorator, AbstractInternalSpanDecorator, AbstractMessagingSpanDecorator, AbstractSpanDecorator, AhcSpanDecorator, AmqpSpanDecorator, AwsSnsSpanDecorator, AwsSqsSpanDecorator, CometdSpanDecorator, CometdsSpanDecorator, CqlSpanDecorator, DirectSpanDecorator, DirectvmSpanDecorator, DisruptorSpanDecorator, DisruptorvmSpanDecorator, ElasticsearchSpanDecorator, HttpSpanDecorator, HttpsSpanDecorator, IronmqSpanDecorator, JdbcSpanDecorator, JettySpanDecorator, JmsSpanDecorator, KafkaSpanDecorator, LogSpanDecorator, MongoDBSpanDecorator, NatsSpanDecorator, NettyHttpSpanDecorator, NsqSpanDecorator, PahoSpanDecorator, PlatformHttpSpanDecorator, RabbitmqSpanDecorator, RestSpanDecorator, SedaSpanDecorator, ServletSpanDecorator, Sjms2SpanDecorator, SjmsSpanDecorator, SqlSpanDecorator, StompSpanDecorator, TimerSpanDecorator, UndertowSpanDecorator, VmSpanDecorator

public interface SpanDecorator

This interface represents a decorator specific to the component/endpoint being instrumented.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CAMEL_COMPONENT
static SpanDecorator	DEFAULT

Method Summary

Modifier and Type	Method and Description
String	getComponent() The camel component name associated with the decorator.
String	getComponentClassName() The camel component FQN classname associated with the decorator.
io.opentracing.propagation.TextMap	getExtractAdapter(Map<String,Object> map, boolean encoding) This method returns the map to be used for headers extraction when the component is receiving a communication.
String	getInitiatorSpanKind() This method returns the 'span.kind' value for use when the component is initiating a communication.
io.opentracing.propagation.TextMap	getInjectAdapter(Map<String,Object> map, boolean encoding) This method returns the map to be used for headers injection when the component is receiving a communication.
String	getOperationName(org.apache.camel.Exchange exchange, org.apache.camel.Endpoint endpoint) This method returns the operation name to use with the Span representing this exchange and endpoint.
String	getReceiverSpanKind() This method returns the 'span.kind' value for use when the component is receiving a communication.
boolean	newSpan() This method indicates whether the component associated with the SpanDecorator should result in a new span being created.
void	post(io.opentracing.Span span, org.apache.camel.Exchange exchange, org.apache.camel.Endpoint endpoint) This method adds appropriate details (tags/logs) to the supplied span based on the post processing of the exchange.
void	pre(io.opentracing.Span span, org.apache.camel.Exchange exchange, org.apache.camel.Endpoint endpoint) This method adds appropriate details (tags/logs) to the supplied span based on the pre processing of the exchange.

Field Detail

CAMEL_COMPONENT

static final String CAMEL_COMPONENT

See Also:

Constant Field Values

DEFAULT

static final SpanDecorator DEFAULT

Method Detail

newSpan

boolean newSpan()

This method indicates whether the component associated with the SpanDecorator should result in a new span being created.

Returns:

Whether a new span should be created

getComponent

String getComponent()

The camel component name associated with the decorator.

Returns:

The camel component name

getComponentClassName

String getComponentClassName()

The camel component FQN classname associated with the decorator.

Returns:

The camel component FQN classname

getOperationName

String getOperationName(org.apache.camel.Exchange exchange,
                        org.apache.camel.Endpoint endpoint)

This method returns the operation name to use with the Span representing this exchange and endpoint.

Parameters:

exchange - The exchange

endpoint - The endpoint

Returns:

The operation name

pre

void pre(io.opentracing.Span span,
         org.apache.camel.Exchange exchange,
         org.apache.camel.Endpoint endpoint)

This method adds appropriate details (tags/logs) to the supplied span based on the pre processing of the exchange.

Parameters:

span - The span

exchange - The exchange

endpoint - The endpoint

post

void post(io.opentracing.Span span,
          org.apache.camel.Exchange exchange,
          org.apache.camel.Endpoint endpoint)

This method adds appropriate details (tags/logs) to the supplied span based on the post processing of the exchange.

Parameters:

span - The span

exchange - The exchange

endpoint - The endpoint

getInitiatorSpanKind

String getInitiatorSpanKind()

This method returns the 'span.kind' value for use when the component is initiating a communication.

Returns:

The kind

getReceiverSpanKind

String getReceiverSpanKind()

This method returns the 'span.kind' value for use when the component is receiving a communication.

Returns:

The kind

getExtractAdapter

io.opentracing.propagation.TextMap getExtractAdapter(Map<String,Object> map,
                                                     boolean encoding)

This method returns the map to be used for headers extraction when the component is receiving a communication.

Parameters:

map - a map containing the objects

encoding - whether the headers are encoded

Returns:

The extraction map

getInjectAdapter

io.opentracing.propagation.TextMap getInjectAdapter(Map<String,Object> map,
                                                    boolean encoding)

This method returns the map to be used for headers injection when the component is receiving a communication.

Parameters:

map - a map containing the objects

encoding - whether the headers are encoded

Returns:

The injection map