Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add --debug=rpc and --debug=profiling flags for enabling debug output #3352

Merged
merged 12 commits into from
May 23, 2023
Merged

Add --debug=rpc and --debug=profiling flags for enabling debug output #3352

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
6ec2c5c
Add `--debug=rpc` flag for enabling Tendermint RPC debug info
romac May 22, 2023
2938d8b
Add `--debug=rpc` flag for enabling profiling output
romac May 22, 2023
f61aa8a
Only output profiling info on console if profiling is enabled
romac May 22, 2023
4c75120
Allow comma-separated values
romac May 22, 2023
42a78f8
Re-generate templates
romac May 22, 2023
1592e16
Add `json-profiling` debug section, change env variable to `PROFILING…
romac May 22, 2023
d095304
Add newline after each JSON entry
romac May 22, 2023
eacd400
Use atomics instead of once cell for profiling flags
romac May 22, 2023
bc105a8
Avoid doing any work when profiling is disabled
romac May 22, 2023
6cfdc14
Update templates
romac May 22, 2023
c9e9f5a
Add note to guide for profiling-json. Add changelog entry
ljoss17 May 23, 2023
fbb5f84
Update changelog entry
romac May 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/unreleased/features/ibc-relayer-cli/2852-add-debug-flag.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Add a global flag `--debug` which allows enabling
profiling, rpc debug logs and/or profiling to json file
romac marked this conversation as resolved.
Show resolved Hide resolved
([#2852](https://github.com/informalsystems/hermes/issues/2852))
3 changes: 3 additions & 0 deletions guide/src/advanced/troubleshooting/profiling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,9 @@ Additionally, if the `--debug=profiling-json` flag is specified, Hermes will out
JSON format in a file named `hermes-YYYY-MM-DD-HHMMSS-prof.json`, in the directory specified in the `PROFILING_DIR`
env variable, or the current directory otherwise.

> __NOTE__: Outputting profiling information in JSON format in a file is only available for the `hermes start` command.
> This debug option won't do anything with the other CLIs.

```json
{"name":"fetch_node_info","src_chain":"ibc-0","elapsed":6}
{"name":"chain_status","src_chain":"ibc-0","elapsed":12}
Expand Down