Skip to content

Commit 812ac0b

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

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

conf/bk_server.conf

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -749,17 +749,31 @@ gcEntryLogMetadataCacheEnabled=false
749749
# How many entries to pre-fill in cache after a read cache miss
750750
# dbStorage_readAheadCacheBatchSize=100
751751

752+
#############################################################################
752753
## RocksDB specific configurations
754+
#############################################################################
753755
## DbLedgerStorage uses RocksDB to store the indexes from
754-
## (ledgerId, entryId) -> (entryLog, offset)
755-
756+
## (ledgerId, entryId) -> (entryLog, offset). This is called the entry location database.
757+
## There's also a separate RocksDB database to to store the ledger metadata.
758+
#
759+
# RocksDB configuration can be applied in two ways: by using a configuration file
760+
# or by setting individual properties.
761+
#
762+
# Most individual properties are applied only to the entry location database.
763+
# To fine-tune the ledger metadata database, the configuration file method should be used.
764+
#
765+
# These properties apply to both entry location and ledger metadata databases
766+
#############################################################################
767+
# dbStorage_rocksDB_format_version=2
768+
# dbStorage_rocksDB_checksum_type=kxxHash
769+
#############################################################################
770+
# Entry location RocksDB database specific configurations:
756771
# Size of RocksDB block-cache. For best performance, this cache
757772
# should be big enough to hold a significant portion of the index
758773
# database which can reach ~2GB in some cases
759774
# Default is to use 10% / numberOfLedgers of the direct memory size
760775
# dbStorage_rocksDB_blockCacheSize=
761-
762-
# Other RocksDB specific tunables
776+
# Other RocksDB specific tunables for the entry location database
763777
# dbStorage_rocksDB_writeBufferSizeMB=64
764778
# dbStorage_rocksDB_sstSizeInMB=64
765779
# dbStorage_rocksDB_blockSize=65536
@@ -769,6 +783,12 @@ gcEntryLogMetadataCacheEnabled=false
769783
# dbStorage_rocksDB_maxSizeInLevel1MB=256
770784
# dbStorage_rocksDB_logPath=
771785
# dbStorage_rocksDB_format_version=2
786+
#############################################################################
787+
# Alternative RocksDB configuration by using configuration files.
788+
#############################################################################
789+
# entryLocationRocksdbConf=conf/entry_location_rocksdb.conf
790+
# ledgerMetadataRocksdbConf=conf/ledger_metadata_rocksdb.conf
791+
# defaultRocksdbConf=conf/default_rocksdb.conf
772792

773793

774794
############################################## Metadata Services ##############################################

0 commit comments

Comments
 (0)