Uses new Rust 2021
|0.12.1||Jun 27, 2022|
#27 in #profiler
162 downloads per month
Used in 2 crates (via pyroscope_rbspy)
You are probably looking for rbspy. This is a fork that supports on-cpu profiling.
Have a running Ruby program that you want to profile without restarting it? Want to profile a Ruby
command line program really easily? You want
rbspy! rbspy can profile any Ruby program just by
running 1 simple command.
rbspy lets you profile Ruby processes that are already running. You give it a PID, and it starts
profiling. It's a sampling profiler, which means it's low overhead and safe to run in
rbspy lets you record profiling data, save the raw profiling data to disk, and then analyze it in
a variety of different ways later on.
only wall-clock profiling
There are 2 main ways to profile code -- you can either profile everything the application does (including waiting), or only profile when the application is using the CPU.
rbspy profiles everything the program does (including waiting) -- there's no option to just profile when the program is using the CPU.
rbspy supports Linux*, Mac, Windows, and FreeBSD.* kernel version 3.2+ required. For Ubuntu, this means Ubuntu 12.04 or newer.
Add a testimonial
Did rbspy help you make your program faster? An awesome way to thank the project is to add a success story to this GitHub issue where people talk about ways rbspy has helped them! Hearing that rbspy is working for people is good motivation :)
On Mac, you can install with Homebrew:
brew install rbspy.
- Download recent release of
rbspyfrom the GitHub releases page.
- The binaries tagged with
muslare statically linked against musl libc and can be used on most systems. The ones tagged with
gnuare dynamically linked against GNU libc, so you will need it to be installed.
- The binaries tagged with
- Unpack it
- Move the
Or have a look at Installing rbspy on our documentation.
As a Rust library
To use rbspy in your Rust project, add the following to your Cargo.toml:
[dependencies] rbspy = "0.8"
WARNING: The rbspy crate's API is not stable yet. We will follow semantic versioning after rbspy reaches version 1.0.
Pull requests that improve usability, fix bugs, or help rbspy support more operating systems are very welcome. If you have a question, the best way to ask is to create a GitHub issue!
If you're not a very experienced Rust programmer, you're very welcome to contribute. A major reason rbspy is written in Rust is that Rust is more approachable for beginners than C/C++. https://www.rust-lang.org/ has great resources for learning Rust.
- Install cargo from crates.io
cargo buildto build
cargo testto test
The built binary will end up at