From 935d621a42dfc0290598025a71e9a08f642def89 Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Mon, 15 Oct 2018 23:18:12 +0200 Subject: [PATCH] Fix mapping of Wavefront base properties Closes gh-14839 --- .../WavefrontPropertiesConfigAdapter.java | 5 +- ...WavefrontPropertiesConfigAdapterTests.java | 75 +++++++++++++++++++ .../appendix-application-properties.adoc | 2 +- 3 files changed, 79 insertions(+), 3 deletions(-) create mode 100644 spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/wavefront/WavefrontPropertiesConfigAdapterTests.java diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/wavefront/WavefrontPropertiesConfigAdapter.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/wavefront/WavefrontPropertiesConfigAdapter.java index 3151cddca2..409ffc38de 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/wavefront/WavefrontPropertiesConfigAdapter.java +++ b/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.PropertiesConfigAdapter; +import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.StepRegistryPropertiesConfigAdapter; /** * Adapter to convert {@link WavefrontProperties} to a {@link WavefrontConfig}. @@ -27,7 +27,8 @@ import org.springframework.boot.actuate.autoconfigure.metrics.export.properties. * @since 2.0.0 */ public class WavefrontPropertiesConfigAdapter - extends PropertiesConfigAdapter implements WavefrontConfig { + extends StepRegistryPropertiesConfigAdapter + implements WavefrontConfig { public WavefrontPropertiesConfigAdapter(WavefrontProperties properties) { super(properties); diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/wavefront/WavefrontPropertiesConfigAdapterTests.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/wavefront/WavefrontPropertiesConfigAdapterTests.java new file mode 100644 index 0000000000..7708efeeab --- /dev/null +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/wavefront/WavefrontPropertiesConfigAdapterTests.java @@ -0,0 +1,75 @@ +/* + * Copyright 2012-2018 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 + * + * http://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.wavefront; + +import java.net.URI; + +import org.junit.Test; + +import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.StepRegistryPropertiesConfigAdapterTests; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for {@link WavefrontPropertiesConfigAdapter}. + * + * @author Stephane Nicoll + */ +public class WavefrontPropertiesConfigAdapterTests extends + StepRegistryPropertiesConfigAdapterTests { + + @Override + protected WavefrontProperties createProperties() { + return new WavefrontProperties(); + } + + @Override + protected WavefrontPropertiesConfigAdapter createConfigAdapter( + WavefrontProperties properties) { + return new WavefrontPropertiesConfigAdapter(properties); + } + + @Test + public void whenPropertiesUriIsSetAdapterUriReturnsIt() { + WavefrontProperties properties = createProperties(); + properties.setUri(URI.create("https://wavefront.example.com")); + assertThat(createConfigAdapter(properties).uri()) + .isEqualTo("https://wavefront.example.com"); + } + + @Test + public void whenPropertiesSourceIsSetAdapterSourceReturnsIt() { + WavefrontProperties properties = createProperties(); + properties.setSource("test"); + assertThat(createConfigAdapter(properties).source()).isEqualTo("test"); + } + + @Test + public void whenPropertiesApiTokenIsSetAdapterApiTokenReturnsIt() { + WavefrontProperties properties = createProperties(); + properties.setApiToken("ABC123"); + assertThat(createConfigAdapter(properties).apiToken()).isEqualTo("ABC123"); + } + + @Test + public void whenPropertiesGlobalPrefixIsSetAdapterGlobalPrefixReturnsIt() { + WavefrontProperties properties = createProperties(); + properties.setGlobalPrefix("test"); + assertThat(createConfigAdapter(properties).globalPrefix()).isEqualTo("test"); + } + +} diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc index eebf1a9c43..7ad398479f 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc @@ -1424,7 +1424,7 @@ content into your application. Rather, pick only the properties that you need. management.metrics.export.wavefront.num-threads=2 # Number of threads to use with the metrics publishing scheduler. management.metrics.export.wavefront.read-timeout=10s # Read timeout for requests to this backend. management.metrics.export.wavefront.source= # Unique identifier for the app instance that is the source of metrics being published to Wavefront. Defaults to the local host name. - management.metrics.export.wavefront.step=10s # Step size (i.e. reporting frequency) to use. + management.metrics.export.wavefront.step=1m # Step size (i.e. reporting frequency) to use. management.metrics.export.wavefront.uri=https://longboard.wavefront.com # URI to ship metrics to. management.metrics.use-global-registry=true # Whether auto-configured MeterRegistry implementations should be bound to the global static registry on Metrics. management.metrics.web.client.max-uri-tags=100 # Maximum number of unique URI tag values allowed. After the max number of tag values is reached, metrics with additional tag values are denied by filter.