rate

Documentation

Index

• Constants
• func GenerateRandomLimitKey(limitType LimitType) (string, error)
• type Config
• type FixedWindowOption
  • func (fwo *FixedWindowOption) UnmarshalJSON(data []byte) error
• type KeyInfo
• type KeyLoader
  • func NewKeyLoader(ksload ksLoadFunc) *KeyLoader
  • func (l *KeyLoader) Load(key string) (*KeyInfo, bool)
• type KeysetFilter
• type LimitAlgoType
• type LimitRule
  • func (r *LimitRule) UnmarshalJSON(data []byte) (err error)
• type LimitType
• type Registry
  • func NewRegistry(kloader *KeyLoader) *Registry
  • func (m *Registry) AutoReload(interval time.Duration, reloader func() (*Config, error))
  • func (r *Registry) Create(ctx context.Context, resource, group string) (rate.Limiter, error)
  • func (r *Registry) GetGroupAndKey(ctx context.Context, resource string) (group, key string, err error)
  • func (r *Registry) SVipStatusFromContext(ctx context.Context) (svip int, ok bool)
• type Strategy
  • func NewStrategy(id uint32, name string) *Strategy
  • func (s *Strategy) UnmarshalJSON(data []byte) error
• type TokenBucketOption
  • func NewTokenBucketOption(r, b int) TokenBucketOption

Constants

const (
	LimitKeyCacheSize     = 5000
	LimitKeyExpirationTTL = 90 * time.Second
)

const (
	// pre-defined default strategy name
	DefaultStrategy = "default"
	// pre-defined strategy config key prefix
	ConfigStrategyPrefix = "ratelimit.strategy."
)

const (
	GCScheduleInterval = 5 * time.Minute
)

const (
	LimitKeyLength = 32
)

Functions

func GenerateRandomLimitKey

func GenerateRandomLimitKey(limitType LimitType) (string, error)

Types

type Config

type Config struct {
	Strategies map[uint32]*Strategy // limit strategies
}

type FixedWindowOption

type FixedWindowOption struct {
	Interval time.Duration
	Quota    int
}

FixedWindowOption limit option for fixed window

func (*FixedWindowOption) UnmarshalJSON

func (fwo *FixedWindowOption) UnmarshalJSON(data []byte) error

UnmarshalJSON implements `json.Unmarshaler`

type KeyInfo

type KeyInfo struct {
	SID  uint32    // bound strategy ID
	Key  string    // limit key
	Type LimitType // limit type
	SVip int       // svip level
}

type KeyLoader

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

func NewKeyLoader

func NewKeyLoader(ksload ksLoadFunc) *KeyLoader

func (*KeyLoader) Load

func (l *KeyLoader) Load(key string) (*KeyInfo, bool)

Load loads key info from cache or raw loading from somewhere else if cache missed.

type KeysetFilter

type KeysetFilter struct {
	SIDs   []uint32 // strategy IDs
	KeySet []string // limit key set
	Limit  int      // result limit size (<= 0 means none)
}

type LimitAlgoType

type LimitAlgoType string

const (
	// rate limit algorithms, only `fixed_window` and `token bucket` are supported for now.
	LimitAlgoFixedWindow LimitAlgoType = "fixed_window"
	LimitAlgoTokenBucket LimitAlgoType = "token_bucket"
)

type LimitRule

type LimitRule struct {
	Algo   LimitAlgoType
	Option interface{}
}

LimitRule resource limit rule

func (*LimitRule) UnmarshalJSON

func (r *LimitRule) UnmarshalJSON(data []byte) (err error)

type LimitType

type LimitType int

const (
	// rate limit types, only `ip` or `key` are supported for now.
	LimitTypeByKey LimitType = iota
	LimitTypeByIp
)

type Registry

type Registry struct {
	*http.Registry
	// contains filtered or unexported fields
}

func NewRegistry

func NewRegistry(kloader *KeyLoader) *Registry

func (*Registry) AutoReload

func (m *Registry) AutoReload(interval time.Duration, reloader func() (*Config, error))

func (*Registry) Create

func (r *Registry) Create(ctx context.Context, resource, group string) (rate.Limiter, error)

func (*Registry) GetGroupAndKey

func (r *Registry) GetGroupAndKey(
	ctx context.Context,
	resource string,
) (group, key string, err error)

func (*Registry) SVipStatusFromContext

func (r *Registry) SVipStatusFromContext(ctx context.Context) (svip int, ok bool)

SVipStatusFromContext returns SVIP status from context

type Strategy

type Strategy struct {
	ID   uint32 // strategy ID
	Name string // strategy name

	LimitOptions map[string]interface{} // resource => limit option

	MD5 [md5.Size]byte `json:"-"` // config data fingerprint
}

Strategy rate limit strategy

func NewStrategy

func NewStrategy(id uint32, name string) *Strategy

func (*Strategy) UnmarshalJSON

func (s *Strategy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements `json.Unmarshaler`

type TokenBucketOption

type TokenBucketOption struct {
	Rate  rate.Limit
	Burst int
}

FixedWindowOption limit option for token bucket

func NewTokenBucketOption

func NewTokenBucketOption(r, b int) TokenBucketOption