From ab9feff7fa8c8d5f76059a7ad5e3015745c23e00 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Fri, 5 Sep 2025 10:03:40 +0100 Subject: [PATCH] Use mongodb consistently in property names Closes gh-47050 --- .../reference/pages/actuator/metrics.adoc | 4 ++-- ...ongoHealthContributorAutoConfiguration.java | 2 +- ...tiveHealthContributorAutoConfiguration.java | 2 +- ...ditional-spring-configuration-metadata.json | 10 +++++++++- ...ealthContributorAutoConfigurationTests.java | 2 +- ...ealthContributorAutoConfigurationTests.java | 2 +- .../metrics/MongoMetricsAutoConfiguration.java | 4 ++-- ...ditional-spring-configuration-metadata.json | 18 +++++++++++++++++- .../MongoMetricsAutoConfigurationTests.java | 4 ++-- 9 files changed, 36 insertions(+), 12 deletions(-) diff --git a/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/metrics.adoc b/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/metrics.adoc index fc1b9c9fc88..7f9de115472 100644 --- a/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/metrics.adoc +++ b/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/metrics.adoc @@ -996,7 +996,7 @@ To disable the auto-configured command metrics, set the following property: ---- management: metrics: - mongo: + mongodb: command: enabled: false ---- @@ -1035,7 +1035,7 @@ To disable the auto-configured connection pool metrics, set the following proper ---- management: metrics: - mongo: + mongodb: connectionpool: enabled: false ---- diff --git a/module/spring-boot-data-mongodb/src/main/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoHealthContributorAutoConfiguration.java b/module/spring-boot-data-mongodb/src/main/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoHealthContributorAutoConfiguration.java index e5d04ac0ff6..115d18fbaf9 100644 --- a/module/spring-boot-data-mongodb/src/main/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoHealthContributorAutoConfiguration.java +++ b/module/spring-boot-data-mongodb/src/main/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoHealthContributorAutoConfiguration.java @@ -41,7 +41,7 @@ import org.springframework.data.mongodb.core.MongoTemplate; MongoAutoConfiguration.class }) @ConditionalOnClass({ MongoTemplate.class, MongoHealthIndicator.class, ConditionalOnEnabledHealthIndicator.class }) @ConditionalOnBean(MongoTemplate.class) -@ConditionalOnEnabledHealthIndicator("mongo") +@ConditionalOnEnabledHealthIndicator("mongodb") public final class MongoHealthContributorAutoConfiguration extends CompositeHealthContributorConfiguration { diff --git a/module/spring-boot-data-mongodb/src/main/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoReactiveHealthContributorAutoConfiguration.java b/module/spring-boot-data-mongodb/src/main/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoReactiveHealthContributorAutoConfiguration.java index 589193e1b4f..8c0fe6b2d86 100644 --- a/module/spring-boot-data-mongodb/src/main/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoReactiveHealthContributorAutoConfiguration.java +++ b/module/spring-boot-data-mongodb/src/main/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoReactiveHealthContributorAutoConfiguration.java @@ -43,7 +43,7 @@ import org.springframework.data.mongodb.core.ReactiveMongoTemplate; @ConditionalOnClass({ ReactiveMongoTemplate.class, Flux.class, MongoReactiveHealthIndicator.class, ConditionalOnEnabledHealthIndicator.class }) @ConditionalOnBean(ReactiveMongoTemplate.class) -@ConditionalOnEnabledHealthIndicator("mongo") +@ConditionalOnEnabledHealthIndicator("mongodb") public final class MongoReactiveHealthContributorAutoConfiguration extends CompositeReactiveHealthContributorConfiguration { diff --git a/module/spring-boot-data-mongodb/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/module/spring-boot-data-mongodb/src/main/resources/META-INF/additional-spring-configuration-metadata.json index 066dabe99f6..dee10308783 100644 --- a/module/spring-boot-data-mongodb/src/main/resources/META-INF/additional-spring-configuration-metadata.json +++ b/module/spring-boot-data-mongodb/src/main/resources/META-INF/additional-spring-configuration-metadata.json @@ -1,7 +1,15 @@ { "properties": [ - { + { "name": "management.health.mongo.enabled", + "deprecation": { + "level": "error", + "replacement": "management.health.mongodb.enabled", + "since": "4.0.0" + } + }, + { + "name": "management.health.mongodb.enabled", "type": "java.lang.Boolean", "description": "Whether to enable MongoDB health check.", "defaultValue": true diff --git a/module/spring-boot-data-mongodb/src/test/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoHealthContributorAutoConfigurationTests.java b/module/spring-boot-data-mongodb/src/test/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoHealthContributorAutoConfigurationTests.java index bdaa586ccc9..2f511e97bd2 100644 --- a/module/spring-boot-data-mongodb/src/test/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoHealthContributorAutoConfigurationTests.java +++ b/module/spring-boot-data-mongodb/src/test/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoHealthContributorAutoConfigurationTests.java @@ -45,7 +45,7 @@ class MongoHealthContributorAutoConfigurationTests { @Test void runWhenDisabledShouldNotCreateIndicator() { - this.contextRunner.withPropertyValues("management.health.mongo.enabled:false") + this.contextRunner.withPropertyValues("management.health.mongodb.enabled:false") .run((context) -> assertThat(context).doesNotHaveBean(MongoHealthIndicator.class)); } diff --git a/module/spring-boot-data-mongodb/src/test/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoReactiveHealthContributorAutoConfigurationTests.java b/module/spring-boot-data-mongodb/src/test/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoReactiveHealthContributorAutoConfigurationTests.java index e5624565d85..432be660ae5 100644 --- a/module/spring-boot-data-mongodb/src/test/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoReactiveHealthContributorAutoConfigurationTests.java +++ b/module/spring-boot-data-mongodb/src/test/java/org/springframework/boot/data/mongodb/autoconfigure/health/MongoReactiveHealthContributorAutoConfigurationTests.java @@ -58,7 +58,7 @@ class MongoReactiveHealthContributorAutoConfigurationTests { @Test void runWhenDisabledShouldNotCreateIndicator() { - this.contextRunner.withPropertyValues("management.health.mongo.enabled:false") + this.contextRunner.withPropertyValues("management.health.mongodb.enabled:false") .run((context) -> assertThat(context).doesNotHaveBean(MongoReactiveHealthIndicator.class) .doesNotHaveBean("mongoHealthContributor")); } diff --git a/module/spring-boot-mongodb/src/main/java/org/springframework/boot/mongodb/autoconfigure/metrics/MongoMetricsAutoConfiguration.java b/module/spring-boot-mongodb/src/main/java/org/springframework/boot/mongodb/autoconfigure/metrics/MongoMetricsAutoConfiguration.java index f098a8a5c0c..8ccc745f40a 100644 --- a/module/spring-boot-mongodb/src/main/java/org/springframework/boot/mongodb/autoconfigure/metrics/MongoMetricsAutoConfiguration.java +++ b/module/spring-boot-mongodb/src/main/java/org/springframework/boot/mongodb/autoconfigure/metrics/MongoMetricsAutoConfiguration.java @@ -49,7 +49,7 @@ import org.springframework.context.annotation.Bean; public final class MongoMetricsAutoConfiguration { @ConditionalOnClass(MongoMetricsCommandListener.class) - @ConditionalOnBooleanProperty(name = "management.metrics.mongo.command.enabled", matchIfMissing = true) + @ConditionalOnBooleanProperty(name = "management.metrics.mongodb.command.enabled", matchIfMissing = true) static class MongoCommandMetricsConfiguration { @Bean @@ -74,7 +74,7 @@ public final class MongoMetricsAutoConfiguration { } @ConditionalOnClass(MongoMetricsConnectionPoolListener.class) - @ConditionalOnBooleanProperty(name = "management.metrics.mongo.connectionpool.enabled", matchIfMissing = true) + @ConditionalOnBooleanProperty(name = "management.metrics.mongodb.connectionpool.enabled", matchIfMissing = true) static class MongoConnectionPoolMetricsConfiguration { @Bean diff --git a/module/spring-boot-mongodb/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/module/spring-boot-mongodb/src/main/resources/META-INF/additional-spring-configuration-metadata.json index 10a03a61ef8..a59955b1fbd 100644 --- a/module/spring-boot-mongodb/src/main/resources/META-INF/additional-spring-configuration-metadata.json +++ b/module/spring-boot-mongodb/src/main/resources/META-INF/additional-spring-configuration-metadata.json @@ -3,11 +3,27 @@ "properties": [ { "name": "management.metrics.mongo.command.enabled", + "deprecation": { + "level": "error", + "replacement": "management.metrics.mongodb.command.enabled", + "since": "4.0.0" + } + }, + { + "name": "management.metrics.mongo.connectionpool.enabled", + "deprecation": { + "level": "error", + "replacement": "management.metrics.mongodb.connectionpool.enabled", + "since": "4.0.0" + } + }, + { + "name": "management.metrics.mongodb.command.enabled", "description": "Whether to enable Mongo client command metrics.", "defaultValue": true }, { - "name": "management.metrics.mongo.connectionpool.enabled", + "name": "management.metrics.mongodb.connectionpool.enabled", "description": "Whether to enable Mongo connection pool metrics.", "defaultValue": true }, diff --git a/module/spring-boot-mongodb/src/test/java/org/springframework/boot/mongodb/autoconfigure/metrics/MongoMetricsAutoConfigurationTests.java b/module/spring-boot-mongodb/src/test/java/org/springframework/boot/mongodb/autoconfigure/metrics/MongoMetricsAutoConfigurationTests.java index 57848a1bc67..d2efabb94bd 100644 --- a/module/spring-boot-mongodb/src/test/java/org/springframework/boot/mongodb/autoconfigure/metrics/MongoMetricsAutoConfigurationTests.java +++ b/module/spring-boot-mongodb/src/test/java/org/springframework/boot/mongodb/autoconfigure/metrics/MongoMetricsAutoConfigurationTests.java @@ -152,7 +152,7 @@ class MongoMetricsAutoConfigurationTests { void whenMetricsCommandListenerEnabledPropertyFalseThenNoMetricsCommandListenerIsAdded() { this.contextRunner.withBean(SimpleMeterRegistry.class) .withConfiguration(AutoConfigurations.of(MongoAutoConfiguration.class)) - .withPropertyValues("management.metrics.mongo.command.enabled:false") + .withPropertyValues("management.metrics.mongodb.command.enabled:false") .run(assertThatMetricsCommandListenerNotAdded()); } @@ -160,7 +160,7 @@ class MongoMetricsAutoConfigurationTests { void whenMetricsConnectionPoolListenerEnabledPropertyFalseThenNoMetricsConnectionPoolListenerIsAdded() { this.contextRunner.withBean(SimpleMeterRegistry.class) .withConfiguration(AutoConfigurations.of(MongoAutoConfiguration.class)) - .withPropertyValues("management.metrics.mongo.connectionpool.enabled:false") + .withPropertyValues("management.metrics.mongodb.connectionpool.enabled:false") .run(assertThatMetricsConnectionPoolListenerNotAdded()); }