Rate limiting with few algorithms (Sliding Window, Leaky Bucket)

This package is based on go-redis/redis_rate and implements GCRA (aka leaky bucket) for rate limiting based on Redis. The code requires Redis version 3.2 or newer since it relies on replicate_commands feature.

Installation

go_limiter requires a Go version with Modules support and uses import versioning. So please make sure to initialize a Go module before installing go_limiter:

go get github.com/bringg/go_redis_ratelimit

Import:

import "github.com/bringg/go_redis_ratelimit"

Examplle

import (
    "context"
    "log"
    "time"

    "github.com/go-redis/redis/v8"

    "github.com/bringg/go_redis_ratelimit"
)

func main() {
    option, err := redis.ParseURL("redis://127.0.0.1:6379/0")
    if err != nil {
        log.Fatal(err)
    }

    client := redis.NewClient(option)
    _ = client.FlushDB(context.Background()).Err()

    limiter := go_redis_ratelimit.NewLimiter(client)
    res, err := limiter.Allow("api_gateway_cache:klu4ik", &go_redis_ratelimit.Limit{
        // or you can use go_limiter.SlidingWindowAlgorithm
        Algorithm: go_redis_ratelimit.GCRAAlgorithm,
        Rate:      10,
        Period:    2 * time.Minute,
        Burst:     10,
    })

    if err != nil {
        log.Fatal(err)
    }

    log.Println("===> ", res.Allowed, res.Remaining)
    // Output: true 1
}