Skip to content

Commit

Permalink
Add Resilience4j documentation
Browse files Browse the repository at this point in the history
The documentation used to describe how to use Hystrix with Vert.x.
Since Hystrix has been obsolete for a long time and the documentation
was removed in a recent commit, this commit adds a modern replacement:
Resilience4j. The documentation mainly links to the Resilience4j
Vert.x how-to that was published recently.
  • Loading branch information
Ladicek committed Sep 5, 2023
1 parent bba9e76 commit 50ffaf4
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions src/main/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -185,3 +185,19 @@ operation has a chance of succeeding, so it goes into the `half-open` state. In
circuit breaker is allowed to execute the guarded operation. Should the call succeed, the circuit breaker resets
and returns to the `closed` state, ready for more routine operation. If this trial call fails, however, the circuit
breaker returns to the `open` state until another timeout elapses.

== Using Resilience4j

link:https://resilience4j.readme.io/[Resilience4j] is a popular library that implements common fault tolerance strategies:

* bulkhead (concurrency limiter)
* circuit breaker
* rate limiter
* retry
* time limiter (timeout)

A link:https://how-to.vertx.io/resilience4j-howto/[how-to] has been published that demonstrates the usage of Resilience4j with Vert.x.
The link:https://github.com/vertx-howtos/resilience4j-howto[repository] of that how-to contains Vert.x adapters for all the fault tolerance strategies listed above.
These adapters glue together the Resilience4j API and Vert.x ``Future``s.

WARNING: Resilience4j 2.0 requires Java 17.

0 comments on commit 50ffaf4

Please sign in to comment.