https://github.com/abo/rerate
redis-based rate counter and rate limiter
https://github.com/abo/rerate
rate-counter rate-limiter redis
Last synced: 5 months ago
JSON representation
redis-based rate counter and rate limiter
- Host: GitHub
- URL: https://github.com/abo/rerate
- Owner: abo
- License: mit
- Created: 2016-05-24T08:59:00.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-28T02:22:25.000Z (about 8 years ago)
- Last Synced: 2024-10-23T02:55:09.473Z (6 months ago)
- Topics: rate-counter, rate-limiter, redis
- Language: Go
- Homepage:
- Size: 43.9 KB
- Stars: 27
- Watchers: 4
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - rerate - redis-based rate counter and rate limiter - ★ 11 (Utilities)
README
rerate
===========
[](https://travis-ci.org/abo/rerate)
[](https://godoc.org/github.com/abo/rerate)
[](https://goreportcard.com/report/github.com/abo/rerate)
[](https://coveralls.io/github/abo/rerate?branch=master)
rerate is a redis-based ratecounter and ratelimiter
* Dead simple api
* With redis as backend, multiple rate counters/limiters can work as a cluster
* Count/Limit requests any period, 2 day, 1 hour, 5 minute or 2 second, it's up to you
* Recording requests as a histotram, which can be used to visualize or monitor
* Limit requests from single ip, userid, applicationid, or any other unique identifier
Tutorial
--------
```
package main
import (
"github.com/abo/rerate"
)
...
func main() {
// redigo buckets
pool := newRedisPool("localhost:6379", "")
buckets := rerate.NewRedigoBuckets(pool)
// OR redis buckets
// client := redis.NewClient(&redis.Options{
// Addr: "localhost:6379",
// Password: "",
// DB: 0,
// })
// buckets := rerate.NewRedisBuckets(client)
// Counter
counter := rerate.NewCounter(buckets, "rl:test", 10 * time.Minute, 15 * time.Second)
counter.Inc("click")
c, err := counter.Count("click")
// Limiter
limiter := rerate.NewLimiter(buckets, "rl:test", 1 * time.Hour, 15 * time.Minute, 100)
limiter.Inc("114.255.86.200")
rem, err := limiter.Remaining("114.255.86.200")
exceed, err := limiter.Exceeded("114.255.86.200")
}
```
Installation
------------
Install rerate using the "go get" command:
go get github.com/abo/rerate
Documentation
-------------
- [API Reference](http://godoc.org/github.com/abo/rerate)
- [Wiki](https://github.com/abo/rerate/wiki)
Sample - Sparkline
------------------
```
cd cmd/sparkline
npm install webpack -g
npm install
webpack && go run main.go
```
Open `http://localhost:8080` in Browser, And then move mouse.
Contributing
------------
WELCOME
License
-------
rerate is available under the [The MIT License (MIT)](https://opensource.org/licenses/MIT).