Added Metrics Instrumentation

Author: Bruno Rodrigues

gradle.properties

@@ -40,6 +40,7 @@ LIB_GRAPHQL_JAVA_VER = 9.2
 LIB_JUNIT_VER = 4.12
 LIB_SPRING_CORE_VER = 5.0.4.RELEASE
 LIB_SPRING_BOOT_VER = 2.0.5.RELEASE
+LIB_MICROMETER_VER = 1.0.6
 LIB_GRAPHQL_SERVLET_VER = 6.1.4
 LIB_GRAPHQL_JAVA_TOOLS_VER = 5.3.3
 LIB_COMMONS_IO_VER = 2.6

graphql-spring-boot-autoconfigure/build.gradle

@@ -21,6 +21,7 @@ dependencies {
     compile "org.springframework.boot:spring-boot-configuration-processor:$LIB_SPRING_BOOT_VER"
     compile "org.springframework.boot:spring-boot-autoconfigure:$LIB_SPRING_BOOT_VER"
     compile "org.springframework.boot:spring-boot-starter-websocket:$LIB_SPRING_BOOT_VER"
+    compile "io.micrometer:micrometer-core:$LIB_MICROMETER_VER"
     compile "com.graphql-java-kickstart:graphql-java-servlet:$LIB_GRAPHQL_SERVLET_VER"
     compile "commons-io:commons-io:$LIB_COMMONS_IO_VER"
     compile "com.graphql-java-kickstart:graphql-java-tools:$LIB_GRAPHQL_JAVA_TOOLS_VER"

graphql-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/graphql/boot/GraphQLInstrumentationAutoConfiguration.java

@@ -3,6 +3,7 @@
 import graphql.analysis.MaxQueryComplexityInstrumentation;
 import graphql.analysis.MaxQueryDepthInstrumentation;
 import graphql.execution.instrumentation.tracing.TracingInstrumentation;
+import io.micrometer.core.instrument.MeterRegistry;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
@@ -44,4 +45,12 @@ public MaxQueryComplexityInstrumentation maxQueryComplexityInstrumentation() {
     public MaxQueryDepthInstrumentation maxQueryDepthInstrumentation() {
         return new MaxQueryDepthInstrumentation(maxQueryDepth);
     }
+
+    @Bean
+    @ConditionalOnMissingBean
+    @ConditionalOnProperty(value = "graphql.servlet.actuator-metrics", havingValue = "true")
+    public MetricsInstrumentation metricsInstrumentation(MeterRegistry meterRegistry) {
+        return new MetricsInstrumentation(meterRegistry);
+    }
+
 }

graphql-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/graphql/boot/MetricsInstrumentation.java

@@ -0,0 +1,66 @@
+package com.oembedler.moon.graphql.boot;
+
+import graphql.ExecutionResult;
+import graphql.execution.instrumentation.InstrumentationContext;
+import graphql.execution.instrumentation.InstrumentationState;
+import graphql.execution.instrumentation.SimpleInstrumentation;
+import graphql.execution.instrumentation.SimpleInstrumentationContext;
+import graphql.execution.instrumentation.parameters.InstrumentationExecutionParameters;
+import graphql.servlet.GraphQLContext;
+import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.Timer;
+
+import java.util.concurrent.TimeUnit;
+
+/**
+ * @author Bruno Rodrigues
+ */
+public class MetricsInstrumentation extends SimpleInstrumentation {
+
+    public InstrumentationState createState() {
+        return new MetricsSupport();
+    }
+
+    private MeterRegistry meterRegistry;
+
+    private static final String OPERATION_TIME_METRIC_NAME = "graphql.timer.operation";
+    private static final String OPERATION_NAME_TAG = "operationName";
+    private static final String UNKNOWN_OPERATION_NAME = "unknown";
+    private static final String EXCEPTION_TAG = "exceptionName";
+    private static final String NONE_EXCEPTION = "None";
+    private static final String TIMER_DESCRIPTION = "Timer that records the time to fetch the data by Operation Name";
+
+    public MetricsInstrumentation(MeterRegistry meterRegistry) {
+        this.meterRegistry = meterRegistry;
+    }
+
+    @Override
+    public InstrumentationContext<ExecutionResult> beginExecution(InstrumentationExecutionParameters parameters) {
+
+        return new SimpleInstrumentationContext<ExecutionResult>() {
+            @Override
+            public void onCompleted(ExecutionResult result, Throwable t) {
+
+            GraphQLContext graphQLContext = parameters.getContext();
+            MetricsSupport metricsSupport = parameters.getInstrumentationState();
+            if (graphQLContext.getHttpServletRequest().isPresent()) {
+
+                Timer timer = buildTimer(parameters.getOperation(), t);
+                timer.record(metricsSupport.getTotalTime(), TimeUnit.NANOSECONDS);
+
+            }
+
+            }
+
+        };
+
+    }
+
+    private Timer buildTimer(String operationName, Throwable t) {
+        return Timer.builder(OPERATION_TIME_METRIC_NAME)
+                .description(TIMER_DESCRIPTION)
+                .tag(OPERATION_NAME_TAG, operationName != null ? operationName : UNKNOWN_OPERATION_NAME)
+                .tag(EXCEPTION_TAG, t == null ? NONE_EXCEPTION : t.getClass().getSimpleName())
+                .register(meterRegistry);
+    }
+}

graphql-spring-boot-autoconfigure/src/main/java/com/oembedler/moon/graphql/boot/MetricsSupport.java

@@ -0,0 +1,16 @@
+package com.oembedler.moon.graphql.boot;
+
+import graphql.execution.instrumentation.InstrumentationState;
+
+/**
+ * @author Bruno Rodrigues
+ */
+public class MetricsSupport implements InstrumentationState {
+
+    private final long startRequestNanos = System.nanoTime();
+
+    public long getTotalTime() {
+        return System.nanoTime() - startRequestNanos;
+    }
+
+}

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

@@ -44,6 +44,11 @@
       "name": "graphql.servlet.maxQueryDepth",
       "defaultValue": null,
       "type": "java.lang.Integer"
+    },
+    {
+      "name": "graphql.servlet.actuator-metrics",
+      "defaultValue": false,
+      "type": "java.lang.Boolean"
     }
   ]
 }

graphql-spring-boot-autoconfigure/src/test/java/com/oembedler/moon/graphql/boot/test/instrumentation/GraphQLInstrumentationAutoConfigurationTest.java

@@ -1,17 +1,16 @@
 package com.oembedler.moon.graphql.boot.test.instrumentation;
 
 import com.oembedler.moon.graphql.boot.GraphQLInstrumentationAutoConfiguration;
-import com.oembedler.moon.graphql.boot.GraphQLWebAutoConfiguration;
+import com.oembedler.moon.graphql.boot.MetricsInstrumentation;
 import com.oembedler.moon.graphql.boot.test.AbstractAutoConfigurationTest;
 import graphql.analysis.MaxQueryComplexityInstrumentation;
 import graphql.analysis.MaxQueryDepthInstrumentation;
-import graphql.execution.AsyncExecutionStrategy;
-import graphql.execution.ExecutionStrategy;
 import graphql.execution.instrumentation.Instrumentation;
 import graphql.execution.instrumentation.tracing.TracingInstrumentation;
 import graphql.schema.GraphQLObjectType;
 import graphql.schema.GraphQLSchema;
-import graphql.servlet.AbstractGraphQLHttpServlet;
+import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
 import org.junit.Assert;
 import org.junit.Test;
 import org.springframework.beans.factory.NoSuchBeanDefinitionException;
@@ -36,6 +35,11 @@ GraphQLSchema schema() {
             return GraphQLSchema.newSchema().query(GraphQLObjectType.newObject().name("Query").build()).build();
         }
 
+        @Bean
+        MeterRegistry meterRegistry() {
+            return new SimpleMeterRegistry();
+        }
+
     }
 
     @Test(expected = NoSuchBeanDefinitionException.class)
@@ -72,4 +76,18 @@ public void maxQueryDepthEnabled() {
 
         Assert.assertNotNull(this.getContext().getBean(MaxQueryDepthInstrumentation.class));
     }
+
+    @Test
+    public void actuatorMetricsEnabled() {
+        load(DefaultConfiguration.class, "graphql.servlet.actuator-metrics=true");
+
+        Assert.assertNotNull(this.getContext().getBean(MetricsInstrumentation.class));
+    }
+
+    @Test(expected = NoSuchBeanDefinitionException.class)
+    public void actuatorMetricsDisabled() {
+        load(DefaultConfiguration.class, "graphql.servlet.actuator-metrics=false");
+
+        this.getContext().getBean(MetricsInstrumentation.class);
+    }
 }