Add comments to parameters in config.ini. steemit#506

plugins/account_history/plugin.cpp

@@ -346,7 +346,7 @@ void plugin::set_program_options(
          ("track-account-range", boost::program_options::value< vector< string > >()->composing()->multitoken(), "Defines a range of accounts to track as a json pair [\"from\",\"to\"] [from,to] Can be specified multiple times")
          ("history-whitelist-ops", boost::program_options::value< vector< string > >()->composing(), "Defines a list of operations which will be explicitly logged.")
          ("history-blacklist-ops", boost::program_options::value< vector< string > >()->composing(), "Defines a list of operations which will be explicitly ignored.")
-         ("history-start-block", boost::program_options::value<uint32_t>()->composing(), "Defines starting block from wich recording starts")
+         ("history-start-block", boost::program_options::value<uint32_t>()->composing(), "Defines starting block from which recording stats.")
          ;
     cfg.add(cli);
 }

share/golosd/config/config.ini

@@ -1,72 +1,90 @@
 # Endpoint for P2P node to listen on
-# p2p-endpoint =
+p2p-endpoint = 0.0.0.0:4243
 
 # Maxmimum number of incoming connections on P2P endpoint
 # p2p-max-connections =
 
 # P2P nodes to connect to on startup (may specify multiple times)
-# seed-node =
+# p2p-seed-node =
 
 # Pairs of [BLOCK_NUM,BLOCK_ID] that should be enforced as checkpoints.
 # checkpoint =
 
-# Endpoint for websocket RPC to listen on
-# rpc-endpoint =
-
-# Endpoint for TLS websocket RPC to listen on
-# rpc-tls-endpoint =
-
-# The TLS certificate file for this server
-# server-pem =
-
-# Password for this certificate
-# server-pem-password =
-
-# Block signing key to use for init witnesses, overrides genesis file
-# dbg-init-key =
-
-# API user specification, may be specified multiple times
-# api-user =
-
+# Number of threads for rpc-clients. The optimal value is `<number of CPU>-1`
 webserver-thread-pool-size = 2
+
+# IP:PORT for HTTP connections
 webserver-http-endpoint = 0.0.0.0:8090
+
+# IP:PORT for WebSocket connections
 webserver-ws-endpoint = 0.0.0.0:8091
-rpc-endpoint = 0.0.0.0:2001
 
+# Maximum microseconds for trying to get read lock
 read-wait-micro = 500000
+
+# Maximum retries to get read lock. Each retry is read-wait-micro microseconds.
+# When all retries are made, the rpc-client receives error 'Unable to acquire READ lock'.
 max-read-wait-retries = 2
 
+# Maximum microseconds for trying to get write lock on broadcast transaction.
 write-wait-micro = 500000
+
+# Maximum retries to get write lock. Each retry is write-wait-micro microseconds.
+# When all retries are made, the rpc-client receives error 'Unable to acquire WRITE lock'.
 max-write-wait-retries = 3
 
+# Do all write operations (push_block/push_transaction) in the single thread.
+# Write lock of database is very heavy. When many threads tries to lock database on writing, rpc-clients
+# receive many errors 'Unable to acquire READ lock' ('Unable to acquire WRITE lock').
+# Enabling of this options can increase performance.
 single-write-thread = true
 
-# Plugins doesn't validate data, so they can be disabled on push_transaction().
-# Disabling of this option allows to increase performance.
+# Enable plugin notifications about operations in a pushed transaction, which should be included to the next generated
+# block. Plugins doesn't validate data in operations, they only update its own indexes, so notifications can be
+# disabled on push_transaction() without any side-effects. The option doesn't have effect on a pushing signed blocks,
+# so it is safe.
+# Disabling of this option can increase performance.
 enable-plugins-on-push-transaction = false
 
+# A start size for shared memory file when it doesn't have any data. Possible cases:
+# - If shared memory has data and the value is greater then the size of shared_memory.bin,
+#   the file will be grown to requested size.
+# - If shared memory has data and the value is less then the size of shared_memory.bin, nothing happens.
+# Changing of this parameter doesn't require the replaying.
 shared-file-size = 2G
-inc-shared-file-size = 2G
+
+# The minimum free space in the shared memory file. When free space reaches the following value, the size of the
+# shared_memory.bin increases by the value of inc-shared-file-size.
 min-free-shared-file-size = 500M
+
+# Step of increasing size of shared_memory.bin. When the free memory size reaches min-free-shared-file-size,
+# the shared memory size increases by the following value.
+inc-shared-file-size = 2G
+
+# How often do checking the free space in shared_memory.bin. A very frequent checking can decrease performance.
+# It's not critical if the free size became very small, because the daemon catches the `bad_alloc` exception
+# and resizes. The optimal strategy is do checking of the free space, but not very often.
 block-num-check-free-size = 1000 # each 3000 seconds
 
 plugin = chain p2p json_rpc webserver network_broadcast_api witness test_api database_api private_message follow social_network market_history account_by_key account_history statsd block_info raw_block
 
+# Remove votes before defined block, should increase performance
+clear-votes-before-block = 4294967295 # clear votes after each cashout
 
-# JSON list of [nblocks,nseconds] pairs, see documentation/bcd-trigger.md
-bcd-trigger = [[0,10],[85,300]]
+# Virtual operations will not be passed to the plugins, enabling of the option helps to save some memory.
+skip-virtual-ops = false
 
-# Defines a range of accounts to track as a json pair ["from","to"] [from,to]
+# Defines a range of accounts to track by the account_history plugin as a json pair ["from","to"] [from,to]
 # track-account-range =
 
-# Ignore posting operations, only track transfers and account updates
-# filter-posting-ops =
+# Defines a list of operations which will be explicitly logged by the account_history plugin.
+# history-whitelist-ops = account_create_operation account_update_operation comment_operation delete_comment_operation vote_operation author_reward_operation curation_reward_operation liquidity_reward_operation interest_operation fill_convert_request_operation transfer_operation transfer_to_vesting_operation withdraw_vesting_operation witness_update_operation account_witness_vote_operation account_witness_proxy_operation feed_publish_operation limit_order_create_operation fill_order_operation limit_order_cancel_operation pow_operation fill_vesting_withdraw_operation shutdown_witness_operation custom_operation request_account_recovery_operation recover_account_operation change_recovery_account_operation escrow_transfer_operation escrow_approve_operation escrow_dispute_operation escrow_release_operation transfer_to_savings_operation transfer_from_savings_operation cancel_transfer_from_savings_operation decline_voting_rights_operation  comment_benefactor_reward_operation
 
-# Database edits to apply on startup (may specify multiple times)
-# edit-script =
+# Defines a list of operations which will be explicitly ignored by the account_history plugin.
+# history-blacklist-ops =
 
-# RPC endpoint of a trusted validating node (required)
-# trusted-node =
+# Defines starting block from which recording stats by the account_history plugin.
+# history-start-block = 0
 
 # Set the maximum size of cached feed for an account
 follow-max-feed-size = 500
@@ -93,7 +111,7 @@ required-participation = 0
 # miner =
 
 # Number of threads to use for proof of work mining
-# mining-threads =
+mining-threads = 0
 
 # WIF PRIVATE KEY to be used by one or more witnesses or miners
 # private-key =
@@ -119,10 +137,10 @@ filename=logs/p2p/p2p.log
 # route any messages logged to the default logger to the "stderr" logger we
 # declared above, if they are info level are higher
 [logger.default]
-level=info
+level=debug
 appenders=stderr
 
 # route messages sent to the "p2p" logger to stderr too
 [logger.p2p]
-level=info
+level=error
 appenders=stderr

share/golosd/config/config_debug.ini

@@ -5,68 +5,86 @@
 # p2p-max-connections =
 
 # P2P nodes to connect to on startup (may specify multiple times)
-# seed-node =
+# p2p-seed-node =
 
 # Pairs of [BLOCK_NUM,BLOCK_ID] that should be enforced as checkpoints.
 # checkpoint =
 
-# Endpoint for websocket RPC to listen on
-# rpc-endpoint =
-
-# Endpoint for TLS websocket RPC to listen on
-# rpc-tls-endpoint =
-
-# The TLS certificate file for this server
-# server-pem =
-
-# Password for this certificate
-# server-pem-password =
-
-# Block signing key to use for init witnesses, overrides genesis file
-# dbg-init-key =
-
-# API user specification, may be specified multiple times
-# api-user =
-
+# Number of threads for rpc-clients. Optimal value `<number of CPU>-1`
 webserver-thread-pool-size = 2
+
+# IP:PORT for HTTP connections
 webserver-http-endpoint = 0.0.0.0:8090
-webserver-ws-endpoint = 0.0.0.0:8091
-rpc-endpoint = 0.0.0.0:2001
 
-shared-file-size = 100M
-inc-shared-file-size = 100M
-min-free-shared-file-size = 50M
-block-num-check-free-size = 100 # each 300 seconds
+# IP:PORT for WebSocket connections
+webserver-ws-endpoint = 0.0.0.0:8091
 
+# Maximum microseconds for trying to get read lock
 read-wait-micro = 500000
+
+# Maximum retries to get read lock. Each retry is read-wait-micro microseconds.
+# When all retries are made, the rpc-client receives error 'Unable to acquire READ lock'.
 max-read-wait-retries = 2
 
+# Maximum microseconds for trying to get write lock on broadcast transaction.
 write-wait-micro = 500000
+
+# Maximum retries to get write lock. Each retry is write-wait-micro microseconds.
+# When all retries are made, the rpc-client receives error 'Unable to acquire WRITE lock'.
 max-write-wait-retries = 3
 
+# Do all write operations (push_block/push_transaction) in the single thread.
+# Write lock of database is very heavy. When many threads tries to lock database on writing, rpc-clients
+# receive many errors 'Unable to acquire READ lock' ('Unable to acquire WRITE lock').
+# Enabling of this options can increase performance.
 single-write-thread = true
 
+# Enable plugin notifications about operations in a pushed transaction, which should be included to the next generated
+# block. Plugins doesn't validate data in operations, they only update its own indexes, so notifications can be
+# disabled on push_transaction() without any side-effects. The option doesn't have effect on a pushing signed blocks,
+# so it is safe.
+# Disabling of this option can increase performance.
+enable-plugins-on-push-transaction = true
+
+# A start size for shared memory file when it doesn't have any data. Possible cases:
+# - If shared memory has data and the value is greater then the size of shared_memory.bin,
+#   the file will be grown to requested size.
+# - If shared memory has data and the value is less then the size of shared_memory.bin, nothing happens.
+# Changing of this parameter doesn't require the replaying.
+shared-file-size = 100M
+
+# The minimum free space in the shared memory file. When free space reaches the following value, the size of the
+# shared_memory.bin increases by the value of inc-shared-file-size.
+min-free-shared-file-size = 50M
+
+# Step of increasing size of shared_memory.bin. When the free memory size reaches min-free-shared-file-size,
+# the shared memory size increases by the following value.
+inc-shared-file-size = 100M
+
+# How often do checking the free space in shared_memory.bin. A very frequent checking can decrease performance.
+# It's not critical if the free size became very small, because the daemon catches the `bad_alloc` exception
+# and resizes. The optimal strategy is do checking of the free space, but not very often.
+block-num-check-free-size = 10 # each 30 seconds
 
 plugin = chain p2p json_rpc webserver network_broadcast_api witness test_api database_api private_message follow social_network market_history account_by_key account_history statsd block_info raw_block debug_node
 
-# Plugins doesn't validate data, so they can be disabled on push_transaction().
-# Disabling of this option allows to increase performance.
-enable-plugins-on-push-transaction = true
+# Remove votes before defined block, should increase performance
+clear-votes-before-block = 0 # don't clear votes
 
-# JSON list of [nblocks,nseconds] pairs, see documentation/bcd-trigger.md
-bcd-trigger = [[0,10],[85,300]]
+# Virtual operations will not be passed to the plugins, enabling of the option helps to save some memory.
+skip-virtual-ops = false
 
-# Defines a range of accounts to track as a json pair ["from","to"] [from,to]
+# Defines a range of accounts to track by the account_history plugin as a json pair ["from","to"] [from,to]
 # track-account-range =
 
-# Ignore posting operations, only track transfers and account updates
-# filter-posting-ops =
+# Defines a list of operations which will be explicitly logged by the account_history plugin.
+# history-whitelist-ops =
 
-# Database edits to apply on startup (may specify multiple times)
-# edit-script =
+# Defines a list of operations which will be explicitly ignored by the account_history plugin.
+# history-blacklist-ops =
 
-# RPC endpoint of a trusted validating node (required)
-# trusted-node =
+# Defines starting block from which recording stats by the account_history plugin.
+# history-start-block =
 
 # Set the maximum size of cached feed for an account
 follow-max-feed-size = 500