SpringCloud/spring-cloud-commons
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Skip health check if null or empty (#1011)

Browse Source 
Fixes gh-1005
This commit is contained in:
Robert McNees
2021-09-16 14:06:48 -04:00
committed by GitHub
parent 38aa3acaca
commit 03fd58cd53
3 changed files with 41 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/src/main/asciidoc/spring-cloud-commons.adoc
View File

@@ -977,7 +977,7 @@ TIP: The `HealthCheckServiceInstanceListSupplier` relies on having updated insta
`HealthCheckServiceInstanceListSupplier` uses properties prefixed with
`spring.cloud.loadbalancer.health-check`. You can set the `initialDelay` and `interval`
for the scheduler. You can set the default path for the healthcheck URL by setting
the value of the `spring.cloud.loadbalancer.health-check.path.default` property. You can also set a specific value for any given service by setting the value of the `spring.cloud.loadbalancer.health-check.path.[SERVICE_ID]` property, substituting `[SERVICE_ID]` with the correct ID of your service. If the path is not set, `/actuator/health` is used by default.
the value of the `spring.cloud.loadbalancer.health-check.path.default` property. You can also set a specific value for any given service by setting the value of the `spring.cloud.loadbalancer.health-check.path.[SERVICE_ID]` property, substituting `[SERVICE_ID]` with the correct ID of your service. If the `[SERVICE_ID]` is not specified, `/actuator/health` is used by default. If the `[SERVICE_ID]` is set to `null` or empty as a value, then the health check will not be executed.
TIP: If you rely on the default path (`/actuator/health`), make sure you add `spring-boot-starter-actuator` to your collaborator's dependencies, unless you are planning to add such an endpoint on your own.

5
spring-cloud-loadbalancer/src/main/java/org/springframework/cloud/loadbalancer/core/HealthCheckServiceInstanceListSupplier.java
View File

@@ -32,6 +32,7 @@ import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.loadbalancer.LoadBalancerProperties;
import org.springframework.util.StringUtils;
/**
* A {@link ServiceInstanceListSupplier} implementation that verifies whether the
@@ -126,7 +127,11 @@ public class HealthCheckServiceInstanceListSupplier extends DelegatingServiceIns
}
protected Mono<Boolean> isAlive(ServiceInstance serviceInstance) {
boolean containsService = healthCheck.getPath().containsKey(serviceInstance.getServiceId());
String healthCheckPropertyValue = healthCheck.getPath().get(serviceInstance.getServiceId());
if (containsService && !StringUtils.hasText(healthCheckPropertyValue)) {
return Mono.just(true);
}
String healthCheckPath = healthCheckPropertyValue != null ? healthCheckPropertyValue : defaultHealthCheckPath;
return aliveFunction.apply(serviceInstance, healthCheckPath);
}

35
spring-cloud-loadbalancer/src/test/java/org/springframework/cloud/loadbalancer/core/HealthCheckServiceInstanceListSupplierTests.java
View File

@@ -52,7 +52,10 @@ import org.springframework.web.client.RestTemplate;
import org.springframework.web.reactive.function.client.WebClient;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.springframework.cloud.loadbalancer.core.ServiceInstanceListSuppliersTestUtils.healthCheckFunction;
@@ -113,6 +116,38 @@ class HealthCheckServiceInstanceListSupplierTests {
assertThat(alive).isTrue();
}
@Test
void shouldNotCheckInstanceWithNullHealthCheckPath() {
BiFunction<ServiceInstance, String, Mono<Boolean>> mockAliveFunction = mock(BiFunction.class);
String serviceId = "no-health-check-service";
healthCheck.getPath().put("no-health-check-service", null);
ServiceInstance serviceInstance = new DefaultServiceInstance("no-health-check-service-1", serviceId,
"127.0.0.1", port, false);
listSupplier = new HealthCheckServiceInstanceListSupplier(
ServiceInstanceListSuppliers.from(serviceId, serviceInstance), healthCheck, mockAliveFunction);
boolean alive = listSupplier.isAlive(serviceInstance).block();
verify(mockAliveFunction, never()).apply(any(), any());
assertThat(alive).isTrue();
}
@Test
void shouldNotCheckInstanceWithEmptyHealthCheckPath() {
BiFunction<ServiceInstance, String, Mono<Boolean>> mockAliveFunction = mock(BiFunction.class);
String serviceId = "no-health-check-service";
healthCheck.getPath().put("no-health-check-service", "");
ServiceInstance serviceInstance = new DefaultServiceInstance("no-health-check-service-1", serviceId,
"127.0.0.1", port, false);
listSupplier = new HealthCheckServiceInstanceListSupplier(
ServiceInstanceListSuppliers.from(serviceId, serviceInstance), healthCheck, mockAliveFunction);
boolean alive = listSupplier.isAlive(serviceInstance).block();
verify(mockAliveFunction, never()).apply(any(), any());
assertThat(alive).isTrue();
}
@SuppressWarnings("ConstantConditions")
@Test
void shouldCheckInstanceWithProvidedHealthCheckPathWithRestTemplate() {