Performance profiling basics in Ruby

Introduction

Performance profiling helps you find which parts of your Ruby program take the most time. This way, you can make your program faster and better.

When your Ruby program feels slow and you want to know why.

Before optimizing code to focus on the slowest parts.

To compare performance before and after changes.

When you want to understand how your program uses time during execution.

Syntax

Ruby

require 'ruby-prof'
RubyProf.start
# code to profile
result = RubyProf.stop
printer = RubyProf::FlatPrinter.new(result)
printer.print(STDOUT)

You need to install the ruby-prof gem first using gem install ruby-prof.

The code between RubyProf.start and RubyProf.stop is what gets measured.

Examples

This example profiles a simple 1-second sleep to show how profiling works.

Ruby

require 'ruby-prof'
RubyProf.start
sleep(1) # simulate work
result = RubyProf.stop
printer = RubyProf::FlatPrinter.new(result)
printer.print(STDOUT)

This example profiles a loop doing calculations and prints a graph-style report.

Ruby

require 'ruby-prof'
RubyProf.start
10.times { (1..1000).map { |i| i * i } }
result = RubyProf.stop
printer = RubyProf::GraphPrinter.new(result)
printer.print(STDOUT)

Sample Program

This program measures how long it takes to calculate the sum of squares from 0 to 999. The flat report shows time spent in each method.

Ruby

require 'ruby-prof'

# Start profiling
RubyProf.start

# Code to profile: simple loop
sum = 0
1000.times do |i|
  sum += i * i
end

# Stop profiling
result = RubyProf.stop

# Print flat report to console
printer = RubyProf::FlatPrinter.new(result)
printer.print(STDOUT)

Important Notes

Profiling adds some overhead, so the program runs slower while profiling.

Use profiling only when you want to improve performance, not all the time.

Look for methods with high self time to find slow parts.

Summary

Performance profiling helps find slow parts of Ruby code.

Use ruby-prof gem to measure and report time spent.

Focus on methods with high self time to optimize your program.

Practice

1. What is the main purpose of performance profiling in Ruby?

easy

A. To find slow parts of the code that need optimization

B. To add new features to the Ruby program

C. To check syntax errors in the code

D. To convert Ruby code into another language

Solution

1. Step 1: Understand the goal of profiling

   Performance profiling is used to measure how long parts of code take to run.

2. Step 2: Identify the main use

   It helps find slow parts so you can improve them.

3. Final Answer:

   To find slow parts of the code that need optimization -> Option A

4. Quick Check:

   Profiling = Find slow code [OK]

Hint: Profiling = finding slow code parts to speed up [OK]

Common Mistakes:

• Confusing profiling with debugging syntax errors
• Thinking profiling adds features
• Believing profiling translates code

2. Which Ruby gem is commonly used for performance profiling?

easy

A. nokogiri

B. rails

C. ruby-prof

D. rspec

Solution

1. Step 1: Recall common Ruby gems

   Rails is a web framework, Nokogiri is for XML/HTML parsing, RSpec is for testing.

2. Step 2: Identify profiling gem

   ruby-prof is the gem designed for performance profiling.

3. Final Answer:

   ruby-prof -> Option C

4. Quick Check:

   Profiling gem = ruby-prof [OK]

Hint: ruby-prof gem is for profiling Ruby code [OK]

Common Mistakes:

• Choosing Rails as a profiling tool
• Confusing testing gem RSpec with profiling
• Picking unrelated gems like Nokogiri

3. Given this Ruby profiling output snippet:

Method       | Total Time | Self Time
calculate    | 0.50       | 0.40
process      | 0.30       | 0.10
render       | 0.20       | 0.20

Which method should you optimize first to improve performance?

medium

A. calculate

B. render

C. All methods equally

D. process

Solution

1. Step 1: Understand self time meaning

   Self time shows how much time the method itself takes, excluding calls to others.

2. Step 2: Compare self times

   calculate has the highest self time (0.40), so it is the slowest part to optimize.

3. Final Answer:

   calculate -> Option A

4. Quick Check:

   Highest self time = calculate [OK]

Hint: Optimize method with highest self time first [OK]

Common Mistakes:

• Choosing method with highest total time instead of self time
• Thinking all methods need equal optimization
• Ignoring self time importance

4. What is wrong with this Ruby profiling code snippet?

require 'ruby-prof'
ruby-prof.start
# some code here
result = RubyProf.stop
puts result

medium

A. Missing require statement for ruby-prof

B. Not starting the profiler before code

C. No code to profile

D. Using puts directly on result object

Solution

1. Step 1: Check require and start

   require 'ruby-prof' and ruby-prof.start are correctly used.

2. Step 2: Understand result object usage

   result is a RubyProf::Profile object; printing it directly with puts won't show readable output.

3. Final Answer:

   Using puts directly on result object -> Option D

4. Quick Check:

   Print profiling result properly, not with puts [OK]

Hint: Use printer classes to display profiling results, not puts [OK]

Common Mistakes:

• Printing result object directly
• Forgetting to start profiler
• Not requiring ruby-prof gem

5. You want to profile a Ruby method heavy_task and save the results to a file in a readable format. Which code snippet correctly does this?

hard

A. require 'ruby-prof'
ruby-prof.start
heavy_task
result = RubyProf.stop
File.open('profile.txt', 'w') { |f| f.puts result }

B. require 'ruby-prof'
ruby-prof.start
heavy_task
result = RubyProf.stop
printer = RubyProf::FlatPrinter.new(result)
File.open('profile.txt', 'w') { |f| printer.print(f) }

C. require 'ruby-prof'
result = RubyProf.profile { heavy_task }
File.write('profile.txt', result.to_s)

D. require 'ruby-prof'
ruby-prof.start
heavy_task
result = RubyProf.stop
puts result.to_s > 'profile.txt'

Solution

1. Step 1: Understand profiling and printing

   ruby-prof returns a result object that needs a printer to format output.

2. Step 2: Check each option for correct usage

   require 'ruby-prof' ruby-prof.start heavy_task result = RubyProf.stop printer = RubyProf::FlatPrinter.new(result) File.open('profile.txt', 'w') { |f| printer.print(f) } uses FlatPrinter to format and writes to file correctly. require 'ruby-prof' ruby-prof.start heavy_task result = RubyProf.stop File.open('profile.txt', 'w') { |f| f.puts result } writes raw object, require 'ruby-prof' result = RubyProf.profile { heavy_task } File.write('profile.txt', result.to_s) misuses to_s, require 'ruby-prof' ruby-prof.start heavy_task result = RubyProf.stop puts result.to_s > 'profile.txt' misuses puts redirection.

3. Final Answer:

   Option B code snippet -> Option B

4. Quick Check:

   Use printer to save profiling output [OK]

Hint: Use RubyProf printers to save readable profiling results [OK]

Common Mistakes:

• Writing raw result object to file
• Using puts with redirection incorrectly
• Not using a printer to format output