Skip to content

storelivenss: update storeliveness/doc.go with heartbeat smearing info #157792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 17, 2025
Merged

storelivenss: update storeliveness/doc.go with heartbeat smearing info #157792

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions pkg/kv/kvserver/storeliveness/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,10 @@
// process is also aided by synchronizing the sending of heartbeats across all
// stores on a given node.
//
// - Heartbeat smearing (enabled by default). The sending of heartbeats across
// all nodes is synchronized and paced to avoid goroutine spikes. See
// Configuration section for more details.
//
// 5.3. Configuration
//
// Store liveness can be enabled/disabled using the `kv.store_liveness.enabled`
Expand All @@ -213,6 +217,18 @@
// well as calls to `SupportFor` and `SupportFrom`. This is required for
// correctness.
//
// The behaviour of heartbeat sends is governed by the
// `kv.store_liveness.heartbeat_smearing.enabled` cluster setting (enabled by
// default). When enabled, heartbeat sends are distributed over a certain
// duration heartbeat (configured via the
// `kv.store_liveness.heartbeat_smearing.refresh` cluster setting), with
// messages being sent at a certain interval (configured via the
// `kv.store_liveness.heartbeat_smearing.smear` cluster setting) to avoid
// spiking the number of runnable goroutines (the per-node send queue
// processors, and the per-node gRPC connections). When disabled, heartbeat
// sends are sent immediately upon enqueueing, bypassing the smearing mechanism.
// Note: the smearing applies to both heartbeat responses and requests.
//
// Additionally, `config.go` defines tunable configuration parameters for the
// various timeouts and intervals that store liveness uses. Other intervals
// (like support duration and heartbeat interval) are defined in
Expand Down