RUBY-PROF(1)

💖 RUBY-PROF 💖

okay bestie, welcome to the ruby-prof manual page, aka the glow-up your slow Ruby script has been begging for 💅 this is section 1 of the manual, and it's about to be your new obsession.

✨ NAME ✨

ruby-prof — a fast ruby profiler 🏃♀️💨

🎀 SYNOPSIS 🎀

ruby-prof options <script.rb> [--]
[profiled-script-command-line-options]

🌸 DESCRIPTION 🌸

So like, ruby-prof is a fast profiler for ruby. periodt. you can run it two ways: as a stand-alone program (which is literally what this man page is documenting, no cap) or as a ruby library 🫶.

the way it works is so simple it's giving main character energy: just run the ruby program you wanna profile using ruby-prof:

ruby-prof script.rb

and at the end of execution, the time spent in each method gets displayed. that's it. that's the vibe check. 💖

🦋 OPTIONS 🦋

• -p, --printer=printer — pick your printer, bestie:
  • flat — prints a flat profile as text (this is the default ✨).
  • flat_with_line_numbers — same as flat, but with line numbers 👀.
  • graph — prints a graph profile as text.
  • graph_html — prints a graph profile as html.
  • call_tree — format for KCacheGrind.
  • call_stack — prints a HTML visualization of the call tree 🌈.
  • dot — prints a graph profile as a dot file.
• -m, --min_percent=min_percent — the minimum percent a method has to take before it gets included in output reports. > heads up: this option is not supported for call tree 🙈
• -f, --file=path — output results to a file instead of standard out 📁.
• --mode=measure_mode — select what ruby-prof should measure:
  • process — process time (the default 👑).
  • wall — wall time.
  • cpu — CPU time (Pentium and PowerPCs only).
  • allocations — object allocations (requires a patched Ruby interpreter 🔧).
  • memory — allocated memory in KB (requires a patched Ruby interpreter 🔧).
  • gc_runs — number of garbage collections (requires a patched Ruby interpreter 🔧).
  • gc_time — time spent in garbage collection (requires a patched Ruby interpreter 🔧).
• -s, --sort=sort_mode — select how ruby-prof results should be sorted:
  • total — total time
  • self — self time
  • wait — wait time
  • child — child time
• --replace-progname — replace $0 when loading the .rb files.
• -v — show version, set $VERBOSE to true, and profile script if option given 💫
• -d — set $DEBUG to true 🐛
• -R, --require-noprof lib — require a specific library (and it's not profiled).
• -E, --eval-noprof code — execute the ruby statements (also not profiled).
• -x, --exclude regexp — exclude methods by regexp (see method elimination 🚫).
• -X, --exclude-file file — exclude methods by regexp listed in file (see method elimination 🚫).
• --exclude-common-cycles — make common iterators like Integer#times appear inlined 🌀.
• --exclude-common-callbacks — make common callbacks invocations like Integer#times appear inlined so you can see call origins in graph 👁️.
• -h, --help — show help message 🆘.
• --version — show version 0.13.1 🏷️.

💜 COPYRIGHT 💜

ruby-prof was written by Shugo Maeda shugo@ruby-lang.org 🫶.

this manual page was written by Arnaud Cornet arnaud.cornet@gmail.com and updated by Jonas Genannt jonas.genannt@capi2name.de for the Debian project (but like, it may be used by others too, sharing is caring 💞).

⭐ SEE ALSO ⭐

the ruby-prof website, https://github.com/ruby-prof/ruby-prof — go follow it, it's iconic 🔥

and that's a wrap, bestie!! this page is from December 2013 and it's RUBY-PROF(1) in the manual — go profile something and slay 💅✨💖