Polish "Add properties for Dynatrace metrics API v2 ingest with Micrometer"

Author: wilkinsona

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

@@ -18,10 +18,9 @@
 
 import java.util.Map;
 
-import io.micrometer.dynatrace.DynatraceApiVersion;
-
 import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.StepRegistryProperties;
 import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.DeprecatedConfigurationProperty;
 
 /**
  * {@link ConfigurationProperties @ConfigurationProperties} for configuring Dynatrace
@@ -34,73 +33,21 @@
 @ConfigurationProperties(prefix = "management.metrics.export.dynatrace")
 public class DynatraceProperties extends StepRegistryProperties {
 
-	/**
-	 * The Dynatrace metrics API version that metrics should be sent to. Defaults to v1.
-	 * Required to define which API is used for export.
-	 */
-	private DynatraceApiVersion apiVersion = DynatraceApiVersion.V1;
+	private final V1 v1 = new V1();
+
+	private final V2 v2 = new V2();
 
 	/**
 	 * Dynatrace authentication token.
-	 *
-	 * API v1: required, API v2: optional
 	 */
 	private String apiToken;
 
-	/**
-	 * ID of the custom device that is exporting metrics to Dynatrace.
-	 *
-	 * API v1: required, API v2: not applicable (ignored)
-	 */
-	private String deviceId;
-
-	/**
-	 * Technology type for exported metrics. Used to group metrics under a logical
-	 * technology name in the Dynatrace UI.
-	 *
-	 * API v1: required, API v2: not applicable (ignored)
-	 */
-	private String technologyType = "java";
-
 	/**
 	 * URI to ship metrics to. Should be used for SaaS, self managed instances or to
 	 * en-route through an internal proxy.
-	 *
-	 * API v1: required, API v2: optional
 	 */
 	private String uri;
 
-	/**
-	 * Group for exported metrics. Used to specify custom device group name in the
-	 * Dynatrace UI.
-	 *
-	 * API v1: required, API v2: not applicable (ignored)
-	 */
-	private String group;
-
-	/**
-	 * An optional prefix string that is added to all metrics exported.
-	 *
-	 * API v1: not applicable (ignored), API v2: optional
-	 */
-	private String metricKeyPrefix;
-
-	/**
-	 * An optional Boolean that allows enabling of the Dynatrace metadata export. On by
-	 * default.
-	 *
-	 * API v1: not applicable (ignored), API v2: optional
-	 */
-	private Boolean enrichWithDynatraceMetadata = true;
-
-	/**
-	 * Optional default dimensions that are added to all metrics in the form of key-value
-	 * pairs. These are overwritten by Micrometer tags if they use the same key.
-	 *
-	 * API v1: not applicable (ignored), API v2: optional
-	 */
-	private Map<String, String> defaultDimensions;
-
 	public String getApiToken() {
 		return this.apiToken;
 	}
@@ -109,20 +56,26 @@ public void setApiToken(String apiToken) {
 		this.apiToken = apiToken;
 	}
 
+	@Deprecated
+	@DeprecatedConfigurationProperty(replacement = "management.metrics.export.dynatrace.v1.device-id")
 	public String getDeviceId() {
-		return this.deviceId;
+		return this.v1.getDeviceId();
 	}
 
+	@Deprecated
 	public void setDeviceId(String deviceId) {
-		this.deviceId = deviceId;
+		this.v1.setDeviceId(deviceId);
 	}
 
+	@Deprecated
+	@DeprecatedConfigurationProperty(replacement = "management.metrics.export.dynatrace.v1.technology-type")
 	public String getTechnologyType() {
-		return this.technologyType;
+		return this.v1.getTechnologyType();
 	}
 
+	@Deprecated
 	public void setTechnologyType(String technologyType) {
-		this.technologyType = technologyType;
+		this.v1.setTechnologyType(technologyType);
 	}
 
 	public String getUri() {
@@ -133,44 +86,112 @@ public void setUri(String uri) {
 		this.uri = uri;
 	}
 
+	@Deprecated
+	@DeprecatedConfigurationProperty(replacement = "management.metrics.export.dynatrace.v1.group")
 	public String getGroup() {
-		return this.group;
+		return this.v1.getGroup();
 	}
 
+	@Deprecated
 	public void setGroup(String group) {
-		this.group = group;
+		this.v1.setGroup(group);
 	}
 
-	public String getMetricKeyPrefix() {
-		return this.metricKeyPrefix;
+	public V1 getV1() {
+		return this.v1;
 	}
 
-	public void setMetricKeyPrefix(String metricKeyPrefix) {
-		this.metricKeyPrefix = metricKeyPrefix;
+	public V2 getV2() {
+		return this.v2;
 	}
 
-	public Boolean getEnrichWithDynatraceMetadata() {
-		return this.enrichWithDynatraceMetadata;
-	}
+	public static class V1 {
 
-	public void setEnrichWithDynatraceMetadata(Boolean enrichWithDynatraceMetadata) {
-		this.enrichWithDynatraceMetadata = enrichWithDynatraceMetadata;
-	}
+		/**
+		 * ID of the custom device that is exporting metrics to Dynatrace.
+		 */
+		private String deviceId;
 
-	public Map<String, String> getDefaultDimensions() {
-		return this.defaultDimensions;
-	}
+		/**
+		 * Group for exported metrics. Used to specify custom device group name in the
+		 * Dynatrace UI.
+		 */
+		private String group;
 
-	public void setDefaultDimensions(Map<String, String> defaultDimensions) {
-		this.defaultDimensions = defaultDimensions;
-	}
+		/**
+		 * Technology type for exported metrics. Used to group metrics under a logical
+		 * technology name in the Dynatrace UI.
+		 */
+		private String technologyType = "java";
+
+		public String getDeviceId() {
+			return this.deviceId;
+		}
+
+		public void setDeviceId(String deviceId) {
+			this.deviceId = deviceId;
+		}
+
+		public String getGroup() {
+			return this.group;
+		}
+
+		public void setGroup(String group) {
+			this.group = group;
+		}
+
+		public String getTechnologyType() {
+			return this.technologyType;
+		}
+
+		public void setTechnologyType(String technologyType) {
+			this.technologyType = technologyType;
+		}
 
-	public DynatraceApiVersion getApiVersion() {
-		return this.apiVersion;
 	}
 
-	public void setApiVersion(DynatraceApiVersion apiVersion) {
-		this.apiVersion = apiVersion;
+	public static class V2 {
+
+		/**
+		 * Default dimensions that are added to all metrics in the form of key-value
+		 * pairs. These are overwritten by Micrometer tags if they use the same key.
+		 */
+		private Map<String, String> defaultDimensions;
+
+		/**
+		 * Whether to enable Dynatrace metadata export.
+		 */
+		private boolean enrichWithDynatraceMetadata = true;
+
+		/**
+		 * Prefix string that is added to all exported metrics.
+		 */
+		private String metricKeyPrefix;
+
+		public Map<String, String> getDefaultDimensions() {
+			return this.defaultDimensions;
+		}
+
+		public void setDefaultDimensions(Map<String, String> defaultDimensions) {
+			this.defaultDimensions = defaultDimensions;
+		}
+
+		public boolean isEnrichWithDynatraceMetadata() {
+			return this.enrichWithDynatraceMetadata;
+		}
+
+		public void setEnrichWithDynatraceMetadata(Boolean enrichWithDynatraceMetadata) {
+			this.enrichWithDynatraceMetadata = enrichWithDynatraceMetadata;
+		}
+
+		public String getMetricKeyPrefix() {
+			return this.metricKeyPrefix;
+		}
+
+		public void setMetricKeyPrefix(String metricKeyPrefix) {
+			this.metricKeyPrefix = metricKeyPrefix;
+		}
+
 	}
 
 }

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

@@ -17,10 +17,13 @@
 package org.springframework.boot.actuate.autoconfigure.metrics.export.dynatrace;
 
 import java.util.Map;
+import java.util.function.Function;
 
 import io.micrometer.dynatrace.DynatraceApiVersion;
 import io.micrometer.dynatrace.DynatraceConfig;
 
+import org.springframework.boot.actuate.autoconfigure.metrics.export.dynatrace.DynatraceProperties.V1;
+import org.springframework.boot.actuate.autoconfigure.metrics.export.dynatrace.DynatraceProperties.V2;
 import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.StepRegistryPropertiesConfigAdapter;
 
 /**
@@ -48,12 +51,12 @@ public String apiToken() {
 
 	@Override
 	public String deviceId() {
-		return get(DynatraceProperties::getDeviceId, DynatraceConfig.super::deviceId);
+		return get(v1(V1::getDeviceId), DynatraceConfig.super::deviceId);
 	}
 
 	@Override
 	public String technologyType() {
-		return get(DynatraceProperties::getTechnologyType, DynatraceConfig.super::technologyType);
+		return get(v1(V1::getTechnologyType), DynatraceConfig.super::technologyType);
 	}
 
 	@Override
@@ -63,27 +66,36 @@ public String uri() {
 
 	@Override
 	public String group() {
-		return get(DynatraceProperties::getGroup, DynatraceConfig.super::group);
+		return get(v1(V1::getGroup), DynatraceConfig.super::group);
 	}
 
 	@Override
 	public DynatraceApiVersion apiVersion() {
-		return get(DynatraceProperties::getApiVersion, DynatraceConfig.super::apiVersion);
+		return get((properties) -> (properties.getV1().getDeviceId() != null) ? DynatraceApiVersion.V1
+				: DynatraceApiVersion.V2, DynatraceConfig.super::apiVersion);
 	}
 
 	@Override
 	public String metricKeyPrefix() {
-		return get(DynatraceProperties::getMetricKeyPrefix, DynatraceConfig.super::metricKeyPrefix);
+		return get(v2(V2::getMetricKeyPrefix), DynatraceConfig.super::metricKeyPrefix);
 	}
 
 	@Override
 	public Map<String, String> defaultDimensions() {
-		return get(DynatraceProperties::getDefaultDimensions, DynatraceConfig.super::defaultDimensions);
+		return get(v2(V2::getDefaultDimensions), DynatraceConfig.super::defaultDimensions);
 	}
 
 	@Override
 	public boolean enrichWithDynatraceMetadata() {
-		return get(DynatraceProperties::getEnrichWithDynatraceMetadata,
-				DynatraceConfig.super::enrichWithDynatraceMetadata);
+		return get(v2(V2::isEnrichWithDynatraceMetadata), DynatraceConfig.super::enrichWithDynatraceMetadata);
 	}
+
+	private <V> Function<DynatraceProperties, V> v1(Function<V1, V> getter) {
+		return (properties) -> getter.apply(properties.getV1());
+	}
+
+	private <V> Function<DynatraceProperties, V> v2(Function<V2, V> getter) {
+		return (properties) -> getter.apply(properties.getV2());
+	}
+
 }

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

@@ -48,14 +48,15 @@ void backsOffWithoutAClock() {
 	}
 
 	@Test
-	void failsWithoutAUri() {
+	void failsWithADeviceIdWithoutAUri() {
 		this.contextRunner.withUserConfiguration(BaseConfiguration.class)
+				.withPropertyValues("management.metrics.export.dynatrace.device-id:dev-1")
 				.run((context) -> assertThat(context).hasFailed());
 	}
 
 	@Test
 	void autoConfiguresConfigAndMeterRegistry() {
-		this.contextRunner.withUserConfiguration(BaseConfiguration.class).with(mandatoryProperties())
+		this.contextRunner.withUserConfiguration(BaseConfiguration.class).with(v1MandatoryProperties())
 				.run((context) -> assertThat(context).hasSingleBean(DynatraceMeterRegistry.class)
 						.hasSingleBean(DynatraceConfig.class));
 	}
@@ -85,22 +86,33 @@ void allowsCustomConfigToBeUsed() {
 
 	@Test
 	void allowsCustomRegistryToBeUsed() {
-		this.contextRunner.withUserConfiguration(CustomRegistryConfiguration.class).with(mandatoryProperties())
+		this.contextRunner.withUserConfiguration(CustomRegistryConfiguration.class).with(v1MandatoryProperties())
 				.run((context) -> assertThat(context).hasSingleBean(DynatraceMeterRegistry.class)
 						.hasBean("customRegistry").hasSingleBean(DynatraceConfig.class));
 	}
 
 	@Test
-	void stopsMeterRegistryWhenContextIsClosed() {
-		this.contextRunner.withUserConfiguration(BaseConfiguration.class).with(mandatoryProperties()).run((context) -> {
+	void stopsMeterRegistryForV1ApiWhenContextIsClosed() {
+		this.contextRunner.withUserConfiguration(BaseConfiguration.class).with(v1MandatoryProperties())
+				.run((context) -> {
+					DynatraceMeterRegistry registry = context.getBean(DynatraceMeterRegistry.class);
+					assertThat(registry.isClosed()).isFalse();
+					context.close();
+					assertThat(registry.isClosed()).isTrue();
+				});
+	}
+
+	@Test
+	void stopsMeterRegistryForV2ApiWhenContextIsClosed() {
+		this.contextRunner.withUserConfiguration(BaseConfiguration.class).run((context) -> {
 			DynatraceMeterRegistry registry = context.getBean(DynatraceMeterRegistry.class);
 			assertThat(registry.isClosed()).isFalse();
 			context.close();
 			assertThat(registry.isClosed()).isTrue();
 		});
 	}
 
-	private Function<ApplicationContextRunner, ApplicationContextRunner> mandatoryProperties() {
+	private Function<ApplicationContextRunner, ApplicationContextRunner> v1MandatoryProperties() {
 		return (runner) -> runner.withPropertyValues(
 				"management.metrics.export.dynatrace.uri=https://dynatrace.example.com",
 				"management.metrics.export.dynatrace.api-token=abcde",