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

Interface MessageSpanCustomizer

  • All Known Implementing Classes:
    DefaultMessageSpanCustomizer
    public interface MessageSpanCustomizer
    Allows customization of messaging spans.
    Since:
    3.0.0
    Author:
    Marcin Grzejszczak

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Span.Builder customizeHandle​(Span.Builder builder, 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 builder, 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 builder, org.springframework.messaging.Message<?> message, org.springframework.messaging.MessageChannel messageChannel)
      Customizes the span created when ChannelInterceptor.preSend(Message, MessageChannel) gets called.

    • Method Detail

      • customizeHandle

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

      • customizeHandle

        Span.Builder customizeHandle​(Span.Builder builder,
                             org.springframework.messaging.Message<?> message,
                             @Nullable
                             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.
        Parameters:
        builder - current span to customize
        message - received or sent message
        messageChannel - channel from / to which the message was sent
        Returns:
        customized span

      • customizeReceive

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

      • customizeSend

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