http

Documentation

Index

• Constants
• Variables
• func GetIP(r *http.Request) string
• func Limit(domain string) func(http.Handler) http.Handler
• func MakeLimitErrorResponse(w http.ResponseWriter, err error)
• func NewAPILimiter(cfg *APILimiterConfig) error
• func NewBandwidthLimiter(r rate.Limit, b int)
• type APILimiterConfig
• type BandwidthLimiter
• type BandwidthLimiterConfig
• type IPLimitConfig
• type KeyToRateLimiterNameCell
• type MemoryLimiterConfig
• type RateLimiterConfig

Constants

const (
	Middleware      = "Middleware"
	MethodSeparator = "-"
)

Variables

var (
	ErrTooManyRequest = gfsperrors.Register(Middleware, http.StatusTooManyRequests, 960001, "too many requests, please try it again later")
)

var LimiterOnce sync.Once

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(domain string) func(http.Handler) http.Handler

func MakeLimitErrorResponse

func MakeLimitErrorResponse(w http.ResponseWriter, err error)

func NewAPILimiter

func NewAPILimiter(cfg *APILimiterConfig) error

func NewBandwidthLimiter

func NewBandwidthLimiter(r rate.Limit, b int)

Types

type APILimiterConfig

type APILimiterConfig struct {
	IPLimitCfg   IPLimitConfig
	PathPattern  map[string][]MemoryLimiterConfig
	PathSequence []string
	APILimits    map[string][]MemoryLimiterConfig // routePrefix-apiName  =>  limit config
	HostPattern  map[string][]MemoryLimiterConfig
	HostSequence []string
}

type BandwidthLimiter

type BandwidthLimiter struct {
	Limiter *rate.Limiter
}

var BandwidthLimit *BandwidthLimiter

type BandwidthLimiterConfig

type BandwidthLimiterConfig struct {
	Enable bool       //Enable Whether to enable bandwidth limiting
	R      rate.Limit //R The speed at which tokens are generated R per second
	B      int        //B The size of the token bucket
}

type IPLimitConfig

type IPLimitConfig struct {
	On         bool   `comment:"optional"`
	RateLimit  int    `comment:"optional"`
	RatePeriod string `comment:"optional"`
}

type KeyToRateLimiterNameCell

type KeyToRateLimiterNameCell struct {
	Key    string
	Method string
	Names  []string
}

type MemoryLimiterConfig

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

type RateLimiterConfig

type RateLimiterConfig struct {
	IPLimitCfg  IPLimitConfig
	PathPattern []KeyToRateLimiterNameCell `comment:"optional"`
	HostPattern []KeyToRateLimiterNameCell `comment:"optional"`
	APILimits   []KeyToRateLimiterNameCell `comment:"optional"`
	NameToLimit []MemoryLimiterConfig      `comment:"optional"`
}