|
| 1 | +--- |
| 2 | +title: "Profiling Rust Code on macOS: My Daily Workflow" |
| 3 | +meta_title: "Rust Profiling on macOS: Micro-Benchmarks, Flamegraphs, and DTrace" |
| 4 | +description: "Learn how to optimize Rust applications with profiling tools like criterion, cargo flamegraph, and DTrace on macOS." |
| 5 | +date: 2024-12-11T08:00:00Z |
| 6 | +image: "/images/posts/2024/profiling-rust-on-macos.jpg" |
| 7 | +categories: ["Rust", "Performance"] |
| 8 | +author: "Medcl" |
| 9 | +tags: ["Rust", "Profiling", "macOS", "criterion", "flamegraph"] |
| 10 | +draft: false |
| 11 | +--- |
| 12 | + |
| 13 | +Profiling Rust code has become part of my daily routine. As I primarily develop on macOS, I've noticed there aren't many tools that allow for easy and quick profiling of Rust applications. So, I’d like to share my daily profiling workflow, in case it helps others. If you have other approaches or tools that work well for you, feel free to share—I’d love to hear them! |
| 14 | + |
| 15 | + |
| 16 | +## Setting Up Micro-Benchmarks |
| 17 | + |
| 18 | +I use micro-benchmark tests to track the performance of critical functions in my Rust application. For this, I rely on `criterion`, which is both powerful and easy to use. Here’s what my project setup looks like: |
| 19 | + |
| 20 | + |
| 21 | + |
| 22 | + |
| 23 | +As you noticed, i organized my benchmark tests per module, and so i can easily include or exclude specify tests in the `benches.rs`, some times, they just take too much time, if i only want to profile specify tests, i can just comment out unrelated one. dirty but works. |
| 24 | + |
| 25 | +If you have many similar tests, you may group them by use a customized name, like this: |
| 26 | + |
| 27 | + |
| 28 | + |
| 29 | +Micro-benchmarking is a fundamental step that helps track performance changes when refactoring code or adding new features. |
| 30 | + |
| 31 | + |
| 32 | +## Profiling The Micro-Benchmark |
| 33 | + |
| 34 | +What if some tests are slow, a quick way to profiling is to use: |
| 35 | +```shell |
| 36 | +sudo CARGO_PROFILE_BENCH_DEBUG=true cargo flamegraph --bench benches -o find-baseline.svg -- --bench |
| 37 | +``` |
| 38 | + |
| 39 | +You can run the benchmarks with a single command, but be sure to comment out any unrelated tests in `benches.rs`. Just remember to revert those changes or avoid checking them in later. that's tedious, yes, i know :( |
| 40 | + |
| 41 | +## Tracking Performance with Bencher |
| 42 | + |
| 43 | +Now that you have several micro-benchmark tests, how can you continuously monitor performance? I’m glad I discovered a free service provided by bencher.dev. It helps track performance over time, making it easier to identify any regressions or improvements. |
| 44 | + |
| 45 | + |
| 46 | + |
| 47 | + |
| 48 | + |
| 49 | + |
| 50 | + |
| 51 | + |
| 52 | +Here is my bencher command in my Makefile: |
| 53 | +```shell |
| 54 | +bencher-engine: |
| 55 | + if [ -z "${BENCHER_API_TOKEN:-}" ]; then \ |
| 56 | + echo "Error: BENCHER_API_TOKEN environment variable is not set."; \ |
| 57 | + exit 1; \ |
| 58 | + fi |
| 59 | + |
| 60 | + bencher run \ |
| 61 | + --project pizza-engine-bd8p44nc \ |
| 62 | + --branch main \ |
| 63 | + --testbed localhost \ |
| 64 | + --adapter rust_criterion \ |
| 65 | + "cd lib/engine && cargo bench" |
| 66 | +``` |
| 67 | + |
| 68 | +Each time you run `make bencher-engine`, it executes all your benchmarks and sends the results to their database. This service is free to use for open-source projects, making it a great resource for ongoing performance tracking. |
| 69 | + |
| 70 | +For example here is my [dashboard](https://bencher.dev/console/projects/pizza-engine-bd8p44nc/plots): |
| 71 | + |
| 72 | + |
| 73 | + |
| 74 | +You can add a CI action to your GitHub repository to automatically track performance changes with each commit. If your code is hosted on GitHub, this setup will record performance variations for every commit, helping you maintain a history of your application's performance over time. |
| 75 | + |
| 76 | + |
| 77 | + |
| 78 | +## Profiling on MacOs |
| 79 | + |
| 80 | +Profiling on macOS can be slightly less convenient than on Linux, where there are many robust tools available. Here’s what I do to make the most of the profiling process, I use `Dtrace` along with two scripts: |
| 81 | + |
| 82 | +```shell |
| 83 | +➜ cat ~/start_profile.sh |
| 84 | +#!/bin/bash |
| 85 | + |
| 86 | +# Check if PID argument is provided |
| 87 | +if [ -z "$1" ]; then |
| 88 | + echo "Usage: $0 <pid>" |
| 89 | + exit 1 |
| 90 | +fi |
| 91 | + |
| 92 | +pid=$1 |
| 93 | + |
| 94 | +# Run dtrace with the provided PID |
| 95 | +sudo rm -rf target/out.user_stacks || true |
| 96 | + |
| 97 | +sudo dtrace -x ustackframes=100 -n "profile-97 /pid == $pid/ { @[ustack()] = count(); } tick-60s { exit(0); }" -o target/out.user_stacks |
| 98 | + |
| 99 | +➜ cat ~/end_profile.sh |
| 100 | +#!/bin/bash |
| 101 | + |
| 102 | +# Clean up previous output files |
| 103 | +rm -f target/stacks.folded target/flamegraph.svg |
| 104 | + |
| 105 | +# Process the new profiling data |
| 106 | +cat target/out.user_stacks | inferno-collapse-dtrace > target/stacks.folded |
| 107 | +cat target/stacks.folded | inferno-flamegraph > target/flamegraph.svg |
| 108 | + |
| 109 | +# Notify the user |
| 110 | +echo "Flamegraph generated at target/flamegraph.svg" |
| 111 | +``` |
| 112 | + |
| 113 | +And then start your target Rust application, make sure you set `debug=true` in `Cargo.toml` |
| 114 | + |
| 115 | +And then execute the start script, wait for a while and Ctrl+C to capture profiling data: |
| 116 | + |
| 117 | +```shell |
| 118 | +➜ indexer git:(batch_indexing) ✗ ~/start_profile.sh 1494 |
| 119 | +dtrace: system integrity protection is on, some features will not be available |
| 120 | + |
| 121 | +dtrace: description 'profile-97 ' matched 2 probes |
| 122 | +^C% |
| 123 | +``` |
| 124 | + |
| 125 | +And then you can generate the flamegraph: |
| 126 | +```shell |
| 127 | +➜ indexer git:(batch_indexing) ✗ ~/end_profile.sh |
| 128 | +Flamegraph generated at target/flamegraph.svg |
| 129 | +``` |
| 130 | +Open it with your web browser and figure out what's the bottlenect, and rock with it. |
| 131 | + |
| 132 | + |
| 133 | + |
| 134 | + |
| 135 | +That’s it! I hope this information helps you in your Rust development journey. If you have any questions or need further assistance, feel free to reach out! |
| 136 | + |
| 137 | +References: |
| 138 | +- https://github.com/bheisler/criterion.rs |
| 139 | +- https://bencher.dev/ |
| 140 | +- https://bencher.dev/console/projects/pizza-engine-bd8p44nc/plots |
0 commit comments