Skip to content

Meter registries are not removed from the global registry when the context is closed #50235

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

Open
kwondh5217 wants to merge 3 commits into
base: main
Choose a base branch
from
+38 −3
Open

Meter registries are not removed from the global registry when the context is closed #50235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
10c5b5b
Remove MeterRegistry from global registry on context close
kwondh5217 Apr 28, 2026
d5a57e7
Conditionally remove MeterRegistry from global registry on context close
kwondh5217 Apr 28, 2026
21cd6a9
Polish
kwondh5217 Apr 28, 2026
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
13 changes: 10 additions & 3 deletions ...a/org/springframework/boot/micrometer/metrics/autoconfigure/MetricsAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import io.micrometer.core.annotation.Timed;
import io.micrometer.core.instrument.Clock;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Metrics;
import io.micrometer.core.instrument.binder.MeterBinder;
import io.micrometer.core.instrument.composite.CompositeMeterRegistry;
import io.micrometer.core.instrument.config.MeterFilter;
Expand Down Expand Up @@ -76,8 +77,8 @@ PropertiesMeterFilter propertiesMeterFilter(MetricsProperties properties) {
}

@Bean
MeterRegistryCloser meterRegistryCloser(ApplicationContext context) {
return new MeterRegistryCloser(context);
MeterRegistryCloser meterRegistryCloser(ApplicationContext context, MetricsProperties properties) {
return new MeterRegistryCloser(context, properties.isUseGlobalRegistry());
}

@Bean
Expand All @@ -103,15 +104,21 @@ static class MeterRegistryCloser implements ApplicationListener<ContextClosedEve

private final Iterable<MeterRegistry> meterRegistries;

MeterRegistryCloser(ApplicationContext context) {
private final boolean useGlobalRegistry;

MeterRegistryCloser(ApplicationContext context, boolean useGlobalRegistry) {
this.meterRegistries = context.getBeansOfType(MeterRegistry.class).values();
this.context = context;
this.useGlobalRegistry = useGlobalRegistry;
}

@Override
public void onApplicationEvent(ContextClosedEvent event) {
if (this.context.equals(event.getApplicationContext())) {
for (MeterRegistry meterRegistry : this.meterRegistries) {
if (this.useGlobalRegistry) {
Metrics.globalRegistry.remove(meterRegistry);
}
if (!meterRegistry.isClosed()) {
meterRegistry.close();
}
Expand Down
28 changes: 28 additions & 0 deletions .../springframework/boot/micrometer/metrics/autoconfigure/MetricsAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import io.micrometer.core.instrument.Clock;
import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Metrics;
import io.micrometer.core.instrument.binder.MeterBinder;
import io.micrometer.core.instrument.config.MeterFilter;
import io.micrometer.core.instrument.config.MeterFilterReply;
Expand Down Expand Up @@ -96,6 +97,33 @@ void meterRegistryCloserShouldCloseRegistryOnShutdown() {
});
}

@Test
void meterRegistryCloserShouldRemoveRegistryFromGlobalRegistryOnShutdown() {
this.contextRunner.withUserConfiguration(MeterRegistryConfiguration.class).run((context) -> {
MeterRegistry meterRegistry = context.getBean(MeterRegistry.class);
assertThat(Metrics.globalRegistry.getRegistries()).contains(meterRegistry);
context.close();
assertThat(Metrics.globalRegistry.getRegistries()).doesNotContain(meterRegistry);
});
}

@Test
void meterRegistryCloserShouldNotRemoveRegistryFromGlobalRegistryWhenUseGlobalRegistryIsFalse() {
this.contextRunner.withUserConfiguration(MeterRegistryConfiguration.class)
.withPropertyValues("management.metrics.use-global-registry=false")
.run((context) -> {
MeterRegistry meterRegistry = context.getBean(MeterRegistry.class);
Metrics.globalRegistry.add(meterRegistry);
try {
context.close();
assertThat(Metrics.globalRegistry.getRegistries()).contains(meterRegistry);
}
finally {
Metrics.globalRegistry.remove(meterRegistry);
}
});
}

@Test
void meterRegistryCloserShouldOnlyCloseRegistriesBelongingToContextBeingClosed() {
MeterRegistry parentMeterRegistry = new SimpleMeterRegistry();
Expand Down
Loading