Skip to content

Commit e46da06

Browse files
committed
Add documentation to bk_server.conf about RocksDB config (#4561)
(cherry picked from commit 64abf31)
1 parent baffa34 commit e46da06

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

conf/bk_server.conf

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -760,17 +760,31 @@ gcEntryLogMetadataCacheEnabled=false
760760
# How many entries to pre-fill in cache after a read cache miss
761761
# dbStorage_readAheadCacheBatchSize=100
762762

763+
#############################################################################
763764
## RocksDB specific configurations
765+
#############################################################################
764766
## DbLedgerStorage uses RocksDB to store the indexes from
765-
## (ledgerId, entryId) -> (entryLog, offset)
766-
767+
## (ledgerId, entryId) -> (entryLog, offset). This is called the entry location database.
768+
## There's also a separate RocksDB database to to store the ledger metadata.
769+
#
770+
# RocksDB configuration can be applied in two ways: by using a configuration file
771+
# or by setting individual properties.
772+
#
773+
# Most individual properties are applied only to the entry location database.
774+
# To fine-tune the ledger metadata database, the configuration file method should be used.
775+
#
776+
# These properties apply to both entry location and ledger metadata databases
777+
#############################################################################
778+
# dbStorage_rocksDB_format_version=5
779+
# dbStorage_rocksDB_checksum_type=kxxHash
780+
#############################################################################
781+
# Entry location RocksDB database specific configurations:
767782
# Size of RocksDB block-cache. For best performance, this cache
768783
# should be big enough to hold a significant portion of the index
769784
# database which can reach ~2GB in some cases
770785
# Default is to use 10% / numberOfLedgers of the direct memory size
771786
# dbStorage_rocksDB_blockCacheSize=
772-
773-
# Other RocksDB specific tunables
787+
# Other RocksDB specific tunables for the entry location database
774788
# dbStorage_rocksDB_writeBufferSizeMB=64
775789
# dbStorage_rocksDB_sstSizeInMB=64
776790
# dbStorage_rocksDB_blockSize=65536
@@ -779,7 +793,12 @@ gcEntryLogMetadataCacheEnabled=false
779793
# dbStorage_rocksDB_numFilesInLevel0=4
780794
# dbStorage_rocksDB_maxSizeInLevel1MB=256
781795
# dbStorage_rocksDB_logPath=
782-
# dbStorage_rocksDB_format_version=5
796+
#############################################################################
797+
# Alternative RocksDB configuration by using configuration files.
798+
#############################################################################
799+
# entryLocationRocksdbConf=conf/entry_location_rocksdb.conf
800+
# ledgerMetadataRocksdbConf=conf/ledger_metadata_rocksdb.conf
801+
# defaultRocksdbConf=conf/default_rocksdb.conf
783802

784803
#############################################################################
785804
## DirectIO entry logger configuration

0 commit comments

Comments
 (0)