http

Documentation

Index

• func GetIP(r *http.Request) string
• func Limit(next http.Handler) http.Handler
• func NewAPILimiter(cfg *APILimiterConfig) error
• type APILimiterConfig
• type HTTPLimitConfig
• type MemoryLimiterConfig
• type RateLimiterCell
• type RateLimiterConfig

Functions

func GetIP

func GetIP(r *http.Request) string

GetIP gets a requests IP address by reading off the forwarded-for header (for proxies) and falls back to use the remote address.

func Limit

func Limit(next http.Handler) http.Handler

func NewAPILimiter

func NewAPILimiter(cfg *APILimiterConfig) error

Types

type APILimiterConfig

type APILimiterConfig struct {
	HTTPLimitCfg HTTPLimitConfig
	PathPattern  map[string]MemoryLimiterConfig
	APILimits    map[string]MemoryLimiterConfig // routePrefix-apiName  =>  limit config
	HostPattern  map[string]MemoryLimiterConfig
}

type HTTPLimitConfig

type HTTPLimitConfig struct {
	On         bool
	RateLimit  int
	RatePeriod string
}

type MemoryLimiterConfig

type MemoryLimiterConfig struct {
	RateLimit  int    // rate
	RatePeriod string // per period
}

type RateLimiterCell

type RateLimiterCell struct {
	Key        string
	RateLimit  int
	RatePeriod string
}

type RateLimiterConfig

type RateLimiterConfig struct {
	HTTPLimitCfg HTTPLimitConfig
	PathPattern  []RateLimiterCell
	HostPattern  []RateLimiterCell
	APILimits    []RateLimiterCell
}