You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update README.md to reflect algorithm used
Signed-off-by: Ben Bangert <100193+bbangert@users.noreply.github.com>
* Fix other token bucket reference
Signed-off-by: Ben Bangert <100193+bbangert@users.noreply.github.com>
---------
Signed-off-by: Ben Bangert <100193+bbangert@users.noreply.github.com>
Copy file name to clipboardExpand all lines: valkeylimiter/README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
2
2
# valkeylimiter
3
3
4
-
This module provides an interface for token bucket rate limiting with precise control over limits and time windows. Inspired by GitHub's approach to scaling their API with a sharded, replicated rate limiter in Valkey ([github.blog](https://github.blog/engineering/infrastructure/how-we-scaled-github-api-sharded-replicated-rate-limiter-redis/)).
4
+
This module provides an interface for fixed window rate limiting with precise control over limits and time windows. Inspired by GitHub's approach to scaling their API with a sharded, replicated rate limiter in Valkey ([github.blog](https://github.blog/engineering/infrastructure/how-we-scaled-github-api-sharded-replicated-rate-limiter-redis/)).
5
5
6
6
## Features
7
7
8
-
-**Token Bucket Algorithm**: Implements a token bucket algorithm to control the number of actions (e.g., API requests) a user can perform within a specified time window.
8
+
-**Fixed Window Algorithm**: Implements a fixed window algorithm to control the number of actions (e.g., API requests) a user can perform within a specified time window.
9
9
-**Customizable Limits**: Allows configuration of request limits and time windows to suit various application requirements.
10
10
-**Distributed Rate Limiting**: Leverages Valkey to maintain rate limit counters, ensuring consistency across distributed environments.
11
11
-**Reset Information**: Provides `ResetAtMs` timestamps to inform clients when they can retry requests.
0 commit comments