docs: align plugin references with current behavior - #13864
Open
Yilialinn wants to merge 2 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Updates English and Chinese plugin documentation to better reflect current runtime behavior.
Changes:
- Corrects
proxy-rewriteexamples. - Expands Prometheus metric and label documentation.
- Clarifies
limit-countrules, headers, synchronization, and Redis defaults.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
docs/en/latest/plugins/proxy-rewrite.md |
Corrects English rewrite and header examples. |
docs/zh/latest/plugins/proxy-rewrite.md |
Mirrors proxy-rewrite corrections in Chinese. |
docs/en/latest/plugins/prometheus.md |
Expands English metrics documentation. |
docs/zh/latest/plugins/prometheus.md |
Expands Chinese metrics documentation. |
docs/en/latest/plugins/limit-count.md |
Clarifies English rate-limit behavior. |
docs/zh/latest/plugins/limit-count.md |
Mirrors limit-count clarifications in Chinese. |
Suppressed comments (4)
docs/en/latest/plugins/limit-count.md:65
- This requirement applies only to the numeric top-level
time_window. Numericrules.time_windowvalues are not rejected when they are less than or equal tosync_interval; the runtime takes the same direct-synchronization fallback as it does for resolved dynamic values. As written, valid rules-mode configurations are documented as invalid.
| sync_interval | number | False | -1 | -1 or >= 0.1 | The delayed synchronization interval in seconds for Redis-based policies. Set to `-1` to synchronize on every request. A positive value must be smaller than a numeric `time_window`; if a dynamic `time_window` resolves to a value less than or equal to `sync_interval`, APISIX synchronizes that request directly. |
docs/zh/latest/plugins/limit-count.md:66
- 该限制只适用于顶层的数值型
time_window。当数值型rules.time_window小于或等于sync_interval时,配置不会被拒绝;运行时会像动态值一样回退为直接同步。当前表述会把有效的规则模式配置描述为无效。
| sync_interval | number | 否 | -1 | -1 或 >= 0.1 | Redis 类策略的延迟同步间隔,单位为秒。设置为 `-1` 时,每个请求都会与 Redis 同步。正数值必须小于数值型 `time_window`;如果动态 `time_window` 解析后的值小于或等于 `sync_interval`,APISIX 会对该请求直接同步。 |
docs/en/latest/plugins/prometheus.md:134
- This gauge does not currently remain an active-connection count when
ai-proxy-multifalls back. Every retry re-enters the loop and increments atapisix/plugins/ai-proxy/base.lua:498, whileapisix/plugins/ai-proxy-multi.lua:1053-1055decrements only once in log phase. A failed instance's labeled series therefore stays positive indefinitely with the default non-expiring metrics, so the documented meaning is inaccurate until per-attempt tracking is balanced.
| apisix_llm_active_connections | gauge | Number of active connections to LLM services. |
docs/zh/latest/plugins/prometheus.md:134
- 当
ai-proxy-multi回退重试时,该 gauge 目前无法持续表示活跃连接数。每次重试都会重新进入循环并在apisix/plugins/ai-proxy/base.lua:498递增,但apisix/plugins/ai-proxy-multi.lua:1053-1055在日志阶段只递减一次。因此失败实例对应的标签序列会在默认永不过期的指标中永久保持正值;在按尝试配平计数前,这里的语义并不准确。
| apisix_llm_active_connections | gauge | 到 LLM 服务的活跃连接数。 |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
proxy-rewriteregex, curl, and request-header examples in English and Chineselimit-countrule conflicts, unique rule keys, quota headers, delayed synchronization fallback, and Redis Sentinel keepalive defaultsValidation
markdownlint-cli@0.25.0on all six changed documentsgit diff --checkScope
This is a documentation-only change. It does not modify plugin behavior, public APIs, titles, descriptions, URLs, or canonical mappings. Plugin documentation continues to use the existing API7 canonical targets.