Skip to content

Commit 0fc97e9

Browse files
bclozelbclozel
committed
Auto-configure ObservationRegistry on JmsTemplate
Spring Boot auto-configures both a `JmsTemplate` and a `JmsMessagingTemplate`. As of Spring Framework 6.2, JMS has observability support when publishing messages. This commit creates a bean post-processor that configures an `ObservationRegistry` on the template, if the registry is present. Closes gh-37388
1 parent d6daf87 commit 0fc97e9

File tree

5 files changed

+170
-0
lines changed

5 files changed

+170
-0
lines changed

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

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
/*
2+
* Copyright 2012-2023 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.actuate.autoconfigure.observation.jms;
18+
19+
import io.micrometer.core.instrument.binder.jms.JmsPublishObservationContext;
20+
import io.micrometer.observation.Observation;
21+
import io.micrometer.observation.ObservationRegistry;
22+
import jakarta.jms.Message;
23+
24+
import org.springframework.beans.BeansException;
25+
import org.springframework.beans.factory.ObjectProvider;
26+
import org.springframework.beans.factory.config.BeanPostProcessor;
27+
import org.springframework.boot.actuate.autoconfigure.observation.ObservationAutoConfiguration;
28+
import org.springframework.boot.autoconfigure.AutoConfiguration;
29+
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
30+
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
31+
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
32+
import org.springframework.boot.autoconfigure.jms.JmsAutoConfiguration;
33+
import org.springframework.context.annotation.Bean;
34+
import org.springframework.jms.core.JmsTemplate;
35+
36+
/**
37+
* {@link EnableAutoConfiguration Auto-configuration} for instrumenting
38+
* {@link JmsTemplate} beans for Observability.
39+
*
40+
* @author Brian Clozel
41+
* @since 3.2.0
42+
*/
43+
@AutoConfiguration(after = { JmsAutoConfiguration.class, ObservationAutoConfiguration.class })
44+
@ConditionalOnBean({ ObservationRegistry.class, JmsTemplate.class })
45+
@ConditionalOnClass({ Observation.class, Message.class, JmsTemplate.class, JmsPublishObservationContext.class })
46+
public class JmsTemplateObservationAutoConfiguration {
47+
48+
@Bean
49+
static JmsTemplateObservationPostProcessor jmsTemplateObservationPostProcessor(
50+
ObjectProvider<ObservationRegistry> observationRegistry) {
51+
return new JmsTemplateObservationPostProcessor(observationRegistry);
52+
}
53+
54+
static class JmsTemplateObservationPostProcessor implements BeanPostProcessor {
55+
56+
private final ObjectProvider<ObservationRegistry> observationRegistry;
57+
58+
JmsTemplateObservationPostProcessor(ObjectProvider<ObservationRegistry> observationRegistry) {
59+
this.observationRegistry = observationRegistry;
60+
}
61+
62+
@Override
63+
public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
64+
if (bean instanceof JmsTemplate jmsTemplate) {
65+
this.observationRegistry.ifAvailable(jmsTemplate::setObservationRegistry);
66+
}
67+
return bean;
68+
}
69+
70+
}
71+
72+
}

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
/*
2+
* Copyright 2012-2023 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
/**
18+
* Auto-configuration for JMS observations.
19+
*/
20+
package org.springframework.boot.actuate.autoconfigure.observation.jms;

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ org.springframework.boot.actuate.autoconfigure.metrics.export.statsd.StatsdMetri
7070
org.springframework.boot.actuate.autoconfigure.metrics.export.wavefront.WavefrontMetricsExportAutoConfiguration
7171
org.springframework.boot.actuate.autoconfigure.observation.batch.BatchObservationAutoConfiguration
7272
org.springframework.boot.actuate.autoconfigure.observation.graphql.GraphQlObservationAutoConfiguration
73+
org.springframework.boot.actuate.autoconfigure.observation.jms.JmsTemplateObservationAutoConfiguration
7374
org.springframework.boot.actuate.autoconfigure.metrics.integration.IntegrationMetricsAutoConfiguration
7475
org.springframework.boot.actuate.autoconfigure.metrics.jdbc.DataSourcePoolMetricsAutoConfiguration
7576
org.springframework.boot.actuate.autoconfigure.metrics.jersey.JerseyServerMetricsAutoConfiguration

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

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
/*
2+
* Copyright 2012-2023 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.actuate.autoconfigure.observation.jms;
18+
19+
import jakarta.jms.ConnectionFactory;
20+
import org.junit.jupiter.api.Test;
21+
22+
import org.springframework.boot.actuate.autoconfigure.observation.ObservationAutoConfiguration;
23+
import org.springframework.boot.autoconfigure.AutoConfigurations;
24+
import org.springframework.boot.autoconfigure.jms.JmsAutoConfiguration;
25+
import org.springframework.boot.test.context.FilteredClassLoader;
26+
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
27+
import org.springframework.context.annotation.Bean;
28+
import org.springframework.jms.core.JmsTemplate;
29+
30+
import static org.assertj.core.api.Assertions.assertThat;
31+
import static org.mockito.Mockito.mock;
32+
33+
/**
34+
* Tests for {@link JmsTemplateObservationAutoConfiguration}.
35+
*
36+
* @author Brian Clozel
37+
*/
38+
class JmsTemplateObservationAutoConfigurationTests {
39+
40+
ApplicationContextRunner contextRunner = new ApplicationContextRunner()
41+
.withConfiguration(AutoConfigurations.of(JmsAutoConfiguration.class, ObservationAutoConfiguration.class,
42+
JmsTemplateObservationAutoConfiguration.class))
43+
.withUserConfiguration(JmsConnectionConfiguration.class);
44+
45+
@Test
46+
void shouldConfigureObservationRegistryOnTemplate() {
47+
this.contextRunner.run((context) -> {
48+
JmsTemplate jmsTemplate = context.getBean(JmsTemplate.class);
49+
assertThat(jmsTemplate).extracting("observationRegistry").isNotNull();
50+
});
51+
}
52+
53+
@Test
54+
void shouldBackOffWhenMircrometerCoreIsNotPresent() {
55+
this.contextRunner.withClassLoader(new FilteredClassLoader("io.micrometer.core")).run((context) -> {
56+
JmsTemplate jmsTemplate = context.getBean(JmsTemplate.class);
57+
assertThat(jmsTemplate).extracting("observationRegistry").isNull();
58+
});
59+
}
60+
61+
static class JmsConnectionConfiguration {
62+
63+
@Bean
64+
ConnectionFactory connectionFactory() {
65+
return mock(ConnectionFactory.class);
66+
}
67+
68+
}
69+
70+
}

‎spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -739,6 +739,13 @@ Auto-configuration enables the instrumentation of all available `ThreadPoolTaskE
739739
Metrics are tagged by the name of the executor, which is derived from the bean name.
740740

741741

742+
[[actuator.metrics.supported.jms]]
743+
==== JMS Metrics
744+
Auto-configuration enables the instrumentation of all available `JmsTemplate` beans.
745+
`JmsMessagingTemplate` instances built with instrumented `JmsTemplate` beans will also record observations.
746+
See the {spring-framework-docs}/integration/observability.html#observability.jms.publish[Spring Framework reference documentation for more information on produced observations].
747+
748+
742749

743750
[[actuator.metrics.supported.spring-mvc]]
744751
==== Spring MVC Metrics

0 commit comments

Comments
 (0)