Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Sep 25, 2025

This PR updates the failure detector documentation across all language versions to reflect the changes introduced in GreptimeDB PR #7005, which refined the failure detector implementation.

Changes Made

Removed Deprecated Configuration

  • Removed failure_detector.first_heartbeat_estimate option from all documentation files as this parameter is no longer used in the refined implementation

Enhanced Parameter Descriptions

Updated the descriptions for all remaining failure detector parameters to provide more technical detail and context:

  • failure_detector.threshold: Now explains this is the maximum acceptable φ (phi) value before a peer is treated as failed, with guidance on tuning (lower values react faster but yield more false positives)
  • failure_detector.min_std_deviation: Clarified this prevents φ from exploding due to tiny variations in heartbeat intervals, providing hypersensitivity protection
  • failure_detector.acceptable_heartbeat_pause: Enhanced description explains this provides additional grace period to the learned mean interval before φ rises, helping absorb temporary network hiccups or GC pauses

Added Algorithm Context

Added explanatory comments in both English and Chinese documentation indicating that GreptimeDB uses the Phi Accrual Failure Detector algorithm to detect datanode failures, providing users with important context about the underlying mechanism.

Files Updated

  • Current English documentation
  • Version 0.17 English documentation
  • Current Chinese documentation (中文文档)
  • Version 0.17 Chinese documentation (v0.17 中文文档)

Screenshot

Updated failure detector documentation showing refined parameter descriptions and algorithm context

The documentation now accurately reflects the current implementation and provides users with better understanding of how to configure the failure detection mechanism effectively.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • googlechromelabs.github.io
    • Triggering command: node install.mjs (dns block)
  • https://storage.googleapis.com/chrome-for-testing-public/137.0.7151.119/linux64/chrome-headless-shell-linux64.zip
    • Triggering command: node install.mjs (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>Update docs for feat: refine failure detector</issue_title>
<issue_description>A document change request is generated from GreptimeTeam/greptimedb#7005</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #2138

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copy link

cloudflare-workers-and-pages bot commented Sep 25, 2025

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: ebbcd55
Status: ✅  Deploy successful!
Preview URL: https://a6780c7e.greptime-docs.pages.dev
Branch Preview URL: https://copilot-fix-76f64fc2-953f-45.greptime-docs.pages.dev

View logs

@Copilot Copilot AI changed the title [WIP] Update docs for feat: refine failure detector Update failure detector documentation to reflect algorithm refinements Sep 25, 2025
@Copilot Copilot AI requested a review from waynexia September 25, 2025 18:56
Copilot finished work on behalf of waynexia September 25, 2025 18:56
@waynexia waynexia marked this pull request as ready for review September 25, 2025 19:00
@waynexia waynexia changed the title Update failure detector documentation to reflect algorithm refinements feat: update failure detector document Sep 25, 2025
Copy link
Collaborator

@nicecui nicecui left a comment

Choose a reason for hiding this comment

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

Does the content need to be applied to 0.17?

Copy link
Contributor

@fengjiachun fengjiachun left a comment

Choose a reason for hiding this comment

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

LGTM

@fengjiachun
Copy link
Contributor

Does the content need to be applied to 0.17?

No, because the options we changed have not been included in v0.17.

@fengjiachun fengjiachun merged commit c95d532 into main Sep 29, 2025
8 of 13 checks passed
@fengjiachun fengjiachun deleted the copilot/fix-76f64fc2-953f-450f-8bb5-3679b5e9fbe8 branch September 29, 2025 02:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update docs for feat: refine failure detector
4 participants