rlimiter

README

rlimiter

Simple redis rate limit

example

// applied only to endpoint login and POST
grbinder.BindVerb(group.Group("/login", rlimiter.GinRateLimit(
  rlimiter.NewIPRateLimiter(
    &rlimiter.Rate{Window: 10 * time.Second, Limit: 10},
    "api.login"),
  []string{"POST"})),
  &loginHandler{})

// Applied to any request method
limiter := rlimiter.GinRateLimit(
  rlimiter.NewIPRateLimiter(
    &rlimiter.Rate{Window: 1 * time.Minute, Limit: 10},
    "api.hardwork"),
  []string{})

r := gin.Default()
r.GET("/hardwork", limiter, func(c *gin.Context) {
})
r.POST("/hardwork", limiter, func(c *gin.Context) {
})
r.PUT("/hardwork", limiter, func(c *gin.Context) {
})

Documentation

Overview

Package rlimiter is for rate limit on heavy endpoints

import "github.com/vanng822/rlimiter" grbinder.BindVerb(group.Group("/login", rlimiter.GinRateLimit(

rlimiter.NewIPRateLimiter(
  &rlimiter.Rate{Window: 10 * time.Second, Limit: 10},
  "api.login"),
[]string{"POST"})),
&loginHandler{})

Index

• func AutoBan(opts ...AutoBanOption) gin.HandlerFunc
• func GetClient() *redis.Client
• func GinRateLimit(limiter GinRateLimiter, methods []string) gin.HandlerFunc
• func SetClient(c *redis.Client)
• func SetGlobalPrefix(prefix string)
• type AutoBanOption
  • func AutoBanWithAutobanPrefix(prefix string) AutoBanOption
  • func AutoBanWithAutobannedPrefix(prefix string) AutoBanOption
  • func AutoBanWithBanDuration(duration time.Duration) AutoBanOption
  • func AutoBanWithRate(rate *Rate) AutoBanOption
  • func AutoBanWithResponseStatus(status int) AutoBanOption
  • func AutoBanWithStatuses(statuses ...int) AutoBanOption
• type GinRateLimiter
  • func NewIPRateLimiter(rate *Rate, prefix string) GinRateLimiter
  • func NewParamRateLimiter(rate *Rate, prefix, paramName string) GinRateLimiter
  • func NewPathRateLimiter(rate *Rate, prefix string) GinRateLimiter
• type Rate
• type RateLimiter
  • func NewRateLimiter(rate *Rate, prefix string) RateLimiter

Functions

func AutoBan

func AutoBan(opts ...AutoBanOption) gin.HandlerFunc

func GetClient

func GetClient() *redis.Client

func GinRateLimit

func GinRateLimit(limiter GinRateLimiter, methods []string) gin.HandlerFunc

func SetClient

func SetClient(c *redis.Client)

func SetGlobalPrefix

func SetGlobalPrefix(prefix string)

SetGlobalPrefix sets a global prefix for all rate limiter keys. This can be useful to avoid key collisions in Redis when using multiple applications or services. The prefix will be automatically suffixed with a colon if it does not already end with one. Remove the global prefix if an empty string is provided.

Types

type AutoBanOption

type AutoBanOption func(*autoBanOption)

func AutoBanWithAutobanPrefix

func AutoBanWithAutobanPrefix(prefix string) AutoBanOption

func AutoBanWithAutobannedPrefix

func AutoBanWithAutobannedPrefix(prefix string) AutoBanOption

func AutoBanWithBanDuration

func AutoBanWithBanDuration(duration time.Duration) AutoBanOption

func AutoBanWithRate

func AutoBanWithRate(rate *Rate) AutoBanOption

func AutoBanWithResponseStatus

func AutoBanWithResponseStatus(status int) AutoBanOption

func AutoBanWithStatuses

func AutoBanWithStatuses(statuses ...int) AutoBanOption

type GinRateLimiter

type GinRateLimiter interface {
	RateLimiter
	Key(c *gin.Context) string
}

func NewIPRateLimiter

func NewIPRateLimiter(rate *Rate, prefix string) GinRateLimiter

func NewParamRateLimiter

func NewParamRateLimiter(rate *Rate, prefix, paramName string) GinRateLimiter

func NewPathRateLimiter

func NewPathRateLimiter(rate *Rate, prefix string) GinRateLimiter

type Rate

type Rate struct {
	Window time.Duration
	Limit  int64
}

Rate define window as describe in https://redis.io/commands/incr#pattern-rate-limiter-2

type RateLimiter

type RateLimiter interface {
	IncrementUsage(key string) (bool, error)
}

func NewRateLimiter

func NewRateLimiter(rate *Rate, prefix string) RateLimiter