Documentation
¶
Overview ¶
Package ratelimiting provides a per-key rate limiter interface using the token bucket algorithm.
Index ¶
Examples ¶
Constants ¶
View Source
const ( ProviderMemory = "memory" ProviderNoop = "noop" )
Variables ¶
View Source
var ( // Providers provides rate limiter construction for dependency injection. Providers = wire.NewSet( ProvideRateLimiterFromConfig, ) )
Functions ¶
func RegisterRateLimiter ¶
RegisterRateLimiter registers a RateLimiter with the injector.
Types ¶
type Config ¶
type Config struct {
Provider string `env:"PROVIDER" json:"provider"`
RequestsPerSec float64 `env:"REQUESTS_PER_SEC" json:"requestsPerSecond"`
BurstSize int `env:"BURST_SIZE" json:"burstSize"`
}
Config configures rate limiting.
func (*Config) EnsureDefaults ¶
func (cfg *Config) EnsureDefaults()
EnsureDefaults sets default values for zero fields.
func (*Config) ProvideRateLimiter ¶
func (cfg *Config) ProvideRateLimiter() (RateLimiter, error)
ProvideRateLimiter returns a RateLimiter from config.
type NoopRateLimiter ¶
type NoopRateLimiter struct{}
NoopRateLimiter always allows requests.
type RateLimiter ¶
RateLimiter limits the rate of operations per key.
func NewInMemoryRateLimiter ¶
func NewInMemoryRateLimiter(requestsPerSec float64, burstSize int) RateLimiter
NewInMemoryRateLimiter returns a RateLimiter that uses per-key limiters in memory.
Example ¶
package main
import (
"context"
"fmt"
"github.com/verygoodsoftwarenotvirus/platform/v2/ratelimiting"
)
func main() {
limiter := ratelimiting.NewInMemoryRateLimiter(10.0, 5)
allowed, err := limiter.Allow(context.Background(), "user-123")
if err != nil {
panic(err)
}
fmt.Println(allowed)
}
Output: true
func NewNoopRateLimiter ¶
func NewNoopRateLimiter() RateLimiter
NewNoopRateLimiter returns a RateLimiter that never limits.
func ProvideRateLimiterFromConfig ¶
func ProvideRateLimiterFromConfig(cfg *Config) (RateLimiter, error)
ProvideRateLimiterFromConfig provides a RateLimiter from config.
Source Files
Click to show internal directories.
Click to hide internal directories.