Skip to content

docs: update kafka-logger plugin documentation#13278

Merged
Yilialinn merged 10 commits into
apache:masterfrom
Yilialinn:docs/update-kafka-logger
Apr 30, 2026
Merged

docs: update kafka-logger plugin documentation#13278
Yilialinn merged 10 commits into
apache:masterfrom
Yilialinn:docs/update-kafka-logger

Conversation

@Yilialinn
Copy link
Copy Markdown
Contributor

Summary

  • Add canonical link to API7 docs
  • Update frontmatter description to better reflect plugin capabilities
  • Fix Required column: optionalFalse for producer_batch_num, producer_batch_size, producer_max_buffering, producer_time_linger, and meta_refresh_interval; fix brokers.port type stringinteger in ZH doc
  • Replace minimal "Enable Plugin" and "Example usage" sections with three comprehensive examples:
    1. Log in Different Meta Log Formats — includes Docker Compose setup, full route configuration, and comparison of default vs origin log output
    2. Log Request and Response Headers With Plugin Metadata — demonstrates using plugin metadata with built-in variables to capture custom request/response headers
    3. Log Request Bodies Conditionally — shows include_req_body + include_req_body_expr for conditional body logging
  • Remove "Delete Plugin" section
  • Add admin_key note block before the first Admin API curl example

- Add canonical link to API7 docs
- Update description to better reflect plugin capabilities
- Fix Required column: 'optional' → 'False' for producer_* and
  meta_refresh_interval attributes; fix brokers.port type string → integer in ZH
- Replace minimal 'Enable Plugin' and 'Example usage' sections with
  three comprehensive examples from API7 docs:
  1. Log in Different Meta Log Formats (with Docker Compose setup)
  2. Log Request and Response Headers With Plugin Metadata
  3. Log Request Bodies Conditionally
- Remove 'Delete Plugin' section
- Add admin_key note block before first Admin API curl example
@dosubot dosubot Bot added size:XL This PR changes 500-999 lines, ignoring generated files. doc Documentation things labels Apr 21, 2026
@Yilialinn Yilialinn requested a review from Copilot April 22, 2026 06:54
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the Kafka Logger plugin documentation (EN/ZH) to better describe batching + customizable log formats, align attribute tables, and provide richer end-to-end configuration examples for common logging scenarios.

Changes:

  • Add canonical links and update frontmatter descriptions in both EN and ZH docs.
  • Refresh attributes / plugin-metadata tables and add an admin_key note before Admin API examples.
  • Replace the previous minimal usage sections with three expanded, scenario-based examples (meta formats, plugin metadata headers, conditional request body logging).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.

File Description
docs/zh/latest/plugins/kafka-logger.md Updates Chinese kafka-logger docs: canonical link, revised attribute tables, and expanded examples.
docs/en/latest/plugins/kafka-logger.md Updates English kafka-logger docs: canonical link, revised attribute tables, and expanded examples.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/zh/latest/plugins/kafka-logger.md Outdated
Comment thread docs/zh/latest/plugins/kafka-logger.md Outdated
Comment thread docs/zh/latest/plugins/kafka-logger.md Outdated
Comment thread docs/en/latest/plugins/kafka-logger.md Outdated
Comment thread docs/en/latest/plugins/kafka-logger.md Outdated
Comment thread docs/en/latest/plugins/kafka-logger.md Outdated
Yilialinn and others added 7 commits April 22, 2026 18:03
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>
@Yilialinn Yilialinn requested a review from kayx23 April 23, 2026 09:18
Copy link
Copy Markdown
Member

@kayx23 kayx23 left a comment

Choose a reason for hiding this comment

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

The new Kafka examples look like they may be broken as written: they configure the plugin to send logs to kafka:29092, but the docs only show Kafka/ZooKeeper being started in a separate kafka_net Docker Compose network and do not show APISIX joining that network. Unless APISIX is also attached to kafka_net, kafka:29092 will not resolve from APISIX. Could you either document that networking prerequisite explicitly or switch the examples to an address that matches the shown setup?

@Yilialinn Yilialinn requested a review from kayx23 April 24, 2026 01:44
kayx23
kayx23 previously approved these changes Apr 24, 2026
Comment thread docs/zh/latest/plugins/kafka-logger.md Outdated
@Yilialinn Yilialinn dismissed stale reviews from shreemaan-abhishek and kayx23 via 9864506 April 29, 2026 02:04
@Yilialinn Yilialinn merged commit 5024b9a into apache:master Apr 30, 2026
10 checks passed
@Yilialinn Yilialinn deleted the docs/update-kafka-logger branch April 30, 2026 03:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation things size:XL This PR changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants