From 5ad9108de97dbf4e9e1675bd23d55ecc7a1e165a Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Thu, 3 Dec 2020 17:18:37 +0100 Subject: [PATCH] Added missing javadocs --- .../messaging/MessageSpanCustomizer.java | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/MessageSpanCustomizer.java b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/MessageSpanCustomizer.java index d824b9460..881e592ed 100644 --- a/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/MessageSpanCustomizer.java +++ b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/MessageSpanCustomizer.java @@ -21,6 +21,8 @@ import brave.SpanCustomizer; import org.springframework.lang.Nullable; import org.springframework.messaging.Message; import org.springframework.messaging.MessageChannel; +import org.springframework.messaging.MessageHandler; +import org.springframework.messaging.support.ExecutorChannelInterceptor; /** * Allows customization of messaging spans. @@ -30,12 +32,38 @@ import org.springframework.messaging.MessageChannel; */ public interface MessageSpanCustomizer { + /** + * Customizes the span created when + * {@link ExecutorChannelInterceptor#beforeHandle(Message, MessageChannel, MessageHandler)} + * gets called. + * @param spanCustomizer current span to customize + * @param message received or sent message + * @param messageChannel channel from / to which the message was sent + * @return customized span + */ SpanCustomizer customizeHandle(SpanCustomizer spanCustomizer, Message message, @Nullable MessageChannel messageChannel); + /** + * Customizes the span created when + * {@link ExecutorChannelInterceptor#postReceive(Message, MessageChannel)} gets + * called. + * @param spanCustomizer current span to customize + * @param message received or sent message + * @param messageChannel channel from / to which the message was sent + * @return customized span + */ SpanCustomizer customizeReceive(SpanCustomizer spanCustomizer, Message message, @Nullable MessageChannel messageChannel); + /** + * Customizes the span created when + * {@link ExecutorChannelInterceptor#preSend(Message, MessageChannel)} gets called. + * @param spanCustomizer current span to customize + * @param message received or sent message + * @param messageChannel channel from / to which the message was sent + * @return customized span + */ SpanCustomizer customizeSend(SpanCustomizer spanCustomizer, Message message, @Nullable MessageChannel messageChannel);