Introduction to Resilience4j #jsug

11.1K Views

May 26, 22

#java #spring #microservices #Resilience4j #サーキットブレイカー #マイクロサービス #Spring Boot #Spring Cloud

スライド概要

2020年4月 #jsug 勉強会での資料です。Netflix Hystrixの代替となるサーキットブレイカーライブラリResilience4jおよびSpring Bootでの利用方法の解説です。

tada

@MasatoshiTada

スライド一覧

Java、Spring、IntelliJ IDEA

またはPlayer版

埋め込む »CMSなどでJSが使えない場合

ダウンロード

ダウンロード(pdf - 1.66MB)

関連スライド

詳解Springトランザクション -初級から上級まで- #jsug

java spring spring-boot

tada 304.5K

Java ORマッパー選定のポイント #jsug

java spring

tada 250K

プロになるためのSpring上級知識 #jsug

java spring

tada 215.1K

今こそ知りたいSpring DI x AOP #jsug

java spring

tada 165.5K

基礎からのOAuth 2.0とSpring Security 5.1による実装 #jsug

java spring oauth2

tada 145.1K

各ページのテキスト

https://github.com/resilience4j-docs-ja/resilience4j-docs-ja

質問はTwitterで #jsug このセッションの目的 ▸ Resilience4jドキュメントを読んで困らないように、背景や仕組みを理解する！ ▸ 今回はSpring Bootでのコード例などは少なめ（ドキュメントに沢山あるので） ▸ サンプルコード ▸ https://github.com/MasatoshiTada/resilience4jspring-boot-sample (C) CASAREAL, Inc. All rights reserved. 4

https://github.com/MasatoshiTada/resilience4j-spring-boot-sample

質問はTwitterで #jsug マイクロサービスは考えることがいっぱい 😇 Design for Failure API Gateway Observability Circuit Breaker Distributed Tracing Polyglot Persistence Orchestration Service Discovery Containerization (C) CASAREAL, Inc. All rights reserved. 7

質問はTwitterで #jsug [豆知識]Spring Cloudのバージョン ▸ 英国ロンドン市内の街の名前が付いている Spring Cloud Angel Brixton Camden Dalston Edgware Finchley Greenwich Hoxton 対応するSpring Bootのバージョン ??? ??? ??? ??? 1.5 2.0 2.1 2.2 ←今ココ (C) CASAREAL, Inc. All rights reserved. 9

10.

質問はTwitterで #jsug Netﬂix OSS ▸ Netﬂix社はマイクロサービスに必要なライブラリを、オリジナルのOSSとして作っている ▸ Hystrix (サーキットブレイカー) ▸ Ribbon (ロードバランシング) ▸ Eureka (サービスディスカバリー) ▸ Zuul (APIゲートウェイ) ▸ ・・・ (C) CASAREAL, Inc. All rights reserved. 10

11.

質問はTwitterで #jsug Spring Cloud Netﬂix ▸ SpringとNetﬂix OSSを連携させるライブラリ ▸ spring-cloud-starter-netﬂix-hystrix ▸ spring-cloud-starter-netﬂix-ribbon ▸ spring-cloud-starter-netﬂix-eureka-server ▸ spring-cloud-starter-netﬂix-zuul ▸ ・・・ ▸ 数年前はSpring Cloudの代名詞的存在だった (C) CASAREAL, Inc. All rights reserved. 11

12.

https://github.com/Netflix/Hystrix

13.

https://www.youtube.com/watch?v=mln3_o6qlBo

14.

質問はTwitterで #jsug Spring Cloud Netﬂixも大半が保守モードへ ▸ spring-cloud-netﬂix-hystrix ※eurekaは対象外 ▸ spring-cloud-netﬂix-hystrix-contract ▸ spring-cloud-netﬂix-hystrix-dashboard ▸ spring-cloud-netﬂix-hystrix-stream ▸ spring-cloud-netﬂix-ribbon ▸ spring-cloud-netﬂix-zuul ▸ spring-cloud-netﬂix-turbine ▸ spring-cloud-netﬂix-turbine-stream ▸ spring-cloud-netﬂix-archaius https://spring.io/blog/2019/01/23/spring-cloud-greenwich-release-is-now-available より (C) CASAREAL, Inc. All rights reserved. 14

https://spring.io/blog/2019/01/23/spring-cloud-greenwich-release-is-now-available

15.

質問はTwitterで #jsug Spring Cloud Netﬂixの代替(あくまで一例) ▸ Hystrix → Resilience4j ▸ Eureka → Spring Cloud Consul ▸ Zuul → Spring Cloud Gateway ▸ Ribbon → Spring Cloud LoadBalancer ▸ Archius → Spring Cloud Conﬁg ▸ Turbine → Micrometer + Prometheus ※繰り返しになりますが、Zuul・Eurekaおよびspring-cloud-netflix-eurekaの開発は継続しています (C) CASAREAL, Inc. All rights reserved. 15

16.

質問はTwitterで #jsug Resilience4jとは ▸ Hystrixに代わるサーキットブレイカーライブラリ ▸ 関数型プログラミングモデルが特徴 ▸ 作者はRobert Winkler氏 (@rbrtwnklr) ▸ SpringやNetﬂixとは独立したプロジェクトだが ▸ HystrixのREADMEには「代わりにResilience4jをオススメするよ！」と書いてある ▸ Spring Bootとの連携機能を提供している (C) CASAREAL, Inc. All rights reserved. 16

17.

18.

質問はTwitterで #jsug アドオンモジュール ▸ Spring Boot 2 Starter ▸ Custom RxJava2 operators ▸ Retroﬁt adapter ▸ Custom Spring Reactor operators ▸ Feign adapter ▸ Micrometer Metrics exporter ▸ Circular Buﬀer Event consumer ▸ Dropwizard Metrics exporter ▸ Kotlin coroutines support ▸ Camel Circuit Breaker ▸ Ratpack Starter ▸ Spring Cloud Circuit Breaker ▸ Vertx Future decorator ▸ http4k resilience module ▸ Prometheus Metrics exporter (C) CASAREAL, Inc. All rights reserved. 18

19.

20.

質問はTwitterで #jsug こんなコード // 設定の作成 CircuitBreakerConfig config = CircuitBreakerConfig.ofDefaults(); // Registryの作成 CircuitBreakerRegistry registry = CircuitBreakerRegistry.of(config); // サーキットブレイカーの作成 CircuitBreaker cb = registry.circuitBreaker("backendB"); (C) CASAREAL, Inc. All rights reserved. 20

21.

[beta]

質問はTwitterで #jsug

こんなコード
// バックエンド呼び出しをデコレート
Supplier<String> ds = cb.decorateSupplier(
() -> backendBService.doSomething());
// 呼び出し実行
Try<String> result = Try.ofSupplier(ds)
// 例外時の代替処理
.recover(throwable -> "Recovery");
// 結果を取得
String resultValue = result.get();

(C) CASAREAL, Inc. All rights reserved.

21

22.

23.

質問はTwitterで #jsug マイクロサービスはなぜ難しい？ ▸ 障害の発生確率が、モノリスより格段に上がるから！ ① 分割する＝間にネットワークが入る＝障害点が増える ▸ 「分散コンピューティングの落とし穴」で検索 ② 稼働率は指数関数的に低下する ▸ 例）99.9% の 10乗 99.0%、99.9% の 30乗 97.0% ③ 頻繁にデプロイ・スケールする＝シャットダウンが頻繁 ▸ タイミング悪く、シャットダウン中にリクエストが来るかも (C) CASAREAL, Inc. All rights reserved. 23

24.

25.

質問はTwitterで #jsug サーキットブレイカーの役割 ▸ 相手の障害を検知したらリクエスト送信を止め、 ▸ 無駄な処理をしないようにする ▸ 相手にこれ以上の負荷をかけないようする ④以降はリクエスト送信せず代替処理のみ実行 ①リクエスト送信マイクロサービス A ③代替処理を実行 🔥 マイクロサービス B ②異常なレスポンス等 (C) CASAREAL, Inc. All rights reserved. 25

26.

質問はTwitterで #jsug サーキットブレイカーの状態状態リクエスト送信 CLOSED する OPEN しない (正常) (異常) HALF_OPEN (CLOSEDに戻ろうとする) 代替処理異常なレスポンス時のみ実行常に実行（相手にリクエスト送信しない）する異常なレスポンス時（指定回数のみ）のみ実行 ※もう2つ特別な状態が存在しますが、今回は説明の範囲外とします (C) CASAREAL, Inc. All rights reserved. 26

27.

28.

質問はTwitterで #jsug 「失敗」「呼出遅延」とは ▸ 失敗＝例外の発生 ▸ 対象の例外は設定可能（デフォルトでは全例外が対象） ▸ 呼出遅延＝戻り値が返るまでの時間が閾値を超える ▸ 閾値は設定可能（デフォルトは60秒）例外＝失敗、遅い＝呼出遅延 CircuitBreaker cb = ...; Supplier<String> ds = cb.decorateSupplier( () -> backendBService.doSomething()); (C) CASAREAL, Inc. All rights reserved. 28

29.

30.

質問はTwitterで #jsug 回数ベースのスライディングウィンドウ ▸ N個の呼出結果の循環配列で保持 ▸ N+1個目以降の呼出結果は、古い結果を上書きする public class FixedSizeSlidingWindowMetrics implements Metrics { // 循環配列の長さ private final int windowSize; // 循環配列の全要素を集計した結果を保持 private final TotalAggregation totalAggregation; // 個別の呼出結果を保持する循環配列 private final Measurement[] measurements; // 循環配列のインデックス int headIndex; (C) CASAREAL, Inc. All rights reserved. 30

31.

質問はTwitterで #jsug 時間ベースのスライディングウィンドウ ▸ 各1秒間の部分集約をN個の循環配列で保持 ▸ 1回1回の呼出結果は保持しない ▸ N+1秒目以降の呼出結果は、古い結果を上書きする public class SlidingTimeWindowMetrics implements Metrics { // 1秒毎の呼出結果集計を保持する循環配列 final PartialAggregation[] partialAggregations; // 循環配列の長さ private final int timeWindowSizeInSeconds; // 循環配列の全要素を集計した結果を保持 private final TotalAggregation totalAggregation; // 循環配列のインデックス int headIndex; (C) CASAREAL, Inc. All rights reserved. 31

32.

質問はTwitterで #jsug 失敗率、呼出遅延率の計算方法(CLOSED→OPEN) ▸ 失敗率＝ (失敗回数総呼出回数) ▸ 呼出遅延率＝ (遅延回数 100 総呼出回数) 100 ▸ 呼出回数が最小呼出回数以上になったら計算される ▸ 最小呼出回数は設定可能（デフォルトは100回） ▸ 逆に言うと、最小呼出回数未満では、全ての呼び出しが失敗であってもCLOSEDからOPENに遷移しない (C) CASAREAL, Inc. All rights reserved. 32

33.

質問はTwitterで #jsug 失敗率、呼出遅延率の計算方法(HALF̲OPEN→OPEN) ▸ 最大呼出可能回数の設定が必要 ▸ デフォルトは10回、これを超えて呼び出すと例外 ▸ 必ず回数ベースになる ▸ ウィンドウサイズ＝最大呼出可能回数 ▸ 最小呼出回数＝ min(最大呼出可能回数, CLOSED時の最小呼出回数) (C) CASAREAL, Inc. All rights reserved. 33

34.

質問はTwitterで #jsug 設定：失敗・呼出遅延 CircuitBreakerConfig config = CircuitBreakerConfig.custom() .minimumNumberOfCalls(5) // 最小呼出回数 .failureRateThreshold(50) // 失敗率の閾値(%) .slowCallDurationThreshold( // 呼出遅延の閾値 Duration.ofMillis(1000)) .recordExceptions( // 失敗と見なす例外のリスト AException.class, BException.class) .ignoreExceptions( // 失敗とも成功ともしない例外のリスト CException.class, DException.class) ... .build(); ※Spring Boot利用時はapplication.propertiesに設定可能なので、上記のコードは必要無し (C) CASAREAL, Inc. All rights reserved. 34

35.

36.

37.

質問はTwitterで #jsug OPEN→HALF̲OPENの待ち時間計算方法 ▸ IntervalFunctionインタフェース実装クラスの apply()メソッドで指定する ▸ デフォルトで用意されている実装 ① 一定時間だけ待つ（Constant Backoﬀ、デフォルト） ② ランダムな時間待つ（Randomized Backoﬀ） ③ 待ち時間を指数関数的に増やす（Exponential Backoﬀ） ④ ランダム＋指数関数（Exponential Random Backoﬀ） (C) CASAREAL, Inc. All rights reserved. 37

38.

質問はTwitterで #jsug 設定：OPEN→HALF̲OPENの待ち時間 // Constant Backoff CircuitBreakerConfig config = CircuitBreakerConfig.custom() .waitDurationInOpenState(Duration.ofSeconds(3)) ... // Randomized Backoff CircuitBreakerConfig config = CircuitBreakerConfig.custom() .waitIntervalFunctionInOpenState( IntervalFunction.ofRandomized()) ... ※Spring Boot利用時はapplication.propertiesに設定可能なので、上記のコードは必要無し (C) CASAREAL, Inc. All rights reserved. 38

39.

質問はTwitterで #jsug 設定：OPEN→HALF̲OPENの待ち時間 // Exponential Backoff CircuitBreakerConfig config = CircuitBreakerConfig.custom() .waitIntervalFunctionInOpenState( IntervalFunction.ofExponentialBackoff( Duration.ofSeconds(1), 2)) ... // Exponential Random Backoff CircuitBreakerConfig config = CircuitBreakerConfig.custom() .waitIntervalFunctionInOpenState( IntervalFunction.ofExponentialRandomBackoff( Duration.ofSeconds(1), 2)) ... ※Spring Boot利用時はapplication.propertiesに設定可能なので、上記のコードは必要無し (C) CASAREAL, Inc. All rights reserved. 39

40.

https://t.co/jpLuSZ12x6

41.

42.

質問はTwitterで #jsug Spring Bootとの連携ライブラリ ▸ resilience4j-spring-boot2 ▸ Spring Boot Starter ▸ 別途spring-boot-starter-actuatorと spring-boot-starter-aopも必要 ▸ resilience4j-spring-cloud2 ▸ resilience4j-spring-boot2に Spring Cloud Conﬁgとの連携機能を加えたもの (C) CASAREAL, Inc. All rights reserved. 42

43.

質問はTwitterで #jsug Spring Cloud併用時の注意 ▸ spring-cloud-dependenciesを含めていた場合、 Resilience4jのバージョン上書きが必要 ▸ spring-cloud-circuitbreakerが使っているResilience4jのバージョンが古いため ▸ 上書きが必要なのは下記3点 ▸ resilience4j-circuitbreaker ▸ resilience4j-timelimiter ▸ resilience4j-micrometer (C) CASAREAL, Inc. All rights reserved. 43

44.

[beta]

質問はTwitterで #jsug

application.yml
resilience4j.circuitbreaker:
名前を揃える
instances:
hello-api:
failure-rate-threshold: 50
slow-call-rate-threshold: 100
slow-call-duration-threshold: 1s
permitted-number-of-calls-in-half-open-state: 3
...
public HelloService(CircuitBreakerRegistry registry) {
this.circuitBreaker =
registry.circuitBreaker("hello-api");
}

(C) CASAREAL, Inc. All rights reserved.

44

45.

質問はTwitterで #jsug Auto Conﬁguration対象範囲 application .properties Bean定義済みなので作成不要インプット CircuitBreakerConfig 生成 CircuitBreakerRegistry 生成 Circuit Breaker Circuit Breaker (C) CASAREAL, Inc. All rights reserved. Circuit Breaker 45

46.

[beta]

質問はTwitterで #jsug

使い方
@Service
public class HelloService {
private final CircuitBreaker circuitBreaker;
// コンストラクタインジェクション
public HelloService(
CircuitBreakerRegistry registry) {
this.circuitBreaker =
registry.circuitBreaker("hello-api");
}

(C) CASAREAL, Inc. All rights reserved.

46

47.

[beta]

質問はTwitterで #jsug

アノテーションスタイル
@CircuitBreaker(name = "hello-api",
fallbackMethod = "helloFallback")
public String hello() {
return restTemplate.getForObject(
helloApiUrl + "/hello", String.class);
}
// 代替処理
public String helloFallback(Throwable t) {
t.printStackTrace();
return "Recover";
}
※この場合はCircuitBreakerインスタンスを生成する必要なし
(C) CASAREAL, Inc. All rights reserved.

47

48.

質問はTwitterで #jsug Actuatorでの監視 ▸ ActuatorでCircuitBreakerの状態を監視できる ▸ /actuator/metrics/resilience4j.circuitbreaker.XXX ▸ /actuator/health ▸ /actuator/circuitbreakers ▸ /actuator/circuitbreakerevents (C) CASAREAL, Inc. All rights reserved. 48

49.

質問はTwitterで #jsug Prometheus利用時の注意点 ▸ resilience4j-prometheusではなく、 resilience4j-micrometer + micrometer-registry-prometheus を使う https://twitter.com/rbrtwnklr/status/1172792997026697216 (C) CASAREAL, Inc. All rights reserved. 49

https://twitter.com/rbrtwnklr/status/1172792997026697216

50.

51.

質問はTwitterで #jsug Spring Cloud Circuit Breaker ▸ Springお得意の抽象化ライブラリ ▸ 下記の対応サーキットブレイカーなら、同じように扱える ▸ Resilience4j ▸ Netﬂix Hystrix ▸ Alibaba Sentinel ▸ Spring Retry (C) CASAREAL, Inc. All rights reserved. 51

52.

質問はTwitterで #jsug spring-cloud-starter-circuitbreaker-resilience4j ▸ Spring Cloud Circuit Breakerの Resilience4j実装 ▸ CircuitBreakerとTimeLimiterが含まれている ▸ resilience4j-micrometerを追加すれば、 Actuatorエンドポイントを作ることも可能 (C) CASAREAL, Inc. All rights reserved. 52

53.

[beta]

質問はTwitterで #jsug

こんなコード
import org.springframework.cloud.client.circuitbreaker.CircuitBreaker;
import org.springframework.cloud.client.circuitbreaker.CircuitBreakerFactory;
@Service
public class HelloService {
private final CircuitBreaker circuitBreaker;
public HelloService(...,
CircuitBreakerFactory circuitBreakerFactory) {
this.circuitBreaker = circuitBreakerFactory.create("hello-api");
}
public String hello() {
String result = circuitBreaker.run(
() -> restTemplate.getForObject(helloApiUrl + "/hello", String.class),
throwable -> "Recovery");
return result;
}
※@CircuitBreakerのようなアノテーションは提供されていない

(C) CASAREAL, Inc. All rights reserved.

53

54.

[beta]

質問はTwitterで #jsug

CircuitBreaker#run()のコード
▸ CircuitBreakerだけでなく、TimeLimiterも
適用される
public class Resilience4JCircuitBreaker implements CircuitBreaker {
@Override
public <T> T run(Supplier<T> toRun, Function<Throwable, T> fallback) {
// TimeLimiterを適用
Callable restrictedCall = TimeLimiter.decorateFutureSupplier(
timeLimiter, futureSupplier);
// CircuitBreakerを適用
Callable<T> callable = io.github.resilience4j.circuitbreaker.CircuitBreaker
.decorateCallable(defaultCircuitBreaker, restrictedCall);
// 実行＆フォールバック処理

}

}

return Try.of(callable::call).recover(fallback).get();

(C) CASAREAL, Inc. All rights reserved.

54

55.

[beta]

質問はTwitterで #jsug

CircuitBreaker・TimeLimiterの設定
▸ Customizerを利用する
▸ application.propertiesを使いたい場合、
自分でConﬁgurationPropertiesなどを作る必要あり
@Bean
public Customizer<Resilience4JCircuitBreakerFactory> defaultCustomizer() {
TimeLimiterConfig timeLimiterConfig = TimeLimiterConfig.custom()
// 何かカスタマイズするコードを書く
.build();
CircuitBreakerConfig circuitBreakerConfig = CircuitBreakerConfig.custom()
// 何かカスタマイズするコードを書く

}

.build();
return factory -> factory.configureDefault(
id -> new Resilience4JConfigBuilder(id)
.timeLimiterConfig(timeLimiterConfig)
.circuitBreakerConfig(circuitBreakerConfig)
.build());
(C) CASAREAL, Inc. All rights reserved.

55

56.

質問はTwitterで #jsug Spring Cloud Circuit Breakerを使うか？ ▸ 一般に、マイクロサービス関連ライブラリは寿命が短い → それを懸念するなら使う ▸ 抽象化されているので、Resilience4j特有の処理は書きづらくなる → それが嫌なら使わない ▸ 呼出にTimeLimiterも必ず適用される → それが嫌なら使わない (C) CASAREAL, Inc. All rights reserved. 56

57.

Introduction to Resilience4j #jsug

tada

関連スライド

最新の6.0で学ぶ！初めてのひとのためのSpring Security

詳解Springトランザクション -初級から上級まで- #jsug

Java ORマッパー選定のポイント #jsug

プロになるためのSpring上級知識 #jsug

今こそ知りたいSpring DI x AOP #jsug

基礎からのOAuth 2.0とSpring Security 5.1による実装 #jsug

各ページのテキスト