Skip to content

Contributing guide: expand on samply #26

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
maksimryndin merged 1 commit into from
Sep 24, 2025
Merged

Contributing guide: expand on samply #26

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
14 changes: 11 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,22 +54,30 @@ To carry out this optimization cycle, we recommend the following profiling tools
* [Dhat](https://crates.io/crates/dhat): Measures memory allocations within the application.

### Hyperfine

Once [installed](https://github.com/sharkdp/hyperfine?tab=readme-ov-file#installation), we can simply run:
```sh
hyperfine 'TODO(template) update with your binary e.g. ./target/release/...'
```
### Samply

Samply creates [flame graphs](https://www.youtube.com/watch?v=D53T1Ejig1Q&t=813s) and detailed call stacks with a browser-based [Firefox Profiler](https://profiler.firefox.com/).

Run
```sh
cargo install --locked samply
```
Please remember to add:
```rust

You [may need](https://github.com/mstange/samply/?tab=readme-ov-file#description) to grant some system access to `samply`.

Into your `Cargo.toml` to add debug symbols in profiling mode:

```toml
[profile.profiling]
inherits = "release"
debug = true
```
Into your `Cargo.toml` to add debug symbols in profiling mode.

Otherwise, reading the output will be impossible.

Then, we can run:
Expand Down