![](\"//ws-fe.amazon-adsystem.com/widgets/q?_encoding=UTF8&ASIN=B086JJNDKS&Format=_SL110_&ID=AsinImage&MarketPlace=JP&ServiceVersion=20070822&WS=1&tag=oshimayuki0d-22&language=ja_JP\")
![\"\"](\"https://ir-jp.amazon-adsystem.com/e/ir?t=oshimayuki0d-22&language=ja_JP&l=li1&o=9&a=B086JJNDKS\")
マイクロサービスなどで利用されるサーキットブレーカと言えば、最近は Envoy (Istio) が最も有名です。
\nEnvoy は別プロセスのプロキシ (コンテナのサイドカー) として導入してサーキットブレーカとして利用可能ですが、サーキットブレーカには各種言語のライブラリとして導入可能なものもあります。
\nNode.js ライブラリ形式のサーキットブレーカである opossum をさわってみたので、その概要や感想をまとめます。
\nopossum は Node.js のサーキットブレーカライブラリです。
\nマイクロサービスにおけるサーキットブレーカと言えば外部サービスとの通信で利用するイメージが強いですが、opossum は任意の処理に対してサーキットブレーカを挿入することができます。
\n使い方は非常に簡単で、失敗する可能性のある関数を CircuitBreaker クラスの引数に渡すだけです。
\nfunction asyncFunctionThatCouldFail(x, y) {\n :\n}\n\nconst options = {\n timeout: 3000,\n errorThresholdPercentage: 50,\n resetTimeout: 30000\n};\n\nconst breaker = new CircuitBreaker(asyncFunctionThatCouldFail, options);\n\nbreaker.fire(x, y)\n .then(console.log)\n .catch(console.error);npm の opossum のページ を眺めれば、なんとなく使えてしまうと思います。
\n実際にサーキットブレーカが動作する様子を見るため、TypeScript でコードを書いてみました。
\n※ ここには主要な処理を抜粋して掲載するので、コードの全体については GitHub のこちら を参照ください。
\nまずはテスト用に、await で指定した時間待てる wait 関数と、指定した時間遅延する slowEcho 関数を用意しました。
\nfunction wait(second: number) {\n return new Promise((resolve) => setTimeout(resolve, second * 1000))\n}\n\nasync function slowEcho(message: string, waitSecond: number = 0) {\n await wait(waitSecond)\n return message\n}続いて、サーキットブレーカの設定を定義します。
\nオプションは色々ありますが、以下の例では
\nを設定しています。
\nconst options = {\n timeout: 3000,\n errorThresholdPercentage: 50,\n resetTimeout: 3000\n}サーキットブレーカを設定します。
\nconst breaker = new CircuitBreaker(slowEcho, options)\n\nbreaker.on('timeout', () => {\n logWithTime('timeout')\n})\nbreaker.on('open', () => {\n logWithTime('open')\n})\nbreaker.on('halfOpen', () => {\n logWithTime('halfOpen')\n})\nbreaker.on('close', () => {\n logWithTime('close')\n})動作を見てみるため、breaker.on を使い、いくつかのイベントでログ出力も設定しました。
\nあとは関数の実行の遅延が 0, 1, 2, … 秒となるように呼び出す処理を書きます。
\n// [0, 1, 2, ...]\nconst waitSeconds = [...Array(10).keys()]\n\nfor (let i = 0; i < waitSeconds.length; i++) {\n const waitSecond = waitSeconds[i]\n logWithTime(`waitSecond = ${waitSecond}`)\n\n\n try {\n const echoMessage = await breaker.fire('Hello!', waitSecond)\n logWithTime(echoMessage)\n } catch (e) {\n logWithTime('error catched!!!')\n }\n}実装したコードを実行してみると、以下のようになりました。
\n※ ”#” 移行は実行結果についての説明です。
\n$ ts-node index.ts\n[20:50:42] waitSecond = 0\n[20:50:42] Hello!\n[20:50:42] waitSecond = 1\n[20:50:43] Hello!\n[20:50:43] waitSecond = 2\n[20:50:45] Hello!\n[20:50:45] waitSecond = 3\n[20:50:48] timeout\n[20:50:48] error catched!!! # 3 秒遅延させた処理は、タイムアウトでエラーとなっています\n[20:50:48] waitSecond = 4\n[20:50:51] timeout\n[20:50:51] error catched!!! # 4 秒遅延させた処理も、3 秒たった時点でタイムアウトでエラーとなっています\n[20:50:51] waitSecond = 5\n[20:50:54] timeout\n[20:50:54] open # エラーが 50% になったため、この時点でサーキットブレーカが開きました\n[20:50:54] error catched!!! # 5 秒遅延させた処理も、3 秒たった時点でタイムアウトでエラーとなっています\n[20:50:54] waitSecond = 6\n[20:50:54] error catched!!! # 以後の処理は 3 秒待つこともなく、即座にエラーになっています\n[20:50:54] waitSecond = 7\n[20:50:54] error catched!!!\n[20:50:54] waitSecond = 8\n[20:50:54] error catched!!!\n[20:50:54] waitSecond = 9\n[20:50:54] error catched!!!サーキットブレーカが動作しているのを確認できました。
\n今回は opossum を試しましたが、他にも npm には
\n\nといったサーキットブレーカのライブラリがありました。
\nただ、これらはすでにメンテナンスされていません。
\nまた、Netflixy 製のサーキットブレーカの Java ライブラリ Hystrix もすでに活発な開発は行っておらず、resilience4j のようなアクティブなライブラリを利用することを推奨しているようです。
\n※ ちなみに、今回 opossum をさわってみたのは、書籍『マイクロサービスパターン』で Hystrix が紹介されていて気になったのがきっかけです。
\nライブラリ形式のサーキットブレーカが少なく、かつメンテナンスされていないケースが多い理由の 1 つは、Envoy (Istio) を利用した別プロセスのプロキシによるサーキットブレーカが主流になっているためだと思います。
\nKubernetes などを使い、Envoy などをサイドカーとして導入すれば、1 つ 1 つのアプリケーションにサーキットブレーカを仕込む手間がかかりません。
\nこれは複数の言語で実装されるマイクロサービスの場合には特に大きなメリットになります。
\n一方、今回ライブラリ形式のサーキットブレーカをさわってみて、Envoy などを導入するよりも簡単だなと感じました。
\nIstio などのサービスメッシュの導入は、事例は増えているものの、気軽に手を出せるものではないと思います。
\n簡易的にサーキットブレーカを導入したい場合などは、opossum などのライブラリ形式のサーキットブレーカも良い選択かもしれないと感じました。
","fields":{"slug":"/posts/hello-opossum","tagSlugs":["/tag/microservices/"],"autoRecommendPosts":["typescript-books","microservices-books","it-trends-2021","refactoring-rearchitecting-books"]},"frontmatter":{"date":"2022-01-21T12:01:19.682Z","description":"マイクロサービスなどで利用されるサーキットブレーカと言えば、最近は Envoy (Istio) が最も有名です。\nEnvoy は別プロセスのプロキシ (コンテナのサイドカー) として導入してサーキットブレーカとして利用可能ですが、サーキットブレーカには各種言語のライブラリとして導入可能なものもあります。\nNode.js ライブラリ形式のサーキットブレーカである opossum をさわってみたので、その概要や感想をまとめます。","tags":["microservices"],"title":"Node.js のサーキットブレーカ opossum をさわってみた","socialImage":null,"recommendPosts":null}}},"pageContext":{"slug":"/posts/hello-opossum"}},"staticQueryHashes":["251939775","3942705351","401334301"]}