Merge pull request #11159 from eddumelendez:influxdb_health

* pr/11159:
  Polish "Add InfluxDb health indicator"
  Add InfluxDb health indicator

spring-boot-project/spring-boot-actuator-autoconfigure/pom.xml

@@ -213,6 +213,11 @@
 			<artifactId>hibernate-validator</artifactId>
 			<optional>true</optional>
 		</dependency>
+		<dependency>
+			<groupId>org.influxdb</groupId>
+			<artifactId>influxdb-java</artifactId>
+			<optional>true</optional>
+		</dependency>
 		<dependency>
 			<groupId>org.jolokia</groupId>
 			<artifactId>jolokia-core</artifactId>

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/influx/InfluxDbHealthIndicatorAutoConfiguration.java

+/*
+ * Copyright 2012-2017 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.influx;
+
+import java.util.Map;
+
+import org.influxdb.InfluxDB;
+
+import org.springframework.boot.actuate.autoconfigure.health.CompositeHealthIndicatorConfiguration;
+import org.springframework.boot.actuate.autoconfigure.health.ConditionalOnEnabledHealthIndicator;
+import org.springframework.boot.actuate.autoconfigure.health.HealthIndicatorAutoConfiguration;
+import org.springframework.boot.actuate.health.HealthIndicator;
+import org.springframework.boot.actuate.infux.InfluxDbHealthIndicator;
+import org.springframework.boot.autoconfigure.AutoConfigureAfter;
+import org.springframework.boot.autoconfigure.AutoConfigureBefore;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.influx.InfluxDbAutoConfiguration;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * {@link EnableAutoConfiguration Auto-configuration} for {@link InfluxDbHealthIndicator}.
+ *
+ * @author Eddú Meléndez
+ * @since 2.0.0
+ */
+@Configuration
+@ConditionalOnClass(InfluxDB.class)
+@ConditionalOnBean(InfluxDB.class)
+@ConditionalOnEnabledHealthIndicator("influxdb")
+@AutoConfigureBefore(HealthIndicatorAutoConfiguration.class)
+@AutoConfigureAfter(InfluxDbAutoConfiguration.class)
+public class InfluxDbHealthIndicatorAutoConfiguration extends
+		CompositeHealthIndicatorConfiguration<InfluxDbHealthIndicator, InfluxDB> {
+
+	private final Map<String, InfluxDB> influxDbs;
+
+	public InfluxDbHealthIndicatorAutoConfiguration(Map<String, InfluxDB> influxDbs) {
+		this.influxDbs = influxDbs;
+	}
+
+	@Bean
+	@ConditionalOnMissingBean(name = "influxDbHealthIndicator")
+	public HealthIndicator influxDbHealthIndicator() {
+		return createHealthIndicator(this.influxDbs);
+	}
+
+}

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -103,6 +103,12 @@
       "description": "Whether to enable elasticsearch health check.",
       "defaultValue": true
     },
+    {
+      "name": "management.influxdb.jms.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Whether to enable InfluxDB health check.",
+      "defaultValue": true
+    },
     {
       "name": "management.health.jms.enabled",
       "type": "java.lang.Boolean",

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/spring.factories

@@ -19,6 +19,7 @@ org.springframework.boot.actuate.autoconfigure.env.EnvironmentEndpointAutoConfig
 org.springframework.boot.actuate.autoconfigure.flyway.FlywayEndpointAutoConfiguration,\
 org.springframework.boot.actuate.autoconfigure.health.HealthEndpointAutoConfiguration,\
 org.springframework.boot.actuate.autoconfigure.health.HealthIndicatorAutoConfiguration,\
+org.springframework.boot.actuate.autoconfigure.influx.InfluxDbHealthIndicatorAutoConfiguration,\
 org.springframework.boot.actuate.autoconfigure.info.InfoContributorAutoConfiguration,\
 org.springframework.boot.actuate.autoconfigure.info.InfoEndpointAutoConfiguration,\
 org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthIndicatorAutoConfiguration,\

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/influx/InfluxDbHealthIndicatorAutoConfigurationTests.java

+/*
+ * Copyright 2012-2017 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.influx;
+
+import org.influxdb.InfluxDB;
+import org.junit.Test;
+
+import org.springframework.boot.actuate.autoconfigure.health.HealthIndicatorAutoConfiguration;
+import org.springframework.boot.actuate.health.ApplicationHealthIndicator;
+import org.springframework.boot.actuate.infux.InfluxDbHealthIndicator;
+import org.springframework.boot.autoconfigure.AutoConfigurations;
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
+
+/**
+ * Tests for {@link InfluxDbHealthIndicatorAutoConfiguration}.
+ *
+ * @author Eddú Meléndez
+ */
+public class InfluxDbHealthIndicatorAutoConfigurationTests {
+
+	private ApplicationContextRunner contextRunner = new ApplicationContextRunner()
+			.withUserConfiguration(InfluxDbConfiguration.class)
+			.withConfiguration(AutoConfigurations.of(
+					InfluxDbHealthIndicatorAutoConfiguration.class,
+					HealthIndicatorAutoConfiguration.class));
+
+	@Test
+	public void runShouldCreateIndicator() {
+		this.contextRunner.run((context) -> assertThat(context)
+				.hasSingleBean(InfluxDbHealthIndicator.class)
+				.doesNotHaveBean(ApplicationHealthIndicator.class));
+	}
+
+	@Test
+	public void runWhenDisabledShouldNotCreateIndicator() {
+		this.contextRunner
+				.withPropertyValues("management.health.influxdb.enabled:false").run(
+				(context) -> assertThat(context)
+						.doesNotHaveBean(InfluxDbHealthIndicator.class)
+						.hasSingleBean(ApplicationHealthIndicator.class));
+	}
+
+	@Configuration
+	static class InfluxDbConfiguration {
+
+		@Bean
+		public InfluxDB influxdb() {
+			return mock(InfluxDB.class);
+		}
+
+	}
+
+}

spring-boot-project/spring-boot-actuator/pom.xml

@@ -101,6 +101,11 @@
 			<artifactId>infinispan-spring4-embedded</artifactId>
 			<optional>true</optional>
 		</dependency>
+		<dependency>
+			<groupId>org.influxdb</groupId>
+			<artifactId>influxdb-java</artifactId>
+			<optional>true</optional>
+		</dependency>
 		<dependency>
 			<groupId>org.liquibase</groupId>
 			<artifactId>liquibase-core</artifactId>

spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/infux/InfluxDbHealthIndicator.java

+/*
+ * Copyright 2012-2017 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.infux;
+
+import org.influxdb.InfluxDB;
+import org.influxdb.dto.Pong;
+
+import org.springframework.boot.actuate.health.AbstractHealthIndicator;
+import org.springframework.boot.actuate.health.Health;
+import org.springframework.boot.actuate.health.HealthIndicator;
+import org.springframework.util.Assert;
+
+/**
+ * {@link HealthIndicator} for InfluxDb.
+ *
+ * @author Eddú Meléndez
+ * @since 2.0.0
+ */
+public class InfluxDbHealthIndicator extends AbstractHealthIndicator {
+
+	private final InfluxDB influxDb;
+
+	public InfluxDbHealthIndicator(InfluxDB influxDb) {
+		Assert.notNull(influxDb, "InfluxDB must not be null");
+		this.influxDb = influxDb;
+	}
+
+	@Override
+	protected void doHealthCheck(Health.Builder builder) {
+		Pong pong = this.influxDb.ping();
+		builder.up().withDetail("version", pong.getVersion());
+	}
+
+}

spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/influx/InfluxDbHealthIndicatorTests.java

+/*
+ * Copyright 2012-2017 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.influx;
+
+import java.io.IOException;
+
+import org.influxdb.InfluxDB;
+import org.influxdb.InfluxDBException;
+import org.influxdb.dto.Pong;
+import org.junit.Test;
+
+import org.springframework.boot.actuate.health.Health;
+import org.springframework.boot.actuate.health.Status;
+import org.springframework.boot.actuate.infux.InfluxDbHealthIndicator;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.BDDMockito.given;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+
+/**
+ * Tests for {@link InfluxDbHealthIndicator}
+ *
+ * @author Eddú Meléndez
+ */
+public class InfluxDbHealthIndicatorTests {
+
+	@Test
+	public void influxDbIsUp() {
+		Pong pong = mock(Pong.class);
+		given(pong.getVersion()).willReturn("0.9");
+		InfluxDB influxDB = mock(InfluxDB.class);
+		given(influxDB.ping()).willReturn(pong);
+		InfluxDbHealthIndicator healthIndicator = new InfluxDbHealthIndicator(influxDB);
+		Health health = healthIndicator.health();
+		assertThat(health.getStatus()).isEqualTo(Status.UP);
+		assertThat(health.getDetails().get("version")).isEqualTo("0.9");
+		verify(influxDB).ping();
+	}
+
+	@Test
+	public void influxDbIsDown() {
+		InfluxDB influxDB = mock(InfluxDB.class);
+		given(influxDB.ping()).willThrow(
+				new InfluxDBException(new IOException("Connection failed")));
+		InfluxDbHealthIndicator healthIndicator = new InfluxDbHealthIndicator(influxDB);
+		Health health = healthIndicator.health();
+		assertThat(health.getStatus()).isEqualTo(Status.DOWN);
+		assertThat((String) health.getDetails().get("error"))
+				.contains("Connection failed");
+		verify(influxDB).ping();
+	}
+
+}

spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc

@@ -1224,6 +1224,7 @@ content into your application. Rather, pick only the properties that you need.
 	management.health.elasticsearch.indices= # Comma-separated index names.
 	management.health.elasticsearch.response-timeout=100ms # The time to wait for a response from the cluster.
 	management.health.jms.enabled=true # Whether to enable JMS health check.
+	management.health.influxdb.enabled=true # Whether to enable InfluxDB health check.
 	management.health.ldap.enabled=true # Whether to enable LDAP health check.
 	management.health.mail.enabled=true # Whether to enable Mail health check.
 	management.health.mongo.enabled=true # Whether to enable MongoDB health check.

spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc

@@ -368,6 +368,9 @@ The following `HealthIndicators` are auto-configured by Spring Boot when appropr
 |{sc-spring-boot-actuator}/elasticsearch/ElasticsearchHealthIndicator.{sc-ext}[`ElasticsearchHealthIndicator`]
 |Checks that an Elasticsearch cluster is up.
 
+|{sc-spring-boot-actuator}/influx/InfluxDbHealthIndicator.{sc-ext}[`InfluxDbHealthIndicator`]
+|Checks that an InfluxDB server is up.
+
 |{sc-spring-boot-actuator}/jms/JmsHealthIndicator.{sc-ext}[`JmsHealthIndicator`]
 |Checks that a JMS broker is up.