docs: update http-logger, rocketmq-logger, and syslog plugin docs#13272
Merged
Baoyuantop merged 19 commits intoApr 28, 2026
Merged
Conversation
dosubot
Bot
added
size:XXL
There was a problem hiding this comment.
Pull request overview
Updates logging plugin documentation (EN/ZH) to align with API7 docs by adding canonical links, refreshing attributes tables (types/defaults/descriptions), and expanding Admin API examples while removing legacy “delete plugin” sections.
Changes:
- Added canonical links to API7 Hub pages for multiple plugin docs.
- Restructured and expanded attributes/metadata sections (including batch-processor-related attributes and body-size limits where applicable).
- Replaced and expanded example sections with complete Admin API walkthroughs (routes + plugin metadata).
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/zh/latest/plugins/syslog.md | Canonical link + rewritten description, updated attribute tables, and expanded examples for syslog. |
| docs/zh/latest/plugins/splunk-hec-logging.md | Canonical link + updated attributes/metadata + expanded Splunk setup and usage examples. |
| docs/zh/latest/plugins/rocketmq-logger.md | Canonical link + updated attributes/metadata + expanded RocketMQ docker-compose and usage examples. |
| docs/zh/latest/plugins/http-logger.md | Canonical link + updated attributes/metadata + expanded mockbin-based examples. |
| docs/zh/latest/plugins/google-cloud-logging.md | Canonical link + updated attributes/metadata + expanded auth_config/auth_file examples. |
| docs/zh/latest/plugins/clickhouse-logger.md | Canonical link + updated attributes/metadata + expanded ClickHouse setup and examples. |
| docs/en/latest/plugins/syslog.md | Canonical link + rewritten description, updated attribute tables, and expanded examples for syslog. |
| docs/en/latest/plugins/splunk-hec-logging.md | Canonical link + updated attributes/metadata + expanded Splunk setup and usage examples. |
| docs/en/latest/plugins/rocketmq-logger.md | Canonical link + updated attributes/metadata + expanded RocketMQ docker-compose and usage examples. |
| docs/en/latest/plugins/http-logger.md | Canonical link + updated attributes/metadata + expanded mockbin-based examples. |
| docs/en/latest/plugins/google-cloud-logging.md | Canonical link + updated attributes/metadata + expanded auth_config/auth_file examples. |
| docs/en/latest/plugins/clickhouse-logger.md | Canonical link + updated attributes/metadata + expanded ClickHouse setup and examples. |
💡 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>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…oud-logging, splunk-hec-logging)
kayx23
reviewed
Apr 24, 2026
| | include_req_body_expr | array | False | | | An array of one or more conditions in the form of [lua-resty-expr](https://github.com/api7/lua-resty-expr) expressions. Used when `include_req_body` is true. Request body is only logged when the expressions configured here evaluate to true. | | ||
| | include_resp_body | boolean | False | false | | If true, include the response body in the log. | | ||
| | include_resp_body_expr | array | False | | | An array of one or more conditions in the form of [lua-resty-expr](https://github.com/api7/lua-resty-expr) expressions. Used when `include_resp_body` is true. Response body is only logged when the expressions configured here evaluate to true. | | ||
| | max_req_body_bytes | integer | False | 524288 | greater than or equal to 1 | Maximum request body size in bytes to include in the log. If the request body exceeds this value, it will be truncated. Available in APISIX from 3.16.0. | |
Member
There was a problem hiding this comment.
The default for max_retry_count is documented as 60, but the batch-processor schema (apisix/utils/batch-processor.lua) defines the default as 0, and the rocketmq-logger schema does not override it. Please correct this to 0.
kayx23
reviewed
Apr 26, 2026
kayx23
approved these changes
Apr 27, 2026
guoqqqi
approved these changes
Apr 28, 2026
Baoyuantop
approved these changes
Apr 28, 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
Update
http-logger,rocketmq-logger, andsyslogplugin docs:batch_max_size,inactive_timeout,buffer_duration,retry_delay,max_retry_count) to rocketmq-logger and syslog attribute tablesmax_req_body_bytesandmax_resp_body_bytesto syslog attribute tableADMIN_API_KEYwithadmin_keyin all examplesBoth EN and ZH docs updated.