Skip to content

docs(limit-count): correct when the delayed-sync snapshot is refreshed - #14017

Open
nic-6443 wants to merge 2 commits into
apache:masterfrom
nic-6443:docs/rate-limiting-info-snapshot-refresh
Open

nic-6443 wants to merge 2 commits into
apache:masterfrom
nic-6443:docs/rate-limiting-info-snapshot-refresh

Conversation

@nic-6443

@nic-6443 nic-6443 commented Oct 8, 2026

Copy link
Copy Markdown
Member

The $rate_limiting_info section added in #13996 says the delayed-sync snapshot is only refreshed after its window has ended. That's wrong. sync_key replaces it through sync_to_shm on every periodic synchronization, which runs within sync_interval after a request (since #14015 also when there is no local delta), and the snapshot is refreshed again when it expires at the end of its window.

This corrects the sentence in en and zh. What it was explaining still holds: a request that arrives after a window boundary but before the next synchronization is still checked against the previous snapshot, so its evaluated_at_ms can briefly be later than current_window.end_ms.

  • I have explained the need for this PR and the problem it solves
  • I have explained the changes or the new features added to this PR
  • I have added tests corresponding to this change
  • I have updated the documentation to reflect this change
  • I have verified that this change is backward compatible

Copilot AI balanced review requested due to automatic review settings October 8, 2026 10:19

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Warning

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Copilot review overview

2 open findings
What changed in this PR

Corrects the limit-count plugin documentation to accurately describe when the delayed-sync snapshot is refreshed, clarifying timing around synchronization vs. window expiration in both English and Chinese docs.

Changes:

  • Update English docs to state the snapshot is replaced on each periodic synchronization, and also refreshed on window expiry.
  • Update Chinese docs with the same corrected explanation.
File Description
docs/​en/​latest/​plugins/​limit-count.md Fixes the delayed-sync snapshot refresh explanation (English).
docs/​zh/​latest/​plugins/​limit-count.md Mirrors the same corrected explanation (Chinese).

🧠 Review effort: Lite


Give feedback about Copilot approvals in this survey to enter a drawing for a $150 gift card.

Comment thread docs/en/latest/plugins/limit-count.md Outdated
Comment thread docs/zh/latest/plugins/limit-count.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants