GoのRateLimit処理の実装

2023/03/19に行われた日大Joken&会津大Zli 合同LTでの発表資料です

イベントページはこちら

- https://zli.connpass.com/event/277175/

Transcript

1. GoのRateLimit処理の実装 日大Joken&会津大Zli 合同LT 2023/03/19
2. • 学年：28期(学部3年) • 所属：会津大学コンピュータ理工学部 • 今興味のある技術：Goʕ◔ϖ◔ʔ • 趣味： ◦ ゲームしたりマンガ読んだり ▪ 最近モンハンで傀異Lv199になりました ▪ イカᔦꙬᔨもやっています ◦ 競プロ ▪ 春休み中、平日21時にくじかつしてます • Twitter：@matumoto_1234 matumoto 松本 響輝 自己紹介
3. 目次 • RateLimitについて • トークンバケット • クライアント側での導入
4. そもそもRateLimitってなに • APIとかでの回数制限的なやつ • APIを呼びすぎてしまうのを防ぐ目的でつけられてたりすることが多い • 例. ◦ Twitter：1日で2400ツイート ◦ Slack：メッセージの投稿は1秒に1回 ◦ GitHub：検索クエリは1分で30リクエスト
5. そもそもRateLimitってなに • APIとかでの回数制限的なやつ • APIを呼びすぎてしまうのを防ぐ目的でつけられてたりすることが多い • 例. ◦ Twitter：1日で2400ツイート ◦ Slack：メッセージの投稿は1秒に1回 ◦ GitHub：検索クエリは1分で30リクエスト これがサーバー側で 設定されてないと大量のリクエストで爆発してしまう 🤯
6. GoでのRateLimit処理の実装 • 調べてみた感じ、golang/x/time/rate という準標準のパッケージが使われるのが多いっぽい • そのパッケージでは「トークンバケット」というアルゴリズムを元に実装がなされている
7. トークンバケット
8. トークンバケットの目的 • トークンバケットはリクエストの流れをなるべく平均化して処理するのが目的 リクエスト リクエスト リクエスト リクエスト 時間 リクエスト リクエスト リクエスト RateLimitの基準
9. トークンバケットの目的 • トークンバケットはリクエストの流れをなるべく平均化して処理するのが目的 リクエスト リクエスト リクエスト リクエスト 時間 リクエスト リクエスト リクエスト RateLimitの基準
10. トークンバケットについて • トークン、バーストという概念がある • トークン := 受付可能な残りリクエスト数 • バースト := 1秒間に受付可能な最大リクエスト数 • トークンは1リクエストにつき1個消費する • トークンは1秒につき r 個補充される • リクエストが来た段階でトークンがなくなっていた場合、トークンが補充されるまで待つ
11. トークンバケットについて • 例1. トークンが1秒につき2個回復、バースト(1秒間最大リクエスト数)は5000兆とする。 リクエスト リクエスト リクエスト リクエスト 時間 リクエスト リクエスト リクエスト
12. トークンバケットについて • 例1. トークンが1秒につき2個回復、バースト(1秒間最大リクエスト数)は5000兆とする。 リクエスト リクエスト リクエスト リクエスト 時間 リクエスト リクエスト リクエスト 0 0 0 2 4 5 トークン：
13. トークンバケットについて • 例2. トークンが1秒につき2個回復、バースト(1秒間最大リクエスト数)は5000兆とする。 リクエスト リクエスト リクエスト リクエスト 時間 リクエスト リクエスト リクエスト
14. トークンバケットについて • 例2. トークンが1秒につき2個回復、バースト(1秒間最大リクエスト数)は5000兆とする。 リクエスト リクエスト リクエスト リクエスト 時間 リクエスト リクエスト リクエスト 2 0 0 2 4 5 トークン：
15. トークンバケットについて • 例3. トークンが1秒につき2個回復、バースト(1秒間最大リクエスト数)は2とする。 リクエスト リクエスト リクエスト リクエスト 時間 リクエスト リクエスト リクエスト
16. トークンバケットについて • 例3. トークンが1秒につき2個回復、バースト(1秒間最大リクエスト数)は2とする。 リクエスト リクエスト リクエスト リクエスト 時間 リクエスト リクエスト リクエスト 2 2 2 2 4 5 トークン： バースト
17. サンプルコード • golang.org/x/time/rateパッケージを使って簡単に動かしてみる
18. サンプルコード • golang.org/x/time/rateパッケージを使って簡単に動かしてみる
19. クライアント側での導入
20. クライアント側での導入 • では、RateLimit処理を使えば「2秒ごとにリクエストをする」みたいなこともいいかんじに抽象化 できるのでは？🤔 • →できます！ 今回はhttp.RoundTripperとして抽象化する方法を紹介
21. http.RoundTripperって？ • net/httpパッケージのhttp.Clientのフィールドにいるやつ •
22. http.RoundTripperって？ • net/httpパッケージのhttp.Clientのフィールドにいるやつ •
23. http.RoundTripperの定義 • http.RoundTripperはインターフェースとして定義されている
24. http.RoundTripperの定義 • http.RoundTripperはインターフェースとして定義されている
25. http.Client.Transportの拡張 • GoでHTTPリクエストを行う場合、http.Client.Transportを通して、最終的に http.RoundTripper.RoundTrip()が呼び出される • http.Client.Transport は http.RoundTripper インターフェースを実装していれば 良いので、自由に置き換えることが可能！ • よって、今回はhttp.RateLimitTransportを実装する
26. サンプルコード • RateLimitTransportに、RoundTrip()を実装する • フィールドにTransportを持たせることで、他のhogeTransportと重ねることも可能
27. サンプルコード • RateLimitTransportに、RoundTrip()を実装する
28. まとめ • GoでのRateLimit処理は golang/x/time/rate パッケージが使われがち • そのパッケージではトークンバケットというアルゴリズムが元になっている • http.RoundTripperを実装して抽象化できる https://github.com/matumoto1234/go-rate-limit-sample 今回使用したコードの一部は GitHubで公開しています〜
29. ありがとうございました