ratelimit

Documentation

Index

• type Client
  • func NewClient(reg prometheus.Registerer) *Client
  • func (c *Client) Dial(ctx context.Context, address string) error
  • func (c *Client) GetRateLimits(ctx context.Context, req *request) (remaining, resetTime int64, err error)
• type Config
• type Middleware
  • func WithLocalRateLimiter(configs ...Config) Middleware
  • func WithSharedRateLimiter(logger log.Logger, client *Client, configs ...Config) Middleware

Types

type Client

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

Client can connect to gubernator and get rate limits.

func NewClient

func NewClient(reg prometheus.Registerer) *Client

NewClient creates a new gubernator client with default configuration.

func (*Client) Dial

func (c *Client) Dial(ctx context.Context, address string) error

Dial connects the client to gubernator.

func (*Client) GetRateLimits

func (c *Client) GetRateLimits(ctx context.Context, req *request) (remaining, resetTime int64, err error)

GetRateLimits gets the rate limits corresponding to a request. Note: Dial must be called before calling this method, otherwise the client will panic.

type Config

type Config struct {
	Tenant  string
	Matcher *regexp.Regexp
	Limit   int
	Window  time.Duration
}

Config configures a rate limiter per endpoint, per tenant.

type Middleware

type Middleware func(http.Handler) http.Handler

Middleware is a convenience type for functions that wrap http.Handlers.

func WithLocalRateLimiter

func WithLocalRateLimiter(configs ...Config) Middleware

WithLocalRateLimiter returns a middleware that controls the amount of requests per tenant using an in-memory store.

func WithSharedRateLimiter

func WithSharedRateLimiter(logger log.Logger, client *Client, configs ...Config) Middleware

WithSharedRateLimiter returns a middleware that controls the amount of requests per tenant using an external service.