Skip to content

chore(docs): Updated Benchmark Docs #894

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

Merged
rakita merged 1 commit into from
Dec 3, 2023
Merged

chore(docs): Updated Benchmark Docs #894

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,17 @@ TODO needs to be updated. Benches can now be found inside `crates/revm/benches`
cargo run --package revm-test --release --bin snailtracer
```

The following flamegraph will require installing [flamegraph] by running `cargo install flamegraph`.

[flamegraph]: https://docs.rs/crate/flamegraph/0.1.6

```shell
cargo flamegraph --root --freq 4000 --min-width 0.001 --package revm-test --bin snailtracer
```

This command will produce a flamegraph image output to `flamegraph.svg`.
Flamegraph also requires sudo mode to run (hence the `--root` cli arg) and will prompt you for your password if not in sudo mode already.

## Running example

```shell
Expand Down