Move wavefront properties to management.wavefront

- Settings moved from management.metrics.export.wavefront to
  management.wavefront.metrics and management.wavefront
- WavefrontSender is created by WavefrontAutoConfiguration and is used
  by the tracing and metrics auto-configurations
- Users can no longer supply a WavefrontConfig bean. WavefrontConfig
  comes from micrometer-core and was used to build the WavefrontSender.
  The WavefrontSender is used by tracing, which doesn't rely on
  micrometer-core. The sender can be configured as usual through
  properties

See spring-projectsgh-30156

Author: mhalbritter

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/wavefront/WavefrontMetricsExportAutoConfiguration.java

@@ -16,10 +16,7 @@
 
 package org.springframework.boot.actuate.autoconfigure.metrics.export.wavefront;
 
-import java.time.Duration;
-
 import com.wavefront.sdk.common.WavefrontSender;
-import com.wavefront.sdk.common.clients.WavefrontClient.Builder;
 import io.micrometer.core.instrument.Clock;
 import io.micrometer.wavefront.WavefrontConfig;
 import io.micrometer.wavefront.WavefrontMeterRegistry;
@@ -28,16 +25,15 @@
 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.metrics.export.wavefront.WavefrontProperties.Sender;
+import org.springframework.boot.actuate.autoconfigure.wavefront.WavefrontAutoConfiguration;
+import org.springframework.boot.actuate.autoconfigure.wavefront.WavefrontProperties;
 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.util.unit.DataSize;
 
 /**
  * {@link EnableAutoConfiguration Auto-configuration} for exporting metrics to Wavefront.
@@ -49,46 +45,23 @@
  */
 @AutoConfiguration(
 		before = { CompositeMeterRegistryAutoConfiguration.class, SimpleMetricsExportAutoConfiguration.class },
-		after = MetricsAutoConfiguration.class)
-@ConditionalOnBean(Clock.class)
-@ConditionalOnClass({ WavefrontMeterRegistry.class, WavefrontSender.class })
+		after = { MetricsAutoConfiguration.class, WavefrontAutoConfiguration.class })
+@ConditionalOnBean({ Clock.class, WavefrontSender.class })
+@ConditionalOnClass(WavefrontMeterRegistry.class)
 @ConditionalOnEnabledMetricsExport("wavefront")
-@EnableConfigurationProperties(WavefrontProperties.class)
+@EnableConfigurationProperties({ WavefrontProperties.class, WavefrontMetricsProperties.class })
 public class WavefrontMetricsExportAutoConfiguration {
 
-	private final WavefrontProperties properties;
-
-	public WavefrontMetricsExportAutoConfiguration(WavefrontProperties properties) {
-		this.properties = properties;
-	}
-
 	@Bean
-	@ConditionalOnMissingBean
-	public WavefrontConfig wavefrontConfig() {
-		return new WavefrontPropertiesConfigAdapter(this.properties);
+	WavefrontConfig wavefrontConfig(WavefrontMetricsProperties metricsProperties, WavefrontProperties properties) {
+		return new WavefrontMetricsPropertiesConfigAdapter(properties, metricsProperties);
 	}
 
 	@Bean
 	@ConditionalOnMissingBean
-	public WavefrontSender wavefrontSender(WavefrontConfig wavefrontConfig) {
-		return createWavefrontSender(wavefrontConfig);
-	}
-
-	@Bean
-	@ConditionalOnMissingBean
-	public WavefrontMeterRegistry wavefrontMeterRegistry(WavefrontConfig wavefrontConfig, Clock clock,
+	WavefrontMeterRegistry wavefrontMeterRegistry(WavefrontConfig wavefrontConfig, Clock clock,
 			WavefrontSender wavefrontSender) {
 		return WavefrontMeterRegistry.builder(wavefrontConfig).clock(clock).wavefrontSender(wavefrontSender).build();
 	}
 
-	private WavefrontSender createWavefrontSender(WavefrontConfig wavefrontConfig) {
-		Builder builder = WavefrontMeterRegistry.getDefaultSenderBuilder(wavefrontConfig);
-		PropertyMapper mapper = PropertyMapper.get().alwaysApplyingWhenNonNull();
-		Sender sender = this.properties.getSender();
-		mapper.from(sender.getMaxQueueSize()).to(builder::maxQueueSize);
-		mapper.from(sender.getFlushInterval()).asInt(Duration::getSeconds).to(builder::flushIntervalSeconds);
-		mapper.from(sender.getMessageSize()).asInt(DataSize::toBytes).to(builder::messageSizeBytes);
-		return builder.build();
-	}
-
 }

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/wavefront/WavefrontMetricsProperties.java

@@ -0,0 +1,49 @@
+/*
+ * 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.metrics.export.wavefront;
+
+import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.PushRegistryProperties;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+/**
+ * {@link ConfigurationProperties @ConfigurationProperties} for configuring Wavefront
+ * metrics export.
+ *
+ * @author Jon Schneider
+ * @author Stephane Nicoll
+ * @author Moritz Halbritter
+ * @since 2.0.0
+ */
+@ConfigurationProperties("management.wavefront.metrics")
+public class WavefrontMetricsProperties extends PushRegistryProperties {
+
+	/**
+	 * Global prefix to separate metrics originating from this app's white box
+	 * instrumentation from those originating from other Wavefront integrations when
+	 * viewed in the Wavefront UI.
+	 */
+	private String globalPrefix;
+
+	public String getGlobalPrefix() {
+		return this.globalPrefix;
+	}
+
+	public void setGlobalPrefix(String globalPrefix) {
+		this.globalPrefix = globalPrefix;
+	}
+
+}

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/wavefront/WavefrontPropertiesConfigAdapter.java renamed to spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/wavefront/WavefrontMetricsPropertiesConfigAdapter.java

@@ -19,18 +19,24 @@
 import io.micrometer.wavefront.WavefrontConfig;
 
 import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.PushRegistryPropertiesConfigAdapter;
+import org.springframework.boot.actuate.autoconfigure.wavefront.WavefrontProperties;
 
 /**
- * Adapter to convert {@link WavefrontProperties} to a {@link WavefrontConfig}.
+ * Adapter to convert {@link WavefrontMetricsProperties} to a {@link WavefrontConfig}.
  *
  * @author Jon Schneider
+ * @author Moritz Halbritter
  * @since 2.0.0
  */
-public class WavefrontPropertiesConfigAdapter extends PushRegistryPropertiesConfigAdapter<WavefrontProperties>
-		implements WavefrontConfig {
+public class WavefrontMetricsPropertiesConfigAdapter
+		extends PushRegistryPropertiesConfigAdapter<WavefrontMetricsProperties> implements WavefrontConfig {
 
-	public WavefrontPropertiesConfigAdapter(WavefrontProperties properties) {
-		super(properties);
+	private final WavefrontProperties properties;
+
+	public WavefrontMetricsPropertiesConfigAdapter(WavefrontProperties properties,
+			WavefrontMetricsProperties metricsProperties) {
+		super(metricsProperties);
+		this.properties = properties;
 	}
 
 	@Override
@@ -45,26 +51,27 @@ public String get(String k) {
 
 	@Override
 	public String uri() {
-		return get(this::getUriAsString, WavefrontConfig.DEFAULT_DIRECT::uri);
+		return this.properties.getUri().toString();
 	}
 
 	@Override
 	public String source() {
-		return get(WavefrontProperties::getSource, WavefrontConfig.super::source);
+		return this.properties.getSourceOrDefault();
 	}
 
 	@Override
-	public String apiToken() {
-		return get(WavefrontProperties::getApiToken, WavefrontConfig.super::apiToken);
+	public int batchSize() {
+		return this.properties.getSender().getBatchSize();
 	}
 
 	@Override
-	public String globalPrefix() {
-		return get(WavefrontProperties::getGlobalPrefix, WavefrontConfig.super::globalPrefix);
+	public String apiToken() {
+		return this.properties.getApiTokenOrThrow();
 	}
 
-	private String getUriAsString(WavefrontProperties properties) {
-		return (properties.getUri() != null) ? properties.getUri().toString() : null;
+	@Override
+	public String globalPrefix() {
+		return get(WavefrontMetricsProperties::getGlobalPrefix, WavefrontConfig.super::globalPrefix);
 	}
 
 }

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/wavefront/WavefrontAutoConfiguration.java renamed to spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/wavefront/WavefrontTracingAutoConfiguration.java

@@ -17,12 +17,10 @@
 package org.springframework.boot.actuate.autoconfigure.tracing.wavefront;
 
 import java.util.Set;
-import java.util.concurrent.TimeUnit;
 
 import brave.handler.SpanHandler;
 import com.wavefront.sdk.common.WavefrontSender;
 import com.wavefront.sdk.common.application.ApplicationTags;
-import com.wavefront.sdk.common.clients.WavefrontClient;
 import io.micrometer.core.instrument.MeterRegistry;
 import io.micrometer.tracing.reporter.wavefront.SpanMetrics;
 import io.micrometer.tracing.reporter.wavefront.WavefrontBraveSpanHandler;
@@ -32,6 +30,8 @@
 
 import org.springframework.boot.actuate.autoconfigure.metrics.CompositeMeterRegistryAutoConfiguration;
 import org.springframework.boot.actuate.autoconfigure.metrics.MetricsAutoConfiguration;
+import org.springframework.boot.actuate.autoconfigure.wavefront.WavefrontAutoConfiguration;
+import org.springframework.boot.actuate.autoconfigure.wavefront.WavefrontProperties;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
@@ -48,30 +48,21 @@
  *
  * @author Moritz Halbritter
  */
-@AutoConfiguration(after = { MetricsAutoConfiguration.class, CompositeMeterRegistryAutoConfiguration.class })
-@EnableConfigurationProperties(WavefrontTracingProperties.class)
-@ConditionalOnClass(WavefrontSender.class)
-class WavefrontAutoConfiguration {
+@AutoConfiguration(after = { MetricsAutoConfiguration.class, CompositeMeterRegistryAutoConfiguration.class,
+		WavefrontAutoConfiguration.class })
+@EnableConfigurationProperties({ WavefrontTracingProperties.class, WavefrontProperties.class })
+@ConditionalOnBean(WavefrontSender.class)
+public class WavefrontTracingAutoConfiguration {
 
 	/**
 	 * Default value for application name if {@code spring.application.name} is not set.
 	 */
 	private static final String DEFAULT_APPLICATION_NAME = "application";
 
-	@Bean
-	@ConditionalOnMissingBean
-	WavefrontSender wavefrontSender(WavefrontTracingProperties properties) {
-		return new WavefrontClient.Builder(properties.getUri().toString(), properties.getApiToken())
-				.flushInterval((int) properties.getSender().getFlushInterval().getSeconds(), TimeUnit.SECONDS)
-				.maxQueueSize(properties.getSender().getMaxQueueSize())
-				.messageSizeBytes((int) properties.getSender().getMessageSize().toBytes()).build();
-	}
-
 	@Bean
 	@ConditionalOnMissingBean
 	ApplicationTags applicationTags(Environment environment, WavefrontTracingProperties properties) {
 		String applicationName = environment.getProperty("spring.application.name");
-
 		return new ApplicationTags.Builder(
 				StringUtils.hasLength(applicationName) ? applicationName : DEFAULT_APPLICATION_NAME,
 				properties.getServiceName()).build();
@@ -109,10 +100,10 @@ static class WavefrontMicrometer {
 
 		@Bean(destroyMethod = "")
 		@ConditionalOnMissingBean
-		WavefrontSpanHandler wavefrontSpanHandler(WavefrontTracingProperties properties,
-				WavefrontSender wavefrontSender, SpanMetrics spanMetrics, ApplicationTags applicationTags) {
+		WavefrontSpanHandler wavefrontSpanHandler(WavefrontProperties properties, WavefrontSender wavefrontSender,
+				SpanMetrics spanMetrics, ApplicationTags applicationTags) {
 			return new WavefrontSpanHandler(properties.getSender().getMaxQueueSize(), wavefrontSender, spanMetrics,
-					properties.getSource(), applicationTags, Set.of());
+					properties.getSourceOrDefault(), applicationTags, Set.of());
 		}
 
 		@Configuration(proxyBeanMethods = false)
@@ -140,4 +131,5 @@ WavefrontOtelSpanHandler wavefrontOtelSpanHandler(WavefrontSpanHandler wavefront
 		}
 
 	}
+
 }

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/wavefront/WavefrontTracingProperties.java

@@ -16,42 +16,19 @@
 
 package org.springframework.boot.actuate.autoconfigure.tracing.wavefront;
 
-import java.net.URI;
-import java.time.Duration;
-
 import org.springframework.boot.context.properties.ConfigurationProperties;
-import org.springframework.util.unit.DataSize;
 
 /**
  * @author Moritz Halbritter
  */
-@ConfigurationProperties("management.tracing.wavefront")
-// TODO MH: Consolidate with WavefrontProperties
+@ConfigurationProperties("management.wavefront.tracing")
 public class WavefrontTracingProperties {
 
-	/**
-	 * URI to ship metrics to.
-	 */
-	private URI uri = URI.create("https://longboard.wavefront.com");
-
-	/**
-	 * Unique identifier for the app instance that is the source of metrics being
-	 * published to Wavefront. Defaults to the local host name.
-	 */
-	private String source;
-
-	/**
-	 * API token used when publishing metrics directly to the Wavefront API host.
-	 */
-	private String apiToken;
-
 	/**
 	 * Service name.
 	 */
 	private String serviceName;
 
-	private final Sender sender = new Sender();
-
 	public String getServiceName() {
 		return this.serviceName;
 	}
@@ -60,66 +37,4 @@ public void setServiceName(String serviceName) {
 		this.serviceName = serviceName;
 	}
 
-	public URI getUri() {
-		return this.uri;
-	}
-
-	public void setUri(URI uri) {
-		this.uri = uri;
-	}
-
-	public String getSource() {
-		return this.source;
-	}
-
-	public void setSource(String source) {
-		this.source = source;
-	}
-
-	public String getApiToken() {
-		return this.apiToken;
-	}
-
-	public void setApiToken(String apiToken) {
-		this.apiToken = apiToken;
-	}
-
-	public Sender getSender() {
-		return this.sender;
-	}
-
-	public static class Sender {
-
-		private int maxQueueSize = 50000;
-
-		private Duration flushInterval = Duration.ofSeconds(1);
-
-		private DataSize messageSize = DataSize.ofBytes(Integer.MAX_VALUE);
-
-		public int getMaxQueueSize() {
-			return this.maxQueueSize;
-		}
-
-		public void setMaxQueueSize(int maxQueueSize) {
-			this.maxQueueSize = maxQueueSize;
-		}
-
-		public Duration getFlushInterval() {
-			return this.flushInterval;
-		}
-
-		public void setFlushInterval(Duration flushInterval) {
-			this.flushInterval = flushInterval;
-		}
-
-		public DataSize getMessageSize() {
-			return this.messageSize;
-		}
-
-		public void setMessageSize(DataSize messageSize) {
-			this.messageSize = messageSize;
-		}
-
-	}
-
 }