org.apache.camel.opentracing.decorators

Class AbstractMessagingSpanDecorator

java.lang.Object

org.apache.camel.opentracing.decorators.AbstractSpanDecorator

org.apache.camel.opentracing.decorators.AbstractMessagingSpanDecorator

All Implemented Interfaces:

SpanDecorator

Direct Known Subclasses:

AmqpSpanDecorator, AwsSnsSpanDecorator, AwsSqsSpanDecorator, CometdSpanDecorator, IronmqSpanDecorator, JmsSpanDecorator, KafkaSpanDecorator, NatsSpanDecorator, NsqSpanDecorator, PahoSpanDecorator, RabbitmqSpanDecorator, Sjms2SpanDecorator, SjmsSpanDecorator, StompSpanDecorator

public abstract class AbstractMessagingSpanDecorator
extends AbstractSpanDecorator

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGE_BUS_ID

Fields inherited from interface org.apache.camel.opentracing.SpanDecorator

CAMEL_COMPONENT, DEFAULT

Constructor Summary

Constructors

Constructor and Description
AbstractMessagingSpanDecorator()

Method Summary

Modifier and Type	Method and Description
protected String	getDestination(org.apache.camel.Exchange exchange, org.apache.camel.Endpoint endpoint) This method identifies the destination from the supplied exchange and/or endpoint.
io.opentracing.propagation.TextMap	getExtractAdapter(Map<String,Object> map, boolean jmsEncoding) 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 jmsEncoding) This method returns the map to be used for headers injection when the component is receiving a communication.
protected String	getMessageId(org.apache.camel.Exchange exchange) This method identifies the message id for the messaging exchange.
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.
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.

Methods inherited from class org.apache.camel.opentracing.decorators.AbstractSpanDecorator

newSpan, post, stripSchemeAndOptions, toQueryParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.opentracing.SpanDecorator

getComponent, getComponentClassName

Field Detail

MESSAGE_BUS_ID

public static final String MESSAGE_BUS_ID

See Also:

Constant Field Values

Constructor Detail

AbstractMessagingSpanDecorator

public AbstractMessagingSpanDecorator()

Method Detail

getOperationName

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

Description copied from interface: SpanDecorator

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

Specified by:

getOperationName in interface SpanDecorator

Overrides:

getOperationName in class AbstractSpanDecorator

Parameters:

exchange - The exchange

endpoint - The endpoint

Returns:

The operation name

pre

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

Description copied from interface: SpanDecorator

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

Specified by:

pre in interface SpanDecorator

Overrides:

pre in class AbstractSpanDecorator

Parameters:

span - The span

exchange - The exchange

endpoint - The endpoint

getDestination

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

This method identifies the destination from the supplied exchange and/or endpoint.

Parameters:

exchange - The exchange

endpoint - The endpoint

Returns:

The message bus destination

getInitiatorSpanKind

public String getInitiatorSpanKind()

Description copied from interface: SpanDecorator

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

Specified by:

getInitiatorSpanKind in interface SpanDecorator

Overrides:

getInitiatorSpanKind in class AbstractSpanDecorator

Returns:

The kind

getReceiverSpanKind

public String getReceiverSpanKind()

Description copied from interface: SpanDecorator

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

Specified by:

getReceiverSpanKind in interface SpanDecorator

Overrides:

getReceiverSpanKind in class AbstractSpanDecorator

Returns:

The kind

getMessageId

protected String getMessageId(org.apache.camel.Exchange exchange)

This method identifies the message id for the messaging exchange.

Returns:

The message id, or null if no id exists for the exchange

getExtractAdapter

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

Description copied from interface: SpanDecorator

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

Specified by:

getExtractAdapter in interface SpanDecorator

Overrides:

getExtractAdapter in class AbstractSpanDecorator

Parameters:

map - a map containing the objects

jmsEncoding - whether the headers are encoded

Returns:

The extraction map

getInjectAdapter

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

Description copied from interface: SpanDecorator

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

Specified by:

getInjectAdapter in interface SpanDecorator

Overrides:

getInjectAdapter in class AbstractSpanDecorator

Parameters:

map - a map containing the objects

jmsEncoding - whether the headers are encoded

Returns:

The injection map