Move code from spring-boot-actuator to spring-boot-http-client

spring-boot-project/spring-boot-http-client/src/main/java/org/springframework/boot/http/client/rest/actuate/observation/ObservationRestClientCustomizer.java

@@ -0,0 +1,58 @@
+/*
+ * Copyright 2012-2025 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.boot.http.client.rest.actuate.observation;
+
+import io.micrometer.observation.ObservationRegistry;
+
+import org.springframework.boot.web.client.RestClientCustomizer;
+import org.springframework.http.client.observation.ClientRequestObservationConvention;
+import org.springframework.util.Assert;
+import org.springframework.web.client.RestClient.Builder;
+
+/**
+ * {@link RestClientCustomizer} that configures the {@link Builder RestClient builder} to
+ * record request observations.
+ *
+ * @author Moritz Halbritter
+ * @since 4.0.0
+ */
+public class ObservationRestClientCustomizer implements RestClientCustomizer {
+
+	private final ObservationRegistry observationRegistry;
+
+	private final ClientRequestObservationConvention observationConvention;
+
+	/**
+	 * Create a new {@link ObservationRestClientCustomizer}.
+	 * @param observationRegistry the observation registry
+	 * @param observationConvention the observation convention
+	 */
+	public ObservationRestClientCustomizer(ObservationRegistry observationRegistry,
+			ClientRequestObservationConvention observationConvention) {
+		Assert.notNull(observationConvention, "'observationConvention' must not be null");
+		Assert.notNull(observationRegistry, "'observationRegistry' must not be null");
+		this.observationRegistry = observationRegistry;
+		this.observationConvention = observationConvention;
+	}
+
+	@Override
+	public void customize(Builder restClientBuilder) {
+		restClientBuilder.observationRegistry(this.observationRegistry);
+		restClientBuilder.observationConvention(this.observationConvention);
+	}
+
+}

spring-boot-project/spring-boot-http-client/src/main/java/org/springframework/boot/http/client/rest/actuate/observation/ObservationRestTemplateCustomizer.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2012-2025 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.boot.http.client.rest.actuate.observation;
+
+import io.micrometer.observation.ObservationRegistry;
+
+import org.springframework.boot.web.client.RestTemplateCustomizer;
+import org.springframework.http.client.observation.ClientRequestObservationConvention;
+import org.springframework.web.client.RestTemplate;
+
+/**
+ * {@link RestTemplateCustomizer} that configures the {@link RestTemplate} to record
+ * request observations.
+ *
+ * @author Brian Clozel
+ * @since 4.0.0
+ */
+public class ObservationRestTemplateCustomizer implements RestTemplateCustomizer {
+
+	private final ObservationRegistry observationRegistry;
+
+	private final ClientRequestObservationConvention observationConvention;
+
+	/**
+	 * Create a new {@code ObservationRestTemplateCustomizer}.
+	 * @param observationConvention the observation convention
+	 * @param observationRegistry the observation registry
+	 */
+	public ObservationRestTemplateCustomizer(ObservationRegistry observationRegistry,
+			ClientRequestObservationConvention observationConvention) {
+		this.observationConvention = observationConvention;
+		this.observationRegistry = observationRegistry;
+	}
+
+	@Override
+	public void customize(RestTemplate restTemplate) {
+		restTemplate.setObservationConvention(this.observationConvention);
+		restTemplate.setObservationRegistry(this.observationRegistry);
+	}
+
+}

spring-boot-project/spring-boot-http-client/src/main/java/org/springframework/boot/http/client/rest/actuate/observation/package-info.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2012-2025 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.
+ */
+
+/**
+ * Observation integration for RestClient and RestTemplate.
+ */
+package org.springframework.boot.http.client.rest.actuate.observation;

spring-boot-project/spring-boot-http-client/src/test/java/org/springframework/boot/http/client/rest/actuate/observation/ObservationRestClientCustomizerTests.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2012-2025 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.boot.http.client.rest.actuate.observation;
+
+import io.micrometer.observation.ObservationRegistry;
+import io.micrometer.observation.tck.TestObservationRegistry;
+import org.junit.jupiter.api.Test;
+
+import org.springframework.http.client.observation.DefaultClientRequestObservationConvention;
+import org.springframework.web.client.RestClient;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link ObservationRestClientCustomizer}.
+ *
+ * @author Brian Clozel
+ * @author Moritz Halbritter
+ */
+class ObservationRestClientCustomizerTests {
+
+	private static final String TEST_METRIC_NAME = "http.test.metric.name";
+
+	private final ObservationRegistry observationRegistry = TestObservationRegistry.create();
+
+	private final RestClient.Builder restClientBuilder = RestClient.builder();
+
+	private final ObservationRestClientCustomizer customizer = new ObservationRestClientCustomizer(
+			this.observationRegistry, new DefaultClientRequestObservationConvention(TEST_METRIC_NAME));
+
+	@Test
+	void shouldCustomizeObservationConfiguration() {
+		this.customizer.customize(this.restClientBuilder);
+		assertThat(this.restClientBuilder).hasFieldOrPropertyWithValue("observationRegistry", this.observationRegistry);
+		assertThat(this.restClientBuilder).extracting("observationConvention")
+			.isInstanceOf(DefaultClientRequestObservationConvention.class)
+			.hasFieldOrPropertyWithValue("name", TEST_METRIC_NAME);
+	}
+
+}

spring-boot-project/spring-boot-http-client/src/test/java/org/springframework/boot/http/client/rest/actuate/observation/ObservationRestTemplateCustomizerTests.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2012-2025 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.boot.http.client.rest.actuate.observation;
+
+import io.micrometer.observation.ObservationRegistry;
+import io.micrometer.observation.tck.TestObservationRegistry;
+import org.junit.jupiter.api.Test;
+
+import org.springframework.http.client.observation.DefaultClientRequestObservationConvention;
+import org.springframework.web.client.RestTemplate;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link ObservationRestTemplateCustomizer}.
+ *
+ * @author Brian Clozel
+ */
+class ObservationRestTemplateCustomizerTests {
+
+	private static final String TEST_METRIC_NAME = "http.test.metric.name";
+
+	private final ObservationRegistry observationRegistry = TestObservationRegistry.create();
+
+	private final RestTemplate restTemplate = new RestTemplate();
+
+	private final ObservationRestTemplateCustomizer customizer = new ObservationRestTemplateCustomizer(
+			this.observationRegistry, new DefaultClientRequestObservationConvention(TEST_METRIC_NAME));
+
+	@Test
+	void shouldCustomizeObservationConfiguration() {
+		this.customizer.customize(this.restTemplate);
+		assertThat(this.restTemplate).hasFieldOrPropertyWithValue("observationRegistry", this.observationRegistry);
+		assertThat(this.restTemplate).extracting("observationConvention")
+			.isInstanceOf(DefaultClientRequestObservationConvention.class)
+			.hasFieldOrPropertyWithValue("name", TEST_METRIC_NAME);
+	}
+
+}