Skip to content

Fix failsafe composition and update README #1872

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rameshmalla wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix failsafe composition and update README #1872

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
899f295
failsafe composition fix
rameshmalla Aug 30, 2026
305ff8b
Merge branch 'zalando:main' into main
rameshmalla Aug 30, 2026
bbaa151
Update readme
rameshmalla Aug 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions riptide-failsafe/src/main/java/org/zalando/riptide/failsafe/FailsafePlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ public FailsafePlugin withPolicy(final RequestPolicy policy) {
return new FailsafePlugin(policies.append(policy), decorators, executorService);
}

public FailsafePlugin withPolicies(final List<RequestPolicy> requestPolicies) {
return new FailsafePlugin(policies.concat(requestPolicies), decorators, executorService);
}

public FailsafePlugin withExecutor(@Nullable final ExecutorService executorService) {
if (executorService instanceof ThreadPoolExecutor
&& ((ThreadPoolExecutor) executorService).getCorePoolSize() == 1) {
Expand Down
75 changes: 27 additions & 48 deletions riptide-spring-boot-autoconfigure/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,12 @@ riptide.clients:
enabled: true
fixed-delay: 50 milliseconds
max-retries: 5
threads:
max-size: 10
min-size: 2
enabled: true
keep-alive: 5 minutes
queue-size: 10
circuit-breaker:
enabled: true
failure-threshold: 3 out of 5
delay: 30 seconds
success-threshold: 5 out of 5
failsafe:
threads:
max-size: 10
min-size: 2
Expand Down Expand Up @@ -298,36 +293,19 @@ riptide:
max-retries: 5
max-duration: 2 seconds
jitter: 25 milliseconds
threads:
max-size: 10
min-size: 2
enabled: true
keep-alive: 5 minutes
queue-size: 10
circuit-breaker:
enabled: true
failure-threshold: 3 out of 5
failure-rate-threshold: 3 out of 5 in 5 seconds
delay: 30 seconds
success-threshold: 5 out of 5
threads:
max-size: 10
min-size: 2
enabled: true
keep-alive: 5 minutes
queue-size: 10
backup-request:
enabled: true
delay: 75 milliseconds
threads:
max-size: 10
min-size: 2
enabled: true
keep-alive: 5 minutes
queue-size: 10
timeouts:
enabled: true
global: 500 milliseconds
failsafe:
threads:
max-size: 10
min-size: 2
Expand Down Expand Up @@ -413,6 +391,13 @@ For a complete overview of available properties, they type and default value ple
| `│   │   ├── max-per-route` | `int` | `20` |
| `│   │   ├── max-total` | `int` | `20` (or at least `max-per-route`); a warning is logged if the configured value is overridden |
| `│   │   └── mode` | `String` | `streaming` (alternative is `buffering`) |
| `│ ├── failsafe` | | shared thread pool for `retry`/`circuit-breaker`/`backup-request`/`timeouts`; see [custom executor](#customization) |
| `│ │ └── threads` | | |
| `│ │ ├── enabled` | `boolean` | `false` |
| `│ │ ├── min-size` | `int` | `1` |
| `│ │ ├── max-size` | `int` | `1` |
| `│ │ ├── keep-alive` | `TimeSpan` | `1 minute` |
| `│ │ └── queue-size` | `int` | `0` (no queue) |
| `│   ├── logging` | | |
| `│   │   └── enabled` | `boolean` | `false` |
| `│   ├── metrics` | | |
Expand Down Expand Up @@ -501,6 +486,13 @@ For a complete overview of available properties, they type and default value ple
| `        │   ├── time-to-live` | `TimeSpan` | see `defaults` |
| `        │   ├── max-per-route` | `int` | see `defaults` |
| `        │   └── max-total` | `int` | see `defaults` |
| ` ├── failsafe` | | shared thread pool for `retry`/`circuit-breaker`/`backup-request`/`timeouts` |
| ` │ └── threads` | | |
| ` │ ├── enabled` | `boolean` | see `defaults` |
| ` │ ├── min-size` | `int` | see `defaults` |
| ` │ ├── max-size` | `int` | see `defaults` |
| ` │ ├── keep-alive` | `TimeSpan` | see `defaults` |
| ` │ └── queue-size` | `int` | see `defaults` |
| `        ├── logging` | | |
| `        │   └── enabled` | `boolean` | see `defaults` |
| `        ├── metrics` | | |
Expand Down Expand Up @@ -636,7 +628,7 @@ public ClientHttpMessageConverters exampleHttpMessageConverters() {

The following code can be used if you cannot use your client name in the method name (e.g. your client name is `my-client`):
```java
@Bean(name = "my-clientCircuitBreakerExecutorService")
@Bean(name = "my-clientHttpMessageConverters")
public ClientHttpMessageConverters httpMessageConverters() {
return new ClientHttpMessageConverters(singletonList(new Jaxb2RootElementHttpMessageConverter()));
}
Expand Down Expand Up @@ -664,52 +656,39 @@ The following table shows all beans with their respective name (for the `example
| `exampleFaultClassifier` | `FaultClassifier` |
| `exampleCircuitBreakerListener` | `CircuitBreakerListener` |
| `exampleAuthorizationProvider` | `AuthorizationProvider` |
| `exampleRetryPolicyExecutorService` | `ExecutorService` |
| `exampleCircuitBreakerExecutorService` | `ExecutorService` |
| `exampleBackupRequestExecutorService` | `ExecutorService` |
| `exampleTimeoutExecutorService` | `ExecutorService` |
| `exampleFailsafeExecutorService` | `ExecutorService` (shared by retry/circuit-breaker/backup-request/timeouts, only if `failsafe.threads.enabled`) |

If you override a bean then all of its dependencies (see the [graph](#customization)), will **not** be registered,
unless required by some other bean.

Riptide uses Failsafe underneath to manage resiliency flows, and Failsafe supports custom thread pool executors. For more details, refer to the [riptide-failsafe](https://github.com/zalando/riptide/tree/main/riptide-failsafe#custom-executor) documentation. To configure a custom thread pool executor for retry, circuit breaker, backup requests, and timeout features, follow the configuration steps below.
Riptide uses Failsafe underneath to manage resiliency flows. `retry`, `circuit-breaker`, `backup-request` and
`timeouts` are merged into a single `FailsafePlugin` per client and share one thread pool executor, configured via
`failsafe.threads`. For more details, refer to the [riptide-failsafe](https://github.com/zalando/riptide/tree/main/riptide-failsafe#custom-executor) documentation.

> The previous per-policy `retry.threads`/`circuit-breaker.threads`/`backup-request.threads`/`timeouts.threads`
> settings are no longer supported. Configuring any of them now throws a `LegacyFailsafeThreadsException` at
> startup; migrate to `failsafe.threads` below.

```yaml
retry:
enabled: true
fixed-delay: 50 milliseconds
max-retries: 5
max-duration: 2 seconds
jitter: 25 milliseconds
threads:
max-size: 10
min-size: 2
enabled: true
keep-alive: 5 minutes
queue-size: 10
circuit-breaker:
enabled: true
failure-threshold: 3 out of 5
failure-rate-threshold: 3 out of 5 in 5 seconds
delay: 30 seconds
success-threshold: 5 out of 5
threads:
max-size: 10
min-size: 2
enabled: true
keep-alive: 5 minutes
queue-size: 10
backup-request:
enabled: true
delay: 75 milliseconds
threads:
max-size: 10
min-size: 2
enabled: true
keep-alive: 5 minutes
queue-size: 10
timeouts:
enabled: true
global: 500 milliseconds
failsafe:
threads:
max-size: 10
min-size: 2
Expand Down
Loading
Loading