This is an automated email from the ASF dual-hosted git repository.
shoothzj pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/bookkeeper.git
The following commit(s) were added to refs/heads/master by this push:
new 4ed58ab007 doc: add missing parameters and reorganize existing
parameters in compact settings (#4355)
4ed58ab007 is described below
commit 4ed58ab00703072d29cf9e3c96d0dfb4ef4bbbd8
Author: Wenzhi Feng <[email protected]>
AuthorDate: Fri May 10 19:24:04 2024 +0800
doc: add missing parameters and reorganize existing parameters in compact
settings (#4355)
### Motivation
The current configuration documentation for BookKeeper lacks some important
parameters. Additionally, existing parameters are not optimally organized. This
update:
- Introduces missing parameters like `isThrottleByBytes`,
`compactionRateByEntries`, and `compactionRateByBytes`.
- Reorganizes the configuration parameters for better clarity.
### 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.
Signed-off-by: ZhangJian He <[email protected]>
Co-authored-by: ZhangJian He <[email protected]>
---
site3/website/docs/reference/config.md | 12 +++++++-----
.../versioned_docs/version-4.10.0/reference/config.md | 10 +++++-----
.../versioned_docs/version-4.11.1/reference/config.md | 10 +++++-----
.../versioned_docs/version-4.12.1/reference/config.md | 10 +++++-----
.../versioned_docs/version-4.13.0/reference/config.md | 10 +++++-----
.../versioned_docs/version-4.14.8/reference/config.md | 12 +++++++-----
.../versioned_docs/version-4.15.5/reference/config.md | 12 +++++++-----
.../versioned_docs/version-4.16.5/reference/config.md | 12 +++++++-----
.../versioned_docs/version-4.17.0/reference/config.md | 12 +++++++-----
.../website/versioned_docs/version-4.5.1/reference/config.md | 12 ++++++------
.../website/versioned_docs/version-4.6.2/reference/config.md | 12 ++++++------
.../website/versioned_docs/version-4.7.3/reference/config.md | 12 ++++++------
.../website/versioned_docs/version-4.8.2/reference/config.md | 12 ++++++------
.../website/versioned_docs/version-4.9.2/reference/config.md | 10 +++++-----
14 files changed, 84 insertions(+), 74 deletions(-)
diff --git a/site3/website/docs/reference/config.md
b/site3/website/docs/reference/config.md
index cf83d4358b..f8d21b2c7b 100644
--- a/site3/website/docs/reference/config.md
+++ b/site3/website/docs/reference/config.md
@@ -172,15 +172,17 @@ The table below lists parameters that you can set to
configure bookies. All conf
| Parameter | Description | Default
| --------- | ----------- | ------- |
+| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
| compactionRate | The rate at which compaction will read entries. The unit is
adds per second. | 1000 |
-| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
-| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
+| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
+| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| compactionMaxOutstandingRequests | Set the maximum number of entries which
can be compacted without flushing. When compacting, the entries are written to
the entrylog and the new offsets are cached in memory. Once the entrylog is
flushed the index is updated with the new offsets. This parameter controls the
number of entries added to the entrylog before a flush is forced. A higher
value for this parameter means more memory will be used for offsets. Each
offset consists of 3 longs. This [...]
+| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
| majorCompactionThreshold | Threshold of major compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a major compaction. Those entry log files whose remaining size
percentage is still higher than the threshold will never be compacted. If it is
set to less than zero, the minor compaction is disabled. | 0.8 |
+| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
| majorCompactionInterval | Interval to run major compaction, in seconds. If
it is set to less than zero, the major compaction is disabled. | 86400 |
-| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
-| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
-| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
+| minorCompactionMaxTimeMillis | Maximum milliseconds to run minor Compaction.
| -1 to run indefinitely. |
+| majorCompactionMaxTimeMillis | Maximum milliseconds to run major Compaction.
| -1 to run indefinitely. |
| useTransactionalCompaction | Flag to enable/disable transactional
compaction. If it is set to true, it will use transactional compaction, which
uses<br />new entry log files to store entries after compaction; otherwise, it
will use normal compaction, which shares same entry<br />log file with normal
add operations.<br /> | false |
diff --git a/site3/website/versioned_docs/version-4.10.0/reference/config.md
b/site3/website/versioned_docs/version-4.10.0/reference/config.md
index 891b447421..971a7796f0 100644
--- a/site3/website/versioned_docs/version-4.10.0/reference/config.md
+++ b/site3/website/versioned_docs/version-4.10.0/reference/config.md
@@ -161,15 +161,15 @@ The table below lists parameters that you can set to
configure bookies. All conf
| Parameter | Description | Default
| --------- | ----------- | ------- |
+| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
| compactionRate | The rate at which compaction will read entries. The unit is
adds per second. | 1000 |
-| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
-| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
+| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
+| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| compactionMaxOutstandingRequests | Set the maximum number of entries which
can be compacted without flushing. When compacting, the entries are written to
the entrylog and the new offsets are cached in memory. Once the entrylog is
flushed the index is updated with the new offsets. This parameter controls the
number of entries added to the entrylog before a flush is forced. A higher
value for this parameter means more memory will be used for offsets. Each
offset consists of 3 longs. This [...]
+| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
| majorCompactionThreshold | Threshold of major compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a major compaction. Those entry log files whose remaining size
percentage is still higher than the threshold will never be compacted. If it is
set to less than zero, the minor compaction is disabled. | 0.8 |
+| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
| majorCompactionInterval | Interval to run major compaction, in seconds. If
it is set to less than zero, the major compaction is disabled. | 86400 |
-| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
-| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
-| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| useTransactionalCompaction | Flag to enable/disable transactional
compaction. If it is set to true, it will use transactional compaction, which
uses<br />new entry log files to store entries after compaction; otherwise, it
will use normal compaction, which shares same entry<br />log file with normal
add operations.<br /> | false |
diff --git a/site3/website/versioned_docs/version-4.11.1/reference/config.md
b/site3/website/versioned_docs/version-4.11.1/reference/config.md
index d95f629c72..a106c0bf06 100644
--- a/site3/website/versioned_docs/version-4.11.1/reference/config.md
+++ b/site3/website/versioned_docs/version-4.11.1/reference/config.md
@@ -161,15 +161,15 @@ The table below lists parameters that you can set to
configure bookies. All conf
| Parameter | Description | Default
| --------- | ----------- | ------- |
+| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
| compactionRate | The rate at which compaction will read entries. The unit is
adds per second. | 1000 |
-| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
-| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
+| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
+| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| compactionMaxOutstandingRequests | Set the maximum number of entries which
can be compacted without flushing. When compacting, the entries are written to
the entrylog and the new offsets are cached in memory. Once the entrylog is
flushed the index is updated with the new offsets. This parameter controls the
number of entries added to the entrylog before a flush is forced. A higher
value for this parameter means more memory will be used for offsets. Each
offset consists of 3 longs. This [...]
+| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
| majorCompactionThreshold | Threshold of major compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a major compaction. Those entry log files whose remaining size
percentage is still higher than the threshold will never be compacted. If it is
set to less than zero, the minor compaction is disabled. | 0.8 |
+| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
| majorCompactionInterval | Interval to run major compaction, in seconds. If
it is set to less than zero, the major compaction is disabled. | 86400 |
-| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
-| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
-| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| useTransactionalCompaction | Flag to enable/disable transactional
compaction. If it is set to true, it will use transactional compaction, which
uses<br />new entry log files to store entries after compaction; otherwise, it
will use normal compaction, which shares same entry<br />log file with normal
add operations.<br /> | false |
diff --git a/site3/website/versioned_docs/version-4.12.1/reference/config.md
b/site3/website/versioned_docs/version-4.12.1/reference/config.md
index d95f629c72..a106c0bf06 100644
--- a/site3/website/versioned_docs/version-4.12.1/reference/config.md
+++ b/site3/website/versioned_docs/version-4.12.1/reference/config.md
@@ -161,15 +161,15 @@ The table below lists parameters that you can set to
configure bookies. All conf
| Parameter | Description | Default
| --------- | ----------- | ------- |
+| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
| compactionRate | The rate at which compaction will read entries. The unit is
adds per second. | 1000 |
-| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
-| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
+| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
+| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| compactionMaxOutstandingRequests | Set the maximum number of entries which
can be compacted without flushing. When compacting, the entries are written to
the entrylog and the new offsets are cached in memory. Once the entrylog is
flushed the index is updated with the new offsets. This parameter controls the
number of entries added to the entrylog before a flush is forced. A higher
value for this parameter means more memory will be used for offsets. Each
offset consists of 3 longs. This [...]
+| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
| majorCompactionThreshold | Threshold of major compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a major compaction. Those entry log files whose remaining size
percentage is still higher than the threshold will never be compacted. If it is
set to less than zero, the minor compaction is disabled. | 0.8 |
+| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
| majorCompactionInterval | Interval to run major compaction, in seconds. If
it is set to less than zero, the major compaction is disabled. | 86400 |
-| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
-| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
-| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| useTransactionalCompaction | Flag to enable/disable transactional
compaction. If it is set to true, it will use transactional compaction, which
uses<br />new entry log files to store entries after compaction; otherwise, it
will use normal compaction, which shares same entry<br />log file with normal
add operations.<br /> | false |
diff --git a/site3/website/versioned_docs/version-4.13.0/reference/config.md
b/site3/website/versioned_docs/version-4.13.0/reference/config.md
index d95f629c72..a106c0bf06 100644
--- a/site3/website/versioned_docs/version-4.13.0/reference/config.md
+++ b/site3/website/versioned_docs/version-4.13.0/reference/config.md
@@ -161,15 +161,15 @@ The table below lists parameters that you can set to
configure bookies. All conf
| Parameter | Description | Default
| --------- | ----------- | ------- |
+| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
| compactionRate | The rate at which compaction will read entries. The unit is
adds per second. | 1000 |
-| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
-| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
+| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
+| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| compactionMaxOutstandingRequests | Set the maximum number of entries which
can be compacted without flushing. When compacting, the entries are written to
the entrylog and the new offsets are cached in memory. Once the entrylog is
flushed the index is updated with the new offsets. This parameter controls the
number of entries added to the entrylog before a flush is forced. A higher
value for this parameter means more memory will be used for offsets. Each
offset consists of 3 longs. This [...]
+| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
| majorCompactionThreshold | Threshold of major compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a major compaction. Those entry log files whose remaining size
percentage is still higher than the threshold will never be compacted. If it is
set to less than zero, the minor compaction is disabled. | 0.8 |
+| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
| majorCompactionInterval | Interval to run major compaction, in seconds. If
it is set to less than zero, the major compaction is disabled. | 86400 |
-| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
-| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
-| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| useTransactionalCompaction | Flag to enable/disable transactional
compaction. If it is set to true, it will use transactional compaction, which
uses<br />new entry log files to store entries after compaction; otherwise, it
will use normal compaction, which shares same entry<br />log file with normal
add operations.<br /> | false |
diff --git a/site3/website/versioned_docs/version-4.14.8/reference/config.md
b/site3/website/versioned_docs/version-4.14.8/reference/config.md
index d95f629c72..17c097fcd7 100644
--- a/site3/website/versioned_docs/version-4.14.8/reference/config.md
+++ b/site3/website/versioned_docs/version-4.14.8/reference/config.md
@@ -161,15 +161,17 @@ The table below lists parameters that you can set to
configure bookies. All conf
| Parameter | Description | Default
| --------- | ----------- | ------- |
+| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
| compactionRate | The rate at which compaction will read entries. The unit is
adds per second. | 1000 |
-| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
-| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
+| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
+| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| compactionMaxOutstandingRequests | Set the maximum number of entries which
can be compacted without flushing. When compacting, the entries are written to
the entrylog and the new offsets are cached in memory. Once the entrylog is
flushed the index is updated with the new offsets. This parameter controls the
number of entries added to the entrylog before a flush is forced. A higher
value for this parameter means more memory will be used for offsets. Each
offset consists of 3 longs. This [...]
+| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
| majorCompactionThreshold | Threshold of major compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a major compaction. Those entry log files whose remaining size
percentage is still higher than the threshold will never be compacted. If it is
set to less than zero, the minor compaction is disabled. | 0.8 |
+| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
| majorCompactionInterval | Interval to run major compaction, in seconds. If
it is set to less than zero, the major compaction is disabled. | 86400 |
-| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
-| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
-| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
+| minorCompactionMaxTimeMillis | Maximum milliseconds to run minor Compaction.
| -1 to run indefinitely. |
+| majorCompactionMaxTimeMillis | Maximum milliseconds to run major Compaction.
| -1 to run indefinitely. |
| useTransactionalCompaction | Flag to enable/disable transactional
compaction. If it is set to true, it will use transactional compaction, which
uses<br />new entry log files to store entries after compaction; otherwise, it
will use normal compaction, which shares same entry<br />log file with normal
add operations.<br /> | false |
diff --git a/site3/website/versioned_docs/version-4.15.5/reference/config.md
b/site3/website/versioned_docs/version-4.15.5/reference/config.md
index 243bd619b3..18771b75af 100644
--- a/site3/website/versioned_docs/version-4.15.5/reference/config.md
+++ b/site3/website/versioned_docs/version-4.15.5/reference/config.md
@@ -167,15 +167,17 @@ The table below lists parameters that you can set to
configure bookies. All conf
| Parameter | Description | Default
| --------- | ----------- | ------- |
+| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
| compactionRate | The rate at which compaction will read entries. The unit is
adds per second. | 1000 |
-| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
-| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
+| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
+| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| compactionMaxOutstandingRequests | Set the maximum number of entries which
can be compacted without flushing. When compacting, the entries are written to
the entrylog and the new offsets are cached in memory. Once the entrylog is
flushed the index is updated with the new offsets. This parameter controls the
number of entries added to the entrylog before a flush is forced. A higher
value for this parameter means more memory will be used for offsets. Each
offset consists of 3 longs. This [...]
+| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
| majorCompactionThreshold | Threshold of major compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a major compaction. Those entry log files whose remaining size
percentage is still higher than the threshold will never be compacted. If it is
set to less than zero, the minor compaction is disabled. | 0.8 |
+| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
| majorCompactionInterval | Interval to run major compaction, in seconds. If
it is set to less than zero, the major compaction is disabled. | 86400 |
-| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
-| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
-| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
+| minorCompactionMaxTimeMillis | Maximum milliseconds to run minor Compaction.
| -1 to run indefinitely. |
+| majorCompactionMaxTimeMillis | Maximum milliseconds to run major Compaction.
| -1 to run indefinitely. |
| useTransactionalCompaction | Flag to enable/disable transactional
compaction. If it is set to true, it will use transactional compaction, which
uses<br />new entry log files to store entries after compaction; otherwise, it
will use normal compaction, which shares same entry<br />log file with normal
add operations.<br /> | false |
diff --git a/site3/website/versioned_docs/version-4.16.5/reference/config.md
b/site3/website/versioned_docs/version-4.16.5/reference/config.md
index a6ab7a8d63..eba40937c4 100644
--- a/site3/website/versioned_docs/version-4.16.5/reference/config.md
+++ b/site3/website/versioned_docs/version-4.16.5/reference/config.md
@@ -172,15 +172,17 @@ The table below lists parameters that you can set to
configure bookies. All conf
| Parameter | Description | Default
| --------- | ----------- | ------- |
+| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
| compactionRate | The rate at which compaction will read entries. The unit is
adds per second. | 1000 |
-| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
-| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
+| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
+| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| compactionMaxOutstandingRequests | Set the maximum number of entries which
can be compacted without flushing. When compacting, the entries are written to
the entrylog and the new offsets are cached in memory. Once the entrylog is
flushed the index is updated with the new offsets. This parameter controls the
number of entries added to the entrylog before a flush is forced. A higher
value for this parameter means more memory will be used for offsets. Each
offset consists of 3 longs. This [...]
+| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
| majorCompactionThreshold | Threshold of major compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a major compaction. Those entry log files whose remaining size
percentage is still higher than the threshold will never be compacted. If it is
set to less than zero, the minor compaction is disabled. | 0.8 |
+| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
| majorCompactionInterval | Interval to run major compaction, in seconds. If
it is set to less than zero, the major compaction is disabled. | 86400 |
-| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
-| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
-| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
+| minorCompactionMaxTimeMillis | Maximum milliseconds to run minor Compaction.
| -1 to run indefinitely. |
+| majorCompactionMaxTimeMillis | Maximum milliseconds to run major Compaction.
| -1 to run indefinitely. |
| useTransactionalCompaction | Flag to enable/disable transactional
compaction. If it is set to true, it will use transactional compaction, which
uses<br />new entry log files to store entries after compaction; otherwise, it
will use normal compaction, which shares same entry<br />log file with normal
add operations.<br /> | false |
diff --git a/site3/website/versioned_docs/version-4.17.0/reference/config.md
b/site3/website/versioned_docs/version-4.17.0/reference/config.md
index 11953b80b3..33cb745ad7 100644
--- a/site3/website/versioned_docs/version-4.17.0/reference/config.md
+++ b/site3/website/versioned_docs/version-4.17.0/reference/config.md
@@ -172,15 +172,17 @@ The table below lists parameters that you can set to
configure bookies. All conf
| Parameter | Description | Default
| --------- | ----------- | ------- |
+| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
| compactionRate | The rate at which compaction will read entries. The unit is
adds per second. | 1000 |
-| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
-| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
+| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
+| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| compactionMaxOutstandingRequests | Set the maximum number of entries which
can be compacted without flushing. When compacting, the entries are written to
the entrylog and the new offsets are cached in memory. Once the entrylog is
flushed the index is updated with the new offsets. This parameter controls the
number of entries added to the entrylog before a flush is forced. A higher
value for this parameter means more memory will be used for offsets. Each
offset consists of 3 longs. This [...]
+| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
| majorCompactionThreshold | Threshold of major compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a major compaction. Those entry log files whose remaining size
percentage is still higher than the threshold will never be compacted. If it is
set to less than zero, the minor compaction is disabled. | 0.8 |
+| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
| majorCompactionInterval | Interval to run major compaction, in seconds. If
it is set to less than zero, the major compaction is disabled. | 86400 |
-| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
-| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
-| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
+| minorCompactionMaxTimeMillis | Maximum milliseconds to run minor Compaction.
| -1 to run indefinitely. |
+| majorCompactionMaxTimeMillis | Maximum milliseconds to run major Compaction.
| -1 to run indefinitely. |
| useTransactionalCompaction | Flag to enable/disable transactional
compaction. If it is set to true, it will use transactional compaction, which
uses<br />new entry log files to store entries after compaction; otherwise, it
will use normal compaction, which shares same entry<br />log file with normal
add operations.<br /> | false |
diff --git a/site3/website/versioned_docs/version-4.5.1/reference/config.md
b/site3/website/versioned_docs/version-4.5.1/reference/config.md
index 891b447421..16402eec41 100644
--- a/site3/website/versioned_docs/version-4.5.1/reference/config.md
+++ b/site3/website/versioned_docs/version-4.5.1/reference/config.md
@@ -161,16 +161,16 @@ The table below lists parameters that you can set to
configure bookies. All conf
| Parameter | Description | Default
| --------- | ----------- | ------- |
+| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
| compactionRate | The rate at which compaction will read entries. The unit is
adds per second. | 1000 |
-| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
-| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
+| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
+| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| compactionMaxOutstandingRequests | Set the maximum number of entries which
can be compacted without flushing. When compacting, the entries are written to
the entrylog and the new offsets are cached in memory. Once the entrylog is
flushed the index is updated with the new offsets. This parameter controls the
number of entries added to the entrylog before a flush is forced. A higher
value for this parameter means more memory will be used for offsets. Each
offset consists of 3 longs. This [...]
+| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
| majorCompactionThreshold | Threshold of major compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a major compaction. Those entry log files whose remaining size
percentage is still higher than the threshold will never be compacted. If it is
set to less than zero, the minor compaction is disabled. | 0.8 |
+| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
| majorCompactionInterval | Interval to run major compaction, in seconds. If
it is set to less than zero, the major compaction is disabled. | 86400 |
-| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
-| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
-| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
-| useTransactionalCompaction | Flag to enable/disable transactional
compaction. If it is set to true, it will use transactional compaction, which
uses<br />new entry log files to store entries after compaction; otherwise, it
will use normal compaction, which shares same entry<br />log file with normal
add operations.<br /> | false |
+| useTransactionalCompaction | Flag to enable/disable transactional
compaction. If it is set to true, it will use transactional compaction, which
uses<br />new entry log files to store entries after compaction; otherwise, it
will use normal compaction, which shares same entry<br />log file with normal
add operations.<br /> | false |
## Garbage collection settings
diff --git a/site3/website/versioned_docs/version-4.6.2/reference/config.md
b/site3/website/versioned_docs/version-4.6.2/reference/config.md
index 891b447421..16402eec41 100644
--- a/site3/website/versioned_docs/version-4.6.2/reference/config.md
+++ b/site3/website/versioned_docs/version-4.6.2/reference/config.md
@@ -161,16 +161,16 @@ The table below lists parameters that you can set to
configure bookies. All conf
| Parameter | Description | Default
| --------- | ----------- | ------- |
+| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
| compactionRate | The rate at which compaction will read entries. The unit is
adds per second. | 1000 |
-| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
-| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
+| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
+| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| compactionMaxOutstandingRequests | Set the maximum number of entries which
can be compacted without flushing. When compacting, the entries are written to
the entrylog and the new offsets are cached in memory. Once the entrylog is
flushed the index is updated with the new offsets. This parameter controls the
number of entries added to the entrylog before a flush is forced. A higher
value for this parameter means more memory will be used for offsets. Each
offset consists of 3 longs. This [...]
+| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
| majorCompactionThreshold | Threshold of major compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a major compaction. Those entry log files whose remaining size
percentage is still higher than the threshold will never be compacted. If it is
set to less than zero, the minor compaction is disabled. | 0.8 |
+| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
| majorCompactionInterval | Interval to run major compaction, in seconds. If
it is set to less than zero, the major compaction is disabled. | 86400 |
-| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
-| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
-| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
-| useTransactionalCompaction | Flag to enable/disable transactional
compaction. If it is set to true, it will use transactional compaction, which
uses<br />new entry log files to store entries after compaction; otherwise, it
will use normal compaction, which shares same entry<br />log file with normal
add operations.<br /> | false |
+| useTransactionalCompaction | Flag to enable/disable transactional
compaction. If it is set to true, it will use transactional compaction, which
uses<br />new entry log files to store entries after compaction; otherwise, it
will use normal compaction, which shares same entry<br />log file with normal
add operations.<br /> | false |
## Garbage collection settings
diff --git a/site3/website/versioned_docs/version-4.7.3/reference/config.md
b/site3/website/versioned_docs/version-4.7.3/reference/config.md
index 891b447421..16402eec41 100644
--- a/site3/website/versioned_docs/version-4.7.3/reference/config.md
+++ b/site3/website/versioned_docs/version-4.7.3/reference/config.md
@@ -161,16 +161,16 @@ The table below lists parameters that you can set to
configure bookies. All conf
| Parameter | Description | Default
| --------- | ----------- | ------- |
+| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
| compactionRate | The rate at which compaction will read entries. The unit is
adds per second. | 1000 |
-| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
-| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
+| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
+| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| compactionMaxOutstandingRequests | Set the maximum number of entries which
can be compacted without flushing. When compacting, the entries are written to
the entrylog and the new offsets are cached in memory. Once the entrylog is
flushed the index is updated with the new offsets. This parameter controls the
number of entries added to the entrylog before a flush is forced. A higher
value for this parameter means more memory will be used for offsets. Each
offset consists of 3 longs. This [...]
+| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
| majorCompactionThreshold | Threshold of major compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a major compaction. Those entry log files whose remaining size
percentage is still higher than the threshold will never be compacted. If it is
set to less than zero, the minor compaction is disabled. | 0.8 |
+| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
| majorCompactionInterval | Interval to run major compaction, in seconds. If
it is set to less than zero, the major compaction is disabled. | 86400 |
-| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
-| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
-| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
-| useTransactionalCompaction | Flag to enable/disable transactional
compaction. If it is set to true, it will use transactional compaction, which
uses<br />new entry log files to store entries after compaction; otherwise, it
will use normal compaction, which shares same entry<br />log file with normal
add operations.<br /> | false |
+| useTransactionalCompaction | Flag to enable/disable transactional
compaction. If it is set to true, it will use transactional compaction, which
uses<br />new entry log files to store entries after compaction; otherwise, it
will use normal compaction, which shares same entry<br />log file with normal
add operations.<br /> | false |
## Garbage collection settings
diff --git a/site3/website/versioned_docs/version-4.8.2/reference/config.md
b/site3/website/versioned_docs/version-4.8.2/reference/config.md
index 891b447421..16402eec41 100644
--- a/site3/website/versioned_docs/version-4.8.2/reference/config.md
+++ b/site3/website/versioned_docs/version-4.8.2/reference/config.md
@@ -161,16 +161,16 @@ The table below lists parameters that you can set to
configure bookies. All conf
| Parameter | Description | Default
| --------- | ----------- | ------- |
+| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
| compactionRate | The rate at which compaction will read entries. The unit is
adds per second. | 1000 |
-| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
-| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
+| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
+| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| compactionMaxOutstandingRequests | Set the maximum number of entries which
can be compacted without flushing. When compacting, the entries are written to
the entrylog and the new offsets are cached in memory. Once the entrylog is
flushed the index is updated with the new offsets. This parameter controls the
number of entries added to the entrylog before a flush is forced. A higher
value for this parameter means more memory will be used for offsets. Each
offset consists of 3 longs. This [...]
+| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
| majorCompactionThreshold | Threshold of major compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a major compaction. Those entry log files whose remaining size
percentage is still higher than the threshold will never be compacted. If it is
set to less than zero, the minor compaction is disabled. | 0.8 |
+| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
| majorCompactionInterval | Interval to run major compaction, in seconds. If
it is set to less than zero, the major compaction is disabled. | 86400 |
-| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
-| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
-| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
-| useTransactionalCompaction | Flag to enable/disable transactional
compaction. If it is set to true, it will use transactional compaction, which
uses<br />new entry log files to store entries after compaction; otherwise, it
will use normal compaction, which shares same entry<br />log file with normal
add operations.<br /> | false |
+| useTransactionalCompaction | Flag to enable/disable transactional
compaction. If it is set to true, it will use transactional compaction, which
uses<br />new entry log files to store entries after compaction; otherwise, it
will use normal compaction, which shares same entry<br />log file with normal
add operations.<br /> | false |
## Garbage collection settings
diff --git a/site3/website/versioned_docs/version-4.9.2/reference/config.md
b/site3/website/versioned_docs/version-4.9.2/reference/config.md
index 891b447421..971a7796f0 100644
--- a/site3/website/versioned_docs/version-4.9.2/reference/config.md
+++ b/site3/website/versioned_docs/version-4.9.2/reference/config.md
@@ -161,15 +161,15 @@ The table below lists parameters that you can set to
configure bookies. All conf
| Parameter | Description | Default
| --------- | ----------- | ------- |
+| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
| compactionRate | The rate at which compaction will read entries. The unit is
adds per second. | 1000 |
-| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
-| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
+| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
+| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| compactionMaxOutstandingRequests | Set the maximum number of entries which
can be compacted without flushing. When compacting, the entries are written to
the entrylog and the new offsets are cached in memory. Once the entrylog is
flushed the index is updated with the new offsets. This parameter controls the
number of entries added to the entrylog before a flush is forced. A higher
value for this parameter means more memory will be used for offsets. Each
offset consists of 3 longs. This [...]
+| minorCompactionThreshold | Threshold of minor compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a minor compaction. If it is set to less than zero, the minor
compaction is disabled. | 0.2 |
| majorCompactionThreshold | Threshold of major compaction. For those entry
log files whose remaining size percentage reaches below this threshold will be
compacted in a major compaction. Those entry log files whose remaining size
percentage is still higher than the threshold will never be compacted. If it is
set to less than zero, the minor compaction is disabled. | 0.8 |
+| minorCompactionInterval | Interval to run minor compaction, in seconds. If
it is set to less than zero, the minor compaction is disabled. | 3600 |
| majorCompactionInterval | Interval to run major compaction, in seconds. If
it is set to less than zero, the major compaction is disabled. | 86400 |
-| isThrottleByBytes | Throttle compaction by bytes or by entries. | false |
-| compactionRateByEntries | Set the rate at which compaction will read
entries. The unit is adds per second. | 1000 |
-| compactionRateByBytes | Set the rate at which compaction will read entries.
The unit is bytes added per second. | 1000000 |
| useTransactionalCompaction | Flag to enable/disable transactional
compaction. If it is set to true, it will use transactional compaction, which
uses<br />new entry log files to store entries after compaction; otherwise, it
will use normal compaction, which shares same entry<br />log file with normal
add operations.<br /> | false |
