Local rate limit
Local rate limiting architecture overview
This filter should be configured with the type URL
type.googleapis.com/envoy.extensions.filters.listener.local_ratelimit.v3.LocalRateLimit.
Note
The token bucket is shared across all workers, thus the rate limits are applied per Envoy process.
Note
Global rate limiting on network layer is also supported via the global rate limit network filter.
Overview
The local rate limit filter applies a token bucket rate limit to incoming sockets that are processed by the filter’s filter chain. Each socket processed by the filter utilizes a single token, and if no tokens are available, the socket will be immediately closed without further filter iteration.
Note
In the current implementation each filter and filter chain has an independent rate limit.
Statistics
Every configured local rate limit filter has statistics rooted at listener_local_ratelimit.<stat_prefix>. with the following statistics:
Name |
Type |
Description |
|---|---|---|
rate_limited |
Counter |
Total sockets that have been closed due to rate limit exceeded |
Runtime
The local rate limit filter can be runtime feature flagged via the enabled configuration field.