Skip to content

Commit 3942ba2

Browse files
committed
Consistently use the spring.metrics configuration property prefix
See gh-9970
1 parent 5efcbad commit 3942ba2

File tree

17 files changed

+36
-26
lines changed

17 files changed

+36
-26
lines changed

spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/atlas/AtlasExportConfiguration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
public class AtlasExportConfiguration {
4545

4646
@Bean
47-
@ConditionalOnProperty(value = "metrics.atlas.enabled", matchIfMissing = true)
47+
@ConditionalOnProperty(value = "spring.metrics.atlas.enabled", matchIfMissing = true)
4848
public MetricsExporter atlasExporter(AtlasConfig config, Clock clock) {
4949
return () -> new AtlasMeterRegistry(config, clock);
5050
}

spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/atlas/AtlasProperties.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@
2929
* @since 2.0.0
3030
* @author Jon Schneider
3131
*/
32-
@ConfigurationProperties(prefix = "metrics.atlas")
32+
@ConfigurationProperties(prefix = "spring.metrics.atlas")
3333
public class AtlasProperties extends RegistryProperties implements AtlasConfig {
3434

3535
@Override
3636
protected String prefix() {
37-
return "atlas";
37+
return "spring.metrics.atlas";
3838
}
3939

4040
public void setStep(Duration step) {

spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/datadog/DatadogExportConfiguration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
public class DatadogExportConfiguration {
4444

4545
@Bean
46-
@ConditionalOnProperty(value = "metrics.datadog.enabled", matchIfMissing = true)
46+
@ConditionalOnProperty(value = "spring.metrics.datadog.enabled", matchIfMissing = true)
4747
public MetricsExporter datadogExporter(DatadogConfig config, Clock clock) {
4848
return () -> new DatadogMeterRegistry(config, clock);
4949
}

spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/datadog/DatadogProperties.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@
2727
* @author Jon Schneider
2828
* @since 2.0.0
2929
*/
30-
@ConfigurationProperties(prefix = "metrics.datadog")
30+
@ConfigurationProperties(prefix = "spring.metrics.datadog")
3131
public class DatadogProperties extends StepRegistryProperties implements DatadogConfig {
3232

3333
@Override
3434
public String prefix() {
35-
return "metrics.datadog";
35+
return "spring.metrics.datadog";
3636
}
3737

3838
public DatadogProperties() {

spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/ganglia/GangliaExportConfiguration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
public class GangliaExportConfiguration {
4545

4646
@Bean
47-
@ConditionalOnProperty(value = "metrics.ganglia.enabled", matchIfMissing = true)
47+
@ConditionalOnProperty(value = "spring.metrics.ganglia.enabled", matchIfMissing = true)
4848
public MetricsExporter gangliaExporter(GangliaConfig config,
4949
HierarchicalNameMapper nameMapper, Clock clock) {
5050
return () -> new GangliaMeterRegistry(config, nameMapper, clock);

spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/ganglia/GangliaProperties.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@
3131
* @author Jon Schneider
3232
* @since 2.0.0
3333
*/
34-
@ConfigurationProperties(prefix = "metrics.ganglia")
34+
@ConfigurationProperties(prefix = "spring.metrics.ganglia")
3535
public class GangliaProperties extends RegistryProperties implements GangliaConfig {
3636

3737
@Override
3838
public String prefix() {
39-
return "metrics.ganglia";
39+
return "spring.metrics.ganglia";
4040
}
4141

4242
public void setStep(Duration step) {

spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/graphite/GraphiteExportConfiguration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
public class GraphiteExportConfiguration {
4545

4646
@Bean
47-
@ConditionalOnProperty(value = "metrics.graphite.enabled", matchIfMissing = true)
47+
@ConditionalOnProperty(value = "spring.metrics.graphite.enabled", matchIfMissing = true)
4848
public MetricsExporter graphiteExporter(GraphiteConfig config,
4949
HierarchicalNameMapper nameMapper, Clock clock) {
5050
return () -> new GraphiteMeterRegistry(config, nameMapper, clock);

spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/graphite/GraphiteProperties.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@
3030
* @author Jon Schneider
3131
* @since 2.0.0
3232
*/
33-
@ConfigurationProperties(prefix = "metrics.graphite")
33+
@ConfigurationProperties(prefix = "spring.metrics.graphite")
3434
public class GraphiteProperties extends RegistryProperties implements GraphiteConfig {
3535

3636
@Override
3737
public String prefix() {
38-
return "metrics.graphite";
38+
return "spring.metrics.graphite";
3939
}
4040

4141
public void setStep(Duration step) {

spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxExportConfiguration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
public class InfluxExportConfiguration {
4444

4545
@Bean
46-
@ConditionalOnProperty(value = "metrics.influx.enabled", matchIfMissing = true)
46+
@ConditionalOnProperty(value = "spring.metrics.influx.enabled", matchIfMissing = true)
4747
public MetricsExporter influxExporter(InfluxConfig config, Clock clock) {
4848
return () -> new InfluxMeterRegistry(config, clock);
4949
}

spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/influx/InfluxProperties.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@
2828
* @author Jon Schneider
2929
* @since 2.0.0
3030
*/
31-
@ConfigurationProperties(prefix = "metrics.influx")
31+
@ConfigurationProperties(prefix = "spring.metrics.influx")
3232
public class InfluxProperties extends StepRegistryProperties implements InfluxConfig {
3333

3434
@Override
3535
public String prefix() {
36-
return "metrics.influx";
36+
return "spring.metrics.influx";
3737
}
3838

3939
public void setDb(String db) {

spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/jmx/JmxExportConfiguration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
public class JmxExportConfiguration {
3939

4040
@Bean
41-
@ConditionalOnProperty(value = "metrics.jmx.enabled", matchIfMissing = true)
41+
@ConditionalOnProperty(value = "spring.metrics.jmx.enabled", matchIfMissing = true)
4242
public MetricsExporter jmxExporter(HierarchicalNameMapper nameMapper, Clock clock) {
4343
return () -> new JmxMeterRegistry(nameMapper, clock);
4444
}

spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/prometheus/PrometheusExportConfiguration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
public class PrometheusExportConfiguration {
4444

4545
@Bean
46-
@ConditionalOnProperty(value = "metrics.prometheus.enabled", matchIfMissing = true)
46+
@ConditionalOnProperty(value = "spring.metrics.prometheus.enabled", matchIfMissing = true)
4747
public MetricsExporter prometheusExporter(PrometheusConfig config,
4848
CollectorRegistry collectorRegistry, Clock clock) {
4949
return () -> new PrometheusMeterRegistry(config, collectorRegistry, clock);

spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/prometheus/PrometheusProperties.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* @author Jon Schneider
2828
* @since 2.0.0
2929
*/
30-
@ConfigurationProperties(prefix = "metrics.prometheus")
30+
@ConfigurationProperties(prefix = "spring.metrics.prometheus")
3131
public class PrometheusProperties extends RegistryProperties implements PrometheusConfig {
3232

3333
private boolean enabled = true;
@@ -46,7 +46,7 @@ public void setDescriptions(Boolean descriptions) {
4646

4747
@Override
4848
public String prefix() {
49-
return "metrics.prometheus";
49+
return "spring.metrics.prometheus";
5050
}
5151

5252
}

spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/simple/SimpleExportConfiguration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
public class SimpleExportConfiguration {
3838

3939
@Bean
40-
@ConditionalOnProperty(value = "metrics.simple.enabled", matchIfMissing = true)
40+
@ConditionalOnProperty(value = "spring.metrics.simple.enabled", matchIfMissing = true)
4141
@ConditionalOnMissingBean(MetricsExporter.class)
4242
public MetricsExporter simpleExporter(Clock clock) {
4343
return () -> new SimpleMeterRegistry(clock);

spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/simple/SimpleProperties.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* @author Jon Schneider
2828
* @since 2.0.0
2929
*/
30-
@ConfigurationProperties(prefix = "metrics.simple")
30+
@ConfigurationProperties(prefix = "spring.metrics.simple")
3131
public class SimpleProperties {
3232

3333
private boolean enabled = true;

spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/simple/SimpleExportConfigurationTests.java

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,13 @@ public class SimpleExportConfigurationTests {
3939
@Test
4040
public void simpleMeterRegistryIsInTheCompositeWhenNoOtherRegistryIs() {
4141
new ApplicationContextRunner()
42-
.withPropertyValues("metrics.atlas.enabled=false",
43-
"metrics.datadog.enabled=false", "metrics.ganglia.enabled=false",
44-
"metrics.graphite.enabled=false", "metrics.influx.enabled=false",
45-
"metrics.jmx.enabled=false", "metrics.prometheus.enabled=false")
42+
.withPropertyValues("spring.metrics.atlas.enabled=false",
43+
"spring.metrics.datadog.enabled=false",
44+
"spring.metrics.ganglia.enabled=false",
45+
"spring.metrics.graphite.enabled=false",
46+
"spring.metrics.influx.enabled=false",
47+
"spring.metrics.jmx.enabled=false",
48+
"spring.metrics.prometheus.enabled=false")
4649
.withConfiguration(AutoConfigurations.of(MetricsAutoConfiguration.class))
4750
.run((context) -> {
4851
CompositeMeterRegistry meterRegistry = context

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1267,7 +1267,14 @@ content into your application; rather pick only the properties that you need.
12671267
management.trace.include=request-headers,response-headers,cookies,errors # Items to be included in the trace.
12681268
12691269
# METRICS
1270-
spring.metrics.use-global-registry=true # Whether or not auto-configured MeterRegistry implementations should be bound to the global static registry on Metrics
1270+
spring.metrics.atlas.enabled=true # Whether not exporting of metrics to Atlas is enabled.
1271+
spring.metrics.ganglia.enabled=true # Whether not exporting of metrics to Ganglia is enabled.
1272+
spring.metrics.graphite.enabled=true # Whether not exporting of metrics to Graphite is enabled.
1273+
spring.metrics.influx.enabled=true # Whether not exporting of metrics to InfluxDB is enabled.
1274+
spring.metrics.jmx.enabled=true # Whether not exporting of metrics to JMX is enabled.
1275+
spring.metrics.prometheus.enabled=true # Whether not exporting of metrics to Prometheus is enabled.
1276+
spring.metrics.simple.enabled=true # Whether not exporting of metrics to a simple in-memory store is enabled.
1277+
spring.metrics.use-global-registry=true # Whether or not auto-configured MeterRegistry implementations should be bound to the global static registry on Metrics
12711278
spring.metrics.web.client.record-request-percentiles=false # Whether or not instrumented requests record percentiles histogram buckets by default.
12721279
spring.metrics.web.client.requests-metric-name=http.client.requests # Name of the metric for sent requests.
12731280
spring.metrics.web.server.auto-time-requests=true Whether or not requests handled by Spring MVC or WebFlux should be automatically timed.

0 commit comments

Comments
 (0)