io.opentracing.contrib.spring.cloud.websocket

Class TracingChannelInterceptor

java.lang.Object

org.springframework.messaging.support.ChannelInterceptorAdapter

io.opentracing.contrib.spring.cloud.websocket.TracingChannelInterceptor

All Implemented Interfaces:

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

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

This class implements a ExecutorChannelInterceptor to instrument the websocket communications using an OpenTracing Tracer.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	OPENTRACING_SCOPE Header name used to carry the current active scope.
protected static String	OPENTRACING_SPAN Header name used to carry the current Span from the initial preSend phase to the beforeHandle phase.
protected static String	SIMP_DESTINATION The STOMP simple destination.
protected static String	SIMP_MESSAGE_TYPE The STOMP simple message type, values defined in enum SimpMessageType.
protected static String	WEBSOCKET The span component tag value.

Constructor Summary

Constructors

Constructor and Description
TracingChannelInterceptor(io.opentracing.Tracer tracer, String spanKind)

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 arg3)
org.springframework.messaging.Message<?>	beforeHandle(org.springframework.messaging.Message<?> message, org.springframework.messaging.MessageChannel channel, org.springframework.messaging.MessageHandler handler)
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, afterSendCompletion, 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, afterSendCompletion, postReceive, postSend, preReceive

Field Detail

WEBSOCKET

protected static final String WEBSOCKET

The span component tag value.

See Also:

Constant Field Values

SIMP_DESTINATION

protected static final String SIMP_DESTINATION

The STOMP simple destination.

See Also:

Constant Field Values

SIMP_MESSAGE_TYPE

protected static final String SIMP_MESSAGE_TYPE

The STOMP simple message type, values defined in enum SimpMessageType.

See Also:

Constant Field Values

OPENTRACING_SPAN

protected static final String OPENTRACING_SPAN

Header name used to carry the current Span from the initial preSend phase to the beforeHandle phase.

See Also:

Constant Field Values

OPENTRACING_SCOPE

protected static final String OPENTRACING_SCOPE

Header name used to carry the current active scope.

See Also:

Constant Field Values

Constructor Detail

TracingChannelInterceptor

public TracingChannelInterceptor(io.opentracing.Tracer tracer,
                                 String spanKind)

Method Detail

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

afterMessageHandled

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

Specified by:

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

beforeHandle

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

Specified by:

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