Fixing documentation

spring-cloud · Nov 30, 2023 · 10f2896 · 10f2896
1 parent 8944e6f
commit 10f2896
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/...cloud-circuitbreaker-resilience4j/circuit-breaker-properties-configuration.adoc b/...cloud-circuitbreaker-resilience4j/circuit-breaker-properties-configuration.adoc
@@ -84,3 +84,21 @@ resilience4j.timelimiter:
 
 For more information on Resilience4j property configuration, see https://resilience4j.readme.io/docs/getting-started-3#configuration[Resilience4J Spring Boot 2 Configuration].
 
+== Disabling the TimeLimiter
+
+By default, the `TimeLimiter` is enabled and every execution is backed by a time limit. This time limit is either defined explicitly or the default time limit (provided by `io.github.resilience4j.timelimiter.TimeLimiterConfig#ofDefaults`) is used.
+
+The `TimeLimiter` can be globally disabled by setting the property `spring.cloud.circuitbreaker.resilience4j.disable-time-limiter` to `true`.
+
+[source,yaml]
+----
+spring:
+	cloud:
+		circuitbreaker:
+			resilience4j:
+				disable-time-limiter: true
+----
+
+This type of option is only provided on a global scope within the `spring-cloud-circuitbreaker` and applies to the
+basic and to the reactive circuitbreaker implementation.
+