github.com/badrootd/celestia-core@v0.0.0-20240305091328-aa4207a4b25d/docs/core/how-to-read-logs.md (about) 1 --- 2 order: 7 3 --- 4 5 # How to read logs 6 7 ## Walkabout example 8 9 We first create three connections (mempool, consensus and query) to the 10 application (running `kvstore` locally in this case). 11 12 ```sh 13 I[10-04|13:54:27.364] Starting multiAppConn module=proxy impl=multiAppConn 14 I[10-04|13:54:27.366] Starting localClient module=abci-client connection=query impl=localClient 15 I[10-04|13:54:27.366] Starting localClient module=abci-client connection=mempool impl=localClient 16 I[10-04|13:54:27.367] Starting localClient module=abci-client connection=consensus impl=localClient 17 ``` 18 19 Then CometBFT and the application perform a handshake. 20 21 ```sh 22 I[10-04|13:54:27.367] ABCI Handshake module=consensus appHeight=90 appHash=E0FBAFBF6FCED8B9786DDFEB1A0D4FA2501BADAD 23 I[10-04|13:54:27.368] ABCI Replay Blocks module=consensus appHeight=90 storeHeight=90 stateHeight=90 24 I[10-04|13:54:27.368] Completed ABCI Handshake - CometBFT and App are synced module=consensus appHeight=90 appHash=E0FBAFBF6FCED8B9786DDFEB1A0D4FA2501BADAD 25 ``` 26 27 After that, we start a few more things like the event switch, reactors, 28 and perform UPNP discover in order to detect the IP address. 29 30 ```sh 31 I[10-04|13:54:27.374] Starting EventSwitch module=types impl=EventSwitch 32 I[10-04|13:54:27.375] This node is a validator module=consensus 33 I[10-04|13:54:27.379] Starting Node module=main impl=Node 34 I[10-04|13:54:27.381] Local listener module=p2p ip=:: port=26656 35 I[10-04|13:54:27.382] Getting UPNP external address module=p2p 36 I[10-04|13:54:30.386] Could not perform UPNP discover module=p2p err="write udp4 0.0.0.0:38238->239.255.255.250:1900: i/o timeout" 37 I[10-04|13:54:30.386] Starting DefaultListener module=p2p impl=Listener(@10.0.2.15:26656) 38 I[10-04|13:54:30.387] Starting P2P Switch module=p2p impl="P2P Switch" 39 I[10-04|13:54:30.387] Starting MempoolReactor module=mempool impl=MempoolReactor 40 I[10-04|13:54:30.387] Starting BlockchainReactor module=blockchain impl=BlockchainReactor 41 I[10-04|13:54:30.387] Starting ConsensusReactor module=consensus impl=ConsensusReactor 42 I[10-04|13:54:30.387] ConsensusReactor module=consensus fastSync=false 43 I[10-04|13:54:30.387] Starting ConsensusState module=consensus impl=ConsensusState 44 I[10-04|13:54:30.387] Starting WAL module=consensus wal=/home/vagrant/.cometbft/data/cs.wal/wal impl=WAL 45 I[10-04|13:54:30.388] Starting TimeoutTicker module=consensus impl=TimeoutTicker 46 ``` 47 48 Notice the second row where CometBFT reports that "This node is a 49 validator". It also could be just an observer (regular node). 50 51 Next we replay all the messages from the WAL. 52 53 ```sh 54 I[10-04|13:54:30.390] Catchup by replaying consensus messages module=consensus height=91 55 I[10-04|13:54:30.390] Replay: New Step module=consensus height=91 round=0 step=RoundStepNewHeight 56 I[10-04|13:54:30.390] Replay: Done module=consensus 57 ``` 58 59 "Started node" message signals that everything is ready for work. 60 61 ```sh 62 I[10-04|13:54:30.391] Starting RPC HTTP server on tcp socket 0.0.0.0:26657 module=rpc-server 63 I[10-04|13:54:30.392] Started node module=main nodeInfo="NodeInfo{id: DF22D7C92C91082324A1312F092AA1DA197FA598DBBFB6526E, moniker: anonymous, network: test-chain-3MNw2N [remote , listen 10.0.2.15:26656], version: 0.11.0-10f361fc ([wire_version=0.6.2 p2p_version=0.5.0 consensus_version=v1/0.2.2 rpc_version=0.7.0/3 tx_index=on rpc_addr=tcp://0.0.0.0:26657])}" 64 ``` 65 66 Next follows a standard block creation cycle, where we enter a new 67 round, propose a block, receive more than 2/3 of prevotes, then 68 precommits and finally have a chance to commit a block. For details, 69 please refer to [Byzantine Consensus Algorithm](https://github.com/cometbft/cometbft/blob/v0.34.x/spec/consensus/consensus.md). 70 71 ```sh 72 I[10-04|13:54:30.393] enterNewRound(91/0). Current: 91/0/RoundStepNewHeight module=consensus 73 I[10-04|13:54:30.393] enterPropose(91/0). Current: 91/0/RoundStepNewRound module=consensus 74 I[10-04|13:54:30.393] enterPropose: Our turn to propose module=consensus proposer=125B0E3C5512F5C2B0E1109E31885C4511570C42 privValidator="PrivValidator{125B0E3C5512F5C2B0E1109E31885C4511570C42 LH:90, LR:0, LS:3}" 75 I[10-04|13:54:30.394] Signed proposal module=consensus height=91 round=0 proposal="Proposal{91/0 1:21B79872514F (-1,:0:000000000000) {/10EDEDD7C84E.../}}" 76 I[10-04|13:54:30.397] Received complete proposal block module=consensus height=91 hash=F671D562C7B9242900A286E1882EE64E5556FE9E 77 I[10-04|13:54:30.397] enterPrevote(91/0). Current: 91/0/RoundStepPropose module=consensus 78 I[10-04|13:54:30.397] enterPrevote: ProposalBlock is valid module=consensus height=91 round=0 79 I[10-04|13:54:30.398] Signed and pushed vote module=consensus height=91 round=0 vote="Vote{0:125B0E3C5512 91/00/1(Prevote) F671D562C7B9 {/89047FFC21D8.../}}" err=null 80 I[10-04|13:54:30.401] Added to prevote module=consensus vote="Vote{0:125B0E3C5512 91/00/1(Prevote) F671D562C7B9 {/89047FFC21D8.../}}" prevotes="VoteSet{H:91 R:0 T:1 +2/3:F671D562C7B9242900A286E1882EE64E5556FE9E:1:21B79872514F BA{1:X} map[]}" 81 I[10-04|13:54:30.401] enterPrecommit(91/0). Current: 91/0/RoundStepPrevote module=consensus 82 I[10-04|13:54:30.401] enterPrecommit: +2/3 prevoted proposal block. Locking module=consensus hash=F671D562C7B9242900A286E1882EE64E5556FE9E 83 I[10-04|13:54:30.402] Signed and pushed vote module=consensus height=91 round=0 vote="Vote{0:125B0E3C5512 91/00/2(Precommit) F671D562C7B9 {/80533478E41A.../}}" err=null 84 I[10-04|13:54:30.404] Added to precommit module=consensus vote="Vote{0:125B0E3C5512 91/00/2(Precommit) F671D562C7B9 {/80533478E41A.../}}" precommits="VoteSet{H:91 R:0 T:2 +2/3:F671D562C7B9242900A286E1882EE64E5556FE9E:1:21B79872514F BA{1:X} map[]}" 85 I[10-04|13:54:30.404] enterCommit(91/0). Current: 91/0/RoundStepPrecommit module=consensus 86 I[10-04|13:54:30.405] Finalizing commit of block with 0 txs module=consensus height=91 hash=F671D562C7B9242900A286E1882EE64E5556FE9E root=E0FBAFBF6FCED8B9786DDFEB1A0D4FA2501BADAD 87 I[10-04|13:54:30.405] Block{ 88 Header{ 89 ChainID: test-chain-3MNw2N 90 Height: 91 91 Time: 2017-10-04 13:54:30.393 +0000 UTC 92 NumTxs: 0 93 LastBlockID: F15AB8BEF9A6AAB07E457A6E16BC410546AA4DC6:1:D505DA273544 94 LastCommit: 56FEF2EFDB8B37E9C6E6D635749DF3169D5F005D 95 Data: 96 Validators: CE25FBFF2E10C0D51AA1A07C064A96931BC8B297 97 App: E0FBAFBF6FCED8B9786DDFEB1A0D4FA2501BADAD 98 }#F671D562C7B9242900A286E1882EE64E5556FE9E 99 Data{ 100 101 }# 102 Commit{ 103 BlockID: F15AB8BEF9A6AAB07E457A6E16BC410546AA4DC6:1:D505DA273544 104 Precommits: Vote{0:125B0E3C5512 90/00/2(Precommit) F15AB8BEF9A6 {/FE98E2B956F0.../}} 105 }#56FEF2EFDB8B37E9C6E6D635749DF3169D5F005D 106 }#F671D562C7B9242900A286E1882EE64E5556FE9E module=consensus 107 I[10-04|13:54:30.408] Executed block module=state height=91 validTxs=0 invalidTxs=0 108 I[10-04|13:54:30.410] Committed state module=state height=91 txs=0 hash=E0FBAFBF6FCED8B9786DDFEB1A0D4FA2501BADAD 109 I[10-04|13:54:30.410] Recheck txs module=mempool numtxs=0 height=91 110 ``` 111 112 ## List of modules 113 114 Here is the list of modules you may encounter in CometBFT's log and a 115 little overview what they do. 116 117 - `abci-client` As mentioned in [Application Development Guide](../app-dev/abci-cli.md), CometBFT acts as an ABCI 118 client with respect to the application and maintains 3 connections: 119 mempool, consensus and query. The code used by CometBFT can 120 be found [here](https://github.com/cometbft/cometbft/blob/v0.34.x/abci/client). 121 - `blockchain` Provides storage, pool (a group of peers), and reactor 122 for both storing and exchanging blocks between peers. 123 - `consensus` The heart of CometBFT, which is the 124 implementation of the consensus algorithm. Includes two 125 "submodules": `wal` (write-ahead logging) for ensuring data 126 integrity and `replay` to replay blocks and messages on recovery 127 from a crash. 128 - `events` Simple event notification system. The list of events can be 129 found 130 [here](https://github.com/cometbft/cometbft/blob/v0.34.x/types/events.go). 131 You can subscribe to them by calling `subscribe` RPC method. Refer 132 to [RPC docs](./rpc.md) for additional information. 133 - `mempool` Mempool module handles all incoming transactions, whenever 134 they are coming from peers or the application. 135 - `p2p` Provides an abstraction around peer-to-peer communication. For 136 more details, please check out the 137 [README](https://github.com/cometbft/cometbft/blob/v0.34.x/p2p/README.md). 138 - `rpc` [CometBFT's RPC](./rpc.md). 139 - `rpc-server` RPC server. For implementation details, please read the 140 [doc.go](https://github.com/cometbft/cometbft/blob/v0.34.x/rpc/jsonrpc/doc.go). 141 - `state` Represents the latest state and execution submodule, which 142 executes blocks against the application. 143 - `types` A collection of the publicly exposed types and methods to 144 work with them.