go-ethereum/docs/cli/debug.md
Manav Darji 0d2b1d0630
internal/cli: add block tracing (#397)
* bad block tracing

* Add debug env framework

* add implementation of custom block tracing

* add few comments

* use tar name fn

* wip: add unit tests for block tracing

* complete test for block tracer

* fix: close grpc server

* refactor cli tests

* fix: change condition for parsing args

* Fix port binding for test server

* add helper for creating and closing mock server for tests

* consume mock server in tests

* fixes due to geth merge

* fix: handle port selection for http server

* update help and markdown for debug command

* update docs

* update debug synopsis

* fix: use chunked encoder to handle large data over grpc

* fix prints

* lint

* rm unused function, rename fn to TraceBorBlock

Co-authored-by: Ferran Borreguero <ferranbt@protonmail.com>
2022-06-06 14:54:05 +05:30

27 lines
No EOL
554 B
Markdown

# Debug
The ```bor debug``` command takes a debug dump of the running client.
- [```bor debug pprof```](./debug_pprof.md): Dumps bor pprof traces.
- [```bor debug block <number>```](./debug_block.md): Dumps bor block traces.
## Examples
By default it creates a tar.gz file with the output:
```
$ bor debug
Starting debugger...
Created debug archive: bor-debug-2021-10-26-073819Z.tar.gz
```
Send the output to a specific directory:
```
$ bor debug --output data
Starting debugger...
Created debug directory: data/bor-debug-2021-10-26-075437Z
```