Skip to content

Add documentation to bk_server.conf about RocksDB config #4561

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.

Sign up for GitHub

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

Merged
StevenLuMT merged 1 commit into from
Apr 1, 2025
Merged

Add documentation to bk_server.conf about RocksDB config #4561

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 24 additions & 5 deletions conf/bk_server.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -758,17 +758,31 @@ gcEntryLogMetadataCacheEnabled=false
# How many entries to pre-fill in cache after a read cache miss
# dbStorage_readAheadCacheBatchSize=100

#############################################################################
## RocksDB specific configurations
#############################################################################
## DbLedgerStorage uses RocksDB to store the indexes from
## (ledgerId, entryId) -> (entryLog, offset)

## (ledgerId, entryId) -> (entryLog, offset). This is called the entry location database.
## There's also a separate RocksDB database to to store the ledger metadata.
#
# RocksDB configuration can be applied in two ways: by using a configuration file
# or by setting individual properties.
#
# Most individual properties are applied only to the entry location database.
# To fine-tune the ledger metadata database, the configuration file method should be used.
#
# These properties apply to both entry location and ledger metadata databases
#############################################################################
# dbStorage_rocksDB_format_version=5
# dbStorage_rocksDB_checksum_type=kxxHash
#############################################################################
# Entry location RocksDB database specific configurations:
# Size of RocksDB block-cache. For best performance, this cache
# should be big enough to hold a significant portion of the index
# database which can reach ~2GB in some cases
# Default is to use 10% / numberOfLedgers of the direct memory size
# dbStorage_rocksDB_blockCacheSize=

# Other RocksDB specific tunables
# Other RocksDB specific tunables for the entry location database
# dbStorage_rocksDB_writeBufferSizeMB=64
# dbStorage_rocksDB_sstSizeInMB=64
# dbStorage_rocksDB_blockSize=65536
Expand All @@ -777,7 +791,12 @@ gcEntryLogMetadataCacheEnabled=false
# dbStorage_rocksDB_numFilesInLevel0=4
# dbStorage_rocksDB_maxSizeInLevel1MB=256
# dbStorage_rocksDB_logPath=
# dbStorage_rocksDB_format_version=5
#############################################################################
# Alternative RocksDB configuration by using configuration files.
#############################################################################
# entryLocationRocksdbConf=conf/entry_location_rocksdb.conf
# ledgerMetadataRocksdbConf=conf/ledger_metadata_rocksdb.conf
# defaultRocksdbConf=conf/default_rocksdb.conf

#############################################################################
## DirectIO entry logger configuration
Expand Down