Adding logic to extract the Rate Limiting statistics #291
Conversation
ratelimit_test.go
Outdated
| } | ||
| } | ||
|
|
||
| func makeHeader(limit, period, reset, remaining string) *http.Response { |
There was a problem hiding this comment.
What are your thoughts on using that same RateLimit struct as a param to this func - these four params here are strings, easy to get confused which one is which?
ratelimit.go
Outdated
| func (client *Client) GetRateLimitStats() map[string]RateLimit { | ||
| client.m.Lock() | ||
| defer client.m.Unlock() | ||
| return client.rateLimitingStats |
There was a problem hiding this comment.
I think you should do a copy of the Map before returning it. Else values can be changed/updated in //
There was a problem hiding this comment.
Thanks @CharlyF Looks good.
Do we need to make this a cached/async thingy?
The only benefit I see with this implementation is that you can get latest values independently from your api calls. However, are there any use cases for it?
Also, I fear we will forget to add new endpoints to the list of supported endpoints.
Have you evaluated the uncached/sync approached?
|
Thank you for the review @gzussa.
I believe clients should be as lightweight and stateless as possible, we need to keep the values in memory so that one can use them anytime, in my use case I submit them as metric to be alerted if I am about to reach the limit:
I don't think we need a full cache though. For the async, it is critical to be able to know when this problem arises, my approach was to 1. Get the most up to date values upon demand, 2. Not contribute to the Rate Limit when requesting the statistics (i.e. we don't have a rate limiting endpoint, so you need to query a rate limited endpoint to get them). Exactly as you said:
With regards to the following,
I added logic to parse the header of every call and look for the |
CharlyF
force-pushed
the
adding-rate-limiting-logic
branch
from
3aa74ab to
678f9cf
Compare
In an effort to give maximum visibility over the communication between the client and the backend, we would like to introduce logic to extract the Rate Limiting stats from the header of calls made to rate limited endpoints.
More details in the official API doc.
It exposes a thread safe public method to get the values.
Additionally, we update the map associated with the Client in the method closest to the request to ensure that we don't miss calls.