docs: add gateway logs example to request-id plugin documentation#13168
Open
Yilialinn wants to merge 2 commits intoapache:masterfrom
Open
docs: add gateway logs example to request-id plugin documentation#13168Yilialinn wants to merge 2 commits intoapache:masterfrom
Yilialinn wants to merge 2 commits intoapache:masterfrom
Conversation
Add new 'Understand Request ID in Gateway Logs' section explaining the difference between Nginx built-in $request_id (plugin disabled) and plugin-generated UUID (plugin enabled), available from APISIX 3.15.0. Also update description to match upstream API7 docs, add canonical link to ZH doc, and replace ADMIN_API_KEY with admin_key variable. Ref: api7/docs#1369
dosubot
bot
added
size:L
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the request-id plugin documentation to clarify how request IDs appear in gateway logs (plugin-enabled vs disabled), align wording with upstream docs, and standardize Admin API key usage in examples.
Changes:
- Added a new section explaining request ID behavior in access/error logs (APISIX ≥ 3.15.0), with curl + log examples.
- Updated plugin description wording and standardized curl examples to use
${admin_key}. - Added a canonical link tag to the ZH doc.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/zh/latest/plugins/request-id.md | Adds canonical link, expands description, adds “gateway logs request ID” section, and updates curl examples to use ${admin_key}. |
| docs/en/latest/plugins/request-id.md | Expands description, adds “gateway logs request ID” section, and updates curl examples to use ${admin_key}. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
$request_id(when plugin is disabled) and plugin-generated UUID (when plugin is enabled), available from APISIX 3.15.0ADMIN_API_KEYwithadmin_keyvariable in all curl commandsRef: https://github.com/api7/docs/pull/1369