Skip to content

Commit e06f3a5

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

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
@@ -763,17 +763,31 @@ gcEntryLogMetadataCacheEnabled=false
763763
# How many entries to pre-fill in cache after a read cache miss
764764
# dbStorage_readAheadCacheBatchSize=100
765765

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

787806
#############################################################################
788807
## DirectIO entry logger configuration

0 commit comments

Comments
 (0)