Skip to content

Remove HierarchicalNameMapper as a configured @Bean #12683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Remove HierarchicalNameMapper as a configured @Bean #12683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 2 additions & 10 deletions ...t/actuate/autoconfigure/metrics/export/ganglia/GangliaMetricsExportAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
package org.springframework.boot.actuate.autoconfigure.metrics.export.ganglia;

import io.micrometer.core.instrument.Clock;
import io.micrometer.core.instrument.util.HierarchicalNameMapper;
import io.micrometer.ganglia.GangliaConfig;
import io.micrometer.ganglia.GangliaMeterRegistry;

Expand Down Expand Up @@ -60,14 +59,7 @@ public GangliaConfig gangliaConfig(GangliaProperties gangliaProperties) {
@Bean
@ConditionalOnMissingBean
public GangliaMeterRegistry gangliaMeterRegistry(GangliaConfig gangliaConfig,
HierarchicalNameMapper nameMapper, Clock clock) {
return new GangliaMeterRegistry(gangliaConfig, clock, nameMapper);
Clock clock) {
return new GangliaMeterRegistry(gangliaConfig, clock);
}

@Bean
@ConditionalOnMissingBean
public HierarchicalNameMapper hierarchicalNameMapper() {
return HierarchicalNameMapper.DEFAULT;
}

}
12 changes: 2 additions & 10 deletions ...actuate/autoconfigure/metrics/export/graphite/GraphiteMetricsExportAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
package org.springframework.boot.actuate.autoconfigure.metrics.export.graphite;

import io.micrometer.core.instrument.Clock;
import io.micrometer.core.instrument.util.HierarchicalNameMapper;
import io.micrometer.graphite.GraphiteConfig;
import io.micrometer.graphite.GraphiteMeterRegistry;

Expand Down Expand Up @@ -60,14 +59,7 @@ public GraphiteConfig graphiteConfig(GraphiteProperties graphiteProperties) {
@Bean
@ConditionalOnMissingBean
public GraphiteMeterRegistry graphiteMeterRegistry(GraphiteConfig graphiteConfig,
HierarchicalNameMapper nameMapper, Clock clock) {
return new GraphiteMeterRegistry(graphiteConfig, clock, nameMapper);
Clock clock) {
return new GraphiteMeterRegistry(graphiteConfig, clock);
}

@Bean
@ConditionalOnMissingBean
public HierarchicalNameMapper hierarchicalNameMapper() {
return HierarchicalNameMapper.DEFAULT;
}

}
13 changes: 2 additions & 11 deletions ...work/boot/actuate/autoconfigure/metrics/export/jmx/JmxMetricsExportAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
package org.springframework.boot.actuate.autoconfigure.metrics.export.jmx;

import io.micrometer.core.instrument.Clock;
import io.micrometer.core.instrument.util.HierarchicalNameMapper;
import io.micrometer.jmx.JmxConfig;
import io.micrometer.jmx.JmxMeterRegistry;

Expand Down Expand Up @@ -59,15 +58,7 @@ public JmxConfig jmxConfig(JmxProperties jmxProperties) {

@Bean
@ConditionalOnMissingBean
public JmxMeterRegistry jmxMeterRegistry(JmxConfig config,
HierarchicalNameMapper nameMapper, Clock clock) {
return new JmxMeterRegistry(config, clock, nameMapper);
public JmxMeterRegistry jmxMeterRegistry(JmxConfig config, Clock clock) {
return new JmxMeterRegistry(config, clock);
}

@Bean
@ConditionalOnMissingBean
public HierarchicalNameMapper hierarchicalNameMapper() {
return HierarchicalNameMapper.DEFAULT;
}

}
11 changes: 2 additions & 9 deletions ...oot/actuate/autoconfigure/metrics/export/statsd/StatsdMetricsExportAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
package org.springframework.boot.actuate.autoconfigure.metrics.export.statsd;

import io.micrometer.core.instrument.Clock;
import io.micrometer.core.instrument.util.HierarchicalNameMapper;
import io.micrometer.statsd.StatsdConfig;
import io.micrometer.statsd.StatsdMeterRegistry;
import io.micrometer.statsd.StatsdMetrics;
Expand Down Expand Up @@ -61,14 +60,8 @@ public StatsdConfig statsdConfig(StatsdProperties statsdProperties) {
@Bean
@ConditionalOnMissingBean
public StatsdMeterRegistry statsdMeterRegistry(StatsdConfig statsdConfig,
HierarchicalNameMapper hierarchicalNameMapper, Clock clock) {
return new StatsdMeterRegistry(statsdConfig, hierarchicalNameMapper, clock);
}

@Bean
@ConditionalOnMissingBean
public HierarchicalNameMapper hierarchicalNameMapper() {
return HierarchicalNameMapper.DEFAULT;
Clock clock) {
return new StatsdMeterRegistry(statsdConfig, clock);
}

@Bean
Expand Down
53 changes: 6 additions & 47 deletions ...boot/actuate/autoconfigure/metrics/export/jmx/JmxMetricsExportAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,6 @@
import java.util.Map;

import io.micrometer.core.instrument.Clock;
import io.micrometer.core.instrument.Meter.Id;
import io.micrometer.core.instrument.config.NamingConvention;
import io.micrometer.core.instrument.util.HierarchicalNameMapper;
import io.micrometer.jmx.JmxConfig;
import io.micrometer.jmx.JmxMeterRegistry;
import org.junit.Test;
Expand Down Expand Up @@ -56,12 +53,11 @@ public void backsOffWithoutAClock() {
}

@Test
public void autoConfiguresItsConfigMeterRegistryAndNameMapper() {
public void autoConfiguresItsConfigAndMeterRegistry() {
this.contextRunner.withUserConfiguration(BaseConfiguration.class)
.run((context) -> assertThat(context)
.hasSingleBean(JmxMeterRegistry.class)
.hasSingleBean(JmxConfig.class)
.hasSingleBean(HierarchicalNameMapper.class));
.hasSingleBean(JmxConfig.class));
}

@Test
Expand All @@ -70,35 +66,23 @@ public void autoConfigurationCanBeDisabled() {
.withPropertyValues("management.metrics.export.jmx.enabled=false")
.run((context) -> assertThat(context)
.doesNotHaveBean(JmxMeterRegistry.class)
.doesNotHaveBean(JmxConfig.class)
.doesNotHaveBean(HierarchicalNameMapper.class));
.doesNotHaveBean(JmxConfig.class));
}

@Test
public void allowsCustomConfigToBeUsed() {
this.contextRunner.withUserConfiguration(CustomConfigConfiguration.class)
.run((context) -> assertThat(context)
.hasSingleBean(JmxMeterRegistry.class)
.hasSingleBean(JmxConfig.class).hasBean("customConfig")
.hasSingleBean(HierarchicalNameMapper.class));
.hasSingleBean(JmxConfig.class).hasBean("customConfig"));
}

@Test
public void allowsCustomRegistryToBeUsed() {
this.contextRunner.withUserConfiguration(CustomRegistryConfiguration.class)
.run((context) -> assertThat(context)
.hasSingleBean(JmxMeterRegistry.class).hasBean("customRegistry")
.hasSingleBean(JmxConfig.class)
.hasSingleBean(HierarchicalNameMapper.class));
}

@Test
public void allowsCustomHierarchicalNameMapperToBeUsed() {
this.contextRunner.withUserConfiguration(CustomNameMapperConfiguration.class)
.run((context) -> assertThat(context)
.hasSingleBean(JmxMeterRegistry.class)
.hasSingleBean(JmxConfig.class).hasBean("customNameMapper")
.hasSingleBean(HierarchicalNameMapper.class));
.hasSingleBean(JmxConfig.class));
}

@Test
Expand Down Expand Up @@ -142,14 +126,7 @@ static class CustomConfigConfiguration {

@Bean
public JmxConfig customConfig() {
return new JmxConfig() {

@Override
public String get(String k) {
return null;
}

};
return k -> null;
}

}
Expand All @@ -165,22 +142,4 @@ public JmxMeterRegistry customRegistry(JmxConfig config, Clock clock) {

}

@Configuration
@Import(BaseConfiguration.class)
static class CustomNameMapperConfiguration {

@Bean
public HierarchicalNameMapper customNameMapper() {
return new HierarchicalNameMapper() {

@Override
public String toHierarchicalName(Id id, NamingConvention convention) {
return "test";
}

};
}

}

}
51 changes: 5 additions & 46 deletions ...ctuate/autoconfigure/metrics/export/statsd/StatsdMetricsExportAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,6 @@
import java.util.Map;

import io.micrometer.core.instrument.Clock;
import io.micrometer.core.instrument.Meter.Id;
import io.micrometer.core.instrument.config.NamingConvention;
import io.micrometer.core.instrument.util.HierarchicalNameMapper;
import io.micrometer.statsd.StatsdConfig;
import io.micrometer.statsd.StatsdMeterRegistry;
import io.micrometer.statsd.StatsdMetrics;
Expand Down Expand Up @@ -57,12 +54,11 @@ public void backsOffWithoutAClock() {
}

@Test
public void autoConfiguresItsConfigMeterRegistryNameMapperAndMetrics() {
public void autoConfiguresItsConfigMeterRegistryAndMetrics() {
this.contextRunner.withUserConfiguration(BaseConfiguration.class)
.run((context) -> assertThat(context)
.hasSingleBean(StatsdMeterRegistry.class)
.hasSingleBean(StatsdConfig.class)
.hasSingleBean(HierarchicalNameMapper.class)
.hasSingleBean(StatsdMetrics.class));
}

Expand All @@ -72,35 +68,23 @@ public void autoConfigurationCanBeDisabled() {
.withPropertyValues("management.metrics.export.statsd.enabled=false")
.run((context) -> assertThat(context)
.doesNotHaveBean(StatsdMeterRegistry.class)
.doesNotHaveBean(StatsdConfig.class)
.doesNotHaveBean(HierarchicalNameMapper.class));
.doesNotHaveBean(StatsdConfig.class));
}

@Test
public void allowsCustomConfigToBeUsed() {
this.contextRunner.withUserConfiguration(CustomConfigConfiguration.class)
.run((context) -> assertThat(context)
.hasSingleBean(StatsdMeterRegistry.class)
.hasSingleBean(StatsdConfig.class).hasBean("customConfig")
.hasSingleBean(HierarchicalNameMapper.class));
.hasSingleBean(StatsdConfig.class).hasBean("customConfig"));
}

@Test
public void allowsCustomRegistryToBeUsed() {
this.contextRunner.withUserConfiguration(CustomRegistryConfiguration.class)
.run((context) -> assertThat(context)
.hasSingleBean(StatsdMeterRegistry.class)
.hasBean("customRegistry").hasSingleBean(StatsdConfig.class)
.hasSingleBean(HierarchicalNameMapper.class));
}

@Test
public void allowsCustomHierarchicalNameMapperToBeUsed() {
this.contextRunner.withUserConfiguration(CustomNameMapperConfiguration.class)
.run((context) -> assertThat(context)
.hasSingleBean(StatsdMeterRegistry.class)
.hasSingleBean(StatsdConfig.class).hasBean("customNameMapper")
.hasSingleBean(HierarchicalNameMapper.class));
.hasBean("customRegistry").hasSingleBean(StatsdConfig.class));
}

@Test
Expand Down Expand Up @@ -144,14 +128,7 @@ static class CustomConfigConfiguration {

@Bean
public StatsdConfig customConfig() {
return new StatsdConfig() {

@Override
public String get(String k) {
return null;
}

};
return k -> null;
}

}
Expand All @@ -167,22 +144,4 @@ public StatsdMeterRegistry customRegistry(StatsdConfig config, Clock clock) {

}

@Configuration
@Import(BaseConfiguration.class)
static class CustomNameMapperConfiguration {

@Bean
public HierarchicalNameMapper customNameMapper() {
return new HierarchicalNameMapper() {

@Override
public String toHierarchicalName(Id id, NamingConvention convention) {
return "test";
}

};
}

}

}
25 changes: 22 additions & 3 deletions ...-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1435,7 +1435,19 @@ to use can be provided using:
management.metrics.export.graphite.port=9004
----

Micrometer provides a default `HierarchicalNameMapper` that governs
how a dimensional meter id is mapped to flat hierarchical names.

TIP: To take control over this behaviour, define your `GraphiteMeterRegistry` and supply your
own `HierarchicalNameMapper`.

[source,java]
----
@Bean
public GraphiteMeterRegistry graphiteMeterRegistry(GraphiteConfig config, Clock clock) {
return new GraphiteMeterRegistry(config, clock, MY_HIERARCHICAL_MAPPER);
}
----

[[production-ready-metrics-export-influx]]
==== Influx
Expand All @@ -1454,12 +1466,19 @@ server] to use can be provided using:
==== JMX
Micrometer provides a hierarchical mapping to
{micrometer-registry-documentation}/jmx[JMX], primarily as a cheap and portable way to
view metrics locally. Spring Boot provides a default `HierarchicalNameMapper` that governs
view metrics locally. Micrometer provides a default `HierarchicalNameMapper` that governs
how a dimensional meter id is mapped to flat hierarchical names.

TIP: To take control over this behaviour, define your own `HierarchicalNameMapper` bean.

TIP: To take control over this behaviour, define your `JmxMeterRegistry` and supply your
own `HierarchicalNameMapper`.

[source,java]
----
@Bean
public JmxMeterRegistry jmxMeterRegistry(JmxConfig config, Clock clock) {
return new JmxMeterRegistry(config, clock, MY_HIERARCHICAL_MAPPER);
}
----

[[production-ready-metrics-export-newrelic]]
==== New Relic
Expand Down