ratelimit

package

v0.1.2 Latest Latest Go to latest Published: Apr 30, 2021 License: Apache-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

Client can connect to gubernator and get rate limits.

func NewClient(reg prometheus.Registerer) *Client

NewClient creates a new gubernator client with default configuration.

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

Dial connects the client to gubernator.

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 struct {
	Tenant  string
	Matcher *regexp.Regexp
	Limit   int
	Window  time.Duration
}

Config configures a rate limiter per endpoint, per tenant.

type Middleware func(http.Handler) http.Handler

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

func WithLocalRateLimiter(configs ...Config) Middleware

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

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.

Path	Synopsis
gubernator