From 1f515ae51aad979c09b3920082e5d8c2aec019af Mon Sep 17 00:00:00 2001 From: Philip Halsall Date: Thu, 19 Nov 2020 12:21:46 +0800 Subject: [PATCH 1/6] update docs to reflect updated code using 128MiB --- .../60_how-to-guides/10_how-to-configure-state-storage.md | 6 +++--- docs/01_nodeos/03_plugins/chain_plugin/index.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md b/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md index 3d969e87cde..fdea8184bf4 100644 --- a/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md +++ b/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md @@ -15,14 +15,14 @@ Config Options for eosio::chain_plugin: compaction. Defaults to the number of available cores. --rocksdb-files arg (=-1) Max number of rocksdb files to keep open. -1 = unlimited. - --rocksdb-write-buffer-size-mb arg (=134217728) - Size of a single rocksdb memtable + --rocksdb-write-buffer-size-mb arg (=128MB) + Size of a single rocksdb memtable (in MiB) # Procedure To use `rocksdb` for state storage: ```shell -nodeos -e -p eosio --plugin eosio::producer_plugin --plugin eosio::producer_api_plugin --plugin eosio::chain_api_plugin --backing-store=’rocksdb’ --rocksdb-threads=’2’ --rocksdb-files=’2’ --rocksdb-write-buffer-size-mb=’134217728’ --plugin eosio::http_plugin +nodeos -e -p eosio --plugin eosio::producer_plugin --plugin eosio::producer_api_plugin --plugin eosio::chain_api_plugin --backing-store=’rocksdb’ --rocksdb-threads=’2’ --rocksdb-files=’2’ --rocksdb-write-buffer-size-mb=’128’ --plugin eosio::http_plugin ``` To use `chainbase` for state storage: diff --git a/docs/01_nodeos/03_plugins/chain_plugin/index.md b/docs/01_nodeos/03_plugins/chain_plugin/index.md index 82659ceb397..671b59dc412 100644 --- a/docs/01_nodeos/03_plugins/chain_plugin/index.md +++ b/docs/01_nodeos/03_plugins/chain_plugin/index.md @@ -120,8 +120,8 @@ Config Options for eosio::chain_plugin: available cores. --rocksdb-files arg (=-1) Max number of rocksdb files to keep open. -1 = unlimited. - --rocksdb-write-buffer-size-mb arg (=134217728) - Size of a single rocksdb memtable + --rocksdb-write-buffer-size-mb arg (=128MB) + Size of a single rocksdb memtable (in MiB) --reversible-blocks-db-size-mb arg (=340) Maximum size (in MiB) of the reversible blocks database From 7c145a5ad19514682444ff725b85dfe1656b72f5 Mon Sep 17 00:00:00 2001 From: Philip Halsall Date: Mon, 23 Nov 2020 12:59:00 +0800 Subject: [PATCH 2/6] removing MB from documentation after PR review --- .../60_how-to-guides/10_how-to-configure-state-storage.md | 2 +- docs/01_nodeos/03_plugins/chain_plugin/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md b/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md index fdea8184bf4..666b9295d11 100644 --- a/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md +++ b/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md @@ -15,7 +15,7 @@ Config Options for eosio::chain_plugin: compaction. Defaults to the number of available cores. --rocksdb-files arg (=-1) Max number of rocksdb files to keep open. -1 = unlimited. - --rocksdb-write-buffer-size-mb arg (=128MB) + --rocksdb-write-buffer-size-mb arg (=128) Size of a single rocksdb memtable (in MiB) # Procedure diff --git a/docs/01_nodeos/03_plugins/chain_plugin/index.md b/docs/01_nodeos/03_plugins/chain_plugin/index.md index 671b59dc412..d8a84440b1e 100644 --- a/docs/01_nodeos/03_plugins/chain_plugin/index.md +++ b/docs/01_nodeos/03_plugins/chain_plugin/index.md @@ -120,7 +120,7 @@ Config Options for eosio::chain_plugin: available cores. --rocksdb-files arg (=-1) Max number of rocksdb files to keep open. -1 = unlimited. - --rocksdb-write-buffer-size-mb arg (=128MB) + --rocksdb-write-buffer-size-mb arg (=128) Size of a single rocksdb memtable (in MiB) --reversible-blocks-db-size-mb arg (=340) Maximum size (in MiB) of the reversible From b64312123042761311ee99b40e5864d978ef2fd9 Mon Sep 17 00:00:00 2001 From: Philip Halsall Date: Thu, 26 Nov 2020 15:59:53 +0800 Subject: [PATCH 3/6] more updates --- .../60_how-to-guides/10_how-to-configure-state-storage.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md b/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md index 666b9295d11..23ff15b843a 100644 --- a/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md +++ b/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md @@ -7,6 +7,7 @@ Version 2.1 or above of the EOSIO development environment. # Parameter Definitions Specify which backing store to use with the `chain_plugin` `--backing-store` argument. This argument sets state storage to either `chainbase`, the default, or `rocksdb`. +```console Config Options for eosio::chain_plugin: --backing-store arg (=chainbase) The storage for state, chainbase or @@ -17,7 +18,8 @@ Config Options for eosio::chain_plugin: open. -1 = unlimited. --rocksdb-write-buffer-size-mb arg (=128) Size of a single rocksdb memtable (in MiB) - +``` + # Procedure To use `rocksdb` for state storage: @@ -37,4 +39,3 @@ or nodeos -e -p eosio --plugin eosio::producer_plugin --plugin eosio::producer_api_plugin --plugin eosio::chain_api_plugin --plugin eosio::http_plugin ``` -# Next Steps From fc690ba4e2f5965bb57ef7d614cb3308e781a0f9 Mon Sep 17 00:00:00 2001 From: Philip Halsall Date: Thu, 26 Nov 2020 17:01:21 +0800 Subject: [PATCH 4/6] updating parameters names --- .../10_how-to-configure-state-storage.md | 17 +++++++++++------ docs/01_nodeos/03_plugins/chain_plugin/index.md | 12 ++++++++---- 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md b/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md index 23ff15b843a..8d030298dc5 100644 --- a/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md +++ b/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md @@ -12,19 +12,24 @@ Config Options for eosio::chain_plugin: --backing-store arg (=chainbase) The storage for state, chainbase or rocksdb - --rocksdb-threads arg Number of rocksdb threads for flush and - compaction. Defaults to the number of available cores. - --rocksdb-files arg (=-1) Max number of rocksdb files to keep + --persistent-storage-num-threads arg Number of rocksdb threads for flush and + compaction. Defaults to the number of + available cores. + --persistent-storage-max-num-files arg (=-1) + Max number of rocksdb files to keep open. -1 = unlimited. - --rocksdb-write-buffer-size-mb arg (=128) - Size of a single rocksdb memtable (in MiB) + --persistent-storage-write-buffer-size-mb arg (=128) + Size of a single rocksdb memtable (in MiB). + --persistent-storage-bytes-per-sync Rocksdb write rate of flushes and compactions. + --persistent-storage-mbytes-snapshot-batch + Rocksdb batch size threshold before writing read in snapshot data to database. ``` # Procedure To use `rocksdb` for state storage: ```shell -nodeos -e -p eosio --plugin eosio::producer_plugin --plugin eosio::producer_api_plugin --plugin eosio::chain_api_plugin --backing-store=’rocksdb’ --rocksdb-threads=’2’ --rocksdb-files=’2’ --rocksdb-write-buffer-size-mb=’128’ --plugin eosio::http_plugin +nodeos -e -p eosio --plugin eosio::producer_plugin --plugin eosio::producer_api_plugin --plugin eosio::chain_api_plugin --backing-store=’rocksdb’ --persistent-storage-num-threads=’2’ --persistent-storage-max-num-files=’2’ --persistent-storage-write-buffer-size-mb=’128’ --plugin eosio::http_plugin ``` To use `chainbase` for state storage: diff --git a/docs/01_nodeos/03_plugins/chain_plugin/index.md b/docs/01_nodeos/03_plugins/chain_plugin/index.md index d8a84440b1e..5241e056de2 100644 --- a/docs/01_nodeos/03_plugins/chain_plugin/index.md +++ b/docs/01_nodeos/03_plugins/chain_plugin/index.md @@ -115,13 +115,17 @@ Config Options for eosio::chain_plugin: drops below this size (in MiB). --backing-store arg (=chainbase) The storage for state, chainbase or rocksdb - --rocksdb-threads arg Number of rocksdb threads for flush and + --persistent-storage-num-threads arg Number of rocksdb threads for flush and compaction. Defaults to the number of available cores. - --rocksdb-files arg (=-1) Max number of rocksdb files to keep + --persistent-storage-max-num-files arg (=-1) + Max number of rocksdb files to keep open. -1 = unlimited. - --rocksdb-write-buffer-size-mb arg (=128) - Size of a single rocksdb memtable (in MiB) + --persistent-storage-write-buffer-size-mb arg (=128) + Size of a single rocksdb memtable (in MiB). + --persistent-storage-bytes-per-sync Rocksdb write rate of flushes and compactions. + --persistent-storage-mbytes-snapshot-batch + Rocksdb batch size threshold before writing read in snapshot data to database. --reversible-blocks-db-size-mb arg (=340) Maximum size (in MiB) of the reversible blocks database From 0195084b24f9b61c87b2a29be869a679d19c27b2 Mon Sep 17 00:00:00 2001 From: Philip Halsall Date: Fri, 27 Nov 2020 11:35:48 +0800 Subject: [PATCH 5/6] removing number of cores as default --- .../60_how-to-guides/10_how-to-configure-state-storage.md | 3 +-- docs/01_nodeos/03_plugins/chain_plugin/index.md | 3 +-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md b/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md index 8d030298dc5..656c2e1a8ba 100644 --- a/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md +++ b/docs/01_nodeos/02_usage/60_how-to-guides/10_how-to-configure-state-storage.md @@ -13,8 +13,7 @@ Config Options for eosio::chain_plugin: --backing-store arg (=chainbase) The storage for state, chainbase or rocksdb --persistent-storage-num-threads arg Number of rocksdb threads for flush and - compaction. Defaults to the number of - available cores. + compaction. --persistent-storage-max-num-files arg (=-1) Max number of rocksdb files to keep open. -1 = unlimited. diff --git a/docs/01_nodeos/03_plugins/chain_plugin/index.md b/docs/01_nodeos/03_plugins/chain_plugin/index.md index 5241e056de2..9c338e3afbb 100644 --- a/docs/01_nodeos/03_plugins/chain_plugin/index.md +++ b/docs/01_nodeos/03_plugins/chain_plugin/index.md @@ -116,8 +116,7 @@ Config Options for eosio::chain_plugin: --backing-store arg (=chainbase) The storage for state, chainbase or rocksdb --persistent-storage-num-threads arg Number of rocksdb threads for flush and - compaction. Defaults to the number of - available cores. + compaction. --persistent-storage-max-num-files arg (=-1) Max number of rocksdb files to keep open. -1 = unlimited. From d808146853363c424acd23f6f875d4adb9a37408 Mon Sep 17 00:00:00 2001 From: Philip Halsall Date: Mon, 7 Dec 2020 17:27:53 +0800 Subject: [PATCH 6/6] adding link to 01_nodeos index - see review requested chnages --- docs/01_nodeos/02_usage/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/01_nodeos/02_usage/index.md b/docs/01_nodeos/02_usage/index.md index 2ab1a5a7ae1..2d9b47842cb 100644 --- a/docs/01_nodeos/02_usage/index.md +++ b/docs/01_nodeos/02_usage/index.md @@ -8,3 +8,4 @@ This section explains how to use `nodeos`, lists its configuration options, desc * [Configuration](01_nodeos-configuration.md) - CLI vs. `config.ini` options; `nodeos` example. * [Node Setups](02_node-setups/index.md) - Producing vs. non-producing nodes setup. * [Development Environment](03_development-environment/index.md) - Setting up a development/test environment. +* [How to Configure State Storage](60_how-to-guides/10_how-to-configure-state-storage.md) - How to configure the `nodeos` `backing store`.