docs: fix prometheus plugin documentation#13275
Open
Yilialinn wants to merge 4 commits intoapache:masterfrom
Open
docs: fix prometheus plugin documentation#13275Yilialinn wants to merge 4 commits intoapache:masterfrom
Yilialinn wants to merge 4 commits intoapache:masterfrom
Conversation
- Fix prefer_name attribute Required field (blank → False) and Default value (False → false) in EN and ZH - Add CPU caution note to 'Expose Metrics on Public API' section (EN+ZH) - Fix broken code examples: restore missing uri field in route creation and missing id field in stream_route creation (EN) - Add missing id field in stream_route creation example (ZH) - Fix internal link to public-api plugin (../../.. → ./) in EN+ZH - Translate mixed-language LLM metrics label section headers to ZH
dosubot
Bot
added
size:M
There was a problem hiding this comment.
Pull request overview
Updates Prometheus plugin documentation (EN/ZH) to correct schema metadata, fix internal links and JSON examples, and add guidance about CPU impact when exposing metrics via the public listener.
Changes:
- Correct
prefer_nameattribute table fields (Required/Default) in EN and ZH. - Fix broken documentation links and route/stream route example payloads (missing
uri/id). - Add a CPU caution note to the “Expose APISIX Metrics on Public API Endpoint” section (EN/ZH).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/en/latest/plugins/prometheus.md | Fixes prefer_name table fields, adds caution note, corrects public-api link, and repairs example payloads (uri/id). |
| docs/zh/latest/plugins/prometheus.md | Fixes prefer_name default formatting, translates LLM metrics label headings, adds caution note, corrects public-api link, and adds missing stream route id. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
kayx23
approved these changes
Apr 23, 2026
shreemaan-abhishek
approved these changes
Apr 24, 2026
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
prefer_nameattributeRequiredfield (blank →False) andDefaultvalue (False→false) in EN and ZHpublic-apiPlugin (EN + ZH)"uri"field in the "Add Extra Labels" route creation and missing"id"field in the "Monitor TCP/UDP" stream route creation (EN)"id"field in stream route creation example (ZH)public-apiplugin (../../../en/latest/plugins/public-api.md→./public-api.md) in EN and ZH