123456789_123456789_123456789_123456789_123456789_

Module: Profiler__

Relationships & Source Files
Namespace Children
Classes:
Defined in: lib/profiler.rb

Overview

Profile provides a way to Profile your Ruby application.

Profiling your program is a way of determining which methods are called and how long each method takes to complete. This way you can detect which methods are possible bottlenecks.

Profiling your program will slow down your execution time considerably, so activate it only when you need it. Don’t confuse benchmarking with profiling.

There are two ways to activate Profiling:

Command line

Run your Ruby script with -rprofile:

ruby -rprofile example.rb

If you’re profiling an executable in your $PATH you can use ruby -S:

ruby -rprofile -S some_executable

From code

Just require ‘profile’:

require 'profile'

def slow_method
  5000.times do
    9999999999999999*999999999
  end
end

def fast_method
  5000.times do
    9999999999999999+999999999
  end
end

slow_method
fast_method

The output in both cases is a report when the execution is over:

ruby -rprofile example.rb

  %   cumulative   self              self     total
 time   seconds   seconds    calls  ms/call  ms/call  name
 68.42     0.13      0.13        2    65.00    95.00  Integer#times
 15.79     0.16      0.03     5000     0.01     0.01  Fixnum#*
 15.79     0.19      0.03     5000     0.01     0.01  Fixnum#+
  0.00     0.19      0.00        2     0.00     0.00  IO#set_encoding
  0.00     0.19      0.00        1     0.00   100.00  Object#slow_method
  0.00     0.19      0.00        2     0.00     0.00  Module#method_added
  0.00     0.19      0.00        1     0.00    90.00  Object#fast_method
  0.00     0.19      0.00        1     0.00   190.00  #toplevel

Constant Summary

  • PROFILE_CALL_PROC = Internal use only

    the map of call data keyed by thread, class and id. Call data contains the call count, total time,

    # File 'lib/profiler.rb', line 80
    TracePoint.new(*%i[call c_call b_call]) {|tp| # :nodoc:
      now = Process.times[0]
      stack = (@@stacks[Thread.current] ||= [])
      stack.push [now, 0.0]
    }
  • PROFILE_RETURN_PROC = Internal use only
    # File 'lib/profiler.rb', line 85
    TracePoint.new(*%i[return c_return b_return]) {|tp| # :nodoc:
      now = Process.times[0]
      key = Wrapper.new(tp.defined_class, tp.method_id)
      stack = (@@stacks[Thread.current] ||= [])
      if tick = stack.pop
        threadmap = (@@maps[Thread.current] ||= {})
        data = (threadmap[key] ||= [0, 0.0, 0.0, key])
        data[0] += 1
        cost = now - tick[0]
        data[1] += cost
        data[2] += cost - tick[1]
        stack[-1][1] += cost if stack[-1]
      end
    }

Class Method Summary

Class Method Details

.start_profile (mod_func)

Starts the profiler.

See Profiler__ for more information.

[ GitHub ]

  
# File 'lib/profiler.rb', line 103

def start_profile
  @@start = Process.times[0]
  @@stacks = {}
  @@maps = {}
  PROFILE_CALL_PROC.enable
  PROFILE_RETURN_PROC.enable
end

.stop_profile (mod_func)

Stops the profiler.

See Profiler__ for more information.

[ GitHub ]

  
# File 'lib/profiler.rb', line 113

def stop_profile
  PROFILE_CALL_PROC.disable
  PROFILE_RETURN_PROC.disable
end