From bf6546c2ab9c0e97ddad5d20a28ae1cce64cd9a2 Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Mon, 12 Mar 2018 15:47:08 +0100 Subject: [PATCH] Updated messaging code --- .../main/asciidoc/spring-cloud-sleuth.adoc | 6 ++- .../messaging/OnMessagingEnabled.java | 36 +++++++++++++ .../messaging/SleuthMessagingProperties.java | 54 +++++++++++++++++++ .../TraceMessagingAutoConfiguration.java | 13 +++-- ...aceSpringIntegrationAutoConfiguration.java | 1 + 5 files changed, 104 insertions(+), 6 deletions(-) create mode 100644 spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/OnMessagingEnabled.java diff --git a/docs/src/main/asciidoc/spring-cloud-sleuth.adoc b/docs/src/main/asciidoc/spring-cloud-sleuth.adoc index 74ad78a04..5d13386c1 100644 --- a/docs/src/main/asciidoc/spring-cloud-sleuth.adoc +++ b/docs/src/main/asciidoc/spring-cloud-sleuth.adoc @@ -1125,6 +1125,8 @@ include::../../../../spring-cloud-sleuth-core/src/test/java/org/springframework/ === Messaging +Features from this section can be disabled by setting the `spring.sleuth.messaging.enabled` property with value equal to `false`. + ==== Spring Integration and Spring Cloud Stream Spring Cloud Sleuth integrates with http://projects.spring.io/spring-integration/[Spring Integration]. @@ -1142,7 +1144,7 @@ Decorating the Spring Integration Executor Channel with `TraceableExecutorServic We instrument the `RabbitTemplate` so that tracing headers get injected into the message. -To block this feature, set `spring.sleuth.messaging.enabled` to `false`. +To block this feature, set `spring.sleuth.messaging.rabbit.enabled` to `false`. ==== Spring Kafka @@ -1150,7 +1152,7 @@ We instrument the Spring Kafka's `ProducerFactory` and `ConsumerFactory` so that tracing headers get injected into the created Spring Kafka's `Producer` and `Consumer`. -To block this feature, set `spring.sleuth.messaging.enabled` to `false`. +To block this feature, set `spring.sleuth.messaging.kafka.enabled` to `false`. === Zuul diff --git a/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/OnMessagingEnabled.java b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/OnMessagingEnabled.java new file mode 100644 index 000000000..4eac04af4 --- /dev/null +++ b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/OnMessagingEnabled.java @@ -0,0 +1,36 @@ +/* + * Copyright 2013-2018 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.cloud.sleuth.instrument.messaging; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; + +/** + * @author Marcin Grzejszczak + * @since 2.0.0 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target({ ElementType.TYPE, ElementType.METHOD }) +@Documented +@ConditionalOnProperty(value = "spring.sleuth.messaging.enabled", matchIfMissing = true) +@interface OnMessagingEnabled { +} diff --git a/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/SleuthMessagingProperties.java b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/SleuthMessagingProperties.java index 0cb2ee9ad..dcf7f870f 100644 --- a/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/SleuthMessagingProperties.java +++ b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/SleuthMessagingProperties.java @@ -60,6 +60,38 @@ public class SleuthMessagingProperties { public static class Messaging { private boolean enabled; + private Rabbit rabbit = new Rabbit(); + + private Kafka kafka = new Kafka(); + + public boolean isEnabled() { + return this.enabled; + } + + public void setEnabled(boolean enabled) { + this.enabled = enabled; + } + + public Rabbit getRabbit() { + return this.rabbit; + } + + public void setRabbit(Rabbit rabbit) { + this.rabbit = rabbit; + } + + public Kafka getKafka() { + return this.kafka; + } + + public void setKafka(Kafka kafka) { + this.kafka = kafka; + } + } + + public static class Rabbit { + private boolean enabled; + private String remoteServiceName = "rabbitmq"; public boolean isEnabled() { @@ -78,4 +110,26 @@ public class SleuthMessagingProperties { this.remoteServiceName = remoteServiceName; } } + + public static class Kafka { + private boolean enabled; + + private String remoteServiceName = "kafka"; + + public boolean isEnabled() { + return this.enabled; + } + + public void setEnabled(boolean enabled) { + this.enabled = enabled; + } + + public String getRemoteServiceName() { + return this.remoteServiceName; + } + + public void setRemoteServiceName(String remoteServiceName) { + this.remoteServiceName = remoteServiceName; + } + } } diff --git a/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/TraceMessagingAutoConfiguration.java b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/TraceMessagingAutoConfiguration.java index 989535409..5b674b0d0 100644 --- a/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/TraceMessagingAutoConfiguration.java +++ b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/TraceMessagingAutoConfiguration.java @@ -52,11 +52,12 @@ import org.springframework.kafka.core.ProducerFactory; @Configuration @ConditionalOnBean(Tracing.class) @AutoConfigureAfter({ TraceAutoConfiguration.class }) -@ConditionalOnProperty(value = "spring.sleuth.messaging.enabled", matchIfMissing = true) +@OnMessagingEnabled @EnableConfigurationProperties(SleuthMessagingProperties.class) public class TraceMessagingAutoConfiguration { @Configuration + @ConditionalOnProperty(value = "spring.sleuth.messaging.rabbit.enabled", matchIfMissing = true) @ConditionalOnClass(RabbitTemplate.class) protected static class SleuthRabbitConfiguration { @Bean @@ -64,7 +65,7 @@ public class TraceMessagingAutoConfiguration { SpringRabbitTracing springRabbitTracing(Tracing tracing, SleuthMessagingProperties properties) { return SpringRabbitTracing.newBuilder(tracing) - .remoteServiceName(properties.getMessaging().getRemoteServiceName()) + .remoteServiceName(properties.getMessaging().getRabbit().getRemoteServiceName()) .build(); } @@ -77,13 +78,17 @@ public class TraceMessagingAutoConfiguration { } @Configuration + @ConditionalOnProperty(value = "spring.sleuth.messaging.kafka.enabled", matchIfMissing = true) @ConditionalOnClass(ProducerFactory.class) protected static class SleuthKafkaConfiguration { @Bean @ConditionalOnMissingBean - KafkaTracing kafkaTracing(Tracing tracing) { - return KafkaTracing.create(tracing); + KafkaTracing kafkaTracing(Tracing tracing, SleuthMessagingProperties properties) { + return KafkaTracing + .newBuilder(tracing) + .remoteServiceName(properties.getMessaging().getKafka().getRemoteServiceName()) + .build(); } @Bean diff --git a/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/TraceSpringIntegrationAutoConfiguration.java b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/TraceSpringIntegrationAutoConfiguration.java index 39a3adf8c..50d80e031 100644 --- a/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/TraceSpringIntegrationAutoConfiguration.java +++ b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/TraceSpringIntegrationAutoConfiguration.java @@ -41,6 +41,7 @@ import org.springframework.integration.config.GlobalChannelInterceptor; @ConditionalOnClass(GlobalChannelInterceptor.class) @ConditionalOnBean(Tracing.class) @AutoConfigureAfter({ TraceAutoConfiguration.class }) +@OnMessagingEnabled @ConditionalOnProperty(value = "spring.sleuth.integration.enabled", matchIfMissing = true) @EnableConfigurationProperties(SleuthMessagingProperties.class) public class TraceSpringIntegrationAutoConfiguration {