Issue ReactiveX#607: The CircuitBreakerHealthIndicator and RateLimite…

…rHealthIn… (ReactiveX#615) * Issue ReactiveX#607: The CircuitBreakerHealthIndicator and RateLimiterHealthIndicator should be disabled by default. Otherwise the application health status is DOWN when a CircuitBreaker is open which is not what users want.
jihoonson · Sep 13, 2019 · f8f9d22 · f8f9d22
1 parent b8c4f71
commit f8f9d22
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 11 deletions.
diff --git a/...silience4j/common/circuitbreaker/configuration/CircuitBreakerConfigurationProperties.java b/...silience4j/common/circuitbreaker/configuration/CircuitBreakerConfigurationProperties.java
@@ -41,7 +41,11 @@ public class CircuitBreakerConfigurationProperties {
 	private Map<String, InstanceProperties> configs = new HashMap<>();
 
 	public Optional<InstanceProperties> findCircuitBreakerProperties(String name) {
-		return Optional.ofNullable(instances.get(name));
+		InstanceProperties instanceProperties = instances.get(name);
+		if(instanceProperties == null){
+			instanceProperties = configs.get("default");
+		}
+		return Optional.ofNullable(instanceProperties);
 	}
 
 	public CircuitBreakerConfig createCircuitBreakerConfig(InstanceProperties instanceProperties) {

diff --git a/...hub/resilience4j/common/ratelimiter/configuration/RateLimiterConfigurationProperties.java b/...hub/resilience4j/common/ratelimiter/configuration/RateLimiterConfigurationProperties.java
@@ -33,7 +33,11 @@ public class RateLimiterConfigurationProperties {
 	private Map<String, InstanceProperties> configs = new HashMap<>();
 
 	public Optional<InstanceProperties> findRateLimiterProperties(String name) {
-		return Optional.ofNullable(instances.get(name));
+		InstanceProperties instanceProperties = instances.get(name);
+		if(instanceProperties == null){
+			instanceProperties = configs.get("default");
+		}
+		return Optional.ofNullable(instanceProperties);
 	}
 
 	public RateLimiterConfig createRateLimiterConfig(@Nullable InstanceProperties instanceProperties) {

diff --git a/.../github/resilience4j/circuitbreaker/monitoring/health/CircuitBreakersHealthIndicator.java b/.../github/resilience4j/circuitbreaker/monitoring/health/CircuitBreakersHealthIndicator.java
@@ -65,8 +65,8 @@ public Health health() {
 
     private boolean isRegisterHealthIndicator(CircuitBreaker circuitBreaker) {
         return circuitBreakerProperties.findCircuitBreakerProperties(circuitBreaker.getName())
-                .map(io.github.resilience4j.common.circuitbreaker.configuration.CircuitBreakerConfigurationProperties.InstanceProperties::getRegisterHealthIndicator)
-                .orElse(true);
+                .map(CircuitBreakerConfigurationProperties.InstanceProperties::getRegisterHealthIndicator)
+                .orElse(false);
     }
 
     private static Health mapBackendMonitorState(CircuitBreaker circuitBreaker) {

diff --git a/...ava/io/github/resilience4j/ratelimiter/monitoring/health/RateLimitersHealthIndicator.java b/...ava/io/github/resilience4j/ratelimiter/monitoring/health/RateLimitersHealthIndicator.java
@@ -52,8 +52,8 @@ public Health health() {
 
     private boolean isRegisterHealthIndicator(RateLimiter rateLimiter) {
         return rateLimiterProperties.findRateLimiterProperties(rateLimiter.getName())
-                .map(io.github.resilience4j.common.ratelimiter.configuration.RateLimiterConfigurationProperties.InstanceProperties::getRegisterHealthIndicator)
-                .orElse(true);
+                .map(RateLimiterConfigurationProperties.InstanceProperties::getRegisterHealthIndicator)
+                .orElse(false);
     }
 
     private Health mapRateLimiterHealth(RateLimiter rateLimiter) {

diff --git a/...hub/resilience4j/circuitbreaker/monitoring/health/CircuitBreakersHealthIndicatorTest.java b/...hub/resilience4j/circuitbreaker/monitoring/health/CircuitBreakersHealthIndicatorTest.java
@@ -33,8 +33,8 @@ public void healthMetricsAndConfig() {
         CircuitBreakerRegistry registry = mock(CircuitBreakerRegistry.class);
         CircuitBreaker.Metrics metrics = mock(CircuitBreaker.Metrics.class);
         CircuitBreaker circuitBreaker = mock(CircuitBreaker.class);
-        io.github.resilience4j.common.circuitbreaker.configuration.CircuitBreakerConfigurationProperties.InstanceProperties instanceProperties =
-                mock(io.github.resilience4j.common.circuitbreaker.configuration.CircuitBreakerConfigurationProperties.InstanceProperties.class);
+        CircuitBreakerConfigurationProperties.InstanceProperties instanceProperties =
+                mock(CircuitBreakerConfigurationProperties.InstanceProperties.class);
         CircuitBreakerConfigurationProperties circuitBreakerProperties = mock(CircuitBreakerConfigurationProperties.class);
         HealthAggregator healthAggregator = new OrderedHealthAggregator();
         CircuitBreakersHealthIndicator healthIndicator =
@@ -86,8 +86,8 @@ public void testHealthStatus() {
         expectedStateToCircuitBreaker.put(OPEN, openCircuitBreaker);
         expectedStateToCircuitBreaker.put(HALF_OPEN, halfOpenCircuitBreaker);
         expectedStateToCircuitBreaker.put(CLOSED, closeCircuitBreaker);
-        io.github.resilience4j.common.circuitbreaker.configuration.CircuitBreakerConfigurationProperties.InstanceProperties instanceProperties =
-                mock(io.github.resilience4j.common.circuitbreaker.configuration.CircuitBreakerConfigurationProperties.InstanceProperties.class);
+        CircuitBreakerConfigurationProperties.InstanceProperties instanceProperties =
+                mock(CircuitBreakerConfigurationProperties.InstanceProperties.class);
         CircuitBreakerConfigurationProperties circuitBreakerProperties = mock(CircuitBreakerConfigurationProperties.class);
 
         // given
@@ -126,7 +126,7 @@ private void setCircuitBreakerWhen(CircuitBreaker.State givenState, CircuitBreak
         when(circuitBreaker.getState()).thenReturn(givenState);
         when(circuitBreaker.getCircuitBreakerConfig()).thenReturn(config);
         when(circuitBreaker.getMetrics()).thenReturn(metrics);
-        when(circuitBreakerProperties.findCircuitBreakerProperties("test")).thenReturn(Optional.of(instanceProperties));
+        when(circuitBreakerProperties.findCircuitBreakerProperties(givenState.name())).thenReturn(Optional.of(instanceProperties));
         when(instanceProperties.getRegisterHealthIndicator()).thenReturn(true);
     }
 

diff --git a/resilience4j-spring-boot2/src/test/resources/application.yaml b/resilience4j-spring-boot2/src/test/resources/application.yaml
@@ -39,6 +39,7 @@ resilience4j.circuitbreaker:
       registerHealthIndicator: true
   backends:
     backendA:
+      registerHealthIndicator: true
       slidingWindowSize: 6
       permittedNumberOfCallsInHalfOpenState: 2
       waitDurationInOpenState: 5s