You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

416 lines
14 KiB

limit number of /subscribe clients and queries per client (#3269) * limit number of /subscribe clients and queries per client Add the following config variables (under [rpc] section): * max_subscription_clients * max_subscriptions_per_client * timeout_broadcast_tx_commit Fixes #2826 new HTTPClient interface for subscriptions finalize HTTPClient events interface remove EventSubscriber fix data race ``` WARNING: DATA RACE Read at 0x00c000a36060 by goroutine 129: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe.func1() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:168 +0x1f0 Previous write at 0x00c000a36060 by goroutine 132: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:191 +0x4e0 github.com/tendermint/tendermint/rpc/client.WaitForOneEvent() /go/src/github.com/tendermint/tendermint/rpc/client/helpers.go:64 +0x178 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync.func1() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:139 +0x298 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 Goroutine 129 (running) created at: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:164 +0x4b7 github.com/tendermint/tendermint/rpc/client.WaitForOneEvent() /go/src/github.com/tendermint/tendermint/rpc/client/helpers.go:64 +0x178 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync.func1() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:139 +0x298 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 Goroutine 132 (running) created at: testing.(*T).Run() /usr/local/go/src/testing/testing.go:878 +0x659 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:119 +0x186 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 ================== ``` lite client works (tested manually) godoc comments httpclient: do not close the out channel use TimeoutBroadcastTxCommit no timeout for unsubscribe but 1s Local (5s HTTP) timeout for resubscribe format code change Subscribe#out cap to 1 and replace config vars with RPCConfig TimeoutBroadcastTxCommit can't be greater than rpcserver.WriteTimeout rpc: Context as first parameter to all functions reformat code fixes after my own review fixes after Ethan's review add test stubs fix config.toml * fixes after manual testing - rpc: do not recommend to use BroadcastTxCommit because it's slow and wastes Tendermint resources (pubsub) - rpc: better error in Subscribe and BroadcastTxCommit - HTTPClient: do not resubscribe if err = ErrAlreadySubscribed * fixes after Ismail's review * Update rpc/grpc/grpc_test.go Co-Authored-By: melekes <anton.kalyaev@gmail.com>
6 years ago
limit number of /subscribe clients and queries per client (#3269) * limit number of /subscribe clients and queries per client Add the following config variables (under [rpc] section): * max_subscription_clients * max_subscriptions_per_client * timeout_broadcast_tx_commit Fixes #2826 new HTTPClient interface for subscriptions finalize HTTPClient events interface remove EventSubscriber fix data race ``` WARNING: DATA RACE Read at 0x00c000a36060 by goroutine 129: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe.func1() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:168 +0x1f0 Previous write at 0x00c000a36060 by goroutine 132: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:191 +0x4e0 github.com/tendermint/tendermint/rpc/client.WaitForOneEvent() /go/src/github.com/tendermint/tendermint/rpc/client/helpers.go:64 +0x178 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync.func1() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:139 +0x298 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 Goroutine 129 (running) created at: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:164 +0x4b7 github.com/tendermint/tendermint/rpc/client.WaitForOneEvent() /go/src/github.com/tendermint/tendermint/rpc/client/helpers.go:64 +0x178 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync.func1() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:139 +0x298 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 Goroutine 132 (running) created at: testing.(*T).Run() /usr/local/go/src/testing/testing.go:878 +0x659 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:119 +0x186 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 ================== ``` lite client works (tested manually) godoc comments httpclient: do not close the out channel use TimeoutBroadcastTxCommit no timeout for unsubscribe but 1s Local (5s HTTP) timeout for resubscribe format code change Subscribe#out cap to 1 and replace config vars with RPCConfig TimeoutBroadcastTxCommit can't be greater than rpcserver.WriteTimeout rpc: Context as first parameter to all functions reformat code fixes after my own review fixes after Ethan's review add test stubs fix config.toml * fixes after manual testing - rpc: do not recommend to use BroadcastTxCommit because it's slow and wastes Tendermint resources (pubsub) - rpc: better error in Subscribe and BroadcastTxCommit - HTTPClient: do not resubscribe if err = ErrAlreadySubscribed * fixes after Ismail's review * Update rpc/grpc/grpc_test.go Co-Authored-By: melekes <anton.kalyaev@gmail.com>
6 years ago
blockchain: Reorg reactor (#3561) * go routines in blockchain reactor * Added reference to the go routine diagram * Initial commit * cleanup * Undo testing_logger change, committed by mistake * Fix the test loggers * pulled some fsm code into pool.go * added pool tests * changes to the design added block requests under peer moved the request trigger in the reactor poolRoutine, triggered now by a ticker in general moved everything required for making block requests smarter in the poolRoutine added a simple map of heights to keep track of what will need to be requested next added a few more tests * send errors to FSM in a different channel than blocks send errors (RemovePeer) from switch on a different channel than the one receiving blocks renamed channels added more pool tests * more pool tests * lint errors * more tests * more tests * switch fast sync to new implementation * fixed data race in tests * cleanup * finished fsm tests * address golangci comments :) * address golangci comments :) * Added timeout on next block needed to advance * updating docs and cleanup * fix issue in test from previous cleanup * cleanup * Added termination scenarios, tests and more cleanup * small fixes to adr, comments and cleanup * Fix bug in sendRequest() If we tried to send a request to a peer not present in the switch, a missing continue statement caused the request to be blackholed in a peer that was removed and never retried. While this bug was manifesting, the reactor kept asking for other blocks that would be stored and never consumed. Added the number of unconsumed blocks in the math for requesting blocks ahead of current processing height so eventually there will be no more blocks requested until the already received ones are consumed. * remove bpPeer's didTimeout field * Use distinct err codes for peer timeout and FSM timeouts * Don't allow peers to update with lower height * review comments from Ethan and Zarko * some cleanup, renaming, comments * Move block execution in separate goroutine * Remove pool's numPending * review comments * fix lint, remove old blockchain reactor and duplicates in fsm tests * small reorg around peer after review comments * add the reactor spec * verify block only once * review comments * change to int for max number of pending requests * cleanup and godoc * Add configuration flag fast sync version * golangci fixes * fix config template * move both reactor versions under blockchain * cleanup, golint, renaming stuff * updated documentation, fixed more golint warnings * integrate with behavior package * sync with master * gofmt * add changelog_pending entry * move to improvments * suggestion to changelog entry
5 years ago
  1. ---
  2. order: 3
  3. ---
  4. # Configuration
  5. Tendermint Core can be configured via a TOML file in
  6. `$TMHOME/config/config.toml`. Some of these parameters can be overridden by
  7. command-line flags. For most users, the options in the `##### main base configuration options #####` are intended to be modified while config options
  8. further below are intended for advance power users.
  9. ## Options
  10. The default configuration file create by `tendermint init` has all
  11. the parameters set with their default values. It will look something
  12. like the file below, however, double check by inspecting the
  13. `config.toml` created with your version of `tendermint` installed:
  14. ```
  15. # This is a TOML config file.
  16. # For more information, see https://github.com/toml-lang/toml
  17. # NOTE: Any path below can be absolute (e.g. "/var/myawesomeapp/data") or
  18. # relative to the home directory (e.g. "data"). The home directory is
  19. # "$HOME/.tendermint" by default, but could be changed via $TMHOME env variable
  20. # or --home cmd flag.
  21. ##### main base config options #####
  22. # TCP or UNIX socket address of the ABCI application,
  23. # or the name of an ABCI application compiled in with the Tendermint binary
  24. proxy_app = "tcp://127.0.0.1:26658"
  25. # A custom human readable name for this node
  26. moniker = "anonymous"
  27. # If this node is many blocks behind the tip of the chain, FastSync
  28. # allows them to catchup quickly by downloading blocks in parallel
  29. # and verifying their commits
  30. fast_sync = true
  31. # Database backend: goleveldb | cleveldb | boltdb | rocksdb
  32. # * goleveldb (github.com/syndtr/goleveldb - most popular implementation)
  33. # - pure go
  34. # - stable
  35. # * cleveldb (uses levigo wrapper)
  36. # - fast
  37. # - requires gcc
  38. # - use cleveldb build tag (go build -tags cleveldb)
  39. # * boltdb (uses etcd's fork of bolt - github.com/etcd-io/bbolt)
  40. # - EXPERIMENTAL
  41. # - may be faster is some use-cases (random reads - indexer)
  42. # - use boltdb build tag (go build -tags boltdb)
  43. # * rocksdb (uses github.com/tecbot/gorocksdb)
  44. # - EXPERIMENTAL
  45. # - requires gcc
  46. # - use rocksdb build tag (go build -tags rocksdb)
  47. db_backend = "goleveldb"
  48. # Database directory
  49. db_dir = "data"
  50. # Output level for logging, including package level options
  51. log_level = "main:info,state:info,*:error"
  52. # Output format: 'plain' (colored text) or 'json'
  53. log_format = "plain"
  54. ##### additional base config options #####
  55. # Path to the JSON file containing the initial validator set and other meta data
  56. genesis_file = "config/genesis.json"
  57. # Path to the JSON file containing the private key to use as a validator in the consensus protocol
  58. priv_validator_file = "config/priv_validator.json"
  59. # TCP or UNIX socket address for Tendermint to listen on for
  60. # connections from an external PrivValidator process
  61. priv_validator_laddr = ""
  62. # Path to the JSON file containing the private key to use for node authentication in the p2p protocol
  63. node_key_file = "config/node_key.json"
  64. # Mechanism to connect to the ABCI application: socket | grpc
  65. abci = "socket"
  66. # TCP or UNIX socket address for the profiling server to listen on
  67. prof_laddr = ""
  68. # If true, query the ABCI app on connecting to a new peer
  69. # so the app can decide if we should keep the connection or not
  70. filter_peers = false
  71. ##### advanced configuration options #####
  72. ##### rpc server configuration options #####
  73. [rpc]
  74. # TCP or UNIX socket address for the RPC server to listen on
  75. laddr = "tcp://0.0.0.0:26657"
  76. # A list of origins a cross-domain request can be executed from
  77. # Default value '[]' disables cors support
  78. # Use '["*"]' to allow any origin
  79. cors_allowed_origins = []
  80. # A list of methods the client is allowed to use with cross-domain requests
  81. cors_allowed_methods = ["HEAD", "GET", "POST"]
  82. # A list of non simple headers the client is allowed to use with cross-domain requests
  83. cors_allowed_headers = ["Origin", "Accept", "Content-Type", "X-Requested-With", "X-Server-Time"]
  84. # TCP or UNIX socket address for the gRPC server to listen on
  85. # NOTE: This server only supports /broadcast_tx_commit
  86. grpc_laddr = ""
  87. # Maximum number of simultaneous connections.
  88. # Does not include RPC (HTTP&WebSocket) connections. See max_open_connections
  89. # If you want to accept a larger number than the default, make sure
  90. # you increase your OS limits.
  91. # 0 - unlimited.
  92. # Should be < {ulimit -Sn} - {MaxNumInboundPeers} - {MaxNumOutboundPeers} - {N of wal, db and other open files}
  93. # 1024 - 40 - 10 - 50 = 924 = ~900
  94. grpc_max_open_connections = 900
  95. # Activate unsafe RPC commands like /dial_seeds and /unsafe_flush_mempool
  96. unsafe = false
  97. # Maximum number of simultaneous connections (including WebSocket).
  98. # Does not include gRPC connections. See grpc_max_open_connections
  99. # If you want to accept a larger number than the default, make sure
  100. # you increase your OS limits.
  101. # 0 - unlimited.
  102. # Should be < {ulimit -Sn} - {MaxNumInboundPeers} - {MaxNumOutboundPeers} - {N of wal, db and other open files}
  103. # 1024 - 40 - 10 - 50 = 924 = ~900
  104. max_open_connections = 900
  105. # Maximum number of unique clientIDs that can /subscribe
  106. # If you're using /broadcast_tx_commit, set to the estimated maximum number
  107. # of broadcast_tx_commit calls per block.
  108. max_subscription_clients = 100
  109. # Maximum number of unique queries a given client can /subscribe to
  110. # If you're using GRPC (or Local RPC client) and /broadcast_tx_commit, set to
  111. # the estimated # maximum number of broadcast_tx_commit calls per block.
  112. max_subscriptions_per_client = 5
  113. # How long to wait for a tx to be committed during /broadcast_tx_commit.
  114. # WARNING: Using a value larger than 10s will result in increasing the
  115. # global HTTP write timeout, which applies to all connections and endpoints.
  116. # See https://github.com/tendermint/tendermint/issues/3435
  117. timeout_broadcast_tx_commit = "10s"
  118. # Maximum size of request body, in bytes
  119. max_body_bytes = {{ .RPC.MaxBodyBytes }}
  120. # Maximum size of request header, in bytes
  121. max_header_bytes = {{ .RPC.MaxHeaderBytes }}
  122. # The path to a file containing certificate that is used to create the HTTPS server.
  123. # Migth be either absolute path or path related to tendermint's config directory.
  124. # If the certificate is signed by a certificate authority,
  125. # the certFile should be the concatenation of the server's certificate, any intermediates,
  126. # and the CA's certificate.
  127. # NOTE: both tls_cert_file and tls_key_file must be present for Tendermint to create HTTPS server. Otherwise, HTTP server is run.
  128. tls_cert_file = ""
  129. # The path to a file containing matching private key that is used to create the HTTPS server.
  130. # Migth be either absolute path or path related to tendermint's config directory.
  131. # NOTE: both tls_cert_file and tls_key_file must be present for Tendermint to create HTTPS server. Otherwise, HTTP server is run.
  132. tls_key_file = ""
  133. ##### peer to peer configuration options #####
  134. [p2p]
  135. # Address to listen for incoming connections
  136. laddr = "tcp://0.0.0.0:26656"
  137. # Address to advertise to peers for them to dial
  138. # If empty, will use the same port as the laddr,
  139. # and will introspect on the listener or use UPnP
  140. # to figure out the address.
  141. external_address = ""
  142. # Comma separated list of seed nodes to connect to
  143. seeds = ""
  144. # Comma separated list of nodes to keep persistent connections to
  145. persistent_peers = ""
  146. # UPNP port forwarding
  147. upnp = false
  148. # Path to address book
  149. addr_book_file = "config/addrbook.json"
  150. # Set true for strict address routability rules
  151. # Set false for private or local networks
  152. addr_book_strict = true
  153. # Maximum number of inbound peers
  154. max_num_inbound_peers = 40
  155. # Maximum number of outbound peers to connect to, excluding persistent peers
  156. max_num_outbound_peers = 10
  157. # Time to wait before flushing messages out on the connection
  158. flush_throttle_timeout = "100ms"
  159. # Maximum size of a message packet payload, in bytes
  160. max_packet_msg_payload_size = 1024
  161. # Rate at which packets can be sent, in bytes/second
  162. send_rate = 5120000
  163. # Rate at which packets can be received, in bytes/second
  164. recv_rate = 5120000
  165. # Set true to enable the peer-exchange reactor
  166. pex = true
  167. # Seed mode, in which node constantly crawls the network and looks for
  168. # peers. If another node asks it for addresses, it responds and disconnects.
  169. #
  170. # Does not work if the peer-exchange reactor is disabled.
  171. seed_mode = false
  172. # Comma separated list of peer IDs to keep private (will not be gossiped to other peers)
  173. private_peer_ids = ""
  174. # Toggle to disable guard against peers connecting from the same ip.
  175. allow_duplicate_ip = false
  176. # Peer connection configuration.
  177. handshake_timeout = "20s"
  178. dial_timeout = "3s"
  179. ##### mempool configuration options #####
  180. [mempool]
  181. recheck = true
  182. broadcast = true
  183. wal_dir = ""
  184. # Maximum number of transactions in the mempool
  185. size = 5000
  186. # Limit the total size of all txs in the mempool.
  187. # This only accounts for raw transactions (e.g. given 1MB transactions and
  188. # max_txs_bytes=5MB, mempool will only accept 5 transactions).
  189. max_txs_bytes = 1073741824
  190. # Size of the cache (used to filter transactions we saw earlier) in transactions
  191. cache_size = 10000
  192. # Maximum size of a single transaction.
  193. # NOTE: the max size of a tx transmitted over the network is {max_tx_bytes} + {amino overhead}.
  194. max_tx_bytes = 1048576
  195. ##### fast sync configuration options #####
  196. [fastsync]
  197. # Fast Sync version to use:
  198. # 1) "v0" (default) - the legacy fast sync implementation
  199. # 2) "v1" - refactor of v0 version for better testability
  200. version = "v0"
  201. ##### consensus configuration options #####
  202. [consensus]
  203. wal_file = "data/cs.wal/wal"
  204. timeout_propose = "3s"
  205. timeout_propose_delta = "500ms"
  206. timeout_prevote = "1s"
  207. timeout_prevote_delta = "500ms"
  208. timeout_precommit = "1s"
  209. timeout_precommit_delta = "500ms"
  210. timeout_commit = "1s"
  211. # Make progress as soon as we have all the precommits (as if TimeoutCommit = 0)
  212. skip_timeout_commit = false
  213. # EmptyBlocks mode and possible interval between empty blocks
  214. create_empty_blocks = true
  215. create_empty_blocks_interval = "0s"
  216. # Reactor sleep duration parameters
  217. peer_gossip_sleep_duration = "100ms"
  218. peer_query_maj23_sleep_duration = "2s"
  219. # Block time parameters. Corresponds to the minimum time increment between consecutive blocks.
  220. blocktime_iota = "1s"
  221. ##### transactions indexer configuration options #####
  222. [tx_index]
  223. # What indexer to use for transactions
  224. #
  225. # Options:
  226. # 1) "null"
  227. # 2) "kv" (default) - the simplest possible indexer, backed by key-value storage (defaults to levelDB; see DBBackend).
  228. indexer = "kv"
  229. # Comma-separated list of compositeKeys to index (by default the only key is "tx.hash")
  230. # Remember that Event has the following structure: type.key
  231. # type: [
  232. # key: value,
  233. # ...
  234. # ]
  235. #
  236. # You can also index transactions by height by adding "tx.height" event here.
  237. #
  238. # It's recommended to index only a subset of keys due to possible memory
  239. # bloat. This is, of course, depends on the indexer's DB and the volume of
  240. # transactions.
  241. index_keys = ""
  242. # When set to true, tells indexer to index all compositeKeys (predefined keys:
  243. # "tx.hash", "tx.height" and all keys from DeliverTx responses).
  244. #
  245. # Note this may be not desirable (see the comment above). IndexEvents has a
  246. # precedence over IndexAllEvents (i.e. when given both, IndexEvents will be
  247. # indexed).
  248. index_all_keys = false
  249. ##### instrumentation configuration options #####
  250. [instrumentation]
  251. # When true, Prometheus metrics are served under /metrics on
  252. # PrometheusListenAddr.
  253. # Check out the documentation for the list of available metrics.
  254. prometheus = false
  255. # Address to listen for Prometheus collector(s) connections
  256. prometheus_listen_addr = ":26660"
  257. # Maximum number of simultaneous connections.
  258. # If you want to accept a larger number than the default, make sure
  259. # you increase your OS limits.
  260. # 0 - unlimited.
  261. max_open_connections = 3
  262. # Instrumentation namespace
  263. namespace = "tendermint"
  264. ```
  265. ## Empty blocks VS no empty blocks
  266. **create_empty_blocks = true**
  267. If `create_empty_blocks` is set to `true` in your config, blocks will be
  268. created ~ every second (with default consensus parameters). You can regulate
  269. the delay between blocks by changing the `timeout_commit`. E.g. `timeout_commit = "10s"` should result in ~ 10 second blocks.
  270. **create_empty_blocks = false**
  271. In this setting, blocks are created when transactions received.
  272. Note after the block H, Tendermint creates something we call a "proof block"
  273. (only if the application hash changed) H+1. The reason for this is to support
  274. proofs. If you have a transaction in block H that changes the state to X, the
  275. new application hash will only be included in block H+1. If after your
  276. transaction is committed, you want to get a lite-client proof for the new state
  277. (X), you need the new block to be committed in order to do that because the new
  278. block has the new application hash for the state X. That's why we make a new
  279. (empty) block if the application hash changes. Otherwise, you won't be able to
  280. make a proof for the new state.
  281. Plus, if you set `create_empty_blocks_interval` to something other than the
  282. default (`0`), Tendermint will be creating empty blocks even in the absence of
  283. transactions every `create_empty_blocks_interval`. For instance, with
  284. `create_empty_blocks = false` and `create_empty_blocks_interval = "30s"`,
  285. Tendermint will only create blocks if there are transactions, or after waiting
  286. 30 seconds without receiving any transactions.
  287. ## Consensus timeouts explained
  288. There's a variety of information about timeouts in [Running in
  289. production](./running-in-production.md)
  290. You can also find more detailed technical explanation in the spec: [The latest
  291. gossip on BFT consensus](https://arxiv.org/abs/1807.04938).
  292. ```
  293. [consensus]
  294. ...
  295. timeout_propose = "3s"
  296. timeout_propose_delta = "500ms"
  297. timeout_prevote = "1s"
  298. timeout_prevote_delta = "500ms"
  299. timeout_precommit = "1s"
  300. timeout_precommit_delta = "500ms"
  301. timeout_commit = "1s"
  302. ```
  303. Note that in a successful round, the only timeout that we absolutely wait no
  304. matter what is `timeout_commit`.
  305. Here's a brief summary of the timeouts:
  306. - `timeout_propose` = how long we wait for a proposal block before prevoting
  307. nil
  308. - `timeout_propose_delta` = how much timeout_propose increases with each round
  309. - `timeout_prevote` = how long we wait after receiving +2/3 prevotes for
  310. anything (ie. not a single block or nil)
  311. - `timeout_prevote_delta` = how much the timeout_prevote increases with each
  312. round
  313. - `timeout_precommit` = how long we wait after receiving +2/3 precommits for
  314. anything (ie. not a single block or nil)
  315. - `timeout_precommit_delta` = how much the timeout_precommit increases with
  316. each round
  317. - `timeout_commit` = how long we wait after committing a block, before starting
  318. on the new height (this gives us a chance to receive some more precommits,
  319. even though we already have +2/3)