Skip to content

Commit

Permalink
Text files updated (ReactiveX#853)
Browse files Browse the repository at this point in the history
README.adoc:
spaces removed
modules list simplified (duplication of User Guide)
wrong link to **Hystrix** vs Istio by Nicolas Fränkel replaced
Copyright updated

CONTRIBUTING.adoc
code formatting comment added

ISSUE_TEMPLATE
reordered and simplified
  • Loading branch information
hexmind committed Feb 7, 2020
1 parent b1d6cf5 commit 7691102
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 43 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Use link:ISSUE_TEMPLATE[ISSUE_TEMPLATE] to provide required details.

* Use a clear and descriptive title for the issue to identify the problem.
* Explain which behavior you expected to see instead and why.
* Format your logs, configuration or code snippets in a proper way.

We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it.
Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions.
Expand Down
8 changes: 3 additions & 5 deletions ISSUE_TEMPLATE
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
Thanks for raising a Resilience4j issue.
Please provide a brief description of your problem along with the versions you are using.
If possible, please also consider putting together a complete JUnit test that reproduces the issue.

Resilience4j version:

Java version:

Problem description:
Thanks for raising a Resilience4j issue.
Please replace this text with a brief description of your problem along with the versions you are using.
If possible, please also consider putting together a complete JUnit test that reproduces the issue.
49 changes: 11 additions & 38 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,13 @@ Bulkhead bulkhead = Bulkhead.ofDefaults("backendService");
Supplier<String> supplier = () -> backendService
.doSomething(param1, param2);
// Decorate your call to backendService.doSomething()
// Decorate your call to backendService.doSomething()
// with a Bulkhead, CircuitBreaker and Retry
// **note: you will need the resilience4j-all dependency for this
Supplier<String> decoratedSupplier = Decorators.ofSupplier(supplier)
.withCircuitBreaker(circuitBreaker)
.withBulkhead(bulkhead)
.withRetry(retry)
.withRetry(retry)
.decorate();
// Execute the decorated supplier and recover from any exception
Expand All @@ -83,7 +83,7 @@ CompletableFuture<String> future = Decorators.ofSupplier(supplier)
.withThreadPoolBulkhead(threadPoolBulkhead)
.withTimeLimiter(timeLimiter, scheduledExecutorService)
.withCircuitBreaker(circuitBreaker)
.withFallback(asList(TimeoutException.class, CallNotPermittedException.class, BulkheadFullException.class),
.withFallback(asList(TimeoutException.class, CallNotPermittedException.class, BulkheadFullException.class),
throwable -> "Hello from Recovery")
.get().toCompletableFuture();
----
Expand All @@ -99,13 +99,7 @@ Setup and usage is described in our *https://resilience4j.readme.io/docs[User Gu

== Overview

Resilience4j provides several core modules and add-on modules:

=== All core modules and the Decorators class

* resilience4j-all

=== Core modules
Resilience4j provides several core modules:

* resilience4j-circuitbreaker: Circuit breaking
* resilience4j-ratelimiter: Rate limiting
Expand All @@ -114,32 +108,11 @@ Resilience4j provides several core modules and add-on modules:
* resilience4j-timelimiter: Timeout handling
* resilience4j-cache: Result caching

=== Add-on modules

* resilience4j-retrofit: Retrofit adapter
* resilience4j-feign: Feign adapter
* resilience4j-consumer: Circular Buffer Event consumer
* resilience4j-kotlin: Kotlin coroutines support

==== Frameworks modules

* resilience4j-spring-boot: Spring Boot Starter
* resilience4j-spring-boot2: Spring Boot 2 Starter
* resilience4j-spring-boot-cloud: Spring Cloud Config Server
* resilience4j-spring-boot-cloud2: Spring Cloud 2 Config Server
* resilience4j-ratpack: Ratpack Starter
* resilience4j-vertx: Vertx Future decorator

==== Reactive modules

* resilience4j-rxjava2: Custom RxJava2 operators
* resilience4j-reactor: Custom Spring Reactor operators
There are also add-on modules for metrics, Retrofit, Feign, Kotlin, Spring, Ratpack, Vertx, RxJava2 and more.

==== Metrics modules
NOTE: Find out full list of modules in our *https://resilience4j.readme.io/docs#section-modularization[User Guide]*.

* resilience4j-micrometer: Micrometer Metrics exporter
* resilience4j-metrics: Dropwizard Metrics exporter
* resilience4j-prometheus: Prometheus Metrics exporter
TIP: For core modules package or `Decorators` builder see *https://mvnrepository.com/artifact/io.github.resilience4j/resilience4j-all[resilience4j-all]*.

== Resilience patterns

Expand Down Expand Up @@ -391,10 +364,10 @@ Find out more in our *https://resilience4j.readme.io/[User Guide]*.
[cols="4*"]
|===

|0:37
|https://www.youtube.com/watch?v=YXP6RKdQkz0[Battle of the Circuit Breakers: Resilience4J vs Istio]
|0:33
|https://www.youtube.com/watch?v=AwcjOhD91Q0[Battle of the Circuit Breakers: Istio vs. Hystrix/Resilience4J]
|Nicolas Frankel
|GOTO Berlin
|JFuture

|0:42
|https://www.youtube.com/watch?v=KosSsZEqS-k&t=157[Resilience patterns in the post-Hystrix world]
Expand Down Expand Up @@ -425,7 +398,7 @@ Find out more in our *https://resilience4j.readme.io/[User Guide]*.

== License

Copyright 2019 Robert Winkler, Bohdan Storozhuk, Mahmoud Romeh and Dan Maas
Copyright 2020 Robert Winkler, Bohdan Storozhuk, Mahmoud Romeh, Dan Maas and others

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down

0 comments on commit 7691102

Please sign in to comment.