Package org.springframework.cloud.sleuth.instrument.messaging

Class DefaultMessageSpanCustomizer

java.lang.Object
org.springframework.cloud.sleuth.instrument.messaging.DefaultMessageSpanCustomizer
All Implemented Interfaces:
MessageSpanCustomizer
public class DefaultMessageSpanCustomizer extends Object implements MessageSpanCustomizer
Provides default customization of messaging spans.
Since:
2.2.7
Author:
Marcin Grzejszczak

  • Constructor Summary

    Constructors
    Constructor
    Description
    DefaultMessageSpanCustomizer()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected String
    channelName(org.springframework.messaging.MessageChannel channel)
    Retrieves the channel name from the MessageChannel.
    Span.Builder
    customizeHandle(Span.Builder spanCustomizer, org.springframework.messaging.Message<?> message, org.springframework.messaging.MessageChannel messageChannel)
    Customizes the span created when ExecutorChannelInterceptor.beforeHandle(Message, MessageChannel, MessageHandler) gets called for a span retrieved from the incoming headers.
    Span
    customizeHandle(Span spanCustomizer, org.springframework.messaging.Message<?> message, org.springframework.messaging.MessageChannel messageChannel)
    Customizes the span created when ExecutorChannelInterceptor.beforeHandle(Message, MessageChannel, MessageHandler) gets called.
    Span.Builder
    customizeReceive(Span.Builder spanCustomizer, org.springframework.messaging.Message<?> message, org.springframework.messaging.MessageChannel messageChannel)
    Customizes the span created when ChannelInterceptor.postReceive(Message, MessageChannel) gets called.
    Span.Builder
    customizeSend(Span.Builder spanCustomizer, org.springframework.messaging.Message<?> message, org.springframework.messaging.MessageChannel messageChannel)
    Customizes the span created when ChannelInterceptor.preSend(Message, MessageChannel) gets called.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DefaultMessageSpanCustomizer

      public DefaultMessageSpanCustomizer()

  • Method Details

    • channelName

      protected String channelName(org.springframework.messaging.MessageChannel channel)
      Retrieves the channel name from the MessageChannel.
      Parameters:
      channel - - message channel from which message got received or was sent to
      Returns:
      channel name
      Since:
      2.2.7

    • customizeHandle

      public Span customizeHandle(Span spanCustomizer, org.springframework.messaging.Message<?> message, @Nullable org.springframework.messaging.MessageChannel messageChannel)
      Description copied from interface: MessageSpanCustomizer
      Customizes the span created when ExecutorChannelInterceptor.beforeHandle(Message, MessageChannel, MessageHandler) gets called.
      Specified by:
      customizeHandle in interface MessageSpanCustomizer
      Parameters:
      spanCustomizer - current span to customize
      message - received or sent message
      messageChannel - channel from / to which the message was sent
      Returns:
      customized span

    • customizeHandle

      public Span.Builder customizeHandle(Span.Builder spanCustomizer, org.springframework.messaging.Message<?> message, @Nullable org.springframework.messaging.MessageChannel messageChannel)
      Description copied from interface: MessageSpanCustomizer
      Customizes the span created when ExecutorChannelInterceptor.beforeHandle(Message, MessageChannel, MessageHandler) gets called for a span retrieved from the incoming headers.
      Specified by:
      customizeHandle in interface MessageSpanCustomizer
      Parameters:
      spanCustomizer - current span to customize
      message - received or sent message
      messageChannel - channel from / to which the message was sent
      Returns:
      customized span

    • customizeReceive

      public Span.Builder customizeReceive(Span.Builder spanCustomizer, org.springframework.messaging.Message<?> message, @Nullable org.springframework.messaging.MessageChannel messageChannel)
      Description copied from interface: MessageSpanCustomizer
      Customizes the span created when ChannelInterceptor.postReceive(Message, MessageChannel) gets called.
      Specified by:
      customizeReceive in interface MessageSpanCustomizer
      Parameters:
      spanCustomizer - current span to customize
      message - received or sent message
      messageChannel - channel from / to which the message was sent
      Returns:
      customized span

    • customizeSend

      public Span.Builder customizeSend(Span.Builder spanCustomizer, org.springframework.messaging.Message<?> message, @Nullable org.springframework.messaging.MessageChannel messageChannel)
      Description copied from interface: MessageSpanCustomizer
      Customizes the span created when ChannelInterceptor.preSend(Message, MessageChannel) gets called.
      Specified by:
      customizeSend in interface MessageSpanCustomizer
      Parameters:
      spanCustomizer - current span to customize
      message - received or sent message
      messageChannel - channel from / to which the message was sent
      Returns:
      customized span