Introduce PushRegistry abstraction

This commit introduces a separate layer between PushRegistry and
StepRegistry-based implementations.

See gh-17699

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

@@ -0,0 +1,111 @@
+/*
+ * Copyright 2012-2019 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.properties;
+
+import java.time.Duration;
+
+/**
+ * Base class for properties that configure a metrics registry that pushes aggregated
+ * metrics on a regular interval.
+ *
+ * @author Jon Schneider
+ * @author Andy Wilkinson
+ * @author Stephane Nicoll
+ * @since 2.2.0
+ */
+public abstract class PushRegistryProperties {
+
+	/**
+	 * Step size (i.e. reporting frequency) to use.
+	 */
+	private Duration step = Duration.ofMinutes(1);
+
+	/**
+	 * Whether exporting of metrics to this backend is enabled.
+	 */
+	private boolean enabled = true;
+
+	/**
+	 * Connection timeout for requests to this backend.
+	 */
+	private Duration connectTimeout = Duration.ofSeconds(1);
+
+	/**
+	 * Read timeout for requests to this backend.
+	 */
+	private Duration readTimeout = Duration.ofSeconds(10);
+
+	/**
+	 * Number of threads to use with the metrics publishing scheduler.
+	 */
+	private Integer numThreads = 2;
+
+	/**
+	 * Number of measurements per request to use for this backend. If more measurements
+	 * are found, then multiple requests will be made.
+	 */
+	private Integer batchSize = 10000;
+
+	public Duration getStep() {
+		return this.step;
+	}
+
+	public void setStep(Duration step) {
+		this.step = step;
+	}
+
+	public boolean isEnabled() {
+		return this.enabled;
+	}
+
+	public void setEnabled(boolean enabled) {
+		this.enabled = enabled;
+	}
+
+	public Duration getConnectTimeout() {
+		return this.connectTimeout;
+	}
+
+	public void setConnectTimeout(Duration connectTimeout) {
+		this.connectTimeout = connectTimeout;
+	}
+
+	public Duration getReadTimeout() {
+		return this.readTimeout;
+	}
+
+	public void setReadTimeout(Duration readTimeout) {
+		this.readTimeout = readTimeout;
+	}
+
+	public Integer getNumThreads() {
+		return this.numThreads;
+	}
+
+	public void setNumThreads(Integer numThreads) {
+		this.numThreads = numThreads;
+	}
+
+	public Integer getBatchSize() {
+		return this.batchSize;
+	}
+
+	public void setBatchSize(Integer batchSize) {
+		this.batchSize = batchSize;
+	}
+
+}

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

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2012-2019 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.properties;
+
+import java.time.Duration;
+
+import io.micrometer.core.instrument.push.PushRegistryConfig;
+
+/**
+ * Base class for {@link PushRegistryProperties} to {@link PushRegistryConfig} adapters.
+ *
+ * @param <T> the properties type
+ * @author Jon Schneider
+ * @author Phillip Webb
+ * @author Artsiom Yudovin
+ * @since 2.2.0
+ */
+public abstract class PushRegistryPropertiesConfigAdapter<T extends PushRegistryProperties>
+		extends PropertiesConfigAdapter<T> implements PushRegistryConfig {
+
+	public PushRegistryPropertiesConfigAdapter(T properties) {
+		super(properties);
+	}
+
+	@Override
+	public String prefix() {
+		return null;
+	}
+
+	@Override
+	public String get(String k) {
+		return null;
+	}
+
+	@Override
+	public Duration step() {
+		return get(T::getStep, PushRegistryConfig.super::step);
+	}
+
+	@Override
+	public boolean enabled() {
+		return get(T::isEnabled, PushRegistryConfig.super::enabled);
+	}
+
+	@Override
+	public int numThreads() {
+		return get(T::getNumThreads, PushRegistryConfig.super::numThreads);
+	}
+
+	@Override
+	public int batchSize() {
+		return get(T::getBatchSize, PushRegistryConfig.super::batchSize);
+	}
+
+}

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

@@ -16,96 +16,14 @@
 
 package org.springframework.boot.actuate.autoconfigure.metrics.export.properties;
 
-import java.time.Duration;
-
 /**
- * Base class for properties that configure a metrics registry that pushes aggregated
+ * {@link PushRegistryProperties} extensions for registries that are step-normalized.
- * metrics on a regular interval.
  *
  * @author Jon Schneider
  * @author Andy Wilkinson
  * @author Stephane Nicoll
  * @since 2.0.0
  */
-public abstract class StepRegistryProperties {
+public abstract class StepRegistryProperties extends PushRegistryProperties {
-
-	/**
-	 * Step size (i.e. reporting frequency) to use.
-	 */
-	private Duration step = Duration.ofMinutes(1);
-
-	/**
-	 * Whether exporting of metrics to this backend is enabled.
-	 */
-	private boolean enabled = true;
-
-	/**
-	 * Connection timeout for requests to this backend.
-	 */
-	private Duration connectTimeout = Duration.ofSeconds(1);
-
-	/**
-	 * Read timeout for requests to this backend.
-	 */
-	private Duration readTimeout = Duration.ofSeconds(10);
-
-	/**
-	 * Number of threads to use with the metrics publishing scheduler.
-	 */
-	private Integer numThreads = 2;
-
-	/**
-	 * Number of measurements per request to use for this backend. If more measurements
-	 * are found, then multiple requests will be made.
-	 */
-	private Integer batchSize = 10000;
-
-	public Duration getStep() {
-		return this.step;
-	}
-
-	public void setStep(Duration step) {
-		this.step = step;
-	}
-
-	public boolean isEnabled() {
-		return this.enabled;
-	}
-
-	public void setEnabled(boolean enabled) {
-		this.enabled = enabled;
-	}
-
-	public Duration getConnectTimeout() {
-		return this.connectTimeout;
-	}
-
-	public void setConnectTimeout(Duration connectTimeout) {
-		this.connectTimeout = connectTimeout;
-	}
-
-	public Duration getReadTimeout() {
-		return this.readTimeout;
-	}
-
-	public void setReadTimeout(Duration readTimeout) {
-		this.readTimeout = readTimeout;
-	}
-
-	public Integer getNumThreads() {
-		return this.numThreads;
-	}
-
-	public void setNumThreads(Integer numThreads) {
-		this.numThreads = numThreads;
-	}
-
-	public Integer getBatchSize() {
-		return this.batchSize;
-	}
-
-	public void setBatchSize(Integer batchSize) {
-		this.batchSize = batchSize;
-	}
 
 }

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

@@ -16,8 +16,6 @@
 
 package org.springframework.boot.actuate.autoconfigure.metrics.export.properties;
 
-import java.time.Duration;
-
 import io.micrometer.core.instrument.step.StepRegistryConfig;
 
 /**
@@ -30,40 +28,10 @@ import io.micrometer.core.instrument.step.StepRegistryConfig;
  * @since 2.0.0
  */
 public abstract class StepRegistryPropertiesConfigAdapter<T extends StepRegistryProperties>
-		extends PropertiesConfigAdapter<T> implements StepRegistryConfig {
+		extends PushRegistryPropertiesConfigAdapter<T> {
 
 	public StepRegistryPropertiesConfigAdapter(T properties) {
 		super(properties);
 	}
 
-	@Override
-	public String prefix() {
-		return null;
-	}
-
-	@Override
-	public String get(String k) {
-		return null;
-	}
-
-	@Override
-	public Duration step() {
-		return get(T::getStep, StepRegistryConfig.super::step);
-	}
-
-	@Override
-	public boolean enabled() {
-		return get(T::isEnabled, StepRegistryConfig.super::enabled);
-	}
-
-	@Override
-	public int numThreads() {
-		return get(T::getNumThreads, StepRegistryConfig.super::numThreads);
-	}
-
-	@Override
-	public int batchSize() {
-		return get(T::getBatchSize, StepRegistryConfig.super::batchSize);
-	}
-
 }

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

@@ -19,7 +19,7 @@ package org.springframework.boot.actuate.autoconfigure.metrics.export.wavefront;
 import java.net.URI;
 import java.time.Duration;
 
-import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.StepRegistryProperties;
+import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.PushRegistryProperties;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 
 /**
@@ -30,7 +30,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
  * @since 2.0.0
  */
 @ConfigurationProperties("management.metrics.export.wavefront")
-public class WavefrontProperties extends StepRegistryProperties {
+public class WavefrontProperties extends PushRegistryProperties {
 
 	/**
 	 * Step size (i.e. reporting frequency) to use.

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

@@ -18,7 +18,7 @@ package org.springframework.boot.actuate.autoconfigure.metrics.export.wavefront;
 
 import io.micrometer.wavefront.WavefrontConfig;
 
-import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.StepRegistryPropertiesConfigAdapter;
+import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.PushRegistryPropertiesConfigAdapter;
 
 /**
  * Adapter to convert {@link WavefrontProperties} to a {@link WavefrontConfig}.
@@ -26,7 +26,7 @@ import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.
  * @author Jon Schneider
  * @since 2.0.0
  */
-public class WavefrontPropertiesConfigAdapter extends StepRegistryPropertiesConfigAdapter<WavefrontProperties>
+public class WavefrontPropertiesConfigAdapter extends PushRegistryPropertiesConfigAdapter<WavefrontProperties>
 		implements WavefrontConfig {
 
 	public WavefrontPropertiesConfigAdapter(WavefrontProperties properties) {

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

@@ -0,0 +1,67 @@
+/*
+ * Copyright 2012-2019 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.properties;
+
+import java.time.Duration;
+
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Base test for {@link PushRegistryPropertiesConfigAdapter} implementations.
+ *
+ * @param <P> properties used by the tests
+ * @param <A> adapter used by the tests
+ * @author Stephane Nicoll
+ * @author Artsiom Yudovin
+ */
+public abstract class PushRegistryPropertiesConfigAdapterTests<P extends PushRegistryProperties, A extends PushRegistryPropertiesConfigAdapter<P>> {
+
+	protected abstract P createProperties();
+
+	protected abstract A createConfigAdapter(P properties);
+
+	@Test
+	void whenPropertiesStepIsSetAdapterStepReturnsIt() {
+		P properties = createProperties();
+		properties.setStep(Duration.ofSeconds(42));
+		assertThat(createConfigAdapter(properties).step()).isEqualTo(Duration.ofSeconds(42));
+	}
+
+	@Test
+	void whenPropertiesEnabledIsSetAdapterEnabledReturnsIt() {
+		P properties = createProperties();
+		properties.setEnabled(false);
+		assertThat(createConfigAdapter(properties).enabled()).isFalse();
+	}
+
+	@Test
+	void whenPropertiesNumThreadsIsSetAdapterNumThreadsReturnsIt() {
+		P properties = createProperties();
+		properties.setNumThreads(42);
+		assertThat(createConfigAdapter(properties).numThreads()).isEqualTo(42);
+	}
+
+	@Test
+	void whenPropertiesBatchSizeIsSetAdapterBatchSizeReturnsIt() {
+		P properties = createProperties();
+		properties.setBatchSize(10042);
+		assertThat(createConfigAdapter(properties).batchSize()).isEqualTo(10042);
+	}
+
+}

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

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2012-2019 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.properties;
+
+import io.micrometer.core.instrument.push.PushRegistryConfig;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Base tests for {@link PushRegistryProperties} implementation.
+ *
+ * @author Stephane Nicoll
+ */
+public abstract class PushRegistryPropertiesTests {
+
+	@SuppressWarnings("deprecation")
+	protected void assertStepRegistryDefaultValues(PushRegistryProperties properties, PushRegistryConfig config) {
+		assertThat(properties.getStep()).isEqualTo(config.step());
+		assertThat(properties.isEnabled()).isEqualTo(config.enabled());
+		assertThat(properties.getConnectTimeout()).isEqualTo(config.connectTimeout());
+		assertThat(properties.getReadTimeout()).isEqualTo(config.readTimeout());
+		assertThat(properties.getNumThreads()).isEqualTo(config.numThreads());
+		assertThat(properties.getBatchSize()).isEqualTo(config.batchSize());
+	}
+
+}

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

@@ -16,12 +16,6 @@
 
 package org.springframework.boot.actuate.autoconfigure.metrics.export.properties;
 
-import java.time.Duration;
-
-import org.junit.jupiter.api.Test;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
 /**
  * Base test for {@link StepRegistryPropertiesConfigAdapter} implementations.
  *
@@ -30,38 +24,7 @@ import static org.assertj.core.api.Assertions.assertThat;
  * @author Stephane Nicoll
  * @author Artsiom Yudovin
  */
-public abstract class StepRegistryPropertiesConfigAdapterTests<P extends StepRegistryProperties, A extends StepRegistryPropertiesConfigAdapter<P>> {
+public abstract class StepRegistryPropertiesConfigAdapterTests<P extends StepRegistryProperties, A extends StepRegistryPropertiesConfigAdapter<P>>
-
+		extends PushRegistryPropertiesConfigAdapterTests<P, A> {
-	protected abstract P createProperties();
-
-	protected abstract A createConfigAdapter(P properties);
-
-	@Test
-	void whenPropertiesStepIsSetAdapterStepReturnsIt() {
-		P properties = createProperties();
-		properties.setStep(Duration.ofSeconds(42));
-		assertThat(createConfigAdapter(properties).step()).isEqualTo(Duration.ofSeconds(42));
-	}
-
-	@Test
-	void whenPropertiesEnabledIsSetAdapterEnabledReturnsIt() {
-		P properties = createProperties();
-		properties.setEnabled(false);
-		assertThat(createConfigAdapter(properties).enabled()).isFalse();
-	}
-
-	@Test
-	void whenPropertiesNumThreadsIsSetAdapterNumThreadsReturnsIt() {
-		P properties = createProperties();
-		properties.setNumThreads(42);
-		assertThat(createConfigAdapter(properties).numThreads()).isEqualTo(42);
-	}
-
-	@Test
-	void whenPropertiesBatchSizeIsSetAdapterBatchSizeReturnsIt() {
-		P properties = createProperties();
-		properties.setBatchSize(10042);
-		assertThat(createConfigAdapter(properties).batchSize()).isEqualTo(10042);
-	}
 
 }

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

@@ -18,23 +18,15 @@ package org.springframework.boot.actuate.autoconfigure.metrics.export.properties
 
 import io.micrometer.core.instrument.step.StepRegistryConfig;
 
-import static org.assertj.core.api.Assertions.assertThat;
-
 /**
  * Base tests for {@link StepRegistryProperties} implementation.
  *
  * @author Stephane Nicoll
  */
-public abstract class StepRegistryPropertiesTests {
+public abstract class StepRegistryPropertiesTests extends PushRegistryPropertiesTests {
 
-	@SuppressWarnings("deprecation")
 	protected void assertStepRegistryDefaultValues(StepRegistryProperties properties, StepRegistryConfig config) {
-		assertThat(properties.getStep()).isEqualTo(config.step());
+		super.assertStepRegistryDefaultValues(properties, config);
-		assertThat(properties.isEnabled()).isEqualTo(config.enabled());
-		assertThat(properties.getConnectTimeout()).isEqualTo(config.connectTimeout());
-		assertThat(properties.getReadTimeout()).isEqualTo(config.readTimeout());
-		assertThat(properties.getNumThreads()).isEqualTo(config.numThreads());
-		assertThat(properties.getBatchSize()).isEqualTo(config.batchSize());
 	}
 
 }

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

@@ -20,7 +20,7 @@ import java.net.URI;
 
 import org.junit.jupiter.api.Test;
 
-import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.StepRegistryPropertiesConfigAdapterTests;
+import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.PushRegistryPropertiesConfigAdapterTests;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -30,7 +30,7 @@ import static org.assertj.core.api.Assertions.assertThat;
  * @author Stephane Nicoll
  */
 class WavefrontPropertiesConfigAdapterTests
-		extends StepRegistryPropertiesConfigAdapterTests<WavefrontProperties, WavefrontPropertiesConfigAdapter> {
+		extends PushRegistryPropertiesConfigAdapterTests<WavefrontProperties, WavefrontPropertiesConfigAdapter> {
 
 	@Override
 	protected WavefrontProperties createProperties() {

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

@@ -19,7 +19,7 @@ package org.springframework.boot.actuate.autoconfigure.metrics.export.wavefront;
 import io.micrometer.wavefront.WavefrontConfig;
 import org.junit.jupiter.api.Test;
 
-import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.StepRegistryPropertiesTests;
+import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.PushRegistryPropertiesTests;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -28,7 +28,7 @@ import static org.assertj.core.api.Assertions.assertThat;
  *
  * @author Stephane Nicoll
  */
-class WavefrontPropertiesTests extends StepRegistryPropertiesTests {
+class WavefrontPropertiesTests extends PushRegistryPropertiesTests {
 
 	@Test
 	void defaultValuesAreConsistent() {