Rate limit data returned from API methods
メンテナーはふだん 1 日以内に返信
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 32/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- ruby
- 領域
- api, authentication
調査の方向性
ファイルやテストは指定されていません。まず Authentication and Management API のメソッドと、レスポンスが現在どのように処理されているかを確認します。既存の呼び出しを変更せずに、オプションのレスポンスおよび rate-limit callback を定義します。各 API 呼び出しから rate-limit データを収集でき、元のメソッドの動作との互換性が維持されれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Checklist
- I have looked into the Readme and Examples, and have not found a suitable solution or answer.
- I have looked into the API documentation and have not found a suitable solution or answer.
- I have searched the issues and have not found a suitable solution or answer.
- I have searched the Auth0 Community forums and have not found a suitable solution or answer.
- I agree to the terms within the Auth0 Code of Conduct.
Describe the problem you'd like to have solved
We're integrating with Auth0 and we would like to gather rate limit data from our calls to the Authentication and Management APIs. We have monitors for when we are rate limited, but we would like to gather metrics on the rate limit data returned from each API call. This would give us clear data points on how close we are to the rate limits as we continue to roll it out to more of our users.
Describe the ideal solution
I've partially implemented this as a proof of concept and I'd be happy to create a pull request for this if you're open to it:
- An optional block can be given to capture the response and rate limit
- The original methods can still be called as is making this a non-breaking change
For example, both of these are valid method calls:
# Original method still works
auth0_client.user_sessions(auth0_id)
# We could use the returned `rate_limit_info` to create Datadog metrics
auth0_client.user_sessions(auth0_id) do |response_body, rate_limit_info|
puts "Response body: #{response_body}"
puts "Rate limit info: #{rate_limit_info}"
end
We're considering monkey patching something like this to gather the rate limit information, but we'd much rather contribute this change if you're open to it!
Alternatives and current workarounds
No response
Additional context
No response
- 主要言語
- Ruby
- スター
- 205
- フォーク
- 146
- 平均マージ
- 16時間 2分
- マージ済み PR(30日)
- 5
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
auth0/ruby-auth0 のほかの issue
-
feature request
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
auth0/ruby-auth0#709 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 1/5 1時間未満 初心者へのやさしさ 50/100
auth0/ruby-auth0#610 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
MFA API Bearer token issue対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンbug
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
auth0/ruby-auth0#556 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
feature request
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
auth0/ruby-auth0#500 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
Move from `rest-client` to `faraday`?対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンfeature request
難易度 4/5 3〜5日 初心者へのやさしさ 28/100
auth0/ruby-auth0#483 · コメント 4 件 ·
メンテナーはふだん 1 日以内に返信
auth0/ruby-auth0 の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
scanaislop/aislop#476 ·
メンテナーはふだん 1 日以内に返信
-
Dependencies view: `getParent` loops forever on untitled documents, extension host runs out of memory対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
メンテナーはふだん 1 日以内に返信
-
area/web interface
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
mastodon/mastodon#41000 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
zerocracy/judges-action#2743 ·
メンテナーはふだん 8 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
endoflife-date/endoflife.date#11314 ·
メンテナーはふだん 1 日以内に返信