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.

379 lines
13 KiB

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
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
  1. # Configuration
  2. Tendermint Core can be configured via a TOML file in
  3. `$TMHOME/config/config.toml`. Some of these parameters can be overridden by
  4. command-line flags. For most users, the options in the `##### main base configuration options #####` are intended to be modified while
  5. config options further below are intended for advance power users.
  6. ## Options
  7. The default configuration file create by `tendermint init` has all
  8. the parameters set with their default values. It will look something
  9. like the file below, however, double check by inspecting the
  10. `config.toml` created with your version of `tendermint` installed:
  11. ```
  12. # This is a TOML config file.
  13. # For more information, see https://github.com/toml-lang/toml
  14. ##### main base config options #####
  15. # TCP or UNIX socket address of the ABCI application,
  16. # or the name of an ABCI application compiled in with the Tendermint binary
  17. proxy_app = "tcp://127.0.0.1:26658"
  18. # A custom human readable name for this node
  19. moniker = "anonymous"
  20. # If this node is many blocks behind the tip of the chain, FastSync
  21. # allows them to catchup quickly by downloading blocks in parallel
  22. # and verifying their commits
  23. fast_sync = true
  24. # Database backend: goleveldb | cleveldb | boltdb
  25. # * goleveldb (github.com/syndtr/goleveldb - most popular implementation)
  26. # - pure go
  27. # - stable
  28. # * cleveldb (uses levigo wrapper)
  29. # - fast
  30. # - requires gcc
  31. # - use cleveldb build tag (go build -tags cleveldb)
  32. # * boltdb (uses etcd's fork of bolt - github.com/etcd-io/bbolt)
  33. # - EXPERIMENTAL
  34. # - may be faster is some use-cases (random reads - indexer)
  35. # - use boltdb build tag (go build -tags boltdb)
  36. db_backend = "goleveldb"
  37. # Database directory
  38. db_dir = "data"
  39. # Output level for logging, including package level options
  40. log_level = "main:info,state:info,*:error"
  41. # Output format: 'plain' (colored text) or 'json'
  42. log_format = "plain"
  43. ##### additional base config options #####
  44. # Path to the JSON file containing the initial validator set and other meta data
  45. genesis_file = "config/genesis.json"
  46. # Path to the JSON file containing the private key to use as a validator in the consensus protocol
  47. priv_validator_file = "config/priv_validator.json"
  48. # TCP or UNIX socket address for Tendermint to listen on for
  49. # connections from an external PrivValidator process
  50. priv_validator_laddr = ""
  51. # Path to the JSON file containing the private key to use for node authentication in the p2p protocol
  52. node_key_file = "config/node_key.json"
  53. # Mechanism to connect to the ABCI application: socket | grpc
  54. abci = "socket"
  55. # TCP or UNIX socket address for the profiling server to listen on
  56. prof_laddr = ""
  57. # If true, query the ABCI app on connecting to a new peer
  58. # so the app can decide if we should keep the connection or not
  59. filter_peers = false
  60. ##### advanced configuration options #####
  61. ##### rpc server configuration options #####
  62. [rpc]
  63. # TCP or UNIX socket address for the RPC server to listen on
  64. laddr = "tcp://0.0.0.0:26657"
  65. # A list of origins a cross-domain request can be executed from
  66. # Default value '[]' disables cors support
  67. # Use '["*"]' to allow any origin
  68. cors_allowed_origins = []
  69. # A list of methods the client is allowed to use with cross-domain requests
  70. cors_allowed_methods = ["HEAD", "GET", "POST"]
  71. # A list of non simple headers the client is allowed to use with cross-domain requests
  72. cors_allowed_headers = ["Origin", "Accept", "Content-Type", "X-Requested-With", "X-Server-Time"]
  73. # TCP or UNIX socket address for the gRPC server to listen on
  74. # NOTE: This server only supports /broadcast_tx_commit
  75. grpc_laddr = ""
  76. # Maximum number of simultaneous connections.
  77. # Does not include RPC (HTTP&WebSocket) connections. See max_open_connections
  78. # If you want to accept a larger number than the default, make sure
  79. # you increase your OS limits.
  80. # 0 - unlimited.
  81. # Should be < {ulimit -Sn} - {MaxNumInboundPeers} - {MaxNumOutboundPeers} - {N of wal, db and other open files}
  82. # 1024 - 40 - 10 - 50 = 924 = ~900
  83. grpc_max_open_connections = 900
  84. # Activate unsafe RPC commands like /dial_seeds and /unsafe_flush_mempool
  85. unsafe = false
  86. # Maximum number of simultaneous connections (including WebSocket).
  87. # Does not include gRPC connections. See grpc_max_open_connections
  88. # If you want to accept a larger number than the default, make sure
  89. # you increase your OS limits.
  90. # 0 - unlimited.
  91. # Should be < {ulimit -Sn} - {MaxNumInboundPeers} - {MaxNumOutboundPeers} - {N of wal, db and other open files}
  92. # 1024 - 40 - 10 - 50 = 924 = ~900
  93. max_open_connections = 900
  94. # Maximum number of unique clientIDs that can /subscribe
  95. # If you're using /broadcast_tx_commit, set to the estimated maximum number
  96. # of broadcast_tx_commit calls per block.
  97. max_subscription_clients = 100
  98. # Maximum number of unique queries a given client can /subscribe to
  99. # If you're using GRPC (or Local RPC client) and /broadcast_tx_commit, set to
  100. # the estimated # maximum number of broadcast_tx_commit calls per block.
  101. max_subscriptions_per_client = 5
  102. # How long to wait for a tx to be committed during /broadcast_tx_commit.
  103. # WARNING: Using a value larger than 10s will result in increasing the
  104. # global HTTP write timeout, which applies to all connections and endpoints.
  105. # See https://github.com/tendermint/tendermint/issues/3435
  106. timeout_broadcast_tx_commit = "10s"
  107. # The name of a file containing certificate that is used to create the HTTPS server.
  108. # If the certificate is signed by a certificate authority,
  109. # the certFile should be the concatenation of the server's certificate, any intermediates,
  110. # and the CA's certificate.
  111. # NOTE: both tls_cert_file and tls_key_file must be present for Tendermint to create HTTPS server. Otherwise, HTTP server is run.
  112. tls_cert_file = ""
  113. # The name of a file containing matching private key that is used to create the HTTPS server.
  114. # NOTE: both tls_cert_file and tls_key_file must be present for Tendermint to create HTTPS server. Otherwise, HTTP server is run.
  115. tls_key_file = ""
  116. ##### peer to peer configuration options #####
  117. [p2p]
  118. # Address to listen for incoming connections
  119. laddr = "tcp://0.0.0.0:26656"
  120. # Address to advertise to peers for them to dial
  121. # If empty, will use the same port as the laddr,
  122. # and will introspect on the listener or use UPnP
  123. # to figure out the address.
  124. external_address = ""
  125. # Comma separated list of seed nodes to connect to
  126. seeds = ""
  127. # Comma separated list of nodes to keep persistent connections to
  128. persistent_peers = ""
  129. # UPNP port forwarding
  130. upnp = false
  131. # Path to address book
  132. addr_book_file = "config/addrbook.json"
  133. # Set true for strict address routability rules
  134. # Set false for private or local networks
  135. addr_book_strict = true
  136. # Maximum number of inbound peers
  137. max_num_inbound_peers = 40
  138. # Maximum number of outbound peers to connect to, excluding persistent peers
  139. max_num_outbound_peers = 10
  140. # Time to wait before flushing messages out on the connection
  141. flush_throttle_timeout = "100ms"
  142. # Maximum size of a message packet payload, in bytes
  143. max_packet_msg_payload_size = 1024
  144. # Rate at which packets can be sent, in bytes/second
  145. send_rate = 5120000
  146. # Rate at which packets can be received, in bytes/second
  147. recv_rate = 5120000
  148. # Set true to enable the peer-exchange reactor
  149. pex = true
  150. # Seed mode, in which node constantly crawls the network and looks for
  151. # peers. If another node asks it for addresses, it responds and disconnects.
  152. #
  153. # Does not work if the peer-exchange reactor is disabled.
  154. seed_mode = false
  155. # Comma separated list of peer IDs to keep private (will not be gossiped to other peers)
  156. private_peer_ids = ""
  157. # Toggle to disable guard against peers connecting from the same ip.
  158. allow_duplicate_ip = false
  159. # Peer connection configuration.
  160. handshake_timeout = "20s"
  161. dial_timeout = "3s"
  162. ##### mempool configuration options #####
  163. [mempool]
  164. recheck = true
  165. broadcast = true
  166. wal_dir = ""
  167. # Maximum number of transactions in the mempool
  168. size = 5000
  169. # Limit the total size of all txs in the mempool.
  170. # This only accounts for raw transactions (e.g. given 1MB transactions and
  171. # max_txs_bytes=5MB, mempool will only accept 5 transactions).
  172. max_txs_bytes = 1073741824
  173. # Size of the cache (used to filter transactions we saw earlier) in transactions
  174. cache_size = 10000
  175. ##### consensus configuration options #####
  176. [consensus]
  177. wal_file = "data/cs.wal/wal"
  178. timeout_propose = "3s"
  179. timeout_propose_delta = "500ms"
  180. timeout_prevote = "1s"
  181. timeout_prevote_delta = "500ms"
  182. timeout_precommit = "1s"
  183. timeout_precommit_delta = "500ms"
  184. timeout_commit = "1s"
  185. # Make progress as soon as we have all the precommits (as if TimeoutCommit = 0)
  186. skip_timeout_commit = false
  187. # EmptyBlocks mode and possible interval between empty blocks
  188. create_empty_blocks = true
  189. create_empty_blocks_interval = "0s"
  190. # Reactor sleep duration parameters
  191. peer_gossip_sleep_duration = "100ms"
  192. peer_query_maj23_sleep_duration = "2s"
  193. # Block time parameters. Corresponds to the minimum time increment between consecutive blocks.
  194. blocktime_iota = "1s"
  195. ##### transactions indexer configuration options #####
  196. [tx_index]
  197. # What indexer to use for transactions
  198. #
  199. # Options:
  200. # 1) "null"
  201. # 2) "kv" (default) - the simplest possible indexer, backed by key-value storage (defaults to levelDB; see DBBackend).
  202. indexer = "kv"
  203. # Comma-separated list of tags to index (by default the only tag is "tx.hash")
  204. #
  205. # You can also index transactions by height by adding "tx.height" tag here.
  206. #
  207. # It's recommended to index only a subset of tags due to possible memory
  208. # bloat. This is, of course, depends on the indexer's DB and the volume of
  209. # transactions.
  210. index_tags = ""
  211. # When set to true, tells indexer to index all tags (predefined tags:
  212. # "tx.hash", "tx.height" and all tags from DeliverTx responses).
  213. #
  214. # Note this may be not desirable (see the comment above). IndexTags has a
  215. # precedence over IndexAllTags (i.e. when given both, IndexTags will be
  216. # indexed).
  217. index_all_tags = false
  218. ##### instrumentation configuration options #####
  219. [instrumentation]
  220. # When true, Prometheus metrics are served under /metrics on
  221. # PrometheusListenAddr.
  222. # Check out the documentation for the list of available metrics.
  223. prometheus = false
  224. # Address to listen for Prometheus collector(s) connections
  225. prometheus_listen_addr = ":26660"
  226. # Maximum number of simultaneous connections.
  227. # If you want to accept a larger number than the default, make sure
  228. # you increase your OS limits.
  229. # 0 - unlimited.
  230. max_open_connections = 3
  231. # Instrumentation namespace
  232. namespace = "tendermint"
  233. ```
  234. ## Empty blocks VS no empty blocks
  235. **create_empty_blocks = true**
  236. If `create_empty_blocks` is set to `true` in your config, blocks will be
  237. created ~ every second (with default consensus parameters). You can regulate
  238. the delay between blocks by changing the `timeout_commit`. E.g. `timeout_commit
  239. = "10s"` should result in ~ 10 second blocks.
  240. **create_empty_blocks = false**
  241. In this setting, blocks are created when transactions received.
  242. Note after the block H, Tendermint creates something we call a "proof block"
  243. (only if the application hash changed) H+1. The reason for this is to support
  244. proofs. If you have a transaction in block H that changes the state to X, the
  245. new application hash will only be included in block H+1. If after your
  246. transaction is committed, you want to get a lite-client proof for the new state
  247. (X), you need the new block to be committed in order to do that because the new
  248. block has the new application hash for the state X. That's why we make a new
  249. (empty) block if the application hash changes. Otherwise, you won't be able to
  250. make a proof for the new state.
  251. Plus, if you set `create_empty_blocks_interval` to something other than the
  252. default (`0`), Tendermint will be creating empty blocks even in the absence of
  253. transactions every `create_empty_blocks_interval`. For instance, with
  254. `create_empty_blocks = false` and `create_empty_blocks_interval = "30s"`,
  255. Tendermint will only create blocks if there are transactions, or after waiting
  256. 30 seconds without receiving any transactions.
  257. ## Consensus timeouts explained
  258. There's a variety of information about timeouts in [Running in
  259. production](./running-in-production.html)
  260. You can also find more detailed technical explanation in the spec: [The latest
  261. gossip on BFT consensus](https://arxiv.org/abs/1807.04938).
  262. ```
  263. [consensus]
  264. ...
  265. timeout_propose = "3s"
  266. timeout_propose_delta = "500ms"
  267. timeout_prevote = "1s"
  268. timeout_prevote_delta = "500ms"
  269. timeout_precommit = "1s"
  270. timeout_precommit_delta = "500ms"
  271. timeout_commit = "1s"
  272. ```
  273. Note that in a successful round, the only timeout that we absolutely wait no
  274. matter what is `timeout_commit`.
  275. Here's a brief summary of the timeouts:
  276. - `timeout_propose` = how long we wait for a proposal block before prevoting
  277. nil
  278. - `timeout_propose_delta` = how much timeout_propose increases with each round
  279. - `timeout_prevote` = how long we wait after receiving +2/3 prevotes for
  280. anything (ie. not a single block or nil)
  281. - `timeout_prevote_delta` = how much the timeout_prevote increases with each
  282. round
  283. - `timeout_precommit` = how long we wait after receiving +2/3 precommits for
  284. anything (ie. not a single block or nil)
  285. - `timeout_precommit_delta` = how much the timeout_precommit increases with
  286. each round
  287. - `timeout_commit` = how long we wait after committing a block, before starting
  288. on the new height (this gives us a chance to receive some more precommits,
  289. even though we already have +2/3)