From 8eb73bcf017983cdbe077e1a149af79abd227fa4 Mon Sep 17 00:00:00 2001 From: Tommy Ludwig <8924140+shakuzen@users.noreply.github.com> Date: Wed, 17 Mar 2021 12:48:40 +0900 Subject: [PATCH 1/2] Support sending metrics to InfluxDB v2 See gh-25721 --- .../export/influx/InfluxProperties.java | 65 ++++++++++++++++++- .../influx/InfluxPropertiesConfigAdapter.java | 21 ++++++ .../export/influx/InfluxPropertiesTests.java | 4 ++ .../asciidoc/production-ready-features.adoc | 3 +- 4 files changed, 91 insertions(+), 2 deletions(-) diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxProperties.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxProperties.java index 6b909dccc1..ce7b017cca 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxProperties.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxProperties.java @@ -16,10 +16,12 @@ package org.springframework.boot.actuate.autoconfigure.metrics.export.influx; +import io.micrometer.influx.InfluxApiVersion; import io.micrometer.influx.InfluxConsistency; import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.StepRegistryProperties; import org.springframework.boot.context.properties.ConfigurationProperties; +import org.springframework.util.StringUtils; /** * {@link ConfigurationProperties @ConfigurationProperties} for configuring Influx metrics @@ -33,7 +35,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties; public class InfluxProperties extends StepRegistryProperties { /** - * Database to send metrics to. + * Database to send metrics to when using an InfluxDB 1.x database. */ private String db = "mydb"; @@ -93,6 +95,29 @@ public class InfluxProperties extends StepRegistryProperties { */ private boolean autoCreateDb = true; + /** + * API version of InfluxDB to use. Defaults to 'v1' unless an org is configured. If an + * org is configured, defaults to 'v2'. + */ + private InfluxApiVersion apiVersion; + + /** + * InfluxDB v2 org to write metrics. + */ + private String org; + + /** + * InfluxDB v2 bucket for metrics. Use either the bucket name or ID. Defaults to the + * value of the db property if not set. + */ + private String bucket; + + /** + * Authentication token to use with calls to the InfluxDB backend. For InfluxDB v1, + * the Bearer scheme is used. For v2, the Token scheme is used. + */ + private String token; + public String getDb() { return this.db; } @@ -181,4 +206,42 @@ public class InfluxProperties extends StepRegistryProperties { this.autoCreateDb = autoCreateDb; } + public InfluxApiVersion getApiVersion() { + if (this.apiVersion != null) { + return this.apiVersion; + } + return StringUtils.hasText(this.org) ? InfluxApiVersion.V2 : InfluxApiVersion.V1; + } + + public void setApiVersion(InfluxApiVersion apiVersion) { + this.apiVersion = apiVersion; + } + + public String getOrg() { + return this.org; + } + + public void setOrg(String org) { + this.org = org; + } + + public String getBucket() { + if (this.bucket != null) { + return this.bucket; + } + return this.db; + } + + public void setBucket(String bucket) { + this.bucket = bucket; + } + + public String getToken() { + return this.token; + } + + public void setToken(String token) { + this.token = token; + } + } diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxPropertiesConfigAdapter.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxPropertiesConfigAdapter.java index 782354f500..e8fdc58dd9 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxPropertiesConfigAdapter.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxPropertiesConfigAdapter.java @@ -16,6 +16,7 @@ package org.springframework.boot.actuate.autoconfigure.metrics.export.influx; +import io.micrometer.influx.InfluxApiVersion; import io.micrometer.influx.InfluxConfig; import io.micrometer.influx.InfluxConsistency; @@ -94,4 +95,24 @@ class InfluxPropertiesConfigAdapter extends StepRegistryPropertiesConfigAdapter< return get(InfluxProperties::isAutoCreateDb, InfluxConfig.super::autoCreateDb); } + @Override + public InfluxApiVersion apiVersion() { + return get(InfluxProperties::getApiVersion, InfluxConfig.super::apiVersion); + } + + @Override + public String org() { + return get(InfluxProperties::getOrg, InfluxConfig.super::org); + } + + @Override + public String bucket() { + return get(InfluxProperties::getBucket, InfluxConfig.super::bucket); + } + + @Override + public String token() { + return get(InfluxProperties::getToken, InfluxConfig.super::token); + } + } diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxPropertiesTests.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxPropertiesTests.java index c45eb10027..47f44b79a7 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxPropertiesTests.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxPropertiesTests.java @@ -46,6 +46,10 @@ class InfluxPropertiesTests extends StepRegistryPropertiesTests { assertThat(properties.getUri()).isEqualTo(config.uri()); assertThat(properties.isCompressed()).isEqualTo(config.compressed()); assertThat(properties.isAutoCreateDb()).isEqualTo(config.autoCreateDb()); + assertThat(properties.getApiVersion()).isEqualTo(config.apiVersion()); + assertThat(properties.getOrg()).isEqualTo(config.org()); + assertThat(properties.getBucket()).isEqualTo(config.bucket()); + assertThat(properties.getToken()).isEqualTo(config.token()); } } diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/production-ready-features.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/production-ready-features.adoc index 3e393b2916..0db7777e02 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/production-ready-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/production-ready-features.adoc @@ -1833,7 +1833,8 @@ You should also configure one or more tags to identify the data source to which [[production-ready-metrics-export-influx]] ==== Influx -By default, metrics are exported to {micrometer-registry-docs}/influx[Influx] running on your local machine. +By default, metrics are exported to an {micrometer-registry-docs}/influx[Influx] v1 instance running on your local machine with the default configuration. +To export metrics to InfluxDB v2, configure the `org`, `bucket`, and authentication `token` for writing metrics. The location of the https://www.influxdata.com[Influx server] to use can be provided using: [source,yaml,indent=0,configprops,configblocks] From 8808d5e4c061200e3f804cf20f7ceee097e80a39 Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Wed, 17 Mar 2021 15:50:35 +0100 Subject: [PATCH 2/2] Polish "Support sending metrics to InfluxDB v2" See gh-25721 --- .../export/influx/InfluxProperties.java | 25 +++----- .../InfluxPropertiesConfigAdapterTests.java | 61 +++++++++++++++++++ .../export/influx/InfluxPropertiesTests.java | 2 - 3 files changed, 70 insertions(+), 18 deletions(-) create mode 100644 spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxPropertiesConfigAdapterTests.java diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxProperties.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxProperties.java index ce7b017cca..ead56e9d7c 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxProperties.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxProperties.java @@ -21,7 +21,6 @@ import io.micrometer.influx.InfluxConsistency; import org.springframework.boot.actuate.autoconfigure.metrics.export.properties.StepRegistryProperties; import org.springframework.boot.context.properties.ConfigurationProperties; -import org.springframework.util.StringUtils; /** * {@link ConfigurationProperties @ConfigurationProperties} for configuring Influx metrics @@ -35,7 +34,7 @@ import org.springframework.util.StringUtils; public class InfluxProperties extends StepRegistryProperties { /** - * Database to send metrics to when using an InfluxDB 1.x database. + * Database to send metrics to. InfluxDB v1 only. */ private String db = "mydb"; @@ -45,12 +44,12 @@ public class InfluxProperties extends StepRegistryProperties { private InfluxConsistency consistency = InfluxConsistency.ONE; /** - * Login user of the Influx server. + * Login user of the Influx server. InfluxDB v1 only. */ private String userName; /** - * Login password of the Influx server. + * Login password of the Influx server. InfluxDB v1 only. */ private String password; @@ -91,7 +90,7 @@ public class InfluxProperties extends StepRegistryProperties { /** * Whether to create the Influx database if it does not exist before attempting to - * publish metrics to it. + * publish metrics to it. InfluxDB v1 only. */ private boolean autoCreateDb = true; @@ -102,13 +101,13 @@ public class InfluxProperties extends StepRegistryProperties { private InfluxApiVersion apiVersion; /** - * InfluxDB v2 org to write metrics. + * Org to write metrics to. InfluxDB v2 only. */ private String org; /** - * InfluxDB v2 bucket for metrics. Use either the bucket name or ID. Defaults to the - * value of the db property if not set. + * Bucket for metrics. Use either the bucket name or ID. Defaults to the value of the + * db property if not set. InfluxDB v2 only. */ private String bucket; @@ -207,10 +206,7 @@ public class InfluxProperties extends StepRegistryProperties { } public InfluxApiVersion getApiVersion() { - if (this.apiVersion != null) { - return this.apiVersion; - } - return StringUtils.hasText(this.org) ? InfluxApiVersion.V2 : InfluxApiVersion.V1; + return this.apiVersion; } public void setApiVersion(InfluxApiVersion apiVersion) { @@ -226,10 +222,7 @@ public class InfluxProperties extends StepRegistryProperties { } public String getBucket() { - if (this.bucket != null) { - return this.bucket; - } - return this.db; + return this.bucket; } public void setBucket(String bucket) { diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxPropertiesConfigAdapterTests.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxPropertiesConfigAdapterTests.java new file mode 100644 index 0000000000..2d86262c66 --- /dev/null +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxPropertiesConfigAdapterTests.java @@ -0,0 +1,61 @@ +/* + * 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. + * 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.influx; + +import io.micrometer.influx.InfluxApiVersion; +import org.junit.jupiter.api.Test; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for {@link InfluxPropertiesConfigAdapter}. + * + * @author Stephane Nicoll + */ +class InfluxPropertiesConfigAdapterTests { + + @Test + void adaptInfluxV1BasicConfig() { + InfluxProperties properties = new InfluxProperties(); + properties.setDb("test-db"); + properties.setUri("https://influx.example.com:8086"); + properties.setUserName("user"); + properties.setPassword("secret"); + InfluxPropertiesConfigAdapter adapter = new InfluxPropertiesConfigAdapter(properties); + assertThat(adapter.apiVersion()).isEqualTo(InfluxApiVersion.V1); + assertThat(adapter.db()).isEqualTo("test-db"); + assertThat(adapter.uri()).isEqualTo("https://influx.example.com:8086"); + assertThat(adapter.userName()).isEqualTo("user"); + assertThat(adapter.password()).isEqualTo("secret"); + } + + @Test + void adaptInfluxV2BasicConfig() { + InfluxProperties properties = new InfluxProperties(); + properties.setOrg("test-org"); + properties.setBucket("test-bucket"); + properties.setUri("https://influx.example.com:8086"); + properties.setToken("token"); + InfluxPropertiesConfigAdapter adapter = new InfluxPropertiesConfigAdapter(properties); + assertThat(adapter.apiVersion()).isEqualTo(InfluxApiVersion.V2); + assertThat(adapter.org()).isEqualTo("test-org"); + assertThat(adapter.bucket()).isEqualTo("test-bucket"); + assertThat(adapter.uri()).isEqualTo("https://influx.example.com:8086"); + assertThat(adapter.token()).isEqualTo("token"); + } + +} diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxPropertiesTests.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxPropertiesTests.java index 47f44b79a7..400818dbc8 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxPropertiesTests.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxPropertiesTests.java @@ -46,9 +46,7 @@ class InfluxPropertiesTests extends StepRegistryPropertiesTests { assertThat(properties.getUri()).isEqualTo(config.uri()); assertThat(properties.isCompressed()).isEqualTo(config.compressed()); assertThat(properties.isAutoCreateDb()).isEqualTo(config.autoCreateDb()); - assertThat(properties.getApiVersion()).isEqualTo(config.apiVersion()); assertThat(properties.getOrg()).isEqualTo(config.org()); - assertThat(properties.getBucket()).isEqualTo(config.bucket()); assertThat(properties.getToken()).isEqualTo(config.token()); }