Expose Elastic's apiKeyCredentials property

See gh-28400

Author: jonatan-ivanov

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2021 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.
@@ -60,12 +60,14 @@ public class ElasticProperties extends StepRegistryProperties {
 	private boolean autoCreateIndex = true;
 
 	/**
-	 * Login user of the Elastic server.
+	 * Login user of the Elastic server. If API key is configured, it will be used for
+	 * authentication instead of username/password.
 	 */
 	private String userName;
 
 	/**
-	 * Login password of the Elastic server.
+	 * Login password of the Elastic server. If API key is configured, it will be used for
+	 * authentication instead of username/password.
 	 */
 	private String password;
 
@@ -74,6 +76,12 @@ public class ElasticProperties extends StepRegistryProperties {
 	 */
 	private String pipeline;
 
+	/**
+	 * Base64-encoded credentials string. If configured, it will be used for
+	 * authentication instead of username/password.
+	 */
+	private String apiKeyCredentials;
+
 	public String getHost() {
 		return this.host;
 	}
@@ -146,4 +154,12 @@ public void setPipeline(String pipeline) {
 		this.pipeline = pipeline;
 	}
 
+	public String getApiKeyCredentials() {
+		return this.apiKeyCredentials;
+	}
+
+	public void setApiKeyCredentials(String apiKeyCredentials) {
+		this.apiKeyCredentials = apiKeyCredentials;
+	}
+
 }

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2021 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.
@@ -82,4 +82,9 @@ public String pipeline() {
 		return get(ElasticProperties::getPipeline, ElasticConfig.super::pipeline);
 	}
 
+	@Override
+	public String apiKeyCredentials() {
+		return get(ElasticProperties::getApiKeyCredentials, ElasticConfig.super::apiKeyCredentials);
+	}
+
 }

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/elastic/ElasticPropertiesConfigAdapterTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2021 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.
@@ -90,4 +90,11 @@ void whenPropertiesPipelineIsSetAdapterPipelineReturnsIt() {
 		assertThat(new ElasticPropertiesConfigAdapter(properties).pipeline()).isEqualTo("testPipeline");
 	}
 
+	@Test
+	void whenPropertiesApiKeyCredentialsIsSetAdapterPipelineReturnsIt() {
+		ElasticProperties properties = new ElasticProperties();
+		properties.setApiKeyCredentials("secret");
+		assertThat(new ElasticPropertiesConfigAdapter(properties).apiKeyCredentials()).isEqualTo("secret");
+	}
+
 }

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/elastic/ElasticPropertiesTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2021 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.
@@ -44,6 +44,7 @@ void defaultValuesAreConsistent() {
 		assertThat(properties.getUserName()).isEqualTo(config.userName());
 		assertThat(properties.isAutoCreateIndex()).isEqualTo(config.autoCreateIndex());
 		assertThat(properties.getPipeline()).isEqualTo(config.pipeline());
+		assertThat(properties.getApiKeyCredentials()).isEqualTo(config.apiKeyCredentials());
 	}
 
 }