rate

Documentation

Index

• Constants
• type Config
• type Limiter
  • func NewLimiter(lg Logger, cfg Config) *Limiter
  • func (lim *Limiter) Excess()
  • func (lim *Limiter) ExcessRate() float64
  • func (lim *Limiter) Regulate(ctx context.Context) error
  • func (lim *Limiter) Success()
  • func (lim *Limiter) SuccessRate() float64
• type Logger

Constants

const (
	StartRateFactor   = 3
	IncreaseSteps     = 100
	DecreaseFactor    = 0.75
	IncreaseThreshold = 0.6
	DecreaseThreshold = 0.1
	RegulateEveryNTau = 3
)

Types

type Config

type Config struct {
	Name    string
	MinRate rate.Limit
	MaxRate rate.Limit
	Burst   int
	Tau     time.Duration
}

type Limiter

type Limiter struct {
	L *rate.Limiter
	// contains filtered or unexported fields
}

func NewLimiter

func NewLimiter(lg Logger, cfg Config) *Limiter

func (*Limiter) Excess

func (lim *Limiter) Excess()

func (*Limiter) ExcessRate

func (lim *Limiter) ExcessRate() float64

func (*Limiter) Regulate

func (lim *Limiter) Regulate(ctx context.Context) error

func (*Limiter) Success

func (lim *Limiter) Success()

func (*Limiter) SuccessRate

func (lim *Limiter) SuccessRate() float64

type Logger

type Logger interface {
	Infow(msg string, kv ...interface{})
}