[Bifrost] Introduce bifrost.record-size-limit (hidden) #4139
Conversation
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
This was referenced Jan 7, 2026
AhmedSoliman
force-pushed
the
pr4139
branch
2 times, most recently
from
ece5fd3 to
a9d3771
Compare
tillrohrmann
approved these changes
Jan 7, 2026
Contributor
tillrohrmann
left a comment
tillrohrmann
left a comment
There was a problem hiding this comment.
Thanks a lot for adding the record-size-limit guardrails to bifrost @AhmedSoliman. LGTM. +1 for merging :-)
muhamadazmy
reviewed
Jan 8, 2026
Contributor
muhamadazmy
left a comment
muhamadazmy
left a comment
There was a problem hiding this comment.
Thank you so much for this PR! The changes looks good to me. I left couple of very minor comments below. +1 for merging
crates/bifrost/src/error.rs
Outdated
| MetadataStoreError(#[from] Arc<ReadWriteError>), | ||
| #[error("record batch too large: {record_size} bytes exceeds limit of {limit} bytes")] | ||
| BatchTooLarge { | ||
| record_size: usize, |
Contributor
There was a problem hiding this comment.
I assume this should be batch_size?
Suggested change
| record_size: usize, | |
| batch_size: usize, |
crates/bifrost/src/appender.rs
Outdated
| let record_size = body.estimated_encode_size(); | ||
| let limit = self.record_size_limit(); | ||
| if body.estimated_encode_size() > self.record_size_limit().get() { | ||
| return Err(Error::BatchTooLarge { record_size, limit }); |
Contributor
There was a problem hiding this comment.
Wondering if this should be a RecordTooLarge error instead?
Suggested change
| return Err(Error::BatchTooLarge { record_size, limit }); | |
| return Err(Error::RecordTooLarge { record_size, limit }); |
Contributor
Author
There was a problem hiding this comment.
Not really, the appender only operates on batches.
| #[error("error when self proposing")] | ||
| SelfProposer, | ||
| #[error("error when self proposing: {0}")] | ||
| SelfProposer(String), |
Contributor
There was a problem hiding this comment.
I like that we finally propagate the source error 😆! But maybe it's a good idea to use a Box<dyn Error + Send + Sync> or anyhow::Error ?
Contributor
Author
There was a problem hiding this comment.
I opted out from doing this because in various places we return EnqueueError(T) where T might not be Debug or Send+Sync.
AhmedSoliman
force-pushed
the
pr4139
branch
2 times, most recently
from
11d2bc4 to
e08efaa
Compare
Add a record size limit check at append time in Bifrost to validate that individual records do not exceed a configured maximum size. Important note: This configuration option is not going to be effective without implementing size estimation of records. At the moment, all typed records are assumed to be 2048 bytes in size which makes this check useless. Nevertheless, This check is useful for the future when we implement size estimation of records. Changes: - Add `bifrost.record-size-limit` configuration option that defaults to `networking.message-size-limit` (32 MiB) and is clamped to that value - Add `BatchTooLarge/RecordTooLarge` error variants to get notified when a record too large or when a batch is too large depending on whether you're using Appender or BackgroundAppender. - Add record size validation to all `LogSender` enqueue methods in `BackgroundAppender` to fail fast at enqueue time This prevents oversized records from being written to the log, which could cause issues during replication and network transmission. Part of #4130, #4132
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Add a record size limit check at append time in Bifrost to validate that
individual records do not exceed a configured maximum size.
Important note: This configuration option is not going to be effective without implementing size estimation of records. At the moment, all typed records are assumed to be 2048 bytes in size which makes this check useless. Nevertheless,
This check is useful for the future when we implement size estimation of records.
Changes:
bifrost.record-size-limitconfiguration option that defaults tonetworking.message-size-limit(32 MiB) and is clamped to that valueBatchTooLarge/RecordTooLargeerror variants to get notified when a record too large or when a batch is too large depending on whether you're using Appender or BackgroundAppender.LogSenderenqueue methods inBackgroundAppenderto fail fast at enqueue timeThis prevents oversized records from being written to the log, which could cause issues during replication and network transmission.
Part of #4130, #4132
Stack created with Sapling. Best reviewed with ReviewStack.