metrics

Author: Alexander Furer

README.adoc

@@ -237,7 +237,22 @@ public  class GreeterService extends  GreeterGrpc.GreeterImplBase{
     // ommited
 }
 ----
-=== Spring Validation support
+
+=== GRPC server metrics (Micrometer.io integration)
+
+By including `org.springframework.boot:spring-boot-starter-actuator` dependency,
+the starter will collect gRPC server metrics , broken down by
+
+. gRPC service method FQN (Fully Qualified Name)
+. https://grpc.github.io/grpc-java/javadoc/io/grpc/Status.Code.html[Response status code]
+
+After configuring the exporter of your https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#production-ready-metrics[choice],
+you should see the `timer` named `grpc.server.calls`.
+
+
+
+
+=== Spring Boot Validation support
 
 The starter can be  auto-configured to validate request/response gRPC service messages.
 Please continue to <<Implementing message validation>> for configuration details.

grpc-spring-boot-starter-demo/build.gradle

@@ -39,6 +39,7 @@ dependencies {
     testCompile 'com.github.stefanbirkner:system-rules:1.18.0'
     testCompile('org.springframework.cloud:spring-cloud-starter-consul-discovery')
     testCompile 'com.pszymczyk.consul:embedded-consul:2.1.4'
+    testCompile 'org.awaitility:awaitility:4.0.3'
 
     testCompile "org.springframework.cloud:spring-cloud-config-server:2.1.1.RELEASE"
     testCompile "org.springframework.cloud:spring-cloud-config-client:2.1.1.RELEASE"

grpc-spring-boot-starter-demo/src/test/java/org/lognet/springboot/grpc/GrpcMeterTest.java

@@ -0,0 +1,53 @@
+package org.lognet.springboot.grpc;
+
+import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.Timer;
+import io.micrometer.core.instrument.simple.SimpleConfig;
+import org.awaitility.Awaitility;
+import org.junit.Before;
+import org.junit.runner.RunWith;
+import org.lognet.springboot.grpc.demo.DemoApp;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.junit4.SpringRunner;
+
+import java.time.Duration;
+import java.util.concurrent.TimeUnit;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.greaterThan;
+import static org.hamcrest.Matchers.notNullValue;
+import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.NONE;
+
+@RunWith(SpringRunner.class)
+@SpringBootTest(classes = {DemoApp.class}, webEnvironment = NONE, properties = {"grpc.port=0"})
+@ActiveProfiles("measure")
+public class GrpcMeterTest extends GrpcServerTestBase {
+    @Autowired
+    private MeterRegistry registry;
+
+    @Autowired
+    private SimpleConfig registryConfig;
+
+    @Before
+    public void setUp()  {
+        registry.clear();
+    }
+
+    @Override
+    protected void afterGreeting()  {
+
+
+        final Timer timer = registry.find("grpc.server.calls").timer();
+        assertThat(timer,notNullValue(Timer.class));
+
+        Awaitility
+                .waitAtMost(Duration.ofMillis(registryConfig.step().toMillis() * 2))
+                .until(timer::count,greaterThan(0L));
+
+        assertThat(timer.max(TimeUnit.MILLISECONDS),greaterThan(0d));
+        assertThat(timer.mean(TimeUnit.MILLISECONDS),greaterThan(0d));
+        assertThat(timer.totalTime(TimeUnit.MILLISECONDS),greaterThan(0d));
+    }
+}

grpc-spring-boot-starter-demo/src/test/resources/application-measure.yml

@@ -0,0 +1,6 @@
+management:
+  metrics:
+    export:
+      simple:
+        step: 10s
+        enabled: true

grpc-spring-boot-starter-demo/src/test/resources/application.yml

@@ -1,4 +1,8 @@
 management:
+  metrics:
+    export:
+      simple:
+        enabled: false
   endpoints:
     web:
       base-path: "/"

grpc-spring-boot-starter/build.gradle

@@ -131,6 +131,7 @@ dependencies {
     compileOnly "org.springframework.security:spring-security-oauth2-resource-server"
     compileOnly "org.springframework.security:spring-security-oauth2-jose"
     compileOnly 'org.springframework.boot:spring-boot-starter-validation'
+    compileOnly "org.springframework.boot:spring-boot-starter-actuator"
     compileOnly group: 'org.springframework.cloud', name: 'spring-cloud-starter-consul-discovery', version: '2.1.1.RELEASE'
 
 

grpc-spring-boot-starter/src/main/java/org/lognet/springboot/grpc/autoconfigure/metrics/GRpcMetricsAutoConfiguration.java

@@ -0,0 +1,94 @@
+package org.lognet.springboot.grpc.autoconfigure.metrics;
+
+import io.grpc.ForwardingServerCall;
+import io.grpc.Metadata;
+import io.grpc.ServerCall;
+import io.grpc.ServerCallHandler;
+import io.grpc.ServerInterceptor;
+import io.grpc.Status;
+import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.Timer;
+import org.lognet.springboot.grpc.GRpcGlobalInterceptor;
+import org.lognet.springboot.grpc.GRpcService;
+import org.springframework.boot.actuate.autoconfigure.metrics.CompositeMeterRegistryAutoConfiguration;
+import org.springframework.boot.actuate.autoconfigure.metrics.MetricsAutoConfiguration;
+import org.springframework.boot.autoconfigure.AutoConfigureAfter;
+import org.springframework.boot.autoconfigure.condition.AllNestedConditions;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Conditional;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.Ordered;
+
+@Configuration
+@AutoConfigureAfter({MetricsAutoConfiguration.class, CompositeMeterRegistryAutoConfiguration.class})
+@ConditionalOnClass({MeterRegistry.class})
+@Conditional(GRpcMetricsAutoConfiguration.OnGrpcAndMeterRegistryEnabledCondition.class)
+public class GRpcMetricsAutoConfiguration {
+
+    protected static class OnGrpcAndMeterRegistryEnabledCondition extends AllNestedConditions {
+
+        OnGrpcAndMeterRegistryEnabledCondition() {
+            super(ConfigurationPhase.REGISTER_BEAN);
+        }
+
+        @ConditionalOnBean(value = {MeterRegistry.class})
+        static class MeterRegistryCondition {
+        }
+
+        @ConditionalOnBean(annotation = {GRpcService.class})
+        static class GrpcServiceCondition {
+        }
+
+    }
+
+    static class MonitoringServerCall<ReqT, RespT> extends  ForwardingServerCall.SimpleForwardingServerCall<ReqT, RespT> {
+
+        private MeterRegistry registry;
+        final Timer.Sample start;
+        protected MonitoringServerCall(ServerCall<ReqT, RespT> delegate, MeterRegistry registry) {
+            super(delegate);
+            this.start = Timer.start(registry);
+            this.registry = registry;
+
+
+        }
+        @Override
+        public void close(Status status, Metadata trailers) {
+            start.stop(Timer.builder("grpc.server.calls")
+                    .tag("method",getMethodDescriptor().getFullMethodName())
+                    .tag("result",status.getCode().name())
+                    .register(registry));
+
+            super.close(status, trailers);
+        }
+    }
+
+    static class MonitoringServerInterceptor implements ServerInterceptor, Ordered {
+
+
+        private MeterRegistry registry;
+
+        public MonitoringServerInterceptor(MeterRegistry registry) {
+            this.registry = registry;
+        }
+
+        @Override
+        public <ReqT, RespT> ServerCall.Listener<ReqT> interceptCall(ServerCall<ReqT, RespT> call, Metadata headers, ServerCallHandler<ReqT, RespT> next) {
+            return next.startCall(new MonitoringServerCall<>(call,registry), headers);
+
+        }
+
+        @Override
+        public int getOrder() {
+            return HIGHEST_PRECEDENCE+20;
+        }
+    }
+
+    @Bean
+    @GRpcGlobalInterceptor
+    public ServerInterceptor measure(MeterRegistry registry){
+        return  new MonitoringServerInterceptor(registry);
+    }
+}

grpc-spring-boot-starter/src/main/resources/META-INF/spring.factories

@@ -1,5 +1,6 @@
 org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
 org.lognet.springboot.grpc.autoconfigure.GRpcAutoConfiguration,\
+org.lognet.springboot.grpc.autoconfigure.metrics.GRpcMetricsAutoConfiguration,\
 org.lognet.springboot.grpc.autoconfigure.consul.ConsulGrpcAutoConfiguration,\
 org.lognet.springboot.grpc.autoconfigure.security.SecurityAutoConfiguration