From 10f28966ab647fad1fe14998313e4ffe3b0bb736 Mon Sep 17 00:00:00 2001 From: Ryan Baxter <524254+ryanjbaxter@users.noreply.github.com> Date: Thu, 30 Nov 2023 14:56:58 -0500 Subject: [PATCH] Fixing documentation --- ...rcuit-breaker-properties-configuration.adoc | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/modules/ROOT/pages/spring-cloud-circuitbreaker-resilience4j/circuit-breaker-properties-configuration.adoc b/docs/modules/ROOT/pages/spring-cloud-circuitbreaker-resilience4j/circuit-breaker-properties-configuration.adoc index c440d7f9..dffd7d9a 100644 --- a/docs/modules/ROOT/pages/spring-cloud-circuitbreaker-resilience4j/circuit-breaker-properties-configuration.adoc +++ b/docs/modules/ROOT/pages/spring-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. +