---
id: "envoy-ratelimit"
type: "component"
kind: "rate-limiter"
provider: "default"
category: "edge"
docs: "https://github.com/envoyproxy/ratelimit"
url: "https://localhost:3000/catalogue/components/envoy-ratelimit"
---

# Envoy rate limit service

Envoy's global rate limit service backed by Redis.

| | |
|---|---|
| Provider | [default](https://localhost:3000/catalogue?provider=default) |
| Kind | [Rate limiter](https://localhost:3000/catalogue/kinds/rate-limiter) |
| Category | Edge |
| Official docs | [https://github.com/envoyproxy/ratelimit](https://github.com/envoyproxy/ratelimit) |

## Properties

| 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` (advanced) | 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 |

Bold values are the ones this component pins.

## Rules that apply · 0

No rule selects this kind or its category.

## Other products of the same kind · 6

- [Cloudflare Rate Limiting](https://localhost:3000/catalogue/components/cloudflare-rate-limiting.md) `cloudflare-rate-limiting` — cloudflare
- [Cloudflare Waiting Room](https://localhost:3000/catalogue/components/cloudflare-waiting-room.md) `cloudflare-waiting-room` — cloudflare
- [In-process rate limiter](https://localhost:3000/catalogue/components/in-process-limiter.md) `in-process-limiter` — default
- [NGINX limit_req](https://localhost:3000/catalogue/components/nginx-limit-req.md) `nginx-limit-req` — default
- [Generic rate limiter](https://localhost:3000/catalogue/components/rate-limiter.md) `rate-limiter` — default
- [Redis rate limiter](https://localhost:3000/catalogue/components/redis-rate-limiter.md) `redis-rate-limiter` — default

## Use it in a design

```yaml
nodes:
  - { id: "envoy-ratelimit", component: "envoy-ratelimit" }
```

## Source (`component` YAML, verbatim)

```yaml
# 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"
```

Human page: https://localhost:3000/catalogue/components/envoy-ratelimit