feat: update failure detector document #2148
Merged
+40
−40
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.
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
failure_detector.first_heartbeat_estimate
option from all documentation files as this parameter is no longer used in the refined implementationEnhanced 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 protectionfailure_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 pausesAdded 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
Screenshot
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
node install.mjs
(dns block)https://storage.googleapis.com/chrome-for-testing-public/137.0.7151.119/linux64/chrome-headless-shell-linux64.zip
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
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.