redisstore

README

Go Rate Limiter

This package provides a rate limiting interface in Go (Golang), using Redis. See sethvargo/go-limiter for more information.

Documentation

Overview

Package redisstore defines a redis-backed storage system for limiting.

Index

• func New(c *Config) (limiter.Store, error)
• func NewWithClient(c *Config, client *redis.Client) (limiter.Store, error)
• type Config

Examples

• New

Functions

func New

func New(c *Config) (limiter.Store, error)

New uses a Redis instance to back a rate limiter that to limit the number of permitted events over an interval.

Example

package main

import (
	"context"
	"log"
	"time"

	"github.com/go-redis/redis/v8"
	"github.com/zavitax/go-redisstore"
)

func main() {
	ctx := context.Background()

	store, err := redisstore.New(&redisstore.Config{
		Tokens:   15,
		Interval: time.Minute,
		RedisOptions: &redis.Options{
			Addr: "127.0.0.1:6379",
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	defer store.Close(ctx)

	limit, remaining, reset, ok, err := store.Take(ctx, "my-key")
	if err != nil {
		log.Fatal(err)
	}
	_, _, _, _ = limit, remaining, reset, ok
}

func NewWithClient

func NewWithClient(c *Config, client *redis.Client) (limiter.Store, error)

NewWithClient creates a new limiter using the given redis pool. Use this to customize lower-level details about the pool.

Types

type Config

type Config struct {
	// Tokens is the number of tokens to allow per interval. The default value is
	// 1.
	Tokens uint64

	// Interval is the time interval upon which to enforce rate limiting. The
	// default value is 1 second.
	Interval time.Duration

	// Redis client options
	RedisOptions *redis.Options
}

Config is used as input to New. It defines the behavior of the storage system.