Consul health check

Alexander Furer · Alexander Furer · commit 2da3148ecdea · 2020-06-10T17:13:56.000+03:00
diff --git a/README.adoc b/README.adoc
@@ -260,9 +260,16 @@ This is the current limitation.
 
 == Consul Integration
 
-Starting from version `3.3.0`, the starter will auto-register the running grpc server in Consul registry  if `org.springframework.cloud:spring-cloud-starter-consul-discovery` is in classpath. +
+Starting from version `3.3.0`, the starter will auto-register the running grpc server in Consul registry
+if `org.springframework.cloud:spring-cloud-starter-consul-discovery` is in classpath and
+`spring.cloud.service-registry.auto-registration.enabled` is *NOT* set to `false`. +
+
 The registered service name will be prefixed with `grpc-` ,i.e. `grpc-${spring.application.name}` to not interfere with standard registered web-service name if you choose to run both embedded `Grpc` and `Web` servers. +
 
+Setting `spring.cloud.consul.discovery.register-health-check` to true will register GRPC health check service in Consul.
+
+Tags could be set by defining `spring.cloud.consul.discovery.tags` property.
+
 You can find the test that demonstrates the feature link:grpc-spring-boot2-starter-demo/src/test/java/org/lognet/springboot/grpc/ConsulRegistrationTest.java[here].
 
 == Eureka Integration
diff --git a/build.gradle b/build.gradle
@@ -2,7 +2,7 @@ buildscript {
     ext {
         springBoot_1_X_Version = '1.5.13.RELEASE'
         springBoot_2_X_Version = '2.1.3.RELEASE'
-        grpcVersion = '1.29.0'
+        grpcVersion = '1.30.0'
     }
     repositories {
         mavenCentral()
diff --git a/grpc-spring-boot-starter-demo/src/main/java/org/lognet/springboot/grpc/demo/DemoApp.java b/grpc-spring-boot-starter-demo/src/main/java/org/lognet/springboot/grpc/demo/DemoApp.java
@@ -1,54 +1,16 @@
 package org.lognet.springboot.grpc.demo;
 
 
-import io.grpc.examples.CalculatorGrpc;
-import io.grpc.examples.CalculatorOuterClass;
-import io.grpc.stub.StreamObserver;
-import org.lognet.springboot.grpc.GRpcService;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
-import org.springframework.context.annotation.Bean;
 
 /**
  * Created by alexf on 28-Jan-16.
  */
 @SpringBootApplication
 public class DemoApp {
 
-    @Bean
-    public GreeterService greeterService() {
-		return new GreeterService();
-	}
 
-    @GRpcService(interceptors = NotSpringBeanInterceptor.class)
-    public static class CalculatorService extends CalculatorGrpc.CalculatorImplBase{
-        @Override
-        public void calculate(CalculatorOuterClass.CalculatorRequest request, StreamObserver<CalculatorOuterClass.CalculatorResponse> responseObserver) {
-            CalculatorOuterClass.CalculatorResponse.Builder resultBuilder = CalculatorOuterClass.CalculatorResponse.newBuilder();
-            switch (request.getOperation()){
-                case ADD:
-                    resultBuilder.setResult(request.getNumber1()+request.getNumber2());
-                    break;
-                case SUBTRACT:
-                    resultBuilder.setResult(request.getNumber1()-request.getNumber2());
-                    break;
-                case MULTIPLY:
-                    resultBuilder.setResult(request.getNumber1()*request.getNumber2());
-                    break;
-                case DIVIDE:
-                    resultBuilder.setResult(request.getNumber1()/request.getNumber2());
-                    break;
-                case UNRECOGNIZED:
-                    break;
-            }
-            responseObserver.onNext(resultBuilder.build());
-            responseObserver.onCompleted();
-
-
-        }
-
-
-    }
 
     public static void main(String[] args) {
         SpringApplication.run(DemoApp.class,args);
diff --git a/grpc-spring-boot-starter-demo/src/main/java/org/lognet/springboot/grpc/demo/DemoAppConfiguration.java b/grpc-spring-boot-starter-demo/src/main/java/org/lognet/springboot/grpc/demo/DemoAppConfiguration.java
@@ -0,0 +1,46 @@
+package org.lognet.springboot.grpc.demo;
+
+import io.grpc.examples.CalculatorGrpc;
+import io.grpc.examples.CalculatorOuterClass;
+import io.grpc.stub.StreamObserver;
+import org.lognet.springboot.grpc.GRpcService;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class DemoAppConfiguration {
+    @Bean
+    public GreeterService greeterService() {
+        return new GreeterService();
+    }
+
+    @GRpcService(interceptors = NotSpringBeanInterceptor.class)
+    public static class CalculatorService extends CalculatorGrpc.CalculatorImplBase{
+        @Override
+        public void calculate(CalculatorOuterClass.CalculatorRequest request, StreamObserver<CalculatorOuterClass.CalculatorResponse> responseObserver) {
+            CalculatorOuterClass.CalculatorResponse.Builder resultBuilder = CalculatorOuterClass.CalculatorResponse.newBuilder();
+            switch (request.getOperation()){
+                case ADD:
+                    resultBuilder.setResult(request.getNumber1()+request.getNumber2());
+                    break;
+                case SUBTRACT:
+                    resultBuilder.setResult(request.getNumber1()-request.getNumber2());
+                    break;
+                case MULTIPLY:
+                    resultBuilder.setResult(request.getNumber1()*request.getNumber2());
+                    break;
+                case DIVIDE:
+                    resultBuilder.setResult(request.getNumber1()/request.getNumber2());
+                    break;
+                case UNRECOGNIZED:
+                    break;
+            }
+            responseObserver.onNext(resultBuilder.build());
+            responseObserver.onCompleted();
+
+
+        }
+
+
+    }
+}
diff --git a/grpc-spring-boot-starter-demo/src/main/protoGen/io/grpc/examples/CalculatorGrpc.java b/grpc-spring-boot-starter-demo/src/main/protoGen/io/grpc/examples/CalculatorGrpc.java
@@ -10,7 +10,7 @@
 /**
  */
 @javax.annotation.Generated(
-    value = "by gRPC proto compiler (version 1.29.0)",
+    value = "by gRPC proto compiler (version 1.30.0)",
     comments = "Source: calculator.proto")
 public final class CalculatorGrpc {
 
diff --git a/grpc-spring-boot-starter-demo/src/main/protoGen/io/grpc/examples/GreeterGrpc.java b/grpc-spring-boot-starter-demo/src/main/protoGen/io/grpc/examples/GreeterGrpc.java
@@ -13,7 +13,7 @@
  * </pre>
  */
 @javax.annotation.Generated(
-    value = "by gRPC proto compiler (version 1.29.0)",
+    value = "by gRPC proto compiler (version 1.30.0)",
     comments = "Source: greeter.proto")
 public final class GreeterGrpc {
 
diff --git a/grpc-spring-boot-starter-demo/src/test/java/org/lognet/springboot/grpc/DemoAppTestAop.java b/grpc-spring-boot-starter-demo/src/test/java/org/lognet/springboot/grpc/DemoAppTestAop.java
@@ -4,6 +4,7 @@
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.lognet.springboot.grpc.demo.DemoApp;
+import org.lognet.springboot.grpc.demo.DemoAppConfiguration.CalculatorService;
 import org.lognet.springboot.grpc.demo.GreeterService;
 import org.springframework.aop.support.AopUtils;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -33,7 +34,7 @@ public class DemoAppTestAop extends GrpcServerTestBase{
     private GreeterService greeterService;
 
     @Autowired
-    private DemoApp.CalculatorService calculatorService;
+    private CalculatorService calculatorService;
 
     @Rule
     public OutputCapture outputCapture = new OutputCapture();
diff --git a/grpc-spring-boot-starter/src/main/java/org/lognet/springboot/grpc/autoconfigure/consul/GRpcConsulHealthCheck.java b/grpc-spring-boot-starter/src/main/java/org/lognet/springboot/grpc/autoconfigure/consul/GRpcConsulHealthCheck.java
@@ -0,0 +1,40 @@
+package org.lognet.springboot.grpc.autoconfigure.consul;
+
+import com.ecwid.consul.v1.agent.model.NewService;
+import com.google.gson.annotations.SerializedName;
+import lombok.*;
+
+/**
+ * created by Yehor Kravchenko
+ * 04/02/2020 - 16:20
+ */
+@Getter
+@Setter
+@EqualsAndHashCode(callSuper = true)
+@ToString
+@Builder
+public class GRpcConsulHealthCheck extends NewService.Check {
+
+    /**
+     * Host address + port
+     */
+    @SerializedName("grpc")
+    private String socketAddr;
+
+    /**
+     * interval for health check polling
+     */
+    @Builder.Default
+    private String interval = "30s";
+
+    /**
+     * Is server used TLS
+     */
+    @SerializedName("grpc_use_tls")
+    private boolean grpcUseTlc;
+
+    /**
+     * timeout on healthcheck polling
+     */
+    private String timeout;
+}
diff --git a/grpc-spring-boot-starter/src/main/java/org/lognet/springboot/grpc/autoconfigure/consul/GrpcConsulRegistrar.java b/grpc-spring-boot-starter/src/main/java/org/lognet/springboot/grpc/autoconfigure/consul/GrpcConsulRegistrar.java
@@ -1,6 +1,7 @@
 package org.lognet.springboot.grpc.autoconfigure.consul;
 
 import com.ecwid.consul.v1.agent.model.NewService;
+import org.lognet.springboot.grpc.autoconfigure.GRpcServerProperties;
 import org.lognet.springboot.grpc.context.GRpcServerInitializedEvent;
 import org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties;
 import org.springframework.cloud.consul.serviceregistry.ConsulAutoRegistration;
@@ -10,6 +11,9 @@
 import org.springframework.context.SmartLifecycle;
 import org.springframework.context.event.EventListener;
 
+import java.util.Objects;
+import java.util.stream.Collectors;
+
 public class GrpcConsulRegistrar implements SmartLifecycle {
 
     private final ConsulServiceRegistry consulServiceRegistry;
@@ -30,30 +34,40 @@ private ConsulRegistration getRegistration(GRpcServerInitializedEvent event) {
         ApplicationContext applicationContext = event.getApplicationContext();
 
 
-        ConsulDiscoveryProperties properties = applicationContext.getBean(ConsulDiscoveryProperties.class);
+        ConsulDiscoveryProperties consulProperties = applicationContext.getBean(ConsulDiscoveryProperties.class);
+        GRpcServerProperties gRpcServerProperties = event.getApplicationContext().getBean(GRpcServerProperties.class);
 
         NewService grpcService = new NewService();
         grpcService.setPort(event.getServer().getPort());
-        if (!properties.isPreferAgentAddress()) {
-            grpcService.setAddress(properties.getHostname());
+        if (!consulProperties.isPreferAgentAddress()) {
+            grpcService.setAddress(consulProperties.getHostname());
         }
-        String appName = "grpc-" + ConsulAutoRegistration.getAppName(properties, applicationContext.getEnvironment());
+        String appName = "grpc-" + ConsulAutoRegistration.getAppName(consulProperties, applicationContext.getEnvironment());
         grpcService.setName(ConsulAutoRegistration.normalizeForDns(appName));
-        grpcService.setId("grpc-" + ConsulAutoRegistration.getInstanceId(properties, applicationContext));
-
-/*
-        service.setTags(createTags(properties));
-        setCheck(service, autoServiceRegistrationProperties, properties, context,
-                    heartbeatProperties);
+        grpcService.setId("grpc-" + ConsulAutoRegistration.getInstanceId(consulProperties, applicationContext));
+        grpcService.setTags(ConsulAutoRegistration.createTags(consulProperties)
+                .stream()
+                .filter(t->!t.startsWith("secure="))
+                .collect(Collectors.toList())
+        );
 
 
+        if(consulProperties.isRegisterHealthCheck()) {
+            GRpcConsulHealthCheck health = GRpcConsulHealthCheck.builder()
+                    .socketAddr(consulProperties.getHostname() + ":" + event.getServer().getPort())
+                    .grpcUseTlc(Objects.nonNull(gRpcServerProperties.getSecurity()))
+                    .interval(consulProperties.getHealthCheckInterval())
+                    .timeout(consulProperties.getHealthCheckTimeout())
+                    .build();
 
+            health.setDeregisterCriticalServiceAfter(consulProperties.getHealthCheckCriticalTimeout());
 
+            grpcService.setCheck(health);
+        }
 
-        */
 
 
-        return new ConsulRegistration(grpcService, properties);
+        return new ConsulRegistration(grpcService, consulProperties);
     }
 
 
diff --git a/grpc-spring-boot2-starter-demo/build.gradle b/grpc-spring-boot2-starter-demo/build.gradle
@@ -23,7 +23,8 @@ ext {
 }
 dependencies {
 
-    testCompile project(':grpc-spring-boot-starter-demo')
+
+    compile project(':grpc-spring-boot-starter-demo')
 
 	testCompile project(':grpc-spring-boot-starter-demo').sourceSets.test.output
 
@@ -36,8 +37,9 @@ dependencies {
     testRuntime('org.springframework.boot:spring-boot-starter-web')
 	
 	
-    testRuntime('org.springframework.cloud:spring-cloud-starter-consul-discovery')
-	testCompile 'com.pszymczyk.consul:embedded-consul:2.0.0'
+    testCompile('org.springframework.cloud:spring-cloud-starter-consul-discovery')
+    runtime('org.springframework.cloud:spring-cloud-starter-consul-discovery')
+	testCompile 'com.pszymczyk.consul:embedded-consul:2.1.4'
 
 	testCompile "org.springframework.cloud:spring-cloud-config-server:2.1.1.RELEASE"
 	testCompile "org.springframework.cloud:spring-cloud-config-client:2.1.1.RELEASE"
diff --git a/grpc-spring-boot2-starter-demo/src/main/java/org/lognet/springboot/grpc/demo/DemoApp.java b/grpc-spring-boot2-starter-demo/src/main/java/org/lognet/springboot/grpc/demo/DemoApp.java
@@ -0,0 +1,18 @@
+package org.lognet.springboot.grpc.demo;
+
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.core.env.AbstractEnvironment;
+
+/**
+ * Created by alexf on 28-Jan-16.
+ */
+@SpringBootApplication
+public class DemoApp {
+    public static void main(String[] args) {
+        System.setProperty(AbstractEnvironment.ACTIVE_PROFILES_PROPERTY_NAME,"app");
+        SpringApplication.run(DemoApp.class,args);
+    }
+
+}
diff --git a/grpc-spring-boot2-starter-demo/src/main/resources/application-app.properties b/grpc-spring-boot2-starter-demo/src/main/resources/application-app.properties
@@ -0,0 +1,5 @@
+spring.main.allow-bean-definition-overriding=true
+spring.jmx.enabled=false
+spring.cloud.consul.discovery.enabled=true
+spring.cloud.service-registry.auto-registration.enabled=true
+spring.application.name=Demo
diff --git a/grpc-spring-boot2-starter-demo/src/test/java/org/lognet/springboot/grpc/ConsulRegistrationTest.java b/grpc-spring-boot2-starter-demo/src/test/java/org/lognet/springboot/grpc/ConsulRegistrationTest.java
@@ -1,5 +1,9 @@
 package org.lognet.springboot.grpc;
 
+import com.ecwid.consul.v1.ConsulClient;
+import com.ecwid.consul.v1.QueryParams;
+import com.ecwid.consul.v1.health.model.Check;
+import com.ecwid.consul.v1.health.model.HealthService;
 import com.pszymczyk.consul.junit.ConsulResource;
 import io.grpc.ManagedChannel;
 import io.grpc.ManagedChannelBuilder;
@@ -18,11 +22,11 @@
 import org.springframework.test.context.junit4.SpringRunner;
 import org.springframework.util.SocketUtils;
 
+import java.time.Duration;
 import java.util.List;
 import java.util.concurrent.ExecutionException;
 
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.*;
 
 
 @RunWith(SpringRunner.class)
@@ -55,7 +59,11 @@ public  static void clear(){
 
     @Test
     public void contextLoads() throws ExecutionException, InterruptedException {
-        List<ServiceInstance> instances = discoveryClient.getInstances("grpc-grpc-demo");
+        final String serviceId = "grpc-grpc-demo";
+        final ConsulClient consulClient = new ConsulClient("localhost", Integer.parseInt(System.getProperty("spring.cloud.consul.port")));
+
+
+        List<ServiceInstance> instances = discoveryClient.getInstances(serviceId);
         assertFalse(instances.isEmpty());
 
         ServiceInstance serviceInstance = instances.get(0);
@@ -67,6 +75,21 @@ public void contextLoads() throws ExecutionException, InterruptedException {
         final GreeterOuterClass.HelloRequest helloRequest =GreeterOuterClass.HelloRequest.newBuilder().setName("Bob").build();
         final String reply = greeterFutureStub.sayHello(helloRequest).get().getMessage();
         assertNotNull("Replay should not be null",reply);
+
+        boolean isHealthy = false;
+        for(int i=0;i<5; ++i){
+            final List<HealthService> healthServices = consulClient.getHealthServices(serviceId, true, QueryParams.DEFAULT).getValue();
+            isHealthy =healthServices
+                    .stream()
+                    .flatMap(h->h.getChecks().stream())
+                    .anyMatch(c-> Check.CheckStatus.PASSING.equals(c.getStatus())&& c.getCheckId().contains(serviceId));
+            if(isHealthy){
+                break;
+            }else{
+                Thread.sleep(Duration.ofSeconds(10).toMillis());
+            }
+        }
+        assertTrue(isHealthy);
         applicationContext.stop();
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ buildscript {`
`2`	`2`	`ext {`
`3`	`3`	`springBoot_1_X_Version = '1.5.13.RELEASE'`
`4`	`4`	`springBoot_2_X_Version = '2.1.3.RELEASE'`
`5`		`- grpcVersion = '1.29.0'`
	`5`	`+ grpcVersion = '1.30.0'`
`6`	`6`	`}`
`7`	`7`	`repositories {`
`8`	`8`	`mavenCentral()`