Rebase with upstream main

krimsz · antonpperez · commit b73248874eab · 2022-07-04T09:32:01.000+02:00
diff --git a/spring-cloud-aws-autoconfigure/pom.xml b/spring-cloud-aws-autoconfigure/pom.xml
@@ -75,6 +75,11 @@
 			<artifactId>s3-transfer-manager</artifactId>
 			<optional>true</optional>
 		</dependency>
+		<dependency>
+			<groupId>software.amazon.awssdk</groupId>
+			<artifactId>cloudwatch-metric-publisher</artifactId>
+			<optional>true</optional>
+		</dependency>
 		<dependency>
 			<groupId>io.awspring.cloud</groupId>
 			<artifactId>spring-cloud-aws-s3-cross-region-client</artifactId>
diff --git a/spring-cloud-aws-autoconfigure/src/main/java/io/awspring/cloud/autoconfigure/AwsClientProperties.java b/spring-cloud-aws-autoconfigure/src/main/java/io/awspring/cloud/autoconfigure/AwsClientProperties.java
@@ -37,6 +37,12 @@ public abstract class AwsClientProperties {
 	@Nullable
 	private String region;
 
+	/**
+	 * Overrides the global enablement of the CloudWatch MetricsPublisher.
+	 */
+	@Nullable
+	private Boolean metricsEnabled;
+
 	@Nullable
 	public URI getEndpoint() {
 		return this.endpoint;
@@ -54,4 +60,13 @@ public String getRegion() {
 	public void setRegion(String region) {
 		this.region = region;
 	}
+
+	@Nullable
+	public Boolean getMetricsEnabled() {
+		return metricsEnabled;
+	}
+
+	public void setMetricsEnabled(@Nullable Boolean metricsEnabled) {
+		this.metricsEnabled = metricsEnabled;
+	}
 }
diff --git a/spring-cloud-aws-autoconfigure/src/main/java/io/awspring/cloud/autoconfigure/config/AbstractAwsConfigDataLocationResolver.java b/spring-cloud-aws-autoconfigure/src/main/java/io/awspring/cloud/autoconfigure/config/AbstractAwsConfigDataLocationResolver.java
@@ -22,9 +22,6 @@
 import io.awspring.cloud.autoconfigure.core.RegionProperties;
 import io.awspring.cloud.autoconfigure.core.RegionProviderAutoConfiguration;
 import io.awspring.cloud.core.SpringCloudClientConfiguration;
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.List;
 import org.springframework.boot.BootstrapContext;
 import org.springframework.boot.BootstrapRegistry;
 import org.springframework.boot.ConfigurableBootstrapContext;
@@ -40,9 +37,17 @@
 import org.springframework.util.StringUtils;
 import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider;
 import software.amazon.awssdk.awscore.client.builder.AwsClientBuilder;
+import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
+import software.amazon.awssdk.metrics.MetricPublisher;
+import software.amazon.awssdk.metrics.publishers.cloudwatch.CloudWatchMetricPublisher;
 import software.amazon.awssdk.regions.Region;
 import software.amazon.awssdk.regions.providers.AwsRegionProvider;
 
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.Optional;
+
 /**
  * Base class for AWS specific {@link ConfigDataLocationResolver}s.
  *
@@ -151,7 +156,23 @@ else if (awsProperties.getEndpoint() != null) {
 			builder.endpointOverride(awsProperties.getEndpoint());
 		}
 		builder.credentialsProvider(credentialsProvider);
-		builder.overrideConfiguration(new SpringCloudClientConfiguration().clientOverrideConfiguration());
+
+		Optional<MetricPublisher> metricPublisher;
+		try {
+			Class.forName("software.amazon.awssdk.metrics.publishers.cloudwatch.CloudWatchMetricPublisher");
+			metricPublisher = Optional.of(context.get(CloudWatchMetricPublisher.class));
+		}
+		catch (IllegalStateException | ClassNotFoundException e) {
+			metricPublisher = Optional.empty();
+		}
+		ClientOverrideConfiguration.Builder clientOverrideConfigurationBuilder = new SpringCloudClientConfiguration()
+				.clientOverrideConfigurationBuilder();
+		if ((awsProperties.getMetricsEnabled() == null || awsProperties.getMetricsEnabled())
+				&& (properties.getMetricsEnabled() == null || properties.getMetricsEnabled())
+				&& metricPublisher.isPresent()) {
+			clientOverrideConfigurationBuilder.addMetricPublisher(metricPublisher.get());
+		}
+		builder.overrideConfiguration(clientOverrideConfigurationBuilder.build());
 		return builder;
 	}
 
diff --git a/spring-cloud-aws-autoconfigure/src/main/java/io/awspring/cloud/autoconfigure/core/AwsAutoConfiguration.java b/spring-cloud-aws-autoconfigure/src/main/java/io/awspring/cloud/autoconfigure/core/AwsAutoConfiguration.java
@@ -15,12 +15,20 @@
  */
 package io.awspring.cloud.autoconfigure.core;
 
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider;
+import software.amazon.awssdk.metrics.LoggingMetricPublisher;
+import software.amazon.awssdk.metrics.MetricPublisher;
+import software.amazon.awssdk.metrics.publishers.cloudwatch.CloudWatchMetricPublisher;
 import software.amazon.awssdk.regions.providers.AwsRegionProvider;
 
+import java.time.Duration;
+
 /**
  * Autoconfigures AWS environment.
  *
@@ -37,6 +45,16 @@ public AwsAutoConfiguration(AwsProperties awsProperties) {
 		this.awsProperties = awsProperties;
 	}
 
+	@ConditionalOnClass(CloudWatchMetricPublisher.class)
+	static class MetricsAutoConfiguration {
+		@Bean
+		@ConditionalOnMissingBean
+		@ConditionalOnProperty(name = "spring.cloud.aws.metrics-enabled", havingValue = "true", matchIfMissing = true)
+		MetricPublisher cloudWatchMetricPublisher() {
+			return CloudWatchMetricPublisher.builder().build();
+		}
+	}
+
 	@Bean
 	public AwsClientBuilderConfigurer awsClientBuilderConfigurer(AwsCredentialsProvider credentialsProvider,
 			AwsRegionProvider awsRegionProvider) {
diff --git a/spring-cloud-aws-autoconfigure/src/main/java/io/awspring/cloud/autoconfigure/core/AwsClientBuilderConfigurer.java b/spring-cloud-aws-autoconfigure/src/main/java/io/awspring/cloud/autoconfigure/core/AwsClientBuilderConfigurer.java
@@ -17,16 +17,18 @@
 
 import io.awspring.cloud.autoconfigure.AwsClientProperties;
 import io.awspring.cloud.core.SpringCloudClientConfiguration;
-import java.util.Optional;
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
 import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider;
 import software.amazon.awssdk.awscore.client.builder.AwsClientBuilder;
 import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
+import software.amazon.awssdk.metrics.MetricPublisher;
 import software.amazon.awssdk.regions.Region;
 import software.amazon.awssdk.regions.providers.AwsRegionProvider;
 
+import java.util.Optional;
+
 /**
  * Provides a convenience method to apply common configuration to any {@link AwsClientBuilder}.
  *
@@ -44,20 +46,24 @@ public class AwsClientBuilderConfigurer {
 		this.credentialsProvider = credentialsProvider;
 		this.regionProvider = regionProvider;
 		this.awsProperties = awsProperties;
-		this.clientOverrideConfiguration = new SpringCloudClientConfiguration().clientOverrideConfiguration();
+		this.clientOverrideConfiguration = new SpringCloudClientConfiguration()
+				.clientOverrideConfiguration();
 	}
 
 	public <T extends AwsClientBuilder<?, ?>> T configure(T builder) {
-		return configure(builder, null, null);
+		return configure(builder, null, null, null);
 	}
 
 	public <T extends AwsClientBuilder<?, ?>> T configure(T builder, @Nullable AwsClientProperties clientProperties,
-			@Nullable AwsClientCustomizer<T> customizer) {
+			@Nullable AwsClientCustomizer<T> customizer, MetricPublisher metricPublisher) {
+		ClientOverrideConfiguration.Builder clientOverrideConfigurationBuilder = clientOverrideConfiguration.toBuilder();
 		Assert.notNull(builder, "builder is required");
 		Assert.notNull(clientProperties, "clientProperties are required");
-
+		if(metricPublisher != null) {
+			clientOverrideConfigurationBuilder.addMetricPublisher(metricPublisher).build();
+		}
 		builder.credentialsProvider(this.credentialsProvider).region(resolveRegion(clientProperties))
-				.overrideConfiguration(this.clientOverrideConfiguration);
+			.overrideConfiguration(clientOverrideConfigurationBuilder.build());
 		Optional.ofNullable(this.awsProperties.getEndpoint()).ifPresent(builder::endpointOverride);
 		Optional.ofNullable(clientProperties).map(AwsClientProperties::getEndpoint)
 				.ifPresent(builder::endpointOverride);
@@ -68,6 +74,7 @@ public class AwsClientBuilderConfigurer {
 		if (customizer != null) {
 			AwsClientCustomizer.apply(customizer, builder);
 		}
+
 		return builder;
 	}
 
diff --git a/spring-cloud-aws-autoconfigure/src/main/java/io/awspring/cloud/autoconfigure/core/AwsProperties.java b/spring-cloud-aws-autoconfigure/src/main/java/io/awspring/cloud/autoconfigure/core/AwsProperties.java
@@ -15,13 +15,14 @@
  */
 package io.awspring.cloud.autoconfigure.core;
 
-import static io.awspring.cloud.autoconfigure.core.AwsProperties.CONFIG_PREFIX;
-
-import java.net.URI;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.lang.Nullable;
 import software.amazon.awssdk.awscore.defaultsmode.DefaultsMode;
 
+import java.net.URI;
+
+import static io.awspring.cloud.autoconfigure.core.AwsProperties.CONFIG_PREFIX;
+
 /**
  * Configuration properties for AWS environment.
  *
@@ -60,6 +61,9 @@ public class AwsProperties {
 	@Nullable
 	private Boolean fipsEnabled;
 
+	@Nullable
+	private Boolean metricsEnabled;
+
 	@Nullable
 	public URI getEndpoint() {
 		return this.endpoint;
@@ -95,4 +99,13 @@ public Boolean getFipsEnabled() {
 	public void setFipsEnabled(@Nullable Boolean fipsEnabled) {
 		this.fipsEnabled = fipsEnabled;
 	}
+
+	@Nullable
+	public Boolean getMetricsEnabled() {
+		return metricsEnabled;
+	}
+
+	public void setMetricsEnabled(@Nullable Boolean metricsEnabled) {
+		this.metricsEnabled = metricsEnabled;
+	}
 }
diff --git a/spring-cloud-aws-core/src/test/java/io/awspring/cloud/core/SpringCloudClientConfigurationTests.java b/spring-cloud-aws-core/src/test/java/io/awspring/cloud/core/SpringCloudClientConfigurationTests.java
@@ -30,11 +30,11 @@ class SpringCloudClientConfigurationTests {
 
 	@Test
 	void returnsClientConfigurationWithVersion() {
-		ClientOverrideConfiguration clientOverrideConfiguration = new SpringCloudClientConfiguration()
-				.clientOverrideConfiguration();
+		ClientOverrideConfiguration.Builder clientOverrideConfigurationBuilder = new SpringCloudClientConfiguration()
+				.clientOverrideConfigurationBuilder();
 
-		assertThat(clientOverrideConfiguration.advancedOption(SdkAdvancedClientOption.USER_AGENT_SUFFIX)).isPresent()
-				.hasValueSatisfying(value -> {
+		assertThat(clientOverrideConfigurationBuilder.build().advancedOption(SdkAdvancedClientOption.USER_AGENT_SUFFIX))
+				.isPresent().hasValueSatisfying(value -> {
 					assertThat(value).startsWith("spring-cloud-aws");
 				});
 	}
