web

Documentation

Index

• func GetRequestIP(r *http.Request) (ip string, err error)
• type RateLimiter
  • func NewIPRateLimiter(config RateLimiterConfig) *RateLimiter
  • func NewRateLimiter(config RateLimiterConfig, keyFunc func(*http.Request) (string, error)) *RateLimiter
  • func (rl *RateLimiter) Burst() int
  • func (rl *RateLimiter) Duration() time.Duration
  • func (rl *RateLimiter) Limit(next http.Handler) http.Handler
  • func (rl *RateLimiter) Run(ctx context.Context)
• type RateLimiterConfig

Functions

func GetRequestIP

func GetRequestIP(r *http.Request) (ip string, err error)

GetRequestIP gets the original IP address of the request by handling the request headers.

Types

type RateLimiter

type RateLimiter struct {
	// contains filtered or unexported fields
}

RateLimiter imposes a rate limit per key.

func NewIPRateLimiter

func NewIPRateLimiter(config RateLimiterConfig) *RateLimiter

NewIPRateLimiter constructs a RateLimiter that limits based on IP address.

func NewRateLimiter

func NewRateLimiter(config RateLimiterConfig, keyFunc func(*http.Request) (string, error)) *RateLimiter

NewRateLimiter constructs a RateLimiter.

func (*RateLimiter) Burst

func (rl *RateLimiter) Burst() int

Burst returns the number of events that happen before the rate limit.

func (*RateLimiter) Duration

func (rl *RateLimiter) Duration() time.Duration

Duration returns the amount of time required between events.

func (*RateLimiter) Limit

func (rl *RateLimiter) Limit(next http.Handler) http.Handler

Limit applies per-key rate limiting as an HTTP Handler.

func (*RateLimiter) Run

func (rl *RateLimiter) Run(ctx context.Context)

Run occasionally cleans old rate-limiting data, until context cancel.

type RateLimiterConfig

type RateLimiterConfig struct {
	Duration  time.Duration `help:"the rate at which request are allowed" default:"5m"`
	Burst     int           `help:"number of events before the limit kicks in" default:"5" testDefault:"3"`
	NumLimits int           `help:"number of clients whose rate limits we store" default:"1000" testDefault:"10"`
}

RateLimiterConfig configures a RateLimiter.