Add ObservationRegistry support to ConfigClientRequestTemplateFactory #3221
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| /* | ||
| * Copyright 2026-present the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.springframework.cloud.config.client; | ||
|
|
||
| import io.micrometer.observation.ObservationRegistry; | ||
| import org.apache.commons.logging.Log; | ||
|
|
||
| import org.springframework.boot.bootstrap.BootstrapContext; | ||
| import org.springframework.boot.restclient.observation.ObservationRestTemplateCustomizer; | ||
| import org.springframework.http.client.observation.DefaultClientRequestObservationConvention; | ||
| import org.springframework.web.client.RestTemplate; | ||
|
|
||
| public class ObservationConfigClientRequestTemplateFactory extends ConfigClientRequestTemplateFactory { | ||
|
|
||
| private final ObservationRestTemplateCustomizer observationRestTemplateCustomizer; | ||
|
|
||
| public ObservationConfigClientRequestTemplateFactory(Log log, ConfigClientProperties properties, | ||
| ObservationRegistry observationRegistry) { | ||
| super(log, properties); | ||
| this.observationRestTemplateCustomizer = observationRegistry != ObservationRegistry.NOOP | ||
| ? new ObservationRestTemplateCustomizer(observationRegistry, | ||
| new DefaultClientRequestObservationConvention()) | ||
| : null; | ||
| } | ||
|
|
||
| @Override | ||
| public RestTemplate create() { | ||
| RestTemplate template = super.create(); | ||
| if (observationRestTemplateCustomizer != null) { | ||
| observationRestTemplateCustomizer.customize(template); | ||
| } | ||
| return template; | ||
| } | ||
|
|
||
| static ConfigClientRequestTemplateFactory createWithObservation(BootstrapContext context, Log log, | ||
| ConfigClientProperties props) { | ||
| ObservationRegistry registry = context.getOrElse(ObservationRegistry.class, ObservationRegistry.NOOP); | ||
| return new ObservationConfigClientRequestTemplateFactory(log, props, registry); | ||
| } | ||
|
|
||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| /* | ||
| * Copyright 2026-present the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.springframework.cloud.config.client; | ||
|
|
||
| import io.micrometer.observation.ObservationRegistry; | ||
|
|
||
| import org.springframework.boot.bootstrap.BootstrapRegistry; | ||
|
|
||
| public class ObservationConfigServerBootstrapper extends ConfigServerBootstrapper { | ||
|
|
||
| private ObservationRegistry observationRegistry; | ||
|
|
||
| public static ObservationConfigServerBootstrapper create() { | ||
| return new ObservationConfigServerBootstrapper(); | ||
| } | ||
|
|
||
| public ObservationConfigServerBootstrapper withObservationRegistry(ObservationRegistry observationRegistry) { | ||
| this.observationRegistry = observationRegistry; | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| public void initialize(BootstrapRegistry registry) { | ||
| super.initialize(registry); | ||
| if (observationRegistry != null) { | ||
| registry.register(ObservationRegistry.class, BootstrapRegistry.InstanceSupplier.of(observationRegistry)); | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| /* | ||
| * Copyright 2026-present the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.springframework.cloud.config.client; | ||
|
|
||
| import io.micrometer.observation.ObservationRegistry; | ||
| import org.apache.commons.logging.LogFactory; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import org.springframework.web.client.RestTemplate; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| /** | ||
| * @author Luccas Asaphe | ||
| * | ||
| */ | ||
| public class ConfigClientRequestTemplateFactoryTests { | ||
|
|
||
| @Test | ||
| void shouldInstrumentRestTemplateWhenObservationRegistryProvided() { | ||
| // 1. set up the factory | ||
| ConfigClientProperties properties = new ConfigClientProperties(); | ||
| ObservationRegistry registry = ObservationRegistry.create(); | ||
| ObservationConfigClientRequestTemplateFactory factory = new ObservationConfigClientRequestTemplateFactory( | ||
| LogFactory.getLog(getClass()), properties, registry); | ||
|
|
||
| // 2. create the RestTemplate | ||
| RestTemplate restTemplate = factory.create(); | ||
|
|
||
| // 3. verify the observation registry | ||
| assertThat(restTemplate.getObservationRegistry()).isEqualTo(registry); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldNotInstrumentRestTemplateWhenObservationRegistryNotProvided() { | ||
| // 1. set up the factory | ||
| ConfigClientProperties properties = new ConfigClientProperties(); | ||
| ConfigClientRequestTemplateFactory factory = new ConfigClientRequestTemplateFactory( | ||
| LogFactory.getLog(getClass()), properties); | ||
|
|
||
| // 2. create the RestTemplate | ||
| RestTemplate restTemplate = factory.create(); | ||
|
|
||
| // 3. verify the observation registry | ||
| assertThat(restTemplate.getObservationRegistry()).isEqualTo(ObservationRegistry.NOOP); | ||
| } | ||
|
|
||
| @Test | ||
| void shouldNotInstrumentRestTemplateWhenObservationRegistryIsNoop() { | ||
| // 1. set up the factory | ||
| ConfigClientProperties properties = new ConfigClientProperties(); | ||
| ObservationRegistry registry = ObservationRegistry.NOOP; | ||
|
LuccasAps marked this conversation as resolved.
|
||
| ObservationConfigClientRequestTemplateFactory factory = new ObservationConfigClientRequestTemplateFactory( | ||
| LogFactory.getLog(getClass()), properties, registry); | ||
|
|
||
| // 2. create the RestTemplate | ||
| RestTemplate restTemplate = factory.create(); | ||
|
|
||
| // 3. verify the observation registry | ||
| assertThat(restTemplate.getObservationRegistry()).isEqualTo(ObservationRegistry.NOOP); | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| /* | ||
| * Copyright 2026-present the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.springframework.cloud.config.client; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import org.springframework.beans.factory.config.ConfigurableListableBeanFactory; | ||
| import org.springframework.boot.SpringBootConfiguration; | ||
| import org.springframework.boot.WebApplicationType; | ||
| import org.springframework.boot.autoconfigure.EnableAutoConfiguration; | ||
| import org.springframework.boot.bootstrap.BootstrapContext; | ||
| import org.springframework.boot.builder.SpringApplicationBuilder; | ||
| import org.springframework.cloud.test.ClassPathExclusions; | ||
| import org.springframework.context.ConfigurableApplicationContext; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| /** | ||
| * @author Luccas Asaphe | ||
| * | ||
| */ | ||
| @ClassPathExclusions({ "spring-boot-restclient-*.jar" }) | ||
| public class ConfigServerConfigDataWithoutMicrometerTests { | ||
|
|
||
| @Test | ||
| void contextStartsWithoutMicrometer() { | ||
|
Contributor
There was a problem hiding this comment. Would be good to verify the correct beans are created |
||
| try (ConfigurableApplicationContext context = new SpringApplicationBuilder(TestConfig.class) | ||
| .web(WebApplicationType.NONE) | ||
| .addBootstrapRegistryInitializer(registry -> registry.addCloseListener(event -> { | ||
| BootstrapContext bootstrapContext = event.getBootstrapContext(); | ||
| ConfigurableListableBeanFactory beanFactory = event.getApplicationContext().getBeanFactory(); | ||
|
|
||
| ConfigClientRequestTemplateFactory templateFactory = bootstrapContext | ||
| .get(ConfigClientRequestTemplateFactory.class); | ||
| beanFactory.registerSingleton("factory", templateFactory); | ||
| })) | ||
| .run("--spring.config.import=optional:configserver:")) { | ||
| assertThat(context).isNotNull(); | ||
|
|
||
| assertThat(context.getBean("factory")).isNotInstanceOf(ObservationConfigClientRequestTemplateFactory.class); | ||
| } | ||
| } | ||
|
|
||
| @SpringBootConfiguration | ||
| @EnableAutoConfiguration | ||
| static class TestConfig { | ||
|
|
||
| } | ||
|
|
||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.