Use GraphQL Observation instrumentation

This commit migrates the existing metrics support (added in #29140) to
the new `Observation` instrumentation contributed in
spring-projects/spring-graphql#501.

We cannot have a smoother migration path here as the instrumentation
does not use the same context information for metadata extraction.

Closes gh-32794

Author: bclozel

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java

@@ -63,8 +63,6 @@ public class MetricsProperties {
 
 	private final Data data = new Data();
 
-	private final Graphql graphql = new Graphql();
-
 	private final System system = new System();
 
 	private final Distribution distribution = new Distribution();
@@ -93,10 +91,6 @@ public Data getData() {
 		return this.data;
 	}
 
-	public Graphql getGraphql() {
-		return this.graphql;
-	}
-
 	public System getSystem() {
 		return this.system;
 	}
@@ -249,20 +243,6 @@ public AutoTimeProperties getAutotime() {
 
 	}
 
-	public static class Graphql {
-
-		/**
-		 * Auto-timed queries settings.
-		 */
-		@NestedConfigurationProperty
-		private final AutoTimeProperties autotime = new AutoTimeProperties();
-
-		public AutoTimeProperties getAutotime() {
-			return this.autotime;
-		}
-
-	}
-
 	public static class System {
 
 		private final Diskspace diskspace = new Diskspace();

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/graphql/GraphQlMetricsAutoConfiguration.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2012-2022 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.actuate.autoconfigure.observation.graphql;
+
+import graphql.GraphQL;
+import io.micrometer.observation.Observation;
+import io.micrometer.observation.ObservationRegistry;
+
+import org.springframework.boot.actuate.autoconfigure.observation.ObservationAutoConfiguration;
+import org.springframework.boot.autoconfigure.AutoConfiguration;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.context.annotation.Bean;
+import org.springframework.graphql.execution.GraphQlSource;
+import org.springframework.graphql.observation.GraphQlObservationInstrumentation;
+
+/**
+ * {@link EnableAutoConfiguration Auto-configuration} for instrumentation of Spring
+ * GraphQL endpoints.
+ *
+ * @author Brian Clozel
+ * @since 3.0.0
+ */
+@AutoConfiguration(after = ObservationAutoConfiguration.class)
+@ConditionalOnBean(ObservationRegistry.class)
+@ConditionalOnClass({ GraphQL.class, GraphQlSource.class, Observation.class })
+@SuppressWarnings("removal")
+public class GraphQlObservationAutoConfiguration {
+
+	@Bean
+	@ConditionalOnMissingBean
+	public GraphQlObservationInstrumentation graphQlObservationInstrumentation(
+			ObservationRegistry observationRegistry) {
+		return new GraphQlObservationInstrumentation(observationRegistry);
+	}
+
+}

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/observation/graphql/GraphQlObservationAutoConfiguration.java

@@ -15,6 +15,6 @@
  */
 
 /**
- * Auto-configuration for Spring GraphQL metrics.
+ * Auto-configuration for Spring GraphQL observations.
  */
-package org.springframework.boot.actuate.autoconfigure.metrics.graphql;
+package org.springframework.boot.actuate.autoconfigure.observation.graphql;

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/graphql/package-info.java renamed to spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/observation/graphql/package-info.java

@@ -1885,6 +1885,32 @@
         "replacement": "management.wavefront.uri"
       }
     },
+    {
+      "name": "management.metrics.graphql.autotime.enabled",
+      "description": "Whether to automatically time web client requests.",
+      "defaultValue": true,
+      "deprecation": {
+        "level": "error",
+        "reason": "Should be applied at the ObservationRegistry level."
+      }
+    },
+    {
+      "name": "management.metrics.graphql.autotime.percentiles",
+      "description": "Computed non-aggregable percentiles to publish.",
+      "deprecation": {
+        "level": "error",
+        "reason": "Should be applied at the ObservationRegistry level."
+      }
+    },
+    {
+      "name": "management.metrics.graphql.autotime.percentiles-histogram",
+      "description": "Whether percentile histograms should be published.",
+      "defaultValue": false,
+      "deprecation": {
+        "level": "error",
+        "reason": "Should be applied at the ObservationRegistry level."
+      }
+    },
     {
       "name": "management.metrics.mongo.command.enabled",
       "description": "Whether to enable Mongo client command metrics.",

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -67,7 +67,7 @@ org.springframework.boot.actuate.autoconfigure.metrics.export.simple.SimpleMetri
 org.springframework.boot.actuate.autoconfigure.metrics.export.stackdriver.StackdriverMetricsExportAutoConfiguration
 org.springframework.boot.actuate.autoconfigure.metrics.export.statsd.StatsdMetricsExportAutoConfiguration
 org.springframework.boot.actuate.autoconfigure.metrics.export.wavefront.WavefrontMetricsExportAutoConfiguration
-org.springframework.boot.actuate.autoconfigure.metrics.graphql.GraphQlMetricsAutoConfiguration
+org.springframework.boot.actuate.autoconfigure.observation.graphql.GraphQlObservationAutoConfiguration
 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/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2012-2022 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.actuate.autoconfigure.observation.graphql;
+
+import io.micrometer.observation.ObservationRegistry;
+import io.micrometer.observation.tck.TestObservationRegistry;
+import org.junit.jupiter.api.Test;
+
+import org.springframework.boot.autoconfigure.AutoConfigurations;
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.graphql.observation.GraphQlObservationInstrumentation;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link GraphQlObservationAutoConfiguration}.
+ *
+ * @author Brian Clozel
+ */
+class GraphQlObservationAutoConfigurationTests {
+
+	private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
+			.withBean(TestObservationRegistry.class, TestObservationRegistry::create)
+			.withConfiguration(AutoConfigurations.of(GraphQlObservationAutoConfiguration.class));
+
+	@Test
+	void backsOffWhenObservationRegistryIsMissing() {
+		new ApplicationContextRunner()
+				.withConfiguration(AutoConfigurations.of(GraphQlObservationAutoConfiguration.class))
+				.run((context) -> assertThat(context).doesNotHaveBean(GraphQlObservationInstrumentation.class));
+	}
+
+	@Test
+	void definesInstrumentationWhenObservationRegistryIsPresent() {
+		this.contextRunner.run((context) -> assertThat(context).hasSingleBean(GraphQlObservationInstrumentation.class));
+	}
+
+	@Test
+	void instrumentationBacksOffIfAlreadyPresent() {
+		this.contextRunner.withUserConfiguration(InstrumentationConfiguration.class)
+				.run((context) -> assertThat(context).hasSingleBean(GraphQlObservationInstrumentation.class)
+						.hasBean("customInstrumentation"));
+	}
+
+	@Configuration(proxyBeanMethods = false)
+	static class InstrumentationConfiguration {
+
+		@Bean
+		GraphQlObservationInstrumentation customInstrumentation(ObservationRegistry registry) {
+			return new GraphQlObservationInstrumentation(registry);
+		}
+
+	}
+
+}