RubyGems - ruby-prof - Versions diffs - 1.7.1 → 2.0.0 - Mend

ruby-prof 1.7.1 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (134) hide show

checksums.yaml +4 -4
data/{CHANGES → CHANGELOG.md} +118 -176
data/README.md +5 -5
data/bin/ruby-prof +1 -4
data/docs/advanced-usage.md +132 -0
data/docs/alternatives.md +98 -0
data/docs/architecture.md +122 -0
data/docs/best-practices.md +27 -0
data/docs/getting-started.md +130 -0
data/docs/history.md +11 -0
data/docs/index.md +45 -0
data/docs/profiling-rails.md +64 -0
data/docs/public/examples/example.rb +33 -0
data/docs/public/examples/generate_reports.rb +92 -0
data/docs/public/examples/reports/call_info.txt +27 -0
data/docs/public/examples/reports/call_stack.html +835 -0
data/docs/public/examples/reports/callgrind.out +150 -0
data/docs/public/examples/reports/flame_graph.html +408 -0
data/docs/public/examples/reports/flat.txt +45 -0
data/docs/public/examples/reports/graph.dot +129 -0
data/docs/public/examples/reports/graph.html +1319 -0
data/docs/public/examples/reports/graph.txt +100 -0
data/docs/public/examples/reports/graphviz_viewer.html +1 -0
data/docs/public/images/call_stack.png +0 -0
data/docs/public/images/class_diagram.png +0 -0
data/docs/public/images/dot_printer.png +0 -0
data/docs/public/images/flame_graph.png +0 -0
data/docs/public/images/flat.png +0 -0
data/docs/public/images/graph.png +0 -0
data/docs/public/images/graph_html.png +0 -0
data/docs/public/images/ruby-prof-logo.svg +1 -0
data/docs/reports.md +150 -0
data/docs/stylesheets/extra.css +80 -0
data/ext/ruby_prof/extconf.rb +23 -22
data/ext/ruby_prof/rp_allocation.c +0 -15
data/ext/ruby_prof/rp_allocation.h +29 -33
data/ext/ruby_prof/rp_call_tree.c +3 -0
data/ext/ruby_prof/rp_call_tree.h +1 -4
data/ext/ruby_prof/rp_call_trees.c +296 -296
data/ext/ruby_prof/rp_call_trees.h +25 -28
data/ext/ruby_prof/rp_measure_allocations.c +47 -47
data/ext/ruby_prof/rp_measure_process_time.c +64 -66
data/ext/ruby_prof/rp_measure_wall_time.c +52 -64
data/ext/ruby_prof/rp_measurement.c +0 -5
data/ext/ruby_prof/rp_measurement.h +49 -53
data/ext/ruby_prof/rp_method.c +554 -551
data/ext/ruby_prof/rp_method.h +1 -4
data/ext/ruby_prof/rp_profile.c +1 -1
data/ext/ruby_prof/rp_profile.h +1 -5
data/ext/ruby_prof/rp_stack.c +212 -212
data/ext/ruby_prof/rp_stack.h +50 -53
data/ext/ruby_prof/rp_thread.h +1 -4
data/ext/ruby_prof/ruby_prof.c +50 -50
data/ext/ruby_prof/ruby_prof.h +4 -6
data/ext/ruby_prof/vc/ruby_prof.vcxproj +7 -8
data/lib/ruby-prof/assets/call_stack_printer.html.erb +746 -711
data/lib/ruby-prof/assets/flame_graph_printer.html.erb +412 -0
data/lib/ruby-prof/assets/graph_printer.html.erb +355 -355
data/lib/ruby-prof/call_tree.rb +57 -57
data/lib/ruby-prof/call_tree_visitor.rb +36 -36
data/lib/ruby-prof/exclude_common_methods.rb +204 -204
data/lib/ruby-prof/measurement.rb +17 -17
data/lib/ruby-prof/printers/abstract_printer.rb +142 -138
data/lib/ruby-prof/printers/call_info_printer.rb +53 -53
data/lib/ruby-prof/printers/call_stack_printer.rb +168 -180
data/lib/ruby-prof/printers/call_tree_printer.rb +132 -145
data/lib/ruby-prof/printers/dot_printer.rb +177 -132
data/lib/ruby-prof/printers/flame_graph_printer.rb +79 -0
data/lib/ruby-prof/printers/flat_printer.rb +52 -52
data/lib/ruby-prof/printers/graph_html_printer.rb +62 -63
data/lib/ruby-prof/printers/graph_printer.rb +112 -113
data/lib/ruby-prof/printers/multi_printer.rb +134 -127
data/lib/ruby-prof/profile.rb +13 -0
data/lib/ruby-prof/rack.rb +114 -105
data/lib/ruby-prof/task.rb +147 -147
data/lib/ruby-prof/thread.rb +20 -20
data/lib/ruby-prof/version.rb +3 -3
data/lib/ruby-prof.rb +50 -52
data/lib/unprof.rb +10 -10
data/ruby-prof.gemspec +66 -65
data/test/abstract_printer_test.rb +25 -27
data/test/alias_test.rb +203 -117
data/test/call_tree_builder.rb +126 -126
data/test/call_tree_visitor_test.rb +27 -27
data/test/call_trees_test.rb +66 -66
data/test/duplicate_names_test.rb +32 -32
data/test/dynamic_method_test.rb +50 -62
data/test/enumerable_test.rb +23 -21
data/test/exceptions_test.rb +24 -24
data/test/exclude_methods_test.rb +363 -257
data/test/exclude_threads_test.rb +48 -48
data/test/fiber_test.rb +195 -195
data/test/gc_test.rb +104 -102
data/test/inverse_call_tree_test.rb +174 -174
data/test/line_number_test.rb +563 -289
data/test/marshal_test.rb +144 -145
data/test/measure_allocations.rb +26 -26
data/test/measure_allocations_test.rb +1511 -1081
data/test/measure_process_time_test.rb +3286 -2477
data/test/measure_times.rb +56 -56
data/test/measure_wall_time_test.rb +773 -568
data/test/measurement_test.rb +82 -82
data/test/merge_test.rb +146 -146
data/test/method_info_test.rb +100 -95
data/test/multi_printer_test.rb +52 -66
data/test/no_method_class_test.rb +15 -15
data/test/pause_resume_test.rb +171 -171
data/test/prime.rb +54 -54
data/test/prime_script.rb +5 -5
data/test/printer_call_stack_test.rb +28 -27
data/test/printer_call_tree_test.rb +30 -30
data/test/printer_flame_graph_test.rb +82 -0
data/test/printer_flat_test.rb +99 -99
data/test/printer_graph_html_test.rb +62 -59
data/test/printer_graph_test.rb +42 -40
data/test/printers_test.rb +162 -135
data/test/printing_recursive_graph_test.rb +81 -81
data/test/profile_test.rb +101 -101
data/test/rack_test.rb +103 -93
data/test/recursive_test.rb +796 -622
data/test/scheduler.rb +4 -0
data/test/singleton_test.rb +39 -38
data/test/stack_printer_test.rb +61 -61
data/test/start_stop_test.rb +106 -106
data/test/test_helper.rb +24 -20
data/test/thread_test.rb +229 -231
data/test/unique_call_path_test.rb +123 -136
data/test/yarv_test.rb +56 -60
metadata +68 -16
data/ext/ruby_prof/rp_measure_memory.c +0 -46
data/lib/ruby-prof/compatibility.rb +0 -113
data/test/compatibility_test.rb +0 -49
data/test/crash2.rb +0 -144
data/test/measure_memory_test.rb +0 -1456

data/lib/ruby-prof/call_tree.rb CHANGED Viewed

@@ -1,57 +1,57 @@
-# encoding: utf-8
-module RubyProf
-  # The CallTree class is used to track the relationships between methods. It is a helper class used by
-  # RubyProf::MethodInfo to keep track of which methods called a given method and which methods a given
-  # method called. Each CallTree has a parent and target method. You cannot create a CallTree object directly,
-  # they are generated while running a profile.
-  class CallTree
-    # The number of times the parent method called the target method
-    def called
-      self.measurement.called
-    end
-    # The total time resulting from the parent method calling the target method
-    def total_time
-      self.measurement.total_time
-    end
-    # The self time (of the parent) resulting from the parent method calling the target method
-    def self_time
-      self.measurement.self_time
-    end
-    # The wait time (of the parent) resulting from the parent method calling the target method
-    def wait_time
-      self.measurement.wait_time
-    end
-    # The time spent in child methods resulting from the parent method calling the target method
-    def children_time
-      self.total_time - self.self_time - self.wait_time
-    end
-    # Compares two CallTree instances. The comparison is based on the CallTree#parent, CallTree#target,
-    # and total time.
-    def <=>(other)
-      if self.target == other.target && self.parent == other.parent
-        0
-      elsif self.total_time < other.total_time
-        -1
-      elsif self.total_time > other.total_time
-        1
-      else
-        self.target.full_name <=> other.target.full_name
-      end
-    end
-    # :nodoc:
-    def to_s
-      "<#{self.class.name} - #{self.target.full_name}>"
-    end
-    def inspect
-      self.to_s
-    end
-  end
-end
+# encoding: utf-8
+module RubyProf
+  # The CallTree class is used to track the relationships between methods. It is a helper class used by
+  # RubyProf::MethodInfo to keep track of which methods called a given method and which methods a given
+  # method called. Each CallTree has a parent and target method. You cannot create a CallTree object directly,
+  # they are generated while running a profile.
+  class CallTree
+    # The number of times the parent method called the target method
+    def called
+      self.measurement.called
+    end
+    # The total time resulting from the parent method calling the target method
+    def total_time
+      self.measurement.total_time
+    end
+    # The self time (of the parent) resulting from the parent method calling the target method
+    def self_time
+      self.measurement.self_time
+    end
+    # The wait time (of the parent) resulting from the parent method calling the target method
+    def wait_time
+      self.measurement.wait_time
+    end
+    # The time spent in child methods resulting from the parent method calling the target method
+    def children_time
+      self.total_time - self.self_time - self.wait_time
+    end
+    # Compares two CallTree instances. The comparison is based on the CallTree#parent, CallTree#target,
+    # and total time.
+    def <=>(other)
+      if self.target == other.target && self.parent == other.parent
+        0
+      elsif self.total_time < other.total_time
+        -1
+      elsif self.total_time > other.total_time
+        1
+      else
+        self.target.full_name <=> other.target.full_name
+      end
+    end
+    # :nodoc:
+    def to_s
+      "<#{self.class.name} - #{self.target.full_name}>"
+    end
+    def inspect
+      self.to_s
+    end
+  end
+end

data/lib/ruby-prof/call_tree_visitor.rb CHANGED Viewed

@@ -1,36 +1,36 @@
-module RubyProf
-  # The call info visitor class does a depth-first traversal across a
-  # list of call infos. At each call_tree node, the visitor executes
-  # the block provided in the #visit method. The block is passed two
-  # parameters, the event and the call_tree instance. Event will be
-  # either :enter or :exit.
-  #
-  #   visitor = RubyProf::CallTreeVisitor.new(result.threads.first.call_tree)
-  #
-  #   method_names = Array.new
-  #
-  #   visitor.visit do |call_tree, event|
-  #     method_names << call_tree.target.full_name if event == :enter
-  #   end
-  #
-  #   puts method_names
-  class CallTreeVisitor
-    def initialize(call_tree)
-      @call_tree = call_tree
-    end
-    def visit(&block)
-      visit_call_tree(@call_tree, &block)
-    end
-    private
-    def visit_call_tree(call_tree, &block)
-      yield call_tree, :enter
-      call_tree.children.each do |child|
-        visit_call_tree(child, &block)
-      end
-      yield call_tree, :exit
-    end
-  end
-end
+module RubyProf
+  # The call info visitor class does a depth-first traversal across a
+  # list of call infos. At each call_tree node, the visitor executes
+  # the block provided in the #visit method. The block is passed two
+  # parameters, the event and the call_tree instance. Event will be
+  # either :enter or :exit.
+  #
+  #   visitor = RubyProf::CallTreeVisitor.new(result.threads.first.call_tree)
+  #
+  #   method_names = Array.new
+  #
+  #   visitor.visit do |call_tree, event|
+  #     method_names << call_tree.target.full_name if event == :enter
+  #   end
+  #
+  #   puts method_names
+  class CallTreeVisitor
+    def initialize(call_tree)
+      @call_tree = call_tree
+    end
+    def visit(&block)
+      visit_call_tree(@call_tree, &block)
+    end
+    private
+    def visit_call_tree(call_tree, &block)
+      yield call_tree, :enter
+      call_tree.children.each do |child|
+        visit_call_tree(child, &block)
+      end
+      yield call_tree, :exit
+    end
+  end
+end

data/lib/ruby-prof/exclude_common_methods.rb CHANGED Viewed

@@ -1,204 +1,204 @@
-require 'set'
-# :enddoc:
-module RubyProf
-  module ExcludeCommonMethods
-    ENUMERABLE_NAMES = Enumerable.instance_methods(false)
-    def self.apply!(profile)
-      ##
-      #  Kernel Methods
-      ##
-      exclude_methods(profile, Kernel, [
-        :dup,
-        :initialize_dup,
-        :tap,
-        :send,
-        :public_send,
-      ])
-      ##
-      #  Fundamental Types
-      ##
-      exclude_methods(profile, BasicObject,  :!=)
-      exclude_methods(profile, Kernel,       :"block_given?")
-      exclude_methods(profile, Method,       :[])
-      exclude_methods(profile, Module,       :new)
-      exclude_methods(profile, Class,        :new)
-      exclude_methods(profile, Proc,         :call, :yield)
-      exclude_methods(profile, Range,        :each)
-      ##
-      #  Value Types
-      ##
-      exclude_methods(profile, Integer, [
-        :times,
-        :succ,
-        :<
-      ])
-      exclude_methods(profile, String, [
-        :sub,
-        :sub!,
-        :gsub,
-        :gsub!,
-      ])
-      ##
-      #  Emumerables
-      ##
-      exclude_enumerable(profile, Enumerable)
-      exclude_enumerable(profile, Enumerator)
-      ##
-      #  Collections
-      ##
-      exclude_enumerable(profile, Array, [
-        :each_index,
-        :map!,
-        :select!,
-        :reject!,
-        :collect!,
-        :sort!,
-        :sort_by!,
-        :index,
-        :delete_if,
-        :keep_if,
-        :drop_while,
-        :uniq,
-        :uniq!,
-        :"==",
-        :eql?,
-        :hash,
-        :to_json,
-        :as_json,
-        :encode_json,
-      ])
-      exclude_enumerable(profile, Hash, [
-        :dup,
-        :initialize_dup,
-        :fetch,
-        :"[]",
-        :"[]=",
-        :each_key,
-        :each_value,
-        :each_pair,
-        :map!,
-        :select!,
-        :reject!,
-        :collect!,
-        :delete_if,
-        :keep_if,
-        :slice,
-        :slice!,
-        :except,
-        :except!,
-        :"==",
-        :eql?,
-        :hash,
-        :to_json,
-        :as_json,
-        :encode_json,
-      ])
-      exclude_enumerable(profile, Set, [
-        :map!,
-        :select!,
-        :reject!,
-        :collect!,
-        :classify,
-        :delete_if,
-        :keep_if,
-        :divide,
-        :"==",
-        :eql?,
-        :hash,
-        :to_json,
-        :as_json,
-        :encode_json,
-      ])
-      ##
-      #  Garbage Collection
-      ##
-      exclude_singleton_methods(profile, GC, [
-        :start
-      ])
-      ##
-      #  Unicorn
-      ##
-      if defined?(Unicorn)
-        exclude_methods(profile, Unicorn::HttpServer, :process_client)
-      end
-      if defined?(Unicorn::OobGC)
-        exclude_methods(profile, Unicorn::OobGC, :process_client)
-      end
-      ##
-      #  New Relic
-      ##
-      if defined?(NewRelic::Agent)
-        if defined?(NewRelic::Agent::Instrumentation::MiddlewareTracing)
-          exclude_methods(profile, NewRelic::Agent::Instrumentation::MiddlewareTracing, [
-            :call
-          ])
-        end
-        if defined?(NewRelic::Agent::MethodTracerHelpers)
-          exclude_methods(profile, NewRelic::Agent::MethodTracerHelpers, [
-            :trace_execution_scoped,
-            :log_errors,
-          ])
-          exclude_singleton_methods(profile, NewRelic::Agent::MethodTracerHelpers, [
-            :trace_execution_scoped,
-            :log_errors,
-          ])
-        end
-        if defined?(NewRelic::Agent::MethodTracer)
-          exclude_methods(profile, NewRelic::Agent::MethodTracer, [
-            :trace_execution_scoped,
-            :trace_execution_unscoped,
-          ])
-        end
-      end
-        ##
-        #  Miscellaneous Methods
-        ##
-      if defined?(Mustache)
-        exclude_methods(profile, Mustache::Context, [
-          :fetch
-        ])
-      end
-    end
-    private
-    def self.exclude_enumerable(profile, mod, *method_or_methods)
-      exclude_methods(profile, mod, [:each, *method_or_methods])
-      exclude_methods(profile, mod, ENUMERABLE_NAMES)
-    end
-    def self.exclude_methods(profile, mod, *method_or_methods)
-      profile.exclude_methods!(mod, method_or_methods)
-    end
-    def self.exclude_singleton_methods(profile, mod, *method_or_methods)
-      profile.exclude_singleton_methods!(mod, method_or_methods)
-    end
-  end
-end
+require 'set'
+# :enddoc:
+module RubyProf
+  module ExcludeCommonMethods
+    ENUMERABLE_NAMES = Enumerable.instance_methods(false)
+    def self.apply!(profile)
+      ##
+      #  Kernel Methods
+      ##
+      exclude_methods(profile, Kernel, [
+        :dup,
+        :initialize_dup,
+        :tap,
+        :send,
+        :public_send,
+      ])
+      ##
+      #  Fundamental Types
+      ##
+      exclude_methods(profile, BasicObject,  :!=)
+      exclude_methods(profile, Kernel,       :"block_given?")
+      exclude_methods(profile, Method,       :[])
+      exclude_methods(profile, Module,       :new)
+      exclude_methods(profile, Class,        :new)
+      exclude_methods(profile, Proc,         :call, :yield)
+      exclude_methods(profile, Range,        :each)
+      ##
+      #  Value Types
+      ##
+      exclude_methods(profile, Integer, [
+        :times,
+        :succ,
+        :<
+      ])
+      exclude_methods(profile, String, [
+        :sub,
+        :sub!,
+        :gsub,
+        :gsub!,
+      ])
+      ##
+      #  Emumerables
+      ##
+      exclude_enumerable(profile, Enumerable)
+      exclude_enumerable(profile, Enumerator)
+      ##
+      #  Collections
+      ##
+      exclude_enumerable(profile, Array, [
+        :each_index,
+        :map!,
+        :select!,
+        :reject!,
+        :collect!,
+        :sort!,
+        :sort_by!,
+        :index,
+        :delete_if,
+        :keep_if,
+        :drop_while,
+        :uniq,
+        :uniq!,
+        :"==",
+        :eql?,
+        :hash,
+        :to_json,
+        :as_json,
+        :encode_json,
+      ])
+      exclude_enumerable(profile, Hash, [
+        :dup,
+        :initialize_dup,
+        :fetch,
+        :"[]",
+        :"[]=",
+        :each_key,
+        :each_value,
+        :each_pair,
+        :map!,
+        :select!,
+        :reject!,
+        :collect!,
+        :delete_if,
+        :keep_if,
+        :slice,
+        :slice!,
+        :except,
+        :except!,
+        :"==",
+        :eql?,
+        :hash,
+        :to_json,
+        :as_json,
+        :encode_json,
+      ])
+      exclude_enumerable(profile, Set, [
+        :map!,
+        :select!,
+        :reject!,
+        :collect!,
+        :classify,
+        :delete_if,
+        :keep_if,
+        :divide,
+        :"==",
+        :eql?,
+        :hash,
+        :to_json,
+        :as_json,
+        :encode_json,
+      ])
+      ##
+      #  Garbage Collection
+      ##
+      exclude_singleton_methods(profile, GC, [
+        :start
+      ])
+      ##
+      #  Unicorn
+      ##
+      if defined?(Unicorn)
+        exclude_methods(profile, Unicorn::HttpServer, :process_client)
+      end
+      if defined?(Unicorn::OobGC)
+        exclude_methods(profile, Unicorn::OobGC, :process_client)
+      end
+      ##
+      #  New Relic
+      ##
+      if defined?(NewRelic::Agent)
+        if defined?(NewRelic::Agent::Instrumentation::MiddlewareTracing)
+          exclude_methods(profile, NewRelic::Agent::Instrumentation::MiddlewareTracing, [
+            :call
+          ])
+        end
+        if defined?(NewRelic::Agent::MethodTracerHelpers)
+          exclude_methods(profile, NewRelic::Agent::MethodTracerHelpers, [
+            :trace_execution_scoped,
+            :log_errors,
+          ])
+          exclude_singleton_methods(profile, NewRelic::Agent::MethodTracerHelpers, [
+            :trace_execution_scoped,
+            :log_errors,
+          ])
+        end
+        if defined?(NewRelic::Agent::MethodTracer)
+          exclude_methods(profile, NewRelic::Agent::MethodTracer, [
+            :trace_execution_scoped,
+            :trace_execution_unscoped,
+          ])
+        end
+      end
+        ##
+        #  Miscellaneous Methods
+        ##
+      if defined?(Mustache)
+        exclude_methods(profile, Mustache::Context, [
+          :fetch
+        ])
+      end
+    end
+    private
+    def self.exclude_enumerable(profile, mod, *method_or_methods)
+      exclude_methods(profile, mod, [:each, *method_or_methods])
+      exclude_methods(profile, mod, ENUMERABLE_NAMES)
+    end
+    def self.exclude_methods(profile, mod, *method_or_methods)
+      profile.exclude_methods!(mod, method_or_methods)
+    end
+    def self.exclude_singleton_methods(profile, mod, *method_or_methods)
+      profile.exclude_singleton_methods!(mod, method_or_methods)
+    end
+  end
+end

data/lib/ruby-prof/measurement.rb CHANGED Viewed

@@ -1,17 +1,17 @@
-module RubyProf
-  # The Measurement class is a helper class used by RubyProf::MethodInfo to store information about the method.
-  # You cannot create a CallTree object directly, they are generated while running a profile.
-  class Measurement
-    def children_time
-      self.total_time - self.self_time - self.wait_time
-    end
-    def to_s
-      "c: #{called}, tt: #{total_time}, st: #{self_time}"
-    end
-    def inspect
-      super + "(#{self.to_s})"
-    end
-  end
-end
+module RubyProf
+  # The Measurement class is a helper class used by RubyProf::MethodInfo to store information about the method.
+  # You cannot create a CallTree object directly, they are generated while running a profile.
+  class Measurement
+    def children_time
+      self.total_time - self.self_time - self.wait_time
+    end
+    def to_s
+      "c: #{called}, tt: #{total_time}, st: #{self_time}"
+    end
+    def inspect
+      super + "(#{self.to_s})"
+    end
+  end
+end