Configure ObservationRegistry on JmsListener

Prior to this commit, we set in gh-37388 the ObservationRegistry on the
auto-configured JmsTemplate bean. This enables observations and context
propagation when sending JMS messages.

This commit applies the same to the `DefaultJmsListenerContainerFactory`
and the `DefaultJmsListenerContainerFactoryConfigurer`, in order to
enable observations on `@JmsListener` annotated methods.

This commit also refactors the support implemented in gh-37388 to avoid
relying on a bean post processor and instead set the observation
registry directly in the main auto-configuration: while Micrometer core
is an actuator-only dependency, Micrometer Observation API is a compile
dependnecy for spring-jms itself and there is no need to separate
concerns there.

Fixes gh-38613

Author: bclozel

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/observation/jms/JmsTemplateObservationAutoConfiguration.java

@@ -71,7 +71,6 @@ org.springframework.boot.actuate.autoconfigure.metrics.export.statsd.StatsdMetri
 org.springframework.boot.actuate.autoconfigure.metrics.export.wavefront.WavefrontMetricsExportAutoConfiguration
 org.springframework.boot.actuate.autoconfigure.observation.batch.BatchObservationAutoConfiguration
 org.springframework.boot.actuate.autoconfigure.observation.graphql.GraphQlObservationAutoConfiguration
-org.springframework.boot.actuate.autoconfigure.observation.jms.JmsTemplateObservationAutoConfiguration
 org.springframework.boot.actuate.autoconfigure.metrics.integration.IntegrationMetricsAutoConfiguration
 org.springframework.boot.actuate.autoconfigure.metrics.jdbc.DataSourcePoolMetricsAutoConfiguration
 org.springframework.boot.actuate.autoconfigure.metrics.jersey.JerseyServerMetricsAutoConfiguration

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/observation/jms/package-info.java

@@ -18,6 +18,7 @@
 
 import java.time.Duration;
 
+import io.micrometer.observation.ObservationRegistry;
 import jakarta.jms.ConnectionFactory;
 import jakarta.jms.ExceptionListener;
 
@@ -49,6 +50,8 @@ public final class DefaultJmsListenerContainerFactoryConfigurer {
 
 	private JmsProperties jmsProperties;
 
+	private ObservationRegistry observationRegistry;
+
 	/**
 	 * Set the {@link DestinationResolver} to use or {@code null} if no destination
 	 * resolver should be associated with the factory by default.
@@ -93,6 +96,15 @@ void setJmsProperties(JmsProperties jmsProperties) {
 		this.jmsProperties = jmsProperties;
 	}
 
+	/**
+	 * Set the {@link ObservationRegistry} to use.
+	 * @param observationRegistry the {@link ObservationRegistry}
+	 * @since 3.2.1
+	 */
+	public void setObservationRegistry(ObservationRegistry observationRegistry) {
+		this.observationRegistry = observationRegistry;
+	}
+
 	/**
 	 * Configure the specified jms listener container factory. The factory can be further
 	 * tuned and default settings can be overridden.
@@ -115,6 +127,7 @@ public void configure(DefaultJmsListenerContainerFactory factory, ConnectionFact
 		if (this.transactionManager == null && sessionProperties.getTransacted() == null) {
 			factory.setSessionTransacted(true);
 		}
+		map.from(this.observationRegistry).to(factory::setObservationRegistry);
 		map.from(sessionProperties::getTransacted).to(factory::setSessionTransacted);
 		map.from(listenerProperties::isAutoStartup).to(factory::setAutoStartup);
 		map.from(listenerProperties::formatConcurrency).to(factory::setConcurrency);

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

@@ -16,6 +16,7 @@
 
 package org.springframework.boot.autoconfigure.jms;
 
+import io.micrometer.observation.ObservationRegistry;
 import jakarta.jms.ConnectionFactory;
 import jakarta.jms.ExceptionListener;
 
@@ -53,15 +54,19 @@ class JmsAnnotationDrivenConfiguration {
 
 	private final ObjectProvider<ExceptionListener> exceptionListener;
 
+	private final ObjectProvider<ObservationRegistry> observationRegistry;
+
 	private final JmsProperties properties;
 
 	JmsAnnotationDrivenConfiguration(ObjectProvider<DestinationResolver> destinationResolver,
 			ObjectProvider<JtaTransactionManager> transactionManager, ObjectProvider<MessageConverter> messageConverter,
-			ObjectProvider<ExceptionListener> exceptionListener, JmsProperties properties) {
+			ObjectProvider<ExceptionListener> exceptionListener,
+			ObjectProvider<ObservationRegistry> observationRegistry, JmsProperties properties) {
 		this.destinationResolver = destinationResolver;
 		this.transactionManager = transactionManager;
 		this.messageConverter = messageConverter;
 		this.exceptionListener = exceptionListener;
+		this.observationRegistry = observationRegistry;
 		this.properties = properties;
 	}
 
@@ -73,6 +78,7 @@ DefaultJmsListenerContainerFactoryConfigurer jmsListenerContainerFactoryConfigur
 		configurer.setTransactionManager(this.transactionManager.getIfUnique());
 		configurer.setMessageConverter(this.messageConverter.getIfUnique());
 		configurer.setExceptionListener(this.exceptionListener.getIfUnique());
+		configurer.setObservationRegistry(this.observationRegistry.getIfUnique());
 		configurer.setJmsProperties(this.properties);
 		return configurer;
 	}

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/observation/jms/JmsTemplateObservationAutoConfigurationTests.java

@@ -19,6 +19,7 @@
 import java.time.Duration;
 import java.util.List;
 
+import io.micrometer.observation.ObservationRegistry;
 import jakarta.jms.ConnectionFactory;
 import jakarta.jms.Message;
 
@@ -74,12 +75,16 @@ protected static class JmsTemplateConfiguration {
 
 		private final ObjectProvider<MessageConverter> messageConverter;
 
+		private final ObjectProvider<ObservationRegistry> observationRegistry;
+
 		public JmsTemplateConfiguration(JmsProperties properties,
 				ObjectProvider<DestinationResolver> destinationResolver,
-				ObjectProvider<MessageConverter> messageConverter) {
+				ObjectProvider<MessageConverter> messageConverter,
+				ObjectProvider<ObservationRegistry> observationRegistry) {
 			this.properties = properties;
 			this.destinationResolver = destinationResolver;
 			this.messageConverter = messageConverter;
+			this.observationRegistry = observationRegistry;
 		}
 
 		@Bean
@@ -91,6 +96,7 @@ public JmsTemplate jmsTemplate(ConnectionFactory connectionFactory) {
 			template.setPubSubDomain(this.properties.isPubSubDomain());
 			map.from(this.destinationResolver::getIfUnique).whenNonNull().to(template::setDestinationResolver);
 			map.from(this.messageConverter::getIfUnique).whenNonNull().to(template::setMessageConverter);
+			map.from(this.observationRegistry::getIfUnique).whenNonNull().to(template::setObservationRegistry);
 			mapTemplateProperties(this.properties.getTemplate(), template);
 			return template;
 		}

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/DefaultJmsListenerContainerFactoryConfigurer.java

@@ -18,6 +18,7 @@
 
 import java.io.IOException;
 
+import io.micrometer.observation.ObservationRegistry;
 import jakarta.jms.ConnectionFactory;
 import jakarta.jms.ExceptionListener;
 import jakarta.jms.Session;
@@ -258,6 +259,17 @@ void testDefaultContainerFactoryWithExceptionListener() {
 			});
 	}
 
+	@Test
+	void testDefaultContainerFactoryWithObservationRegistry() {
+		ObservationRegistry observationRegistry = mock(ObservationRegistry.class);
+		this.contextRunner.withUserConfiguration(EnableJmsConfiguration.class)
+			.withBean(ObservationRegistry.class, () -> observationRegistry)
+			.run((context) -> {
+				DefaultMessageListenerContainer container = getContainer(context, "jmsListenerContainerFactory");
+				assertThat(container.getObservationRegistry()).isSameAs(observationRegistry);
+			});
+	}
+
 	@Test
 	void testCustomContainerFactoryWithConfigurer() {
 		this.contextRunner.withUserConfiguration(TestConfiguration9.class, EnableJmsConfiguration.class)
@@ -290,6 +302,17 @@ void testJmsTemplateWithDestinationResolver() {
 				.isSameAs(context.getBean("myDestinationResolver")));
 	}
 
+	@Test
+	void testJmsTemplateWithObservationRegistry() {
+		ObservationRegistry observationRegistry = mock(ObservationRegistry.class);
+		this.contextRunner.withUserConfiguration(EnableJmsConfiguration.class)
+			.withBean(ObservationRegistry.class, () -> observationRegistry)
+			.run((context) -> {
+				JmsTemplate jmsTemplate = context.getBean(JmsTemplate.class);
+				assertThat(jmsTemplate).extracting("observationRegistry").isSameAs(observationRegistry);
+			});
+	}
+
 	@Test
 	void testJmsTemplateFullCustomization() {
 		this.contextRunner.withUserConfiguration(MessageConvertersConfiguration.class)

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/JmsAnnotationDrivenConfiguration.java

@@ -745,10 +745,9 @@ Metrics are tagged by the name of the executor, which is derived from the bean n
 
 [[actuator.metrics.supported.jms]]
 ==== JMS Metrics
-Auto-configuration enables the instrumentation of all available `JmsTemplate` beans.
-`JmsMessagingTemplate` instances built with instrumented `JmsTemplate` beans will also record observations.
-See the {spring-framework-docs}/integration/observability.html#observability.jms.publish[Spring Framework reference documentation for more information on produced observations].
-
+Auto-configuration enables the instrumentation of all available `JmsTemplate` beans and `@JmsListener` annotated methods.
+This will produce `"jms.message.publish"` and `"jms.message.process"` metrics respectively.
+See the {spring-framework-docs}/integration/observability.html#observability.jms[Spring Framework reference documentation for more information on produced observations].
 
 
 [[actuator.metrics.supported.spring-mvc]]

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/JmsAutoConfiguration.java

@@ -1,6 +1,7 @@
 <?xml version="1.0"?>
 <!DOCTYPE import-control PUBLIC "-//Checkstyle//DTD ImportControl Configuration 1.4//EN" "https://checkstyle.org/dtds/import_control_1_4.dtd">
 <import-control pkg="org.springframework.boot">
+	<allow pkg="io.micrometer.observation" />
 	<disallow pkg="io.micrometer" />
 	<disallow pkg="org.springframework.lang" />
 	<allow pkg=".*" regex="true" />