Optionally ignore routing data sources when creating DB health indicators

See gh-22222

Author: juliojgd

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/jdbc/DataSourceHealthContributorAutoConfiguration.java

@@ -37,6 +37,7 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.boot.jdbc.metadata.CompositeDataSourcePoolMetadataProvider;
 import org.springframework.boot.jdbc.metadata.DataSourcePoolMetadata;
 import org.springframework.boot.jdbc.metadata.DataSourcePoolMetadataProvider;
@@ -61,6 +62,7 @@
 @ConditionalOnBean(DataSource.class)
 @ConditionalOnEnabledHealthIndicator("db")
 @AutoConfigureAfter(DataSourceAutoConfiguration.class)
+@EnableConfigurationProperties(DataSourceHealthIndicatorProperties.class)
 public class DataSourceHealthContributorAutoConfiguration extends
 		CompositeHealthContributorConfiguration<AbstractHealthIndicator, DataSource> implements InitializingBean {
 
@@ -80,7 +82,14 @@ public void afterPropertiesSet() throws Exception {
 
 	@Bean
 	@ConditionalOnMissingBean(name = { "dbHealthIndicator", "dbHealthContributor" })
-	public HealthContributor dbHealthContributor(Map<String, DataSource> dataSources) {
+	public HealthContributor dbHealthContributor(Map<String, DataSource> dataSources,
+			DataSourceHealthIndicatorProperties dataSourceHealthIndicatorProperties) {
+		if (dataSourceHealthIndicatorProperties.isIgnoreRoutingDataSources()) {
+			Map<String, DataSource> filteredDatasources = dataSources.entrySet().stream()
+					.filter((e) -> !(e.getValue() instanceof AbstractRoutingDataSource))
+					.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
+			return createContributor(filteredDatasources);
+		}
 		return createContributor(dataSources);
 	}
 

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/jdbc/DataSourceHealthIndicatorProperties.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2012-2020 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.jdbc;
+
+import org.springframework.boot.actuate.jdbc.DataSourceHealthIndicator;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+/**
+ * External configuration properties for {@link DataSourceHealthIndicator}.
+ *
+ * @author Julio Gomez
+ * @since 2.4.0
+ */
+@ConfigurationProperties(prefix = "management.health.db")
+public class DataSourceHealthIndicatorProperties {
+
+	/**
+	 * Whether to ignore the creation of health indicators for AbstractRoutingDatasource.
+	 */
+	private boolean ignoreRoutingDataSources = false;
+
+	public boolean isIgnoreRoutingDataSources() {
+		return this.ignoreRoutingDataSources;
+	}
+
+	public void setIgnoreRoutingDataSources(boolean ignoreRoutingDataSources) {
+		this.ignoreRoutingDataSources = ignoreRoutingDataSources;
+	}
+
+}

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/jdbc/DataSourceHealthContributorAutoConfigurationTests.java

@@ -82,12 +82,30 @@ void runWithRoutingAndEmbeddedDataSourceShouldIncludeRoutingDataSource() {
 				});
 	}
 
+	@Test
+	void runWithRoutingAndEmbeddedDataSourceShouldNotIncludeRoutingDataSourceWhenIgnored() {
+		this.contextRunner.withUserConfiguration(EmbeddedDataSourceConfiguration.class, RoutingDatasourceConfig.class)
+				.withPropertyValues("management.health.db.ignore-routing-datasources:true").run((context) -> {
+					assertThat(context).doesNotHaveBean(CompositeHealthContributor.class);
+					assertThat(context).hasSingleBean(DataSourceHealthIndicator.class);
+					assertThat(context).doesNotHaveBean(RoutingDataSourceHealthIndicator.class);
+				});
+	}
+
 	@Test
 	void runWithOnlyRoutingDataSourceShouldIncludeRoutingDataSource() {
 		this.contextRunner.withUserConfiguration(RoutingDatasourceConfig.class)
 				.run((context) -> assertThat(context).hasSingleBean(RoutingDataSourceHealthIndicator.class));
 	}
 
+	@Test
+	void runWithOnlyRoutingDataSourceShouldCrashWhenIgnored() {
+		this.contextRunner.withUserConfiguration(RoutingDatasourceConfig.class)
+				.withPropertyValues("management.health.db.ignore-routing-datasources:true")
+				.run((context) -> assertThat(context).hasFailed().getFailure()
+						.hasRootCauseInstanceOf(IllegalArgumentException.class));
+	}
+
 	@Test
 	void runWithValidationQueryPropertyShouldUseCustomQuery() {
 		this.contextRunner