Skip to content

docs(rate-limiting): document sync_rate realtime fallback for short periods #7400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
rajtherengan wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs(rate-limiting): document sync_rate realtime fallback for short periods #7400

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions app/_kong_plugins/rate-limiting/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@

{% include_cached /plugins/rate-limiting/strategies.md name=page.name %}

### Short limit periods and sync_rate

Check failure on line 84 in app/_kong_plugins/rate-limiting/index.md

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[docs.Spelling] Did you really mean 'sync_rate'?

Raw Output:
{"message": "[docs.Spelling] Did you really mean 'sync_rate'?", "location": {"path": "app/_kong_plugins/rate-limiting/index.md", "range": {"start": {"line": 84, "column": 29}}}, "severity": "ERROR"}

When using the `redis` policy, if [`config.sync_rate`](/plugins/rate-limiting/reference/#schema--config-sync-rate) is greater than or equal to the length of a limited period (for example, `sync_rate: 1` with a `second` limit), counters for that period can't be synced before the window closes. Starting in {{site.base_gateway}} 3.X, such periods are synced to Redis on every request, as if `sync_rate` were `-1`, and {{site.base_gateway}} logs a warning. Longer periods continue to sync at `sync_rate`. To keep batched syncing for every period, set `sync_rate` lower than your shortest limited period.

### Using cloud authentication with Redis {% new_in 3.13 %}

{% include_cached /plugins/redis/redis-cloud-auth.md tier=page.tier %}
Expand Down
Loading