Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uber-go/ratelimit
A Go blocking leaky-bucket rate limit implementation
https://github.com/uber-go/ratelimit
Last synced: 3 days ago
JSON representation
A Go blocking leaky-bucket rate limit implementation
- Host: GitHub
- URL: https://github.com/uber-go/ratelimit
- Owner: uber-go
- License: mit
- Created: 2016-09-10T00:45:02.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T03:43:25.000Z (8 months ago)
- Last Synced: 2024-12-02T23:06:36.075Z (10 days ago)
- Language: Go
- Homepage:
- Size: 98.6 KB
- Stars: 4,359
- Watchers: 36
- Forks: 301
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - uber-go/ratelimit - A Go blocking leaky-bucket rate limit implementation (Go)
- go-awesome - uber-go/ratelimit
- awesome-hacking-lists - uber-go/ratelimit - A Go blocking leaky-bucket rate limit implementation (Go)
README
# Go rate limiter [![GoDoc][doc-img]][doc] [![Coverage Status][cov-img]][cov] ![test][test-img]
This package provides a Golang implementation of the leaky-bucket rate limit algorithm.
This implementation refills the bucket based on the time elapsed between
requests instead of requiring an interval clock to fill the bucket discretely.
Create a rate limiter with a maximum number of operations to perform per second.
Call Take() before each operation. Take will sleep until you can continue.
```go
import (
"fmt"
"time"
"go.uber.org/ratelimit"
)
func main() {
rl := ratelimit.New(100) // per second
prev := time.Now()
for i := 0; i < 10; i++ {
now := rl.Take()
fmt.Println(i, now.Sub(prev))
prev = now
}
// Output:
// 0 0
// 1 10ms
// 2 10ms
// 3 10ms
// 4 10ms
// 5 10ms
// 6 10ms
// 7 10ms
// 8 10ms
// 9 10ms
}
```
## FAQ:
- What's the major diff v.s. https://pkg.go.dev/golang.org/x/time/rate? (based on #77)
This ratelimiter was meant to have a (1) simple API and (2) minimal overhead. For more complex use-cases [x/time/rate] is a great choice. See [here][redit] for historical context, and [here][bench] for benchmarks (from 2016).
- Why does example_test.go fail when I run it locally on Windows? (based on #80)
Windows has some known issues with timers precision. See golang/go#44343. We don't expect to work around it.
[cov-img]: https://codecov.io/gh/uber-go/ratelimit/branch/master/graph/badge.svg?token=zhLeUjjrm2
[cov]: https://codecov.io/gh/uber-go/ratelimit
[doc-img]: https://pkg.go.dev/badge/go.uber.org/ratelimit
[doc]: https://pkg.go.dev/go.uber.org/ratelimit
[test-img]: https://github.com/uber-go/ratelimit/workflows/test/badge.svg
[redit]: https://www.reddit.com/r/golang/comments/59k2bi/ubergoratelimit_a_golang_blocking_leakybucket/d99ob9q
[x/time/rate]: https://pkg.go.dev/golang.org/x/time/rate
[bench]: https://gist.github.com/prashantv/26016a7dbc6fc1ec52d8c2b6591f3582