throttle

Mar 6, 2025

Changes in this version

type RateLimitRetryAfterValue

+ func (ra RateLimitRetryAfterValue) MarshalJSON() ([]byte, error)

+ func (ra RateLimitRetryAfterValue) MarshalText() ([]byte, error)

+ func (ra RateLimitRetryAfterValue) MarshalYAML() (interface{}, error)

type RateLimitValue

+ func (rl RateLimitValue) MarshalJSON() ([]byte, error)

+ func (rl RateLimitValue) MarshalText() ([]byte, error)

+ func (rl RateLimitValue) MarshalYAML() (interface{}, error)

type TagsList

+ func (tl TagsList) MarshalJSON() ([]byte, error)

+ func (tl TagsList) MarshalText() ([]byte, error)

+ func (tl TagsList) MarshalYAML() (interface{}, error)

+ func (tl TagsList) String() string

Mar 4, 2025

Changes in this version

+ func InFlightLimitMiddleware(cfg *InFlightLimitZoneConfig, errDomain string, ruleName string, ...) (func(next http.Handler) http.Handler, error)

+ func InFlightLimitMiddlewareWithOpts(cfg *InFlightLimitZoneConfig, errDomain string, ruleName string, ...) (func(next http.Handler) http.Handler, error)

+ func RateLimitMiddleware(cfg *RateLimitZoneConfig, errDomain string, ruleName string, ...) (func(next http.Handler) http.Handler, error)

+ func RateLimitMiddlewareWithOpts(cfg *RateLimitZoneConfig, errDomain string, ruleName string, ...) (func(next http.Handler) http.Handler, error)

+ type InFlightLimitMiddlewareOpts struct

+ GetKeyIdentity func(r *http.Request) (key string, bypass bool, err error)

+ InFlightLimitOnError middleware.InFlightLimitOnErrorFunc

+ InFlightLimitOnReject middleware.InFlightLimitOnRejectFunc

+ InFlightLimitOnRejectInDryRun middleware.InFlightLimitOnRejectFunc

+ type RateLimitMiddlewareOpts struct

+ GetKeyIdentity func(r *http.Request) (key string, bypass bool, err error)

+ RateLimitOnError middleware.RateLimitOnErrorFunc

+ RateLimitOnReject middleware.RateLimitOnRejectFunc

+ RateLimitOnRejectInDryRun middleware.RateLimitOnRejectFunc

Feb 5, 2025

Changes in this version

+ func MapstructureDecodeHook() mapstructure.DecodeHookFunc

+ type ConfigOption func(*configOptions)

+ func WithKeyPrefix(keyPrefix string) ConfigOption

type RateLimitRetryAfterValue

+ func (ra *RateLimitRetryAfterValue) UnmarshalJSON(data []byte) error

+ func (ra *RateLimitRetryAfterValue) UnmarshalYAML(value *yaml.Node) error

+ func (ra RateLimitRetryAfterValue) String() string

type RateLimitValue

+ func (rl *RateLimitValue) UnmarshalJSON(data []byte) error

+ func (rl *RateLimitValue) UnmarshalYAML(value *yaml.Node) error

+ func (rl RateLimitValue) String() string

+ type TagsList []string

+ func (tl *TagsList) UnmarshalJSON(data []byte) error

+ func (tl *TagsList) UnmarshalText(text []byte) error

+ func (tl *TagsList) UnmarshalYAML(value *yaml.Node) error

Sep 9, 2024

Changes in this version

type MetricsCollector

+ IncInFlightLimitRejects func(ruleName string, dryRun bool, backlogged bool)

+ IncRateLimitRejects func(ruleName string, dryRun bool)

+ type PrometheusMetrics struct

+ InFlightLimitRejects *prometheus.CounterVec

+ RateLimitRejects *prometheus.CounterVec

+ func NewPrometheusMetrics() *PrometheusMetrics

+ func NewPrometheusMetricsWithOpts(opts PrometheusMetricsOpts) *PrometheusMetrics

+ func (pm *PrometheusMetrics) IncInFlightLimitRejects(ruleName string, dryRun bool, backlogged bool)

+ func (pm *PrometheusMetrics) IncRateLimitRejects(ruleName string, dryRun bool)

+ func (pm *PrometheusMetrics) MustCurryWith(labels prometheus.Labels) *PrometheusMetrics

+ func (pm *PrometheusMetrics) MustRegister()

+ func (pm *PrometheusMetrics) Unregister()

+ type PrometheusMetricsOpts struct

+ ConstLabels prometheus.Labels

+ CurriedLabelNames []string

+ Namespace string

Aug 26, 2024

Changes in this version

+ const RateLimitAlgLeakyBucket

+ const RateLimitAlgSlidingWindow

+ const RuleLogFieldName

+ func Middleware(cfg *Config, errDomain string, mc *MetricsCollector) func(next http.Handler) http.Handler

+ func MiddlewareWithOpts(cfg *Config, errDomain string, mc *MetricsCollector, opts MiddlewareOpts) func(next http.Handler) http.Handler

+ type Config struct

+ InFlightLimitZones map[string]InFlightLimitZoneConfig

+ RateLimitZones map[string]RateLimitZoneConfig

+ Rules []RuleConfig

+ func NewConfig() *Config

+ func NewConfigWithKeyPrefix(keyPrefix string) *Config

+ func (c *Config) KeyPrefix() string

+ func (c *Config) Set(dp config.DataProvider) error

+ func (c *Config) SetProviderDefaults(_ config.DataProvider)

+ func (c *Config) Validate() error

+ type InFlightLimitZoneConfig struct

+ BacklogLimit int

+ BacklogTimeout time.Duration

+ InFlightLimit int

+ ResponseRetryAfter time.Duration

+ func (c *InFlightLimitZoneConfig) Validate() error

+ type MetricsCollector struct

+ InFlightLimitRejects *prometheus.CounterVec

+ RateLimitRejects *prometheus.CounterVec

+ func NewMetricsCollector(namespace string) *MetricsCollector

+ func (mc *MetricsCollector) MustCurryWith(labels prometheus.Labels) *MetricsCollector

+ func (mc *MetricsCollector) MustRegister()

+ func (mc *MetricsCollector) Unregister()

+ type MiddlewareOpts struct

+ BuildHandlerAtInit bool

+ GetKeyIdentity func(r *http.Request) (key string, bypass bool, err error)

+ InFlightLimitOnError middleware.InFlightLimitOnErrorFunc

+ InFlightLimitOnReject middleware.InFlightLimitOnRejectFunc

+ InFlightLimitOnRejectInDryRun middleware.InFlightLimitOnRejectFunc

+ RateLimitOnError middleware.RateLimitOnErrorFunc

+ RateLimitOnReject middleware.RateLimitOnRejectFunc

+ RateLimitOnRejectInDryRun middleware.RateLimitOnRejectFunc

+ Tags []string

+ func (opts MiddlewareOpts) InFlightLimitOpts() inFlightLimitMiddlewareParams

+ func (opts MiddlewareOpts) RateLimitOpts() rateLimitMiddlewareParams

+ type RateLimitRetryAfterValue struct

+ Duration time.Duration

+ IsAuto bool

+ func (ra *RateLimitRetryAfterValue) UnmarshalText(text []byte) error

+ type RateLimitValue struct

+ Count int

+ Duration time.Duration

+ func (rl *RateLimitValue) UnmarshalText(text []byte) error

+ type RateLimitZoneConfig struct

+ Alg string

+ BacklogLimit int

+ BacklogTimeout time.Duration

+ BurstLimit int

+ RateLimit RateLimitValue

+ ResponseRetryAfter RateLimitRetryAfterValue

+ func (c *RateLimitZoneConfig) Validate() error

+ type RuleConfig struct

+ Alias string

+ ExcludedRoutes []restapi.RouteConfig

+ InFlightLimits []RuleInFlightLimit

+ RateLimits []RuleRateLimit

+ Routes []restapi.RouteConfig

+ Tags []string

+ func (c *RuleConfig) Name() string

+ func (c *RuleConfig) Validate(rateLimitZones map[string]RateLimitZoneConfig, ...) error

+ type RuleInFlightLimit struct

+ Zone string

+ type RuleRateLimit struct

+ Zone string

+ type ZoneConfig struct

+ DryRun bool

+ ExcludedKeys []string

+ IncludedKeys []string

+ Key ZoneKeyConfig

+ MaxKeys int

+ ResponseStatusCode int

+ func (c *ZoneConfig) Validate() error

+ type ZoneKeyConfig struct

+ HeaderName string

+ NoBypassEmpty bool

+ Type ZoneKeyType

+ func (c *ZoneKeyConfig) Validate() error

+ type ZoneKeyType string

+ const ZoneKeyTypeHTTPHeader

+ const ZoneKeyTypeIdentity

+ const ZoneKeyTypeNoKey

+ const ZoneKeyTypeRemoteAddr