Skip to content

docs: update error-log-logger and datadog plugin docs#13270

Merged
Yilialinn merged 23 commits into
apache:masterfrom
Yilialinn:docs/update-error-log-logger-datadog
Apr 28, 2026
Merged

docs: update error-log-logger and datadog plugin docs#13270
Yilialinn merged 23 commits into
apache:masterfrom
Yilialinn:docs/update-error-log-logger-datadog

Conversation

@Yilialinn
Copy link
Copy Markdown
Contributor

Summary

  • Update error-log-logger plugin doc: add canonical link, restructure attributes table with parent attributes, add examples section (TCP/SkyWalking/ClickHouse/Kafka), remove Delete Plugin section
  • Update datadog plugin doc: add canonical link, add Metrics and Tags tables, add examples section, update attributes table with batch processor fields, remove Delete Plugin section

Both EN and ZH docs updated.

@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:37
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 documentation for the error-log-logger and datadog plugins (English + Chinese), aligning the pages with the “hub” canonical URLs and expanding the configuration/explanation sections.

Changes:

  • Added canonical links and refreshed plugin descriptions/front matter.
  • Restructured configuration sections (attributes/metadata) and added richer usage examples.
  • Updated exported metrics/tags documentation for the Datadog plugin and removed “Delete Plugin” sections.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 18 comments.

File Description
docs/en/latest/plugins/error-log-logger.md Adds canonical link, rewrites description and metadata table, and adds TCP/SkyWalking/ClickHouse/Kafka examples.
docs/zh/latest/plugins/error-log-logger.md Same as EN, with updated Chinese description, metadata table, and examples.
docs/en/latest/plugins/datadog.md Adds canonical link, reworks attributes/metadata, adds Metrics/Tags tables and examples.
docs/zh/latest/plugins/datadog.md Same as EN, with updated Chinese structure and examples.

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

Comment thread docs/zh/latest/plugins/error-log-logger.md Outdated
Comment thread docs/zh/latest/plugins/error-log-logger.md Outdated
Comment thread docs/zh/latest/plugins/error-log-logger.md Outdated
Comment thread docs/en/latest/plugins/datadog.md Outdated
Comment thread docs/en/latest/plugins/error-log-logger.md Outdated
Comment thread docs/en/latest/plugins/error-log-logger.md Outdated
Comment thread docs/en/latest/plugins/error-log-logger.md Outdated
Comment thread docs/en/latest/plugins/error-log-logger.md Outdated
Comment thread docs/zh/latest/plugins/error-log-logger.md Outdated
Comment thread docs/zh/latest/plugins/datadog.md Outdated
Yilialinn and others added 10 commits April 22, 2026 15:19
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>
@dosubot dosubot Bot added size:XXL This PR changes 1000+ lines, ignoring generated files. and removed size:XL This PR changes 500-999 lines, ignoring generated files. labels Apr 22, 2026
Yilialinn and others added 7 commits April 22, 2026 15:42
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 22, 2026 08:09
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 Chinese datadog attributes table currently lists max_retry_count default as 60, but this setting comes from the batch processor wrapper and the actual default in apisix/utils/batch-processor.lua is 0. Could you update this value to avoid documenting a different retry policy than the code uses?

@Yilialinn Yilialinn requested a review from kayx23 April 23, 2026 09:17
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 earlier datadog default issue looks fixed now, but the newer elasticsearch-logger docs seem to introduce a different docs/code mismatch: they document field.type and add it to example configs, while apisix/plugins/elasticsearch-logger.lua only defines field.index in the schema and does not accept a user-configurable field.type. The implementation only sets _type = "_doc" internally for ES 5/6 compatibility. Could you remove field.type from the docs/examples unless support is added in the plugin schema?

@Yilialinn Yilialinn requested a review from kayx23 April 24, 2026 01:44
Comment thread docs/en/latest/plugins/elasticsearch-logger.md Outdated
Comment thread docs/zh/latest/plugins/elasticsearch-logger.md Outdated
…er, and datadog

- elasticsearch-logger EN+ZH: remove invalid field.type from all plugin config examples
- error-log-logger EN: fix CREATE TABLE DDL — move ENGINE before ORDER BY
- error-log-logger EN: fix frontmatter description grammar
- datadog ZH: fix batch_max_size description from log entries to metric entries
@Yilialinn Yilialinn requested a review from kayx23 April 27, 2026 02:12
kayx23
kayx23 previously approved these changes Apr 27, 2026
guoqqqi
guoqqqi previously approved these changes Apr 28, 2026
Baoyuantop
Baoyuantop previously approved these changes Apr 28, 2026
@Yilialinn Yilialinn dismissed stale reviews from Baoyuantop, guoqqqi, and kayx23 via 9749339 April 28, 2026 08:12
@Yilialinn Yilialinn merged commit aaabee1 into apache:master Apr 28, 2026
7 checks passed
@Yilialinn Yilialinn deleted the docs/update-error-log-logger-datadog branch April 28, 2026 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation things size:XXL This PR changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants