Update Raft election, lease intervals, etc. #16789
Conversation
|
Hi @erikgrinaker these docs changes are based on your work in cockroachdb/cockroach#92542 and cockroachdb/cockroach#91947 Please let me know if I got some details wrong, I read through your comments in the code PRs but probably didn't understand everything properly also open to any general feedback/comments on how we're presenting this info, or anything else that comes to mind thanks! |
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site settings. |
rmloveland
force-pushed
the
20230418-raft-election-timeouts-lease-intervals
branch
from
2319990
to
73d0b91
Compare
|
@erikgrinaker this is updated based on your previous comments and should be RFAL |
|
Sorry for the hold-up, I just got out of a non-stop L2 rotation and am still working my way through the backlog. Will get back to you shortly. |
There was a problem hiding this comment.
LGTM once comments are addressed. Thanks again for updating this!
I will say that tuning these values isn't trivial, since there are several interactions and aspects to consider. We can write something up around this if you'd like, or we can just consider this to be for advanced users who have some idea of the implications.
NP! Thanks for the thorough review comments, really appreciate it!
Ya this seems pretty scary overall from a user POV. Perhaps we can write more about this in the future if it becomes necessary. I'm pretty torn about having this kind of possibly footgun-adjacent stuff in the docs, but the new ICP is supposed to be pretty smart 'n stuff so I guess it's fine? My personal (perhaps incorrect) opinion is that if you're sophisticated enough to be tweaking your Raft timeouts etc you should probably be pretty deep in the actual code, so these docs might be redundant or just an attractive nuisance to the less skilled. But hey let's go with it and see what happens! :-) |
rmloveland
force-pushed
the
20230418-raft-election-timeouts-lease-intervals
branch
from
fa79111
to
919dd93
Compare
My absolute favorite legal term. |
Fixes DOC-6375, DOC-7125 Summary of changes: - Update 'Distribution Layer' page with updated network timeout and mention the `COCKROACH_NETWORK_TIMEOUT` env var that controls it - Update 'Replication Layer' page with: - A table listing all of the relevant intervals, their values, and how they can controlled (if possible) - More links to the table wherever the values in that table are referred to - Finally, all of the intervals and other constants are stored in variables so their values can be referenced and updated in one place going forward
rmloveland
force-pushed
the
20230418-raft-election-timeouts-lease-intervals
branch
from
919dd93
to
0c486c6
Compare
Fixes DOC-6375, DOC-7125
Summary of changes:
Update 'Distribution Layer' page with updated network timeout and mention the
COCKROACH_NETWORK_TIMEOUTenv var that controls itUpdate 'Replication Layer' page with:
A table listing all of the relevant intervals that can be controlled with the
COCKROACH_RAFT_ELECTION_TIMEOUT_TICKSvariableMore links to the table wherever the values in that table are referred to
Finally, all of the intervals are stored in variables so their values can be referenced and updated in one place going forward