Merge pull request #25721 from shakuzen

* pr/25721:
  Polish "Support sending metrics to InfluxDB v2"
  Support sending metrics to InfluxDB v2

Closes gh-25721
pull/25377/head
Stephane Nicoll 4 years ago
commit b61e4bbe08

@ -16,6 +16,7 @@
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;
@ -33,7 +34,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
public class InfluxProperties extends StepRegistryProperties {
/**
* Database to send metrics to.
* Database to send metrics to. InfluxDB v1 only.
*/
private String db = "mydb";
@ -43,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;
@ -89,10 +90,33 @@ 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;
/**
* 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;
/**
* Org to write metrics to. InfluxDB v2 only.
*/
private String org;
/**
* 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;
/**
* 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 +205,36 @@ public class InfluxProperties extends StepRegistryProperties {
this.autoCreateDb = autoCreateDb;
}
public InfluxApiVersion getApiVersion() {
return this.apiVersion;
}
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() {
return this.bucket;
}
public void setBucket(String bucket) {
this.bucket = bucket;
}
public String getToken() {
return this.token;
}
public void setToken(String token) {
this.token = token;
}
}

@ -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);
}
}

@ -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");
}
}

@ -46,6 +46,8 @@ class InfluxPropertiesTests extends StepRegistryPropertiesTests {
assertThat(properties.getUri()).isEqualTo(config.uri());
assertThat(properties.isCompressed()).isEqualTo(config.compressed());
assertThat(properties.isAutoCreateDb()).isEqualTo(config.autoCreateDb());
assertThat(properties.getOrg()).isEqualTo(config.org());
assertThat(properties.getToken()).isEqualTo(config.token());
}
}

@ -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]

Loading…
Cancel
Save