org.springframework.cloud.sleuth.instrument.messaging

Class TracingChannelInterceptor

java.lang.Object

org.springframework.messaging.support.ChannelInterceptorAdapter

org.springframework.cloud.sleuth.instrument.messaging.TracingChannelInterceptor

All Implemented Interfaces:

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

public final class TracingChannelInterceptor
extends org.springframework.messaging.support.ChannelInterceptorAdapter
implements org.springframework.messaging.support.ExecutorChannelInterceptor

This starts and propagates Span.Kind#PRODUCER span for each message sent (via native headers. It also extracts or creates a Span.Kind#CONSUMER span for each message received. This span is injected onto each message so it becomes the parent when a handler later calls MessageHandler.handleMessage(Message), or a another processing library calls nextSpan(Message).

This implementation uses ThreadLocalSpan to propagate context between callbacks. This is an alternative to ThreadStatePropagationChannelInterceptor which is less sensitive to message manipulation by other interceptors.

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	afterReceiveCompletion(org.springframework.messaging.Message<?> message, org.springframework.messaging.MessageChannel channel, 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) This starts a consumer span as a child of the incoming message or the current trace context.
static TracingChannelInterceptor	create(brave.Tracing tracing)
brave.Span	nextSpan(org.springframework.messaging.Message<?> message) Use this to create a span for processing the given message.
org.springframework.messaging.Message<?>	postReceive(org.springframework.messaging.Message<?> message, org.springframework.messaging.MessageChannel channel) This starts a consumer span as a child of the incoming message or the current trace context, placing it in scope until the receive completes.
org.springframework.messaging.Message<?>	preSend(org.springframework.messaging.Message<?> message, org.springframework.messaging.MessageChannel channel) Starts and propagates Span.Kind#PRODUCER span for each message sent.

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

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

postSend, preReceive

Method Detail

create

public static TracingChannelInterceptor create(brave.Tracing tracing)

nextSpan

public brave.Span nextSpan(org.springframework.messaging.Message<?> message)

Use this to create a span for processing the given message. Note: the result has no name and is not started.

This creates a child from identifiers extracted from the message headers, or a new span if one couldn't be extracted.

preSend

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

Starts and propagates Span.Kind#PRODUCER span for each message sent.

Specified by:

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

Overrides:

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

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

postReceive

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

This starts a consumer span as a child of the incoming message or the current trace context, placing it in scope until the receive completes.

Specified by:

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

Overrides:

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

afterReceiveCompletion

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

Specified by:

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

Overrides:

afterReceiveCompletion 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)

This starts a consumer span as a child of the incoming message or the current trace context. It then creates a span for the handler, placing it in scope.

Specified by:

beforeHandle in interface org.springframework.messaging.support.ExecutorChannelInterceptor

afterMessageHandled

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

Specified by:

afterMessageHandled in interface org.springframework.messaging.support.ExecutorChannelInterceptor