PoC

krimsz · krimsz · commit 5b77aabc44c1 · 2022-05-08T22:59:19.000+02:00
diff --git a/spring-cloud-aws-autoconfigure/pom.xml b/spring-cloud-aws-autoconfigure/pom.xml
@@ -64,6 +64,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 endpoint;
@@ -55,4 +61,12 @@ 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,14 +17,16 @@
 
 import io.awspring.cloud.autoconfigure.AwsClientProperties;
 import io.awspring.cloud.core.SpringCloudClientConfiguration;
-import java.util.Optional;
 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}.
  *
@@ -35,19 +37,22 @@ public class AwsClientBuilderConfigurer {
 	private final AwsCredentialsProvider credentialsProvider;
 	private final AwsRegionProvider regionProvider;
 	private final AwsProperties awsProperties;
-	private final ClientOverrideConfiguration clientOverrideConfiguration;
+	private final ClientOverrideConfiguration.Builder clientOverrideConfigurationBuilder;
 
 	AwsClientBuilderConfigurer(AwsCredentialsProvider credentialsProvider, AwsRegionProvider regionProvider,
 			AwsProperties awsProperties) {
 		this.credentialsProvider = credentialsProvider;
 		this.regionProvider = regionProvider;
 		this.awsProperties = awsProperties;
-		this.clientOverrideConfiguration = new SpringCloudClientConfiguration().clientOverrideConfiguration();
+		this.clientOverrideConfigurationBuilder = new SpringCloudClientConfiguration()
+				.clientOverrideConfigurationBuilder();
 	}
 
-	public AwsClientBuilder<?, ?> configure(AwsClientBuilder<?, ?> builder, AwsClientProperties clientProperties) {
+	public AwsClientBuilder<?, ?> configure(AwsClientBuilder<?, ?> builder, AwsClientProperties clientProperties,
+			Optional<MetricPublisher> metricPublisher) {
+		metricPublisher.ifPresent(clientOverrideConfigurationBuilder::addMetricPublisher);
 		builder.credentialsProvider(credentialsProvider).region(resolveRegion(clientProperties))
-				.overrideConfiguration(clientOverrideConfiguration);
+				.overrideConfiguration(clientOverrideConfigurationBuilder.build());
 		Optional.ofNullable(awsProperties.getEndpoint()).ifPresent(builder::endpointOverride);
 		Optional.ofNullable(clientProperties.getEndpoint()).ifPresent(builder::endpointOverride);
 		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,12 +15,13 @@
  */
 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 java.net.URI;
+
+import static io.awspring.cloud.autoconfigure.core.AwsProperties.CONFIG_PREFIX;
+
 /**
  * Configuration properties for AWS environment.
  *
@@ -40,6 +41,9 @@ public class AwsProperties {
 	@Nullable
 	private URI endpoint;
 
+	@Nullable
+	private Boolean metricsEnabled;
+
 	@Nullable
 	public URI getEndpoint() {
 		return endpoint;
@@ -48,4 +52,13 @@ public URI getEndpoint() {
 	public void setEndpoint(@Nullable URI endpoint) {
 		this.endpoint = endpoint;
 	}
+
+	@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/s3/S3AutoConfiguration.java b/spring-cloud-aws-autoconfigure/src/main/java/io/awspring/cloud/autoconfigure/s3/S3AutoConfiguration.java
@@ -29,7 +29,6 @@
 import io.awspring.cloud.s3.S3ProtocolResolver;
 import io.awspring.cloud.s3.S3Template;
 import io.awspring.cloud.s3.crossregion.CrossRegionS3Client;
-import java.util.Optional;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
@@ -41,10 +40,13 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
+import software.amazon.awssdk.metrics.MetricPublisher;
 import software.amazon.awssdk.services.s3.S3Client;
 import software.amazon.awssdk.services.s3.S3ClientBuilder;
 import software.amazon.awssdk.services.s3.S3Configuration;
 
+import java.util.Optional;
+
 /**
  * {@link EnableAutoConfiguration} for {@link S3Client} and {@link S3ProtocolResolver}.
  *
@@ -58,16 +60,26 @@
 public class S3AutoConfiguration {
 
 	private final S3Properties properties;
+	private final AwsProperties awsProperties;
 
-	public S3AutoConfiguration(S3Properties properties) {
+	public S3AutoConfiguration(AwsProperties awsProperties, S3Properties properties) {
 		this.properties = properties;
+		this.awsProperties = awsProperties;
 	}
 
 	@Bean
 	@ConditionalOnMissingBean
-	S3ClientBuilder s3ClientBuilder(AwsClientBuilderConfigurer awsClientBuilderConfigurer) {
-		S3ClientBuilder builder = (S3ClientBuilder) awsClientBuilderConfigurer.configure(S3Client.builder(),
-				this.properties);
+	S3ClientBuilder s3ClientBuilder(AwsClientBuilderConfigurer awsClientBuilderConfigurer,
+			Optional<MetricPublisher> metricPublisher) {
+		S3ClientBuilder builder;
+		if (awsProperties.getMetricsEnabled() == null || awsProperties.getMetricsEnabled()) {
+			builder = (S3ClientBuilder) awsClientBuilderConfigurer.configure(S3Client.builder(), this.properties,
+					metricPublisher);
+		}
+		else {
+			builder = (S3ClientBuilder) awsClientBuilderConfigurer.configure(S3Client.builder(), this.properties,
+					Optional.empty());
+		}
 		builder.serviceConfiguration(s3ServiceConfiguration());
 		return builder;
 	}
diff --git a/spring-cloud-aws-autoconfigure/src/main/java/io/awspring/cloud/autoconfigure/ses/SesAutoConfiguration.java b/spring-cloud-aws-autoconfigure/src/main/java/io/awspring/cloud/autoconfigure/ses/SesAutoConfiguration.java
@@ -16,11 +16,11 @@
 package io.awspring.cloud.autoconfigure.ses;
 
 import io.awspring.cloud.autoconfigure.core.AwsClientBuilderConfigurer;
+import io.awspring.cloud.autoconfigure.core.AwsProperties;
 import io.awspring.cloud.autoconfigure.core.CredentialsProviderAutoConfiguration;
 import io.awspring.cloud.autoconfigure.core.RegionProviderAutoConfiguration;
 import io.awspring.cloud.ses.SimpleEmailServiceJavaMailSender;
 import io.awspring.cloud.ses.SimpleEmailServiceMailSender;
-import javax.mail.Session;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
@@ -32,8 +32,12 @@
 import org.springframework.context.annotation.Configuration;
 import org.springframework.mail.MailSender;
 import org.springframework.mail.javamail.JavaMailSender;
+import software.amazon.awssdk.metrics.MetricPublisher;
 import software.amazon.awssdk.services.ses.SesClient;
 
+import javax.mail.Session;
+import java.util.Optional;
+
 /**
  * {@link EnableAutoConfiguration} for {@link SimpleEmailServiceMailSender} and
  * {@link SimpleEmailServiceJavaMailSender}.
@@ -43,16 +47,29 @@
  * @author Arun Patra
  */
 @Configuration(proxyBeanMethods = false)
-@EnableConfigurationProperties(SesProperties.class)
+@EnableConfigurationProperties({ SesProperties.class, AwsProperties.class })
 @ConditionalOnClass({ SesClient.class, MailSender.class, SimpleEmailServiceJavaMailSender.class })
 @AutoConfigureAfter({ CredentialsProviderAutoConfiguration.class, RegionProviderAutoConfiguration.class })
 @ConditionalOnProperty(name = "spring.cloud.aws.ses.enabled", havingValue = "true", matchIfMissing = true)
 public class SesAutoConfiguration {
+	private final AwsProperties awsProperties;
+
+	public SesAutoConfiguration(AwsProperties awsProperties) {
+		this.awsProperties = awsProperties;
+	}
 
 	@Bean
 	@ConditionalOnMissingBean
-	public SesClient sesClient(SesProperties properties, AwsClientBuilderConfigurer awsClientBuilderConfigurer) {
-		return (SesClient) awsClientBuilderConfigurer.configure(SesClient.builder(), properties).build();
+	public SesClient sesClient(SesProperties properties, AwsClientBuilderConfigurer awsClientBuilderConfigurer,
+			Optional<MetricPublisher> metricPublisher) {
+		if (awsProperties.getMetricsEnabled() == null || awsProperties.getMetricsEnabled()) {
+			return (SesClient) awsClientBuilderConfigurer
+					.configure(SesClient.builder(), properties, metricPublisher).build();
+		}
+		else {
+			return (SesClient) awsClientBuilderConfigurer.configure(SesClient.builder(), properties, Optional.empty())
+					.build();
+		}
 	}
 
 	@Bean
diff --git a/spring-cloud-aws-autoconfigure/src/main/java/io/awspring/cloud/autoconfigure/sns/SnsAutoConfiguration.java b/spring-cloud-aws-autoconfigure/src/main/java/io/awspring/cloud/autoconfigure/sns/SnsAutoConfiguration.java
@@ -19,6 +19,7 @@
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import io.awspring.cloud.autoconfigure.core.AwsClientBuilderConfigurer;
+import io.awspring.cloud.autoconfigure.core.AwsProperties;
 import io.awspring.cloud.autoconfigure.core.CredentialsProviderAutoConfiguration;
 import io.awspring.cloud.autoconfigure.core.RegionProviderAutoConfiguration;
 import io.awspring.cloud.sns.core.SnsTemplate;
@@ -36,6 +37,8 @@
 import org.springframework.messaging.converter.MappingJackson2MessageConverter;
 import org.springframework.web.method.support.HandlerMethodArgumentResolver;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+import software.amazon.awssdk.metrics.MetricPublisher;
+import software.amazon.awssdk.metrics.publishers.cloudwatch.CloudWatchMetricPublisher;
 import software.amazon.awssdk.services.sns.SnsClient;
 
 /**
@@ -50,21 +53,31 @@
  */
 @Configuration(proxyBeanMethods = false)
 @ConditionalOnClass({ SnsClient.class, SnsTemplate.class })
-@EnableConfigurationProperties({ SnsProperties.class })
+@EnableConfigurationProperties({ SnsProperties.class, AwsProperties.class })
 @AutoConfigureAfter({ CredentialsProviderAutoConfiguration.class, RegionProviderAutoConfiguration.class })
 @ConditionalOnProperty(name = "spring.cloud.aws.sns.enabled", havingValue = "true", matchIfMissing = true)
 public class SnsAutoConfiguration {
 
 	private final SnsProperties properties;
+	private final AwsProperties awsProperties;
 
-	public SnsAutoConfiguration(SnsProperties properties) {
+	public SnsAutoConfiguration(SnsProperties properties, AwsProperties awsProperties) {
 		this.properties = properties;
+		this.awsProperties = awsProperties;
 	}
 
 	@ConditionalOnMissingBean
 	@Bean
-	public SnsClient snsClient(AwsClientBuilderConfigurer awsClientBuilderConfigurer) {
-		return (SnsClient) awsClientBuilderConfigurer.configure(SnsClient.builder(), this.properties).build();
+	public SnsClient snsClient(AwsClientBuilderConfigurer awsClientBuilderConfigurer,
+			Optional<MetricPublisher> metricPublisher) {
+		if (awsProperties.getMetricsEnabled() == null || awsProperties.getMetricsEnabled()) {
+			return (SnsClient) awsClientBuilderConfigurer
+					.configure(SnsClient.builder(), this.properties, metricPublisher).build();
+		}
+		else {
+			return (SnsClient) awsClientBuilderConfigurer
+					.configure(SnsClient.builder(), this.properties, Optional.empty()).build();
+		}
 	}
 
 	@ConditionalOnMissingBean
diff --git a/spring-cloud-aws-core/src/main/java/io/awspring/cloud/core/SpringCloudClientConfiguration.java b/spring-cloud-aws-core/src/main/java/io/awspring/cloud/core/SpringCloudClientConfiguration.java
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
