diff --git a/docs/modules/ROOT/pages/spring-cloud-circuitbreaker-resilience4j.adoc b/docs/modules/ROOT/pages/spring-cloud-circuitbreaker-resilience4j.adoc index 95d0711..94c6410 100644 --- a/docs/modules/ROOT/pages/spring-cloud-circuitbreaker-resilience4j.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-circuitbreaker-resilience4j.adoc @@ -1,5 +1,7 @@ +[[configuring-resilience4j-circuit-breakers]] === Configuring Resilience4J Circuit Breakers +[[starters]] ==== Starters There are two starters for the Resilience4J implementations, one for reactive applications and one for non-reactive applications. @@ -7,10 +9,12 @@ There are two starters for the Resilience4J implementations, one for reactive ap * `org.springframework.cloud:spring-cloud-starter-circuitbreaker-resilience4j` - non-reactive applications * `org.springframework.cloud:spring-cloud-starter-circuitbreaker-reactor-resilience4j` - reactive applications +[[auto-configuration]] ==== Auto-Configuration You can disable the Resilience4J auto-configuration by setting `spring.cloud.circuitbreaker.resilience4j.enabled` to `false`. +[[default-configuration]] ==== Default Configuration To provide a default configuration for all of your circuit breakers create a `Customizer` bean that is passed a @@ -30,6 +34,7 @@ public Customizer defaultCustomizer() { ---- ==== +[[reactive-example]] ===== Reactive Example ==== @@ -44,6 +49,7 @@ public Customizer defaultCustomizer() ---- ==== +[[customizing-the-executorservice]] ===== Customizing The ExecutorService If you would like to configure the `ExecutorService` which executes the circuit breaker you can do so using the `Resilience4JCircuitBreakerFactory`. @@ -63,6 +69,7 @@ public Customizer defaultCustomizer() ---- ==== +[[specific-circuit-breaker-configuration]] ==== Specific Circuit Breaker Configuration Similarly to providing a default configuration, you can create a `Customizer` bean this is passed a @@ -95,6 +102,7 @@ public Customizer slowCustomizer() { ---- ==== +[[reactive-example]] ===== Reactive Example ==== @@ -113,6 +121,7 @@ public Customizer slowCustomizer() { ---- ==== +[[circuit-breaker-properties-configuration]] ==== Circuit Breaker Properties Configuration You can configure `CircuitBreaker` and `TimeLimiter` configs or instances in your application's configuration properties file. @@ -132,6 +141,7 @@ Resilience4JCircuitBreakerFactory.create(String id, String groupName) ---- ==== +[[global-default-properties-configuration]] ===== Global Default Properties Configuration ==== [source] @@ -150,6 +160,7 @@ resilience4j.timelimiter: ---- ==== +[[configs-properties-configuration]] ===== Configs Properties Configuration ==== [source] @@ -168,6 +179,7 @@ resilience4j.timelimiter: ---- ==== +[[instances-properties-configuration]] ===== Instances Properties Configuration ==== [source] @@ -203,6 +215,7 @@ resilience4j.timelimiter: For more information on Resilience4j property configuration, see https://resilience4j.readme.io/docs/getting-started-3#configuration[Resilience4J Spring Boot 2 Configuration]. +[[bulkhead-pattern-supporting]] ==== Bulkhead pattern supporting If `resilience4j-bulkhead` is on the classpath, Spring Cloud CircuitBreaker will wrap all methods with a Resilience4j Bulkhead. You can disable the Resilience4j Bulkhead by setting `spring.cloud.circuitbreaker.bulkhead.resilience4j.enabled` to `false`. @@ -233,6 +246,7 @@ public Customizer defaultBulkheadCustomizer() { ---- ==== +[[specific-bulkhead-configuration]] ==== Specific Bulkhead Configuration Similarly to proving a default 'Bulkhead' or 'ThreadPoolBulkhead' configuration, you can create a `Customizer` bean this @@ -254,6 +268,7 @@ In addition to configuring the Bulkhead that is created you can also customize t have been created but before they are returned to caller. To do this you can use the `addBulkheadCustomizer` and `addThreadPoolBulkheadCustomizer` methods. +[[bulkhead-example]] ===== Bulkhead Example ==== @@ -268,6 +283,7 @@ public Customizer customizer() { ---- ==== +[[thread-pool-bulkhead-example]] ===== Thread Pool Bulkhead Example ==== @@ -282,6 +298,7 @@ public Customizer slowThreadPoolBulkheadCustomizer ---- ==== +[[bulkhead-properties-configuration]] ==== Bulkhead Properties Configuration You can configure ThreadPoolBulkhead and SemaphoreBulkhead instances in your application's configuration properties file. @@ -304,6 +321,7 @@ resilience4j.bulkhead: For more inforamtion on the Resilience4j property configuration, see https://resilience4j.readme.io/docs/getting-started-3#configuration[Resilience4J Spring Boot 2 Configuration]. +[[collecting-metrics]] ==== Collecting Metrics Spring Cloud Circuit Breaker Resilience4j includes auto-configuration to setup metrics collection as long as the right diff --git a/docs/modules/ROOT/pages/spring-cloud-circuitbreaker-spring-retry.adoc b/docs/modules/ROOT/pages/spring-cloud-circuitbreaker-spring-retry.adoc index 8ecea14..863880f 100644 --- a/docs/modules/ROOT/pages/spring-cloud-circuitbreaker-spring-retry.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-circuitbreaker-spring-retry.adoc @@ -1,3 +1,4 @@ +[[configuring-spring-retry-circuit-breakers]] === Configuring Spring Retry Circuit Breakers Spring Retry provides declarative retry support for Spring applications. @@ -9,6 +10,7 @@ All circuit breakers created using Spring Retry will be created using the `Circu https://github.com/spring-projects/spring-retry/blob/master/src/main/java/org/springframework/retry/support/DefaultRetryState.java[`DefaultRetryState`]. Both of these classes can be configured using `SpringRetryConfigBuilder`. +[[default-configuration]] ==== Default Configuration To provide a default configuration for all of your circuit breakers create a `Customizer` bean that is passed a @@ -26,6 +28,7 @@ public Customizer defaultCustomizer() { ---- ==== +[[specific-circuit-breaker-configuration]] ==== Specific Circuit Breaker Configuration Similarly to providing a default configuration, you can create a `Customizer` bean this is passed a diff --git a/docs/modules/ROOT/pages/spring-cloud-circuitbreaker.adoc b/docs/modules/ROOT/pages/spring-cloud-circuitbreaker.adoc index 94fe02a..e78c25e 100755 --- a/docs/modules/ROOT/pages/spring-cloud-circuitbreaker.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-circuitbreaker.adoc @@ -1,3 +1,4 @@ +[[spring-cloud-circuit-breaker]] = Spring Cloud Circuit Breaker include::_attributes.adoc[] @@ -13,10 +14,12 @@ include::spring-cloud-circuitbreaker-resilience4j.adoc[] include::spring-cloud-circuitbreaker-spring-retry.adoc[] +[[building]] == Building include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/modules/ROOT/partials/building.adoc[] +[[contributing]] == Contributing include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/modules/ROOT/partials/contributing.adoc[]