Skip to content
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.

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

release-23.1.0: base: reduce RaftMaxInflightBytes to 32 MB #101508

Merged

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Apr 13, 2023

Backport 1/1 commits from #101437 on behalf of @erikgrinaker.

/cc @cockroachdb/release


This patch reduces the default RaftMaxInflightBytes from 256 MB to 32 MB, to reduce the out-of-memory incidence during bulk operations like RESTORE on clusters with overloaded disks.

RaftMaxInflightBytes specifies the maximum aggregate byte size of Raft log entries that a leader will send to a follower without hearing responses. As such, it also bounds the amount of replication data buffered in memory on the receiver. Individual messages can still exceed this limit (consider the default command size limit at 64 MB).

Normally, RaftMaxInflightMsgs * RaftMaxSizePerMsg will bound this at 4 MB (128 messages at 32 KB each). However, individual messages are allowed to exceed the 32 KB limit, typically large AddSSTable commands that can be around 10 MB each. To prevent followers running out of memory, we place an additional total byte limit of 32 MB, which is 8 times more than normal.

A survey of CC clusters over the past 30 days showed that, excluding a single outlier cluster, the total outstanding raft.rcvd.queued_bytes of any individual node never exceeded 500 MB, and was roughly 0 across all clusters for the majority of time.

Touches #71805.
Resolves #100341.
Resolves #100804.
Resolves #100983.
Resolves #101426.

Epic: none
Release note (ops change): the amount of replication traffic in flight from a single Raft leader to a follower has been reduced from 256 MB to 32 MB, in order to reduce the chance of running out of memory during bulk write operations. This can be controlled via the environment variable COCKROACH_RAFT_MAX_INFLIGHT_BYTES.


Release justification:

@blathers-crl blathers-crl bot requested review from a team as code owners April 13, 2023 23:10
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-23.1.0-101437 branch 2 times, most recently from 1f9ec3e to 33d7615 Compare April 13, 2023 23:10
@blathers-crl
Copy link
Author

blathers-crl bot commented Apr 13, 2023

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Patches should only be created for serious issues or test-only changes.
  • Patches should not break backwards-compatibility.
  • Patches should change as little code as possible.
  • Patches should not change on-disk formats or node communication protocols.
  • Patches should not add new functionality.
  • Patches must not add, edit, or otherwise modify cluster versions; or add version gates.
If some of the basic criteria cannot be satisfied, ensure that the exceptional criteria are satisfied within.
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters.
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.

Add a brief release justification to the body of your PR to justify this backport.

Some other things to consider:

  • What did we do to ensure that a user that doesn’t know & care about this backport, has no idea that it happened?
  • Will this work in a cluster of mixed patch versions? Did we test that?
  • If a user upgrades a patch version, uses this feature, and then downgrades, what happens?

@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels Apr 13, 2023
@cockroach-teamcity
Copy link
Member

This change is Reviewable

This patch reduces the default `RaftMaxInflightBytes` from 256 MB to 32
MB, to reduce the out-of-memory incidence during bulk operations like
`RESTORE` on clusters with overloaded disks.

`RaftMaxInflightBytes` specifies the maximum aggregate byte size of Raft
log entries that a leader will send to a follower without hearing
responses. As such, it also bounds the amount of replication data
buffered in memory on the receiver. Individual messages can still exceed
this limit (consider the default command size limit at 64 MB).

Normally, `RaftMaxInflightMsgs` * `RaftMaxSizePerMsg` will bound this at
4 MB (128 messages at 32 KB each). However, individual messages are
allowed to exceed the 32 KB limit, typically large AddSSTable commands
that can be around 10 MB each. To prevent followers running out of
memory, we place an additional total byte limit of 32 MB, which is 8
times more than normal.

A survey of CC clusters over the past 30 days showed that, excluding a
single outlier cluster, the total outstanding `raft.rcvd.queued_bytes`
of any individual node never exceeded 500 MB, and was roughly 0 across
all clusters for the majority of time.

Epic: none
Release note (ops change): the amount of replication traffic in flight
from a single Raft leader to a follower has been reduced from 256 MB to
32 MB, in order to reduce the chance of running out of memory during
bulk write operations. This can be controlled via the environment
variable `COCKROACH_RAFT_MAX_INFLIGHT_BYTES`.
@erikgrinaker erikgrinaker force-pushed the blathers/backport-release-23.1.0-101437 branch from 33d7615 to 95c95ec Compare April 18, 2023 16:03
@erikgrinaker erikgrinaker merged commit ddd8eea into release-23.1.0 Apr 18, 2023
5 of 6 checks passed
@erikgrinaker erikgrinaker deleted the blathers/backport-release-23.1.0-101437 branch April 18, 2023 20:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants