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.

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

merge-queue: embarking main (769d069) and [#4641 + #4645 + #4647] together #4657

Closed
wants to merge 8 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

38 changes: 38 additions & 0 deletions book/src/dev/tokio-console.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# `tokio-console` support

`tokio-console` is a diagnostics and debugging tool for asynchronous Rust programs. This tool can be
useful to lint runtime behavior, collect diagnostic data from processes, and debugging performance
issues. ["it's like top(1) for tasks!"][top]

### Setup

Support for `tokio-console` is not enabled by default for zebrad. To activate this feature, run:
```sh
$ RUSTFLAGS="--cfg tokio_unstable" cargo build --no-default-features --features="tokio-console" --bin zebrad
```

Install [`tokio-console`][install].

Then start `zebrad` however you wish.

When `zebrad` is running, run:
```
$ tokio-console
```

The default options are used, so `tokio-console` should connect to the running `zebrad` without other configuration.

### Example

<img width="788" alt="image" src="https://user-images.githubusercontent.com/552961/174457604-53c6ffc6-64f6-4952-94c6-ac7eb37c3871.png">


### More

For more details, see the [`tokio` docs][enabling_tokio_instrumentation].


[top]: https://github.com/tokio-rs/console#extremely-cool-and-amazing-screenshots
[install]: https://github.com/tokio-rs/console#running-the-console]
[enabling_tokio_instrumentation]: https://github.com/tokio-rs/console/blob/main/console-subscriber/README.md#enabling-tokio-instrumentation

2 changes: 1 addition & 1 deletion zebra-rpc/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ proptest = { version = "0.10.1", optional = true }
proptest-derive = { version = "0.3.0", optional = true }

[dev-dependencies]
insta = { version = "1.14.1", features = ["redactions"] }
insta = { version = "1.15.0", features = ["redactions"] }
proptest = "0.10.1"
proptest-derive = "0.3.0"
serde_json = "1.0.81"
Expand Down
2 changes: 1 addition & 1 deletion zebra-state/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ once_cell = "1.12.0"
spandoc = "0.2.2"

hex = { version = "0.4.3", features = ["serde"] }
insta = { version = "1.14.1", features = ["ron"] }
insta = { version = "1.15.0", features = ["ron"] }

proptest = "0.10.1"
proptest-derive = "0.3.0"
Expand Down
2 changes: 1 addition & 1 deletion zebra-test/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ edition = "2021"
hex = "0.4.3"
indexmap = "1.8.2"
lazy_static = "1.4.0"
insta = "1.14.1"
insta = "1.15.0"
proptest = "0.10.1"
once_cell = "1.12.0"
rand = { version = "0.8.5", package = "rand" }
Expand Down
2 changes: 1 addition & 1 deletion zebrad/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ sentry = { version = "0.26.0", default-features = false, features = ["backtrace"

# prod feature flamegraph
tracing-flame = { version = "0.2.0", optional = true }
inferno = { version = "0.11.4", default-features = false, optional = true }
inferno = { version = "0.11.5", default-features = false, optional = true }

# prod feature journald
tracing-journald = { version = "0.3.0", optional = true }
Expand Down