Create ApplicationTags in common WavefrontAutoConfiguration

Relocate `ApplicationTags` `@Bean` method from `WavefrontTracingAutoConfiguration` to `WavefrontAutoConfiguration` since it is now shared between tracing and metrics. The `application-name`, `service-name`, `cluster-name` and `shard-name` have also been relocated from `management.wavefront.tracing` to `management.wavefront`. Fixes gh-33244
spring-projects · Nov 18, 2022 · fb5cdbd · fb5cdbd
1 parent fafbefa
commit fb5cdbd
Show file tree

Hide file tree

Showing 9 changed files with 302 additions and 165 deletions.
diff --git a/...tuate/autoconfigure/metrics/export/wavefront/WavefrontMetricsExportAutoConfiguration.java b/...tuate/autoconfigure/metrics/export/wavefront/WavefrontMetricsExportAutoConfiguration.java
@@ -31,6 +31,7 @@
 import org.springframework.boot.actuate.autoconfigure.metrics.MetricsAutoConfiguration;
 import org.springframework.boot.actuate.autoconfigure.metrics.export.ConditionalOnEnabledMetricsExport;
 import org.springframework.boot.actuate.autoconfigure.metrics.export.simple.SimpleMetricsExportAutoConfiguration;
+import org.springframework.boot.actuate.autoconfigure.wavefront.WavefrontAutoConfiguration;
 import org.springframework.boot.actuate.autoconfigure.wavefront.WavefrontProperties;
 import org.springframework.boot.actuate.autoconfigure.wavefront.WavefrontSenderConfiguration;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
@@ -53,7 +54,7 @@
  */
 @AutoConfiguration(
 		before = { CompositeMeterRegistryAutoConfiguration.class, SimpleMetricsExportAutoConfiguration.class },
-		after = MetricsAutoConfiguration.class)
+		after = { MetricsAutoConfiguration.class, WavefrontAutoConfiguration.class })
 @ConditionalOnBean(Clock.class)
 @ConditionalOnClass({ WavefrontMeterRegistry.class, WavefrontSender.class })
 @ConditionalOnEnabledMetricsExport("wavefront")

diff --git a/...ework/boot/actuate/autoconfigure/tracing/wavefront/WavefrontTracingAutoConfiguration.java b/...ework/boot/actuate/autoconfigure/tracing/wavefront/WavefrontTracingAutoConfiguration.java
@@ -17,7 +17,6 @@
 package org.springframework.boot.actuate.autoconfigure.tracing.wavefront;
 
 import java.util.Collections;
-import java.util.function.Supplier;
 
 import brave.handler.SpanHandler;
 import com.wavefront.sdk.common.WavefrontSender;
@@ -32,21 +31,18 @@
 import org.springframework.boot.actuate.autoconfigure.metrics.CompositeMeterRegistryAutoConfiguration;
 import org.springframework.boot.actuate.autoconfigure.metrics.MetricsAutoConfiguration;
 import org.springframework.boot.actuate.autoconfigure.tracing.ConditionalOnEnabledTracing;
+import org.springframework.boot.actuate.autoconfigure.wavefront.WavefrontAutoConfiguration;
 import org.springframework.boot.actuate.autoconfigure.wavefront.WavefrontProperties;
-import org.springframework.boot.actuate.autoconfigure.wavefront.WavefrontProperties.Tracing;
 import org.springframework.boot.actuate.autoconfigure.wavefront.WavefrontSenderConfiguration;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
-import org.springframework.boot.context.properties.PropertyMapper;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
-import org.springframework.core.env.Environment;
-import org.springframework.util.StringUtils;
 
 /**
  * {@link EnableAutoConfiguration Auto-configuration} for Wavefront tracing.
@@ -55,107 +51,67 @@
  * @author Glenn Oppegard
  * @since 3.0.0
  */
-@AutoConfiguration(after = { MetricsAutoConfiguration.class, CompositeMeterRegistryAutoConfiguration.class })
+@AutoConfiguration(after = { MetricsAutoConfiguration.class, CompositeMeterRegistryAutoConfiguration.class,
+		WavefrontAutoConfiguration.class })
+@ConditionalOnClass({ WavefrontSender.class, WavefrontSpanHandler.class })
+@ConditionalOnEnabledTracing
 @EnableConfigurationProperties(WavefrontProperties.class)
-@ConditionalOnClass(WavefrontSender.class)
 @Import(WavefrontSenderConfiguration.class)
-@ConditionalOnEnabledTracing
 public class WavefrontTracingAutoConfiguration {
 
-	/**
-	 * Default value for the Wavefront Application name.
-	 * @see <a href=
-	 * "https://docs.wavefront.com/trace_data_details.html#application-tags">Wavefront
-	 * Application Tags</a>
-	 */
-	private static final String DEFAULT_APPLICATION_NAME = "unnamed_application";
-
-	/**
-	 * Default value for the Wavefront Service name if {@code spring.application.name} is
-	 * not set.
-	 * @see <a href=
-	 * "https://docs.wavefront.com/trace_data_details.html#application-tags">Wavefront
-	 * Application Tags</a>
-	 */
-	private static final String DEFAULT_SERVICE_NAME = "unnamed_service";
-
 	@Bean
 	@ConditionalOnMissingBean
-	public ApplicationTags wavefrontApplicationTags(Environment environment, WavefrontProperties properties) {
-		Tracing tracing = properties.getTracing();
-		String wavefrontServiceName = getName(tracing.getServiceName(),
-				() -> environment.getProperty("spring.application.name", DEFAULT_SERVICE_NAME));
-		String wavefrontApplicationName = getName(tracing.getApplicationName(), () -> DEFAULT_APPLICATION_NAME);
-		PropertyMapper map = PropertyMapper.get().alwaysApplyingWhenNonNull();
-		ApplicationTags.Builder builder = new ApplicationTags.Builder(wavefrontApplicationName, wavefrontServiceName);
-		map.from(tracing::getClusterName).to(builder::cluster);
-		map.from(tracing::getShardName).to(builder::shard);
-		return builder.build();
-	}
-
-	private String getName(String value, Supplier<String> fallback) {
-		return (StringUtils.hasText(value)) ? value : fallback.get();
+	@ConditionalOnBean(WavefrontSender.class)
+	WavefrontSpanHandler wavefrontSpanHandler(WavefrontProperties properties, WavefrontSender wavefrontSender,
+			SpanMetrics spanMetrics, ApplicationTags applicationTags) {
+		return new WavefrontSpanHandler(properties.getSender().getMaxQueueSize(), wavefrontSender, spanMetrics,
+				properties.getSourceOrDefault(), applicationTags, Collections.emptySet());
 	}
 
 	@Configuration(proxyBeanMethods = false)
-	@ConditionalOnClass(WavefrontSpanHandler.class)
-	static class WavefrontMicrometer {
+	@ConditionalOnBean(MeterRegistry.class)
+	static class MeterRegistrySpanMetricsConfiguration {
 
 		@Bean
 		@ConditionalOnMissingBean
-		@ConditionalOnBean(WavefrontSender.class)
-		WavefrontSpanHandler wavefrontSpanHandler(WavefrontProperties properties, WavefrontSender wavefrontSender,
-				SpanMetrics spanMetrics, ApplicationTags applicationTags) {
-			return new WavefrontSpanHandler(properties.getSender().getMaxQueueSize(), wavefrontSender, spanMetrics,
-					properties.getSourceOrDefault(), applicationTags, Collections.emptySet());
+		MeterRegistrySpanMetrics meterRegistrySpanMetrics(MeterRegistry meterRegistry) {
+			return new MeterRegistrySpanMetrics(meterRegistry);
 		}
 
-		@Configuration(proxyBeanMethods = false)
-		@ConditionalOnBean(MeterRegistry.class)
-		static class MeterRegistrySpanMetricsConfiguration {
-
-			@Bean
-			@ConditionalOnMissingBean
-			MeterRegistrySpanMetrics meterRegistrySpanMetrics(MeterRegistry meterRegistry) {
-				return new MeterRegistrySpanMetrics(meterRegistry);
-			}
-
-		}
-
-		@Configuration(proxyBeanMethods = false)
-		@ConditionalOnMissingBean(MeterRegistry.class)
-		static class NoopSpanMetricsConfiguration {
+	}
 
-			@Bean
-			@ConditionalOnMissingBean
-			SpanMetrics meterRegistrySpanMetrics() {
-				return SpanMetrics.NOOP;
-			}
+	@Configuration(proxyBeanMethods = false)
+	@ConditionalOnMissingBean(MeterRegistry.class)
+	static class NoopSpanMetricsConfiguration {
 
+		@Bean
+		@ConditionalOnMissingBean
+		SpanMetrics meterRegistrySpanMetrics() {
+			return SpanMetrics.NOOP;
 		}
 
-		@Configuration(proxyBeanMethods = false)
-		@ConditionalOnClass(SpanHandler.class)
-		static class WavefrontBrave {
+	}
 
-			@Bean
-			@ConditionalOnMissingBean
-			WavefrontBraveSpanHandler wavefrontBraveSpanHandler(WavefrontSpanHandler wavefrontSpanHandler) {
-				return new WavefrontBraveSpanHandler(wavefrontSpanHandler);
-			}
+	@Configuration(proxyBeanMethods = false)
+	@ConditionalOnClass(SpanHandler.class)
+	static class WavefrontBrave {
 
+		@Bean
+		@ConditionalOnMissingBean
+		WavefrontBraveSpanHandler wavefrontBraveSpanHandler(WavefrontSpanHandler wavefrontSpanHandler) {
+			return new WavefrontBraveSpanHandler(wavefrontSpanHandler);
 		}
 
-		@Configuration(proxyBeanMethods = false)
-		@ConditionalOnClass(SpanExporter.class)
-		static class WavefrontOpenTelemetry {
+	}
 
-			@Bean
-			@ConditionalOnMissingBean
-			WavefrontOtelSpanExporter wavefrontOtelSpanExporter(WavefrontSpanHandler wavefrontSpanHandler) {
-				return new WavefrontOtelSpanExporter(wavefrontSpanHandler);
-			}
+	@Configuration(proxyBeanMethods = false)
+	@ConditionalOnClass(SpanExporter.class)
+	static class WavefrontOpenTelemetry {
 
+		@Bean
+		@ConditionalOnMissingBean
+		WavefrontOtelSpanExporter wavefrontOtelSpanExporter(WavefrontSpanHandler wavefrontSpanHandler) {
+			return new WavefrontOtelSpanExporter(wavefrontSpanHandler);
 		}
 
 	}

diff --git a/.../org/springframework/boot/actuate/autoconfigure/wavefront/WavefrontAutoConfiguration.java b/.../org/springframework/boot/actuate/autoconfigure/wavefront/WavefrontAutoConfiguration.java
@@ -0,0 +1,82 @@
+/*
+ * Copyright 2012-2022 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
+ *
+ *      https://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.boot.actuate.autoconfigure.wavefront;
+
+import java.util.function.Supplier;
+
+import com.wavefront.sdk.common.WavefrontSender;
+import com.wavefront.sdk.common.application.ApplicationTags;
+
+import org.springframework.boot.autoconfigure.AutoConfiguration;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.boot.context.properties.PropertyMapper;
+import org.springframework.context.annotation.Bean;
+import org.springframework.core.env.Environment;
+import org.springframework.util.StringUtils;
+
+/**
+ * {@link EnableAutoConfiguration Auto-configuration} for for Wavefront common
+ * infrastructure.
+ *
+ * @author Moritz Halbritter
+ * @author Glenn Oppegard
+ * @author Phillip Webb
+ * @since 3.0.0
+ */
+@AutoConfiguration
+@ConditionalOnClass({ ApplicationTags.class, WavefrontSender.class })
+@EnableConfigurationProperties(WavefrontProperties.class)
+public class WavefrontAutoConfiguration {
+
+	/**
+	 * Default value for the Wavefront Service name if {@code spring.application.name} is
+	 * not set.
+	 * @see <a href=
+	 * "https://docs.wavefront.com/trace_data_details.html#application-tags">Wavefront
+	 * Application Tags</a>
+	 */
+	private static final String DEFAULT_SERVICE_NAME = "unnamed_service";
+
+	/**
+	 * Default value for the Wavefront Application name.
+	 * @see <a href=
+	 * "https://docs.wavefront.com/trace_data_details.html#application-tags">Wavefront
+	 * Application Tags</a>
+	 */
+	private static final String DEFAULT_APPLICATION_NAME = "unnamed_application";
+
+	@Bean
+	@ConditionalOnMissingBean
+	public ApplicationTags wavefrontApplicationTags(Environment environment, WavefrontProperties properties) {
+		String wavefrontServiceName = getName(properties.getServiceName(),
+				() -> environment.getProperty("spring.application.name", DEFAULT_SERVICE_NAME));
+		String wavefrontApplicationName = getName(properties.getApplicationName(), () -> DEFAULT_APPLICATION_NAME);
+		PropertyMapper map = PropertyMapper.get().alwaysApplyingWhenNonNull();
+		ApplicationTags.Builder builder = new ApplicationTags.Builder(wavefrontApplicationName, wavefrontServiceName);
+		map.from(properties::getClusterName).to(builder::cluster);
+		map.from(properties::getShardName).to(builder::shard);
+		return builder.build();
+	}
+
+	private String getName(String value, Supplier<String> fallback) {
+		return (StringUtils.hasText(value)) ? value : fallback.get();
+	}
+
+}