mirror of
https://github.com/tendermint/tendermint.git
synced 2026-01-08 06:15:33 +00:00
bc2b529b95
EDIT: Updated, see [comment below]( https://github.com/tendermint/tendermint/pull/6785#issuecomment-897793175) This change adds a sketch of the `Debug` mode. This change adds a `Debug` struct to the node package. This `Debug` struct is intended to be created and started by a command in the `cmd` directory. The `Debug` struct runs the RPC server on the data directories: both the state store and the block store. This change required a good deal of refactoring. Namely, a new `rpc.go` file was added to the `node` package. This file encapsulates functions for starting RPC servers used by nodes. A potential additional change is to further factor this code into shared code _in_ the `rpc` package. Minor API tweaks were also made that seemed appropriate such as the mechanism for fetching routes from the `rpc/core` package. Additional work is required to register the `Debug` service as a command in the `cmd` directory but I am looking for feedback on if this direction seems appropriate before diving much further. closes: #5908
37 lines
1.3 KiB
Go
37 lines
1.3 KiB
Go
/*
|
|
Package inspect provides a tool for investigating the state of a
|
|
failed Tendermint node.
|
|
|
|
This package provides the Inspector type. The Inspector type runs a subset of the Tendermint
|
|
RPC endpoints that are useful for debugging issues with Tendermint consensus.
|
|
|
|
When a node running the Tendermint consensus engine detects an inconsistent consensus state,
|
|
the entire node will crash. The Tendermint consensus engine cannot run in this
|
|
inconsistent state so the node will not be able to start up again.
|
|
|
|
The RPC endpoints provided by the Inspector type allow for a node operator to inspect
|
|
the block store and state store to better understand what may have caused the inconsistent state.
|
|
|
|
|
|
The Inspector type's lifecycle is controlled by a context.Context
|
|
ins := inspect.NewFromConfig(rpcConfig)
|
|
ctx, cancelFunc:= context.WithCancel(context.Background())
|
|
|
|
// Run blocks until the Inspector server is shut down.
|
|
go ins.Run(ctx)
|
|
...
|
|
|
|
// calling the cancel function will stop the running inspect server
|
|
cancelFunc()
|
|
|
|
Inspector serves its RPC endpoints on the address configured in the RPC configuration
|
|
|
|
rpcConfig.ListenAddress = "tcp://127.0.0.1:26657"
|
|
ins := inspect.NewFromConfig(rpcConfig)
|
|
go ins.Run(ctx)
|
|
|
|
The list of available RPC endpoints can then be viewed by navigating to
|
|
http://127.0.0.1:26657/ in the web browser.
|
|
*/
|
|
package inspect
|