Mukan Erkin Törük
ef24c0b67e
Some checks are pending
docker-build-cometbft / vars (push) Waiting to run
docker-build-cometbft / build-images (amd64, ubuntu-24.04) (push) Blocked by required conditions
docker-build-cometbft / build-images (arm64, ubuntu-24.04-arm) (push) Blocked by required conditions
docker-build-cometbft / merge-images (push) Blocked by required conditions
docker-build-e2e-node / vars (push) Waiting to run
docker-build-e2e-node / build-images (amd64, ubuntu-24.04) (push) Blocked by required conditions
docker-build-e2e-node / build-images (arm64, ubuntu-24.04-arm) (push) Blocked by required conditions
docker-build-e2e-node / merge-images (push) Blocked by required conditions
36 lines
1.3 KiB
Go
36 lines
1.3 KiB
Go
/*
|
|
Package inspect provides a tool for investigating the state of a
|
|
failed CometBFT node.
|
|
|
|
This package provides the Inspector type. The Inspector type runs a subset of the CometBFT
|
|
RPC endpoints that are useful for debugging issues with CometBFT's consensus.
|
|
|
|
When a node running the CometBFT's consensus engine detects an inconsistent consensus state,
|
|
the entire node will crash. The CometBFT's 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
|