org.springframework.cloud.sleuth.instrument.messaging

Class TraceChannelInterceptor

java.lang.Object

org.springframework.messaging.support.ChannelInterceptorAdapter

org.springframework.cloud.sleuth.instrument.messaging.TraceChannelInterceptor

All Implemented Interfaces:

org.springframework.messaging.support.ChannelInterceptor, org.springframework.messaging.support.ExecutorChannelInterceptor

public class TraceChannelInterceptor
extends org.springframework.messaging.support.ChannelInterceptorAdapter

A channel interceptor that automatically starts / continues / closes and detaches spans.

Since:

1.0.0

Author:

Dave Syer

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	MESSAGE_COMPONENT If a span comes from messaging components then it will have this value as a prefix to its name.

Constructor Summary

Constructors

Constructor and Description
TraceChannelInterceptor(Tracer tracer, TraceKeys traceKeys, MessagingSpanTextMapExtractor spanExtractor, MessagingSpanTextMapInjector spanInjector)

Method Summary

Modifier and Type	Method and Description
void	afterMessageHandled(org.springframework.messaging.Message<?> message, org.springframework.messaging.MessageChannel channel, org.springframework.messaging.MessageHandler handler, Exception ex)
void	afterSendCompletion(org.springframework.messaging.Message<?> message, org.springframework.messaging.MessageChannel channel, boolean sent, Exception ex)
org.springframework.messaging.Message<?>	beforeHandle(org.springframework.messaging.Message<?> message, org.springframework.messaging.MessageChannel channel, org.springframework.messaging.MessageHandler handler)
protected Span	buildSpan(SpanTextMap carrier) Returns a span given the message and a channel.
protected MessagingSpanTextMapInjector	getSpanInjector()
protected TraceKeys	getTraceKeys()
protected Tracer	getTracer()
org.springframework.messaging.Message<?>	preSend(org.springframework.messaging.Message<?> message, org.springframework.messaging.MessageChannel channel)

Methods inherited from class org.springframework.messaging.support.ChannelInterceptorAdapter

afterReceiveCompletion, postReceive, postSend, preReceive

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.messaging.support.ChannelInterceptor

afterReceiveCompletion, postReceive, postSend, preReceive

Field Detail

MESSAGE_COMPONENT

protected static final String MESSAGE_COMPONENT

If a span comes from messaging components then it will have this value as a prefix to its name.

Example of a Span name: message:foo

Where message is the prefix and foo is the channel name

See Also:

Constant Field Values

Constructor Detail

TraceChannelInterceptor

public TraceChannelInterceptor(Tracer tracer,
                               TraceKeys traceKeys,
                               MessagingSpanTextMapExtractor spanExtractor,
                               MessagingSpanTextMapInjector spanInjector)

Method Detail

afterSendCompletion

public void afterSendCompletion(org.springframework.messaging.Message<?> message,
                                org.springframework.messaging.MessageChannel channel,
                                boolean sent,
                                Exception ex)

Specified by:

afterSendCompletion in interface org.springframework.messaging.support.ChannelInterceptor

Overrides:

afterSendCompletion in class org.springframework.messaging.support.ChannelInterceptorAdapter

preSend

public org.springframework.messaging.Message<?> preSend(org.springframework.messaging.Message<?> message,
                                                        org.springframework.messaging.MessageChannel channel)

Specified by:

preSend in interface org.springframework.messaging.support.ChannelInterceptor

Overrides:

preSend in class org.springframework.messaging.support.ChannelInterceptorAdapter

beforeHandle

public org.springframework.messaging.Message<?> beforeHandle(org.springframework.messaging.Message<?> message,
                                                             org.springframework.messaging.MessageChannel channel,
                                                             org.springframework.messaging.MessageHandler handler)

afterMessageHandled

public void afterMessageHandled(org.springframework.messaging.Message<?> message,
                                org.springframework.messaging.MessageChannel channel,
                                org.springframework.messaging.MessageHandler handler,
                                Exception ex)

getTracer

protected Tracer getTracer()

getTraceKeys

protected TraceKeys getTraceKeys()

getSpanInjector

protected MessagingSpanTextMapInjector getSpanInjector()

buildSpan

protected Span buildSpan(SpanTextMap carrier)

Returns a span given the message and a channel. Returns null if ids are missing.