Envoy rate limit service
Rate limiterenvoy-ratelimit
Envoy's global rate limit service backed by Redis.
- Provider
- default
- Kind
- Rate limiter
- Category
- Edge
- Official docs
- https://github.com/envoyproxy/ratelimit
| property | type | values | required | kind default | this component |
|---|---|---|---|---|---|
| algorithm | enum | token-bucket | leaky-bucket | sliding-window | fixed-window | adaptive | no | token-bucket | ▸ fixed-window |
| atomicOps | boolean | — | no | true | inherited |
| backend | enum | redis | memcached | no | redis | inherited |
| distributed | boolean | — | no | false | ▸ true |
| failMode | enum | open | closed | no | open | ▸ open |
| managed | boolean | — | no | false | inherited |
| placement | enum | edge | gateway | sidecar | in-process | no | gateway | ▸ gateway |
| scope | enum | global | user | ip | api-key | concurrency | no | user | inherited |
Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.
No rule reads this kind yet. That is a gap, not a guarantee.
nodes:
- { id: "envoy-ratelimit", component: "envoy-ratelimit" }# yaml-language-server: $schema=../../schema/component.schema.json # Envoy global rate limit service: fixed-window counters in Redis, called from the gateway; failure mode allows traffic. schemaVersion: "1" type: "component" id: "envoy-ratelimit" kind: "rate-limiter" provider: "default" docs: "https://github.com/envoyproxy/ratelimit" defaults: algorithm: "fixed-window" placement: "gateway" distributed: true failMode: "open" properties: backend: type: "enum" values: ["redis", "memcached"] default: "redis"