doc: add missing parameters and reorganize existing parameters in compact settings #4355
Conversation
This file contains 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
thetumbled
force-pushed
the
Add_descriptionForCompactionMaxTimeMillis
branch
from
0affae5
to
04c5985
Compare
|
PTAL, thanks. @shoothzj @wenbingshen @eolivelli @dlg99 |
shoothzj
reviewed
May 9, 2024
Signed-off-by: ZhangJian He <shoothzj@gmail.com>
shoothzj
changed the title
|
I reorganize the configuration parameters for better clarity |
shoothzj
approved these changes
May 10, 2024
shoothzj
requested review from
hangc0276,
jiazhai,
nicoloboschi,
zymap and
wenbingshen
jiazhai
approved these changes
May 10, 2024
|
@thetumbled could you please also update the upgrade doc? see #4348 |
I create #4358 to update the upgrade doc, PTAL, thanks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
The current configuration documentation for BookKeeper lacks some important parameters. Additionally, existing parameters are not optimally organized. This update:
isThrottleByBytes,compactionRateByEntries, andcompactionRateByBytes.Changes
Added: New parameters that were missing in the configuration:
compactionRateByEntries: Set the rate at which compaction will read entries, measured in entries per second.compactionRateByBytes: Set the rate at which compaction will read entries, measured in bytes per second.Reorganized: Adjusted the placement of existing parameters for better logical grouping and readability:
minorCompactionThreshold: Adjusted position for clarity.minorCompactionInterval: Moved for logical grouping.