Documentation
¶
Overview ¶
Package ratelimit limits how often each client can call a Tern app:
ternApp(kit.WithPlugins(ratelimit.New(ratelimit.Rate(10, time.Minute))))
Each client gets a token bucket: up to Burst requests at once, refilled at the given rate. By default only state-changing requests (POST, PUT, PATCH, DELETE), such as form actions and API writes, are limited. A client over the limit gets 429 Too Many Requests with Retry-After.
Clients are identified by their IP address from kit.ClientIP. Behind a reverse proxy, configure the app with kit.WithTrustedProxies.
Since v1.16 kit limits state-changing requests without the plugin, to 120 a minute in bursts of 60 (ADR 0027); adding the plugin replaces that limit with its own.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Option ¶
type Option func(*Plugin)
Option configures the plugin.
func KeyFunc ¶
KeyFunc identifies the client for a request. The default is kit.ClientIP. Return "" to exempt a request.
Source Files