docs: Update nightly WAL documentation for bounded Kafka requests by Copilot · Pull Request #2837 · GreptimeTeam/docs

Copilot · 2026-09-08T13:21:51Z

What changed

Documented Kafka WAL’s default total request timeout as 5s.
Clarified that the timeout covers the complete Kafka request.
Added greptime_logstore_op_elapsed_bucket and documented latency buckets extending through 60 seconds.

Example:

[wal]
connect_timeout = "3s"
timeout = "5s"

Scope

Documentation versions: Nightly
Languages: English, Chinese

Verification

Reviewed changes against GreptimeDB PR #9026.
Updated corresponding English and Chinese pages.

Checklist

I verified the content against the applicable GreptimeDB version.
I updated the relevant documentation versions and languages, or explained why not.
I checked changed links and anchors.
I updated navigation when the document structure changed.

Fixes Update docs for fix(wal): bound Kafka requests and extend latency buckets #2822

Co-authored-by: WenyXu <32535939+WenyXu@users.noreply.github.com>

cloudflare-workers-and-pages · 2026-09-08T13:31:24Z

Deploying greptime-docs with Cloudflare Pages

Latest commit:	`7ab2558`
Status:	✅ Deploy successful!
Preview URL:	https://06bd301c.greptime-docs.pages.dev
Branch Preview URL:	https://copilot-update-nightly-zh-an.greptime-docs.pages.dev

View logs

chatgpt-codex-connector · 2026-09-09T06:16:53Z

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review	Status	Commit	Review trigger
📝 Code Review	✅ Completed 2026-09-09T06:21:11.352808Z	`38723b6`	Draft marked ready

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

Copilot

🟡 Changes recommended

The updated timeout wording does not yet explicitly clarify that the deadline covers the full Kafka request lifecycle (send + response wait), which is the key semantic change being documented.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Updates nightly WAL documentation (English + Chinese) to reflect the Kafka remote WAL change that bounds requests with a 5s default total request timeout, and adds the related log-store latency histogram metric guidance.

Changes:

Updated Kafka remote WAL timeout default from "3s" to "5s" and renamed the description to “total request timeout”.
Updated the global wal.timeout configuration docs to match the new "5s" default and wording.
Added greptime_logstore_op_elapsed_bucket to performance tuning metrics, noting buckets extend through 60 seconds.

File summaries

File	Description
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/wal/remote-wal/configuration.md	Chinese Remote WAL config: update timeout default and wording.
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/performance-tuning/performance-tuning-tips.md	Chinese performance metrics: add log-store latency histogram entry.
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/configuration.md	Chinese global config: update `wal.timeout` default and wording.
docs/user-guide/deployments-administration/wal/remote-wal/configuration.md	English Remote WAL config: update timeout default and wording.
docs/user-guide/deployments-administration/performance-tuning/performance-tuning-tips.md	English performance metrics: add log-store latency histogram entry.
docs/user-guide/deployments-administration/configuration.md	English global config: update `wal.timeout` default and wording.

Review details

Suppressed comments (2)

docs/user-guide/deployments-administration/configuration.md:1010

The wal.timeout table description should explicitly state that the timeout covers the entire request lifecycle (send + response wait), not just “operations”, to match the actual semantics change from GreptimeDB PR #9026.

| `wal.timeout`                                 | String  | `5s`                         | The total request timeout for kafka client.<br/>**It's only used when the provider is `kafka`**.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |

i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/configuration.md:997

wal.timeout 的表格说明建议明确该超时覆盖完整的 Kafka 请求（发送请求帧与等待响应），与实现语义一致，减少用户将其误解为仅等待响应或单个操作超时。

| `wal.timeout`                                 | String  | `5s`                 | kafka 客户端的总请求超时时间。<br/>**仅在 provider 为 `kafka` 时使用。**                                                                   |

Files reviewed: 6/6 changed files
Comments generated: 4
Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

killme2008 · 2026-09-09T09:20:32Z

@WenyXu Take a look.

fengjiachun · 2026-09-10T09:47:43Z

 | `overwrite_entry_start_id` | If true, the Datanode will skip over missing entries during WAL replay. Prevents out-of-range errors, but may hide data loss. |
 | `connect_timeout`          | The connect timeout for Kafka client. Default is `"3s"`.                                                                      |
-| `timeout`                  | The timeout for Kafka client operations. Default is `"3s"`.                                                                   |
+| `timeout`                  | The total request timeout for the Kafka client. Default is `"5s"`.                                                            |


GreptimeDB PR 9026 also adds connect_timeout and timeout to metasrv.example.toml and to the Metasrv section of config/config.md, and Metasrv's topic creator uses them for its Kafka client. The Metasrv Configuration section above (example and Options table) still lists neither key, so readers tuning Metasrv from this page miss the new 5s default. Consider adding both rows there as well, and the same on the Chinese page.

fengjiachun · 2026-09-10T09:47:43Z

 | greptime_mito_write_stall_total              | counter   | The total number of write requests stalled due to high memory pressure or transient region states.        |
 | greptime_mito_write_reject_total             | counter   | The number of write requests rejected due to high memory pressure.                                         |
 | raft_engine_sync_log_duration_seconds_bucket | histogram | The elapsed time of flushing the WAL to the disk.                                                         |
+| greptime_logstore_op_elapsed_bucket          | histogram | The elapsed time of log-store operations. Finite latency buckets extend through 60 seconds.                 |


"Finite latency buckets extend through 60 seconds" describes the histogram's bucket layout, which no other row in this table does, and it doesn't say what the metric measures. Suggestion:

Suggested change

| greptime_logstore_op_elapsed_bucket | histogram | The elapsed time of log-store operations. Finite latency buckets extend through 60 seconds. |

| greptime_logstore_op_elapsed_bucket | histogram | The elapsed time of WAL log store operations, such as Kafka appends. Use the `logstore` and `optype` labels to separate stores and operation types. |

The Chinese row (有限延迟桶扩展至 60 秒) reads as a literal translation and should be adjusted to match.

WenyXu · 2026-09-10T11:32:18Z

@copilot address comments

Co-authored-by: WenyXu <32535939+WenyXu@users.noreply.github.com>

Copilot · 2026-09-10T11:42:45Z

@copilot address comments

Addressed in 7ab2558.

fengjiachun

LGTM

Initial plan

54ef468

Copilot AI assigned Copilot and WenyXu Sep 8, 2026

Copilot started work on behalf of WenyXu September 8, 2026 13:22 View session

Copilot AI linked an issue Sep 8, 2026 that may be closed by this pull request

Update docs for fix(wal): bound Kafka requests and extend latency buckets #2822

Open

Update nightly WAL configuration docs

38723b6

Co-authored-by: WenyXu <32535939+WenyXu@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Update docs for bound Kafka requests and extend latency buckets~~ Update nightly WAL documentation for bounded Kafka requests Sep 8, 2026

Copilot finished work on behalf of WenyXu September 8, 2026 13:31

Copilot AI requested a review from WenyXu September 8, 2026 13:31

WenyXu marked this pull request as ready for review September 9, 2026 06:16

WenyXu requested review from fengjiachun and killme2008 as code owners September 9, 2026 06:16

Copilot AI lite review requested due to automatic review settings September 9, 2026 06:16

Copilot started reviewing on behalf of WenyXu September 9, 2026 06:17 View session

WenyXu changed the title ~~Update nightly WAL documentation for bounded Kafka requests~~ docs: Update nightly WAL documentation for bounded Kafka requests Sep 9, 2026

Copilot AI reviewed Sep 9, 2026

View reviewed changes

WenyXu approved these changes Sep 9, 2026

View reviewed changes

fengjiachun reviewed Sep 10, 2026

View reviewed changes

Copilot started work on behalf of WenyXu September 10, 2026 11:32 View session

docs: clarify Kafka WAL request timeout scope

7ab2558

Co-authored-by: WenyXu <32535939+WenyXu@users.noreply.github.com>

Copilot finished work on behalf of WenyXu September 10, 2026 11:43

Copilot AI requested a review from WenyXu September 10, 2026 11:43

fengjiachun approved these changes Sep 10, 2026

View reviewed changes

Navigation Menu

Uh oh!

docs: Update nightly WAL documentation for bounded Kafka requests - #2837

docs: Update nightly WAL documentation for bounded Kafka requests#2837
WenyXu with Copilot wants to merge 3 commits into
mainfrom
copilot/update-nightly-zh-and-en-version

Copilot AI commented Sep 8, 2026 •

edited

Loading

Uh oh!

cloudflare-workers-and-pages Bot commented Sep 8, 2026 •

edited

Loading

Uh oh!

chatgpt-codex-connector Bot commented Sep 9, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

killme2008 commented Sep 9, 2026

Uh oh!

fengjiachun Sep 10, 2026

Uh oh!

fengjiachun Sep 10, 2026

Uh oh!

WenyXu commented Sep 10, 2026

Uh oh!

Copilot AI commented Sep 10, 2026

Uh oh!

fengjiachun left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

	\| greptime_logstore_op_elapsed_bucket \| histogram \| The elapsed time of log-store operations. Finite latency buckets extend through 60 seconds. \|
	\| greptime_logstore_op_elapsed_bucket \| histogram \| The elapsed time of WAL log store operations, such as Kafka appends. Use the `logstore` and `optype` labels to separate stores and operation types. \|

Uh oh!

Conversation

Copilot AI commented Sep 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changed

Scope

Verification

Checklist

Uh oh!

cloudflare-workers-and-pages Bot commented Sep 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying greptime-docs with Cloudflare Pages

Uh oh!

chatgpt-codex-connector Bot commented Sep 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codex Review Summary

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Suppressed comments (2)

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

killme2008 commented Sep 9, 2026

Uh oh!

fengjiachun Sep 10, 2026

Choose a reason for hiding this comment

Uh oh!

fengjiachun Sep 10, 2026

Choose a reason for hiding this comment

Uh oh!

WenyXu commented Sep 10, 2026

Uh oh!

Copilot AI commented Sep 10, 2026

Uh oh!

fengjiachun left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Copilot AI commented Sep 8, 2026 •

edited

Loading

cloudflare-workers-and-pages Bot commented Sep 8, 2026 •

edited

Loading

chatgpt-codex-connector Bot commented Sep 9, 2026 •

edited

Loading