Stop MeterRegistries when context is closed

Closes gh-12006

Author: wilkinsona

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

@@ -55,7 +55,7 @@ public AtlasConfig atlasConfig(AtlasProperties atlasProperties) {
 		return new AtlasPropertiesConfigAdapter(atlasProperties);
 	}
 
-	@Bean
+	@Bean(destroyMethod = "stop")
 	@ConditionalOnMissingBean
 	public AtlasMeterRegistry atlasMeterRegistry(AtlasConfig atlasConfig, Clock clock) {
 		return new AtlasMeterRegistry(atlasConfig, clock);

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

@@ -54,7 +54,7 @@ public DatadogConfig datadogConfig(DatadogProperties datadogProperties) {
 		return new DatadogPropertiesConfigAdapter(datadogProperties);
 	}
 
-	@Bean
+	@Bean(destroyMethod = "stop")
 	@ConditionalOnMissingBean
 	public DatadogMeterRegistry datadogMeterRegistry(DatadogConfig datadogConfig,
 			Clock clock) {

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

@@ -55,7 +55,7 @@ public GraphiteConfig graphiteConfig(GraphiteProperties graphiteProperties) {
 		return new GraphitePropertiesConfigAdapter(graphiteProperties);
 	}
 
-	@Bean
+	@Bean(destroyMethod = "stop")
 	@ConditionalOnMissingBean
 	public GraphiteMeterRegistry graphiteMeterRegistry(GraphiteConfig graphiteConfig,
 			HierarchicalNameMapper nameMapper, Clock clock) {

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

@@ -54,7 +54,7 @@ public InfluxConfig influxConfig(InfluxProperties influxProperties) {
 		return new InfluxPropertiesConfigAdapter(influxProperties);
 	}
 
-	@Bean
+	@Bean(destroyMethod = "stop")
 	@ConditionalOnMissingBean
 	public InfluxMeterRegistry influxMeterRegistry(InfluxConfig influxConfig,
 			Clock clock) {

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

@@ -55,7 +55,7 @@ public JmxConfig jmxConfig(JmxProperties jmxProperties) {
 		return new JmxPropertiesConfigAdapter(jmxProperties);
 	}
 
-	@Bean
+	@Bean(destroyMethod = "stop")
 	@ConditionalOnMissingBean
 	public JmxMeterRegistry jmxMeterRegistry(JmxConfig config,
 			HierarchicalNameMapper nameMapper, Clock clock) {

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/newrelic/NewRelicMetricsExportAutoConfiguration.java

@@ -55,7 +55,7 @@ public NewRelicConfig newRelicConfig(NewRelicProperties props) {
 		return new NewRelicPropertiesConfigAdapter(props);
 	}
 
-	@Bean
+	@Bean(destroyMethod = "stop")
 	@ConditionalOnMissingBean
 	public NewRelicMeterRegistry newRelicMeterRegistry(NewRelicConfig config,
 			Clock clock) {

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/signalfx/SignalFxMetricsExportAutoConfiguration.java

@@ -55,7 +55,7 @@ public SignalFxConfig signalfxConfig(SignalFxProperties props) {
 		return new SignalFxPropertiesConfigAdapter(props);
 	}
 
-	@Bean
+	@Bean(destroyMethod = "stop")
 	@ConditionalOnMissingBean
 	public SignalFxMeterRegistry signalFxMeterRegistry(SignalFxConfig config,
 			Clock clock) {

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/statsd/StatsdMetricsExportAutoConfiguration.java

@@ -55,7 +55,7 @@ public StatsdConfig statsdConfig(StatsdProperties statsdProperties) {
 		return new StatsdPropertiesConfigAdapter(statsdProperties);
 	}
 
-	@Bean
+	@Bean(destroyMethod = "stop")
 	@ConditionalOnMissingBean
 	public StatsdMeterRegistry statsdMeterRegistry(StatsdConfig statsdConfig,
 			HierarchicalNameMapper hierarchicalNameMapper, Clock clock) {

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/atlas/AtlasMetricsExportAutoConfigurationTests.java

@@ -16,18 +16,24 @@
 
 package org.springframework.boot.actuate.autoconfigure.metrics.export.atlas;
 
+import java.util.Map;
+
 import com.netflix.spectator.atlas.AtlasConfig;
 import io.micrometer.atlas.AtlasMeterRegistry;
 import io.micrometer.core.instrument.Clock;
 import org.junit.Test;
 
 import org.springframework.boot.autoconfigure.AutoConfigurations;
+import org.springframework.boot.test.context.assertj.AssertableApplicationContext;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
+import org.springframework.test.util.ReflectionTestUtils;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.verify;
 
 /**
  * Tests for {@link AtlasMetricsExportAutoConfiguration}.
@@ -79,6 +85,30 @@ public void allowsCustomRegistryToBeUsed() {
 						.hasSingleBean(AtlasConfig.class));
 	}
 
+	@Test
+	public void stopsMeterRegistryWhenContextIsClosed() {
+		this.runner.withUserConfiguration(BaseConfiguration.class).run((context) -> {
+			AtlasMeterRegistry registry = spyOnDisposableBean(AtlasMeterRegistry.class,
+					context);
+			context.close();
+			verify(registry).stop();
+		});
+	}
+
+	@SuppressWarnings("unchecked")
+	private <T> T spyOnDisposableBean(Class<T> type,
+			AssertableApplicationContext context) {
+		String[] names = context.getBeanNamesForType(type);
+		assertThat(names).hasSize(1);
+		String registryBeanName = names[0];
+		Map<String, Object> disposableBeans = (Map<String, Object>) ReflectionTestUtils
+				.getField(context.getAutowireCapableBeanFactory(), "disposableBeans");
+		Object registryAdapter = disposableBeans.get(registryBeanName);
+		T registry = (T) spy(ReflectionTestUtils.getField(registryAdapter, "bean"));
+		ReflectionTestUtils.setField(registryAdapter, "bean", registry);
+		return registry;
+	}
+
 	@Configuration
 	static class BaseConfiguration {
 
@@ -111,7 +141,7 @@ public String get(String k) {
 	@Import(BaseConfiguration.class)
 	static class CustomRegistryConfiguration {
 
-		@Bean
+		@Bean(destroyMethod = "stop")
 		public AtlasMeterRegistry customRegistry(AtlasConfig config, Clock clock) {
 			return new AtlasMeterRegistry(config, clock);
 		}

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/export/datadog/DatadogMetricsExportAutoConfigurationTests.java

@@ -16,18 +16,24 @@
 
 package org.springframework.boot.actuate.autoconfigure.metrics.export.datadog;
 
+import java.util.Map;
+
 import io.micrometer.core.instrument.Clock;
 import io.micrometer.datadog.DatadogConfig;
 import io.micrometer.datadog.DatadogMeterRegistry;
 import org.junit.Test;
 
 import org.springframework.boot.autoconfigure.AutoConfigurations;
+import org.springframework.boot.test.context.assertj.AssertableApplicationContext;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
+import org.springframework.test.util.ReflectionTestUtils;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.verify;
 
 /**
  * Tests for {@link DatadogMetricsExportAutoConfiguration}.
@@ -87,6 +93,32 @@ public void allowsCustomRegistryToBeUsed() {
 						.hasBean("customRegistry").hasSingleBean(DatadogConfig.class));
 	}
 
+	@Test
+	public void stopsMeterRegistryWhenContextIsClosed() {
+		this.runner.withUserConfiguration(BaseConfiguration.class)
+				.withPropertyValues("management.metrics.export.datadog.api-key=abcde")
+				.run((context) -> {
+					DatadogMeterRegistry registry = spyOnDisposableBean(
+							DatadogMeterRegistry.class, context);
+					context.close();
+					verify(registry).stop();
+				});
+	}
+
+	@SuppressWarnings("unchecked")
+	private <T> T spyOnDisposableBean(Class<T> type,
+			AssertableApplicationContext context) {
+		String[] names = context.getBeanNamesForType(type);
+		assertThat(names).hasSize(1);
+		String registryBeanName = names[0];
+		Map<String, Object> disposableBeans = (Map<String, Object>) ReflectionTestUtils
+				.getField(context.getAutowireCapableBeanFactory(), "disposableBeans");
+		Object registryAdapter = disposableBeans.get(registryBeanName);
+		T registry = (T) spy(ReflectionTestUtils.getField(registryAdapter, "bean"));
+		ReflectionTestUtils.setField(registryAdapter, "bean", registry);
+		return registry;
+	}
+
 	@Configuration
 	static class BaseConfiguration {
 
@@ -122,7 +154,7 @@ public String get(String k) {
 	@Import(BaseConfiguration.class)
 	static class CustomRegistryConfiguration {
 
-		@Bean
+		@Bean(destroyMethod = "stop")
 		public DatadogMeterRegistry customRegistry(DatadogConfig config, Clock clock) {
 			return new DatadogMeterRegistry(config, clock);
 		}