From 76911023e852efc2c456b5e13645dcb6d2770618 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Skowro=C5=84ski?= <5780288+hexmind@users.noreply.github.com> Date: Fri, 7 Feb 2020 13:59:09 +0100 Subject: [PATCH] Text files updated (#853) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- CONTRIBUTING.adoc | 1 + ISSUE_TEMPLATE | 8 +++----- README.adoc | 49 +++++++++++------------------------------------ 3 files changed, 15 insertions(+), 43 deletions(-) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 09923ade70..fab61fc206 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -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. diff --git a/ISSUE_TEMPLATE b/ISSUE_TEMPLATE index ccb8614b8f..104b502a91 100644 --- a/ISSUE_TEMPLATE +++ b/ISSUE_TEMPLATE @@ -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. \ No newline at end of file diff --git a/README.adoc b/README.adoc index f62dc3f42d..c22bd33457 100644 --- a/README.adoc +++ b/README.adoc @@ -53,13 +53,13 @@ Bulkhead bulkhead = Bulkhead.ofDefaults("backendService"); Supplier 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 decoratedSupplier = Decorators.ofSupplier(supplier) .withCircuitBreaker(circuitBreaker) .withBulkhead(bulkhead) - .withRetry(retry) + .withRetry(retry) .decorate(); // Execute the decorated supplier and recover from any exception @@ -83,7 +83,7 @@ CompletableFuture 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(); ---- @@ -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 @@ -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 @@ -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] @@ -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.