storelivenss: update storeliveness/doc.go with heartbeat smearing info#157792
Merged
craig[bot] merged 1 commit intocockroachdb:masterfrom Nov 17, 2025
Merged
storelivenss: update storeliveness/doc.go with heartbeat smearing info#157792craig[bot] merged 1 commit intocockroachdb:masterfrom
storeliveness/doc.go with heartbeat smearing info#157792craig[bot] merged 1 commit intocockroachdb:masterfrom
Conversation
|
It looks like your PR touches production code but doesn't add or edit any test code. Did you consider adding tests to your PR? 🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf. |
Member
|
This change is |
miraradeva
approved these changes
Nov 14, 2025
Contributor
miraradeva
left a comment
There was a problem hiding this comment.
@miraradeva reviewed 1 of 1 files at r1, all commit messages.
Reviewable status:complete! 1 of 0 LGTMs obtained (waiting on @dodeca12)
pkg/kv/kvserver/storeliveness/doc.go line 223 at r1 (raw file):
// `kv.store_liveness.heartbeat_smearing.enabled` cluster setting (enabled by // default). When enabled, heartbeat sends are distributed over a certain // duration heartbeat sends are distributed over a certain duration
nit: repeated words.
pkg/kv/kvserver/storeliveness/doc.go line 227 at r1 (raw file):
// 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. When disabled, heartbeat sends are
Can you mention what the goroutines are? The per-node send queue processors, and the per-node gRPC connections.
`storeliveness/doc.go` is outdated with respect to heartbeat smearing changes. In particular, the `Transport` section doesn't have information about heartbeat smearing. Additionally, the `Configuration` section didn't detail the heartbeat smearing cluster setting `kv.store_liveness.heartbeat_smearing.enabled`. Added a dedicated bullet point in the `Transport` section (`5.2`) that explicitly describes heartbeat smearing as a feature to avoid goroutine spikes. Also updated the `Configuration` section (`5.3`) to detail that `kv.store_liveness.heartbeat_smearing.enabled` is available, and describes the behaviour of heartbeat sends when the cluster setting is enabled or disabled. Informs: cockroachdb#156830 Release note: None
9b3ac72 to
3bb81f3
Compare
Author
|
bors r=miraradeva |
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
storeliveness/doc.gois outdated with respect to heartbeat smearing changes.In particular, the
Transportsection doesn't have information about heartbeat smearing. Additionally, theConfigurationsection didn't detail the heartbeat smearing cluster settingkv.store_liveness.heartbeat_smearing.enabled.Added a dedicated bullet point in the
Transportsection (5.2) that explicitly describes heartbeat smearing as a feature to avoid goroutine spikes. Also updated theConfigurationsection (5.3) to detail thatkv.store_liveness.heartbeat_smearing.enabledis available, and describes the behaviour of heartbeat sends when the cluster setting is enabled or disabled.Informs: #156830
Release note: None