ruby-prof 1.7.2 → 2.0.0

data/lib/ruby-prof/printers/dot_printer.rb

@@ -1,132 +1,177 @@
-# encoding: utf-8
-
-require 'set'
-
-module RubyProf
-  # Generates a graphviz graph in dot format.
-  #
-  # To use the dot printer:
-  #
-  #   result = RubyProf.profile do
-  #     [code to profile]
-  #   end
-  #
-  #   printer = RubyProf::DotPrinter.new(result)
-  #   printer.print(STDOUT)
-  #
-  # You can use either dot viewer such as GraphViz, or the dot command line tool
-  # to reformat the output into a wide variety of outputs:
-  #
-  #   dot -Tpng graph.dot > graph.png
-  #
-  class DotPrinter < RubyProf::AbstractPrinter
-    CLASS_COLOR = '"#666666"'
-    EDGE_COLOR  = '"#666666"'
-
-    # Creates the DotPrinter using a RubyProf::Proile.
-    def initialize(result)
-      super(result)
-      @seen_methods = Set.new
-    end
-
-    # Print a graph report to the provided output.
-    #
-    # output - Any IO object, including STDOUT or a file. The default value is
-    # STDOUT.
-    #
-    # options - Hash of print options.  See #setup_options
-    # for more information.
-    #
-    # When profiling results that cover a large number of method calls it
-    # helps to use the :min_percent option, for example:
-    #
-    #   DotPrinter.new(result).print(STDOUT, :min_percent=>5)
-    #
-    def print(output = STDOUT, options = {})
-      @output = output
-      setup_options(options)
-
-      puts 'digraph "Profile" {'
-      #puts "label=\"#{mode_name} >=#{min_percent}%\\nTotal: #{total_time}\";"
-      puts "labelloc=t;"
-      puts "labeljust=l;"
-      print_threads
-      puts '}'
-    end
-
-    private
-
-    # Something of a hack, figure out which constant went with the
-    # RubyProf.measure_mode so that we can display it.  Otherwise it's easy to
-    # forget what measurement was made.
-    def mode_name
-      RubyProf.constants.find{|c| RubyProf.const_get(c) == RubyProf.measure_mode}
-    end
-
-    def print_threads
-      @result.threads.each do |thread|
-        puts "subgraph \"Thread #{thread.id}\" {"
-
-        print_thread(thread)
-        puts "}"
-
-        print_classes(thread)
-      end
-    end
-
-    # Determines an ID to use to represent the subject in the Dot file.
-    def dot_id(subject)
-      subject.object_id
-    end
-
-    def print_thread(thread)
-      total_time = thread.total_time
-      thread.methods.sort_by(&sort_method).reverse_each do |method|
-        total_percentage = (method.total_time/total_time) * 100
-
-        next if total_percentage < min_percent
-        name = method.full_name.split("#").last
-        puts "#{dot_id(method)} [label=\"#{name}\\n(#{total_percentage.round}%)\"];"
-        @seen_methods << method
-        print_edges(total_time, method)
-      end
-    end
-
-    def print_classes(thread)
-      grouped = {}
-      thread.methods.each{|m| grouped[m.klass_name] ||= []; grouped[m.klass_name] << m}
-      grouped.each do |cls, methods2|
-        # Filter down to just seen methods
-        big_methods = methods2.select{|m| @seen_methods.include? m}
-
-        if !big_methods.empty?
-          puts "subgraph cluster_#{cls.object_id} {"
-          puts "label = \"#{cls}\";"
-          puts "fontcolor = #{CLASS_COLOR};"
-          puts "fontsize = 16;"
-          puts "color = #{CLASS_COLOR};"
-          big_methods.each do |m|
-            puts "#{m.object_id};"
-          end
-          puts "}"
-        end
-      end
-    end
-
-    def print_edges(total_time, method)
-      method.call_trees.callers.sort_by(&:total_time).reverse.each do |call_tree|
-        target_percentage = (call_tree.target.total_time / total_time) * 100.0
-        next if target_percentage < min_percent
-
-        # Get children method
-        puts "#{dot_id(method)} -> #{dot_id(call_tree.target)} [label=\"#{call_tree.called}/#{call_tree.target.called}\" fontsize=10 fontcolor=#{EDGE_COLOR}];"
-      end
-    end
-
-    # Silly little helper for printing to the @output
-    def puts(str)
-      @output.puts(str)
-    end
-
-  end
-end
+# encoding: utf-8
+
+require 'set'
+
+module RubyProf
+  # Generates a graphviz graph in dot format.
+  #
+  # To use the dot printer:
+  #
+  #   result = RubyProf.profile do
+  #     [code to profile]
+  #   end
+  #
+  #   printer = RubyProf::DotPrinter.new(result)
+  #   printer.print(STDOUT)
+  #
+  # You can use either dot viewer such as GraphViz, or the dot command line tool
+  # to reformat the output into a wide variety of outputs:
+  #
+  #   dot -Tpng graph.dot > graph.png
+  #
+  class DotPrinter < RubyProf::AbstractPrinter
+    CLUSTER_COLORS = %w[#1A35A6 #2E86C1 #1ABC9C #5B2C8E #2471A3 #148F77 #1F618D #7D3C98]
+
+    # Creates the DotPrinter using a RubyProf::Proile.
+    def initialize(result)
+      super(result)
+      @seen_methods = Set.new
+      @class_color_map = {}
+      @color_index = 0
+    end
+
+    # Print a graph report to the provided output.
+    #
+    # output - Any IO object, including STDOUT or a file. The default value is
+    # STDOUT.
+    #
+    # Keyword arguments - See AbstractPrinter#print for available options.
+    #
+    # When profiling results that cover a large number of method calls it
+    # helps to use the min_percent: option, for example:
+    #
+    #   DotPrinter.new(result).print(STDOUT, min_percent: 5)
+    #
+    def print(output = STDOUT, min_percent: 0, max_percent: 100, filter_by: :self_time, sort_method: nil, **)
+      @output = output
+      @min_percent = min_percent
+      @max_percent = max_percent
+      @filter_by = filter_by
+      @sort_method = sort_method
+
+      puts 'digraph "Profile" {'
+      puts 'rankdir=TB;'
+      puts 'bgcolor="#FAFAFA";'
+      puts 'node [fontname="Helvetica" fontsize=11 style="filled,rounded" shape=box fillcolor="#FFFFFF" color="#CCCCCC" penwidth=1.2];'
+      puts 'edge [fontname="Helvetica" fontsize=9 color="#5B7DB1" arrowsize=0.7];'
+      puts 'labelloc=t;'
+      puts 'labeljust=l;'
+      print_threads
+      puts '}'
+    end
+
+    private
+
+    # Something of a hack, figure out which constant went with the
+    # RubyProf.measure_mode so that we can display it.  Otherwise it's easy to
+    # forget what measurement was made.
+    def mode_name
+      RubyProf.constants.find{|c| RubyProf.const_get(c) == RubyProf.measure_mode}
+    end
+
+    def print_threads
+      @result.threads.each do |thread|
+        puts "subgraph \"Thread #{thread.id}\" {"
+
+        print_thread(thread)
+        puts "}"
+
+        print_classes(thread)
+      end
+    end
+
+    # Determines an ID to use to represent the subject in the Dot file.
+    def dot_id(subject)
+      subject.object_id
+    end
+
+    def color_for_class(klass_name)
+      @class_color_map[klass_name] ||= begin
+        color = CLUSTER_COLORS[@color_index % CLUSTER_COLORS.length]
+        @color_index += 1
+        color
+      end
+    end
+
+    def node_color(total_percentage)
+      if total_percentage >= 50
+        '#0D2483'
+      elsif total_percentage >= 25
+        '#1A35A6'
+      elsif total_percentage >= 10
+        '#2E86C1'
+      elsif total_percentage >= 5
+        '#D4E6F1'
+      else
+        '#FFFFFF'
+      end
+    end
+
+    def node_fontcolor(total_percentage)
+      total_percentage >= 10 ? '#FFFFFF' : '#333333'
+    end
+
+    def print_thread(thread)
+      total_time = thread.total_time
+      thread.methods.sort_by(&sort_method).reverse_each do |method|
+        total_percentage = (method.total_time/total_time) * 100
+
+        next if total_percentage < min_percent
+        name = method.full_name.split("#").last
+        label = "#{name}\\n(#{total_percentage.round}%)"
+
+        # Only emit fill/font attrs when they differ from the default (white/#333)
+        fill = node_color(total_percentage)
+        fontcolor = node_fontcolor(total_percentage)
+        attrs = "label=\"#{label}\""
+        attrs += " fillcolor=\"#{fill}\" fontcolor=\"#{fontcolor}\"" unless fill == '#FFFFFF'
+
+        puts "#{dot_id(method)} [#{attrs}];"
+        @seen_methods << method
+        print_edges(total_time, method)
+      end
+    end
+
+    def print_classes(thread)
+      grouped = {}
+      thread.methods.each{|m| grouped[m.klass_name] ||= []; grouped[m.klass_name] << m}
+      grouped.each do |cls, methods2|
+        # Filter down to just seen methods
+        big_methods = methods2.select{|m| @seen_methods.include? m}
+
+        if !big_methods.empty?
+          color = color_for_class(cls)
+          puts "subgraph cluster_#{cls.object_id} {"
+          puts "label = \"#{cls}\";"
+          puts "fontname = \"Helvetica\";"
+          puts "fontcolor = \"#{color}\";"
+          puts "fontsize = 14;"
+          puts "color = \"#{color}\";"
+          puts "style = \"rounded,dashed\";"
+          puts "penwidth = 1.5;"
+          big_methods.each do |m|
+            puts "#{m.object_id};"
+          end
+          puts "}"
+        end
+      end
+    end
+
+    def print_edges(total_time, method)
+      method.call_trees.callees.sort_by(&:total_time).reverse.each do |call_tree|
+        target_percentage = (call_tree.target.total_time / total_time) * 100.0
+        next if target_percentage < min_percent
+        next unless @seen_methods.include?(call_tree.target)
+
+        edge_width = [0.5 + (target_percentage / 20.0), 4.0].min
+        puts "#{dot_id(method)} -> #{dot_id(call_tree.target)} [label=\"#{call_tree.called}/#{call_tree.target.called}\" penwidth=#{format('%.1f', edge_width)}];"
+      end
+    end
+
+    # Silly little helper for printing to the @output
+    def puts(str)
+      @output.puts(str)
+    end
+
+  end
+end

data/lib/ruby-prof/printers/flame_graph_printer.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+
+require 'erb'
+require 'json'
+
+module RubyProf
+  # Prints a HTML flame graph visualization of the call tree.
+  #
+  # To use the printer:
+  #
+  #   result = RubyProf.profile do
+  #     [code to profile]
+  #   end
+  #
+  #   printer = RubyProf::FlameGraphPrinter.new(result)
+  #   printer.print(STDOUT)
+
+  class FlameGraphPrinter < AbstractPrinter
+    include ERB::Util
+
+    # Specify print options.
+    #
+    # output - Any IO object, including STDOUT or a file.
+    #
+    # Keyword arguments:
+    #   title:       - a String to override the default "ruby-prof flame graph"
+    #                  title of the report.
+    #
+    # Also accepts min_percent:, max_percent:, filter_by:, and sort_method:
+    # from AbstractPrinter.
+    def print(output = STDOUT, title: "ruby-prof flame graph",
+              min_percent: 0, max_percent: 100, filter_by: :self_time, sort_method: nil, **)
+      @min_percent = min_percent
+      @max_percent = max_percent
+      @filter_by = filter_by
+      @sort_method = sort_method
+      @title = title
+      output << ERB.new(self.template).result(binding)
+    end
+
+    attr_reader :title
+
+    def build_flame_data(call_tree, visited = Set.new)
+      node = {
+        name: call_tree.target.full_name,
+        value: call_tree.total_time,
+        self_value: call_tree.self_time,
+        called: call_tree.called,
+        children: []
+      }
+
+      unless visited.include?(call_tree.target)
+        visited.add(call_tree.target)
+        call_tree.children.sort_by { |c| -c.total_time }.each do |child|
+          node[:children] << build_flame_data(child, visited)
+        end
+        visited.delete(call_tree.target)
+      end
+
+      node
+    end
+
+    def flame_data_json
+      threads = @result.threads.map do |thread|
+        {
+          id: thread.id,
+          fiber_id: thread.fiber_id,
+          total_time: thread.total_time,
+          data: build_flame_data(thread.call_tree)
+        }
+      end
+      JSON.generate(threads)
+    end
+
+    def template
+      open_asset('flame_graph_printer.html.erb')
+    end
+  end
+end

data/lib/ruby-prof/printers/flat_printer.rb

@@ -1,53 +1,53 @@
-# encoding: utf-8
-
-module RubyProf
-  # Generates flat[link:files/examples/flat_txt.html] profile reports as text.
-  # To use the flat printer:
-  #
-  #   result = RubyProf.profile do
-  #     [code to profile]
-  #   end
-  #
-  #   printer = RubyProf::FlatPrinter.new(result)
-  #   printer.print(STDOUT, {})
-  #
-  class FlatPrinter < AbstractPrinter
-    # Override for this printer to sort by self time by default
-    def sort_method
-      @options[:sort_method] || :self_time
-    end
-
-    private
-
-    def print_column_headers
-      @output << " %self      total      self      wait     child     calls  name                           location\n"
-    end
-
-    def print_methods(thread)
-      total_time = thread.total_time
-      methods = thread.methods.sort_by(&sort_method).reverse
-
-      sum = 0
-      methods.each do |method|
-        percent = (method.send(filter_by) / total_time) * 100
-        next if percent < min_percent
-        next if percent > max_percent
-
-        sum += method.self_time
-        #self_time_called = method.called > 0 ? method.self_time/method.called : 0
-        #total_time_called = method.called > 0? method.total_time/method.called : 0
-
-        @output << "%6.2f  %9.3f %9.3f %9.3f %9.3f %8d  %s%-30s %s\n" % [
-                      method.self_time / total_time * 100, # %self
-                      method.total_time,                   # total
-                      method.self_time,                    # self
-                      method.wait_time,                    # wait
-                      method.children_time,                # children
-                      method.called,                       # calls
-                      method.recursive? ? "*" : " ",       # cycle
-                      method.full_name,                    # method_name]
-                      method_location(method)]             # location]
-      end
-    end
-  end
+# encoding: utf-8
+
+module RubyProf
+  # Generates flat[link:files/examples/flat_txt.html] profile reports as text.
+  # To use the flat printer:
+  #
+  #   result = RubyProf.profile do
+  #     [code to profile]
+  #   end
+  #
+  #   printer = RubyProf::FlatPrinter.new(result)
+  #   printer.print(STDOUT)
+  #
+  class FlatPrinter < AbstractPrinter
+    # Override to default sort by self time
+    def print(output = STDOUT, sort_method: :self_time, **options)
+      super(output, sort_method: sort_method, **options)
+    end
+
+    private
+
+    def print_column_headers
+      @output << " %self      total      self      wait     child     calls  name                           location\n"
+    end
+
+    def print_methods(thread)
+      total_time = thread.total_time
+      methods = thread.methods.sort_by(&sort_method).reverse
+
+      sum = 0
+      methods.each do |method|
+        percent = (method.send(filter_by) / total_time) * 100
+        next if percent < min_percent
+        next if percent > max_percent
+
+        sum += method.self_time
+        #self_time_called = method.called > 0 ? method.self_time/method.called : 0
+        #total_time_called = method.called > 0? method.total_time/method.called : 0
+
+        @output << "%6.2f  %9.3f %9.3f %9.3f %9.3f %8d  %s%-30s %s\n" % [
+                      method.self_time / total_time * 100, # %self
+                      method.total_time,                   # total
+                      method.self_time,                    # self
+                      method.wait_time,                    # wait
+                      method.children_time,                # children
+                      method.called,                       # calls
+                      method.recursive? ? "*" : " ",       # cycle
+                      method.full_name,                    # method_name]
+                      method_location(method)]             # location]
+      end
+    end
+  end
 end

data/lib/ruby-prof/printers/graph_html_printer.rb

@@ -1,63 +1,62 @@
-# encoding: utf-8
-
-require 'erb'
-
-module RubyProf
-  # Generates graph[link:files/examples/graph_html.html] profile reports as html.
-  # To use the graph html printer:
-  #
-  #   result = RubyProf.profile do
-  #     [code to profile]
-  #   end
-  #
-  #   printer = RubyProf::GraphHtmlPrinter.new(result)
-  #   printer.print(STDOUT, :min_percent=>0)
-  #
-  # The Graph printer takes the following options in its print methods:
-
-  class GraphHtmlPrinter < AbstractPrinter
-    include ERB::Util
-
-    def setup_options(options)
-      super(options)
-      @erb = ERB.new(self.template)
-    end
-
-    def print(output = STDOUT, options = {})
-      setup_options(options)
-      output << @erb.result(binding)
-    end
-
-    # Creates a link to a method.  Note that we do not create
-    # links to methods which are under the min_percent
-    # specified by the user, since they will not be
-    # printed out.
-    def create_link(thread, overall_time, method)
-      total_percent = (method.total_time/overall_time) * 100
-      if total_percent < min_percent
-        # Just return name
-        h method.full_name
-      else
-        href = '#' + method_href(thread, method)
-        "<a href=\"#{href}\">#{h method.full_name}</a>"
-      end
-    end
-
-    def method_href(thread, method)
-      h(method.full_name.gsub(/[><#\.\?=:]/,"_") + "_" + thread.fiber_id.to_s)
-    end
-
-    def file_link(path, linenum)
-      if path.nil?
-        ""
-      else
-        srcfile = File.expand_path(path)
-        "<a href=\"file://#{h srcfile}##{linenum}\" title=\"#{h srcfile}:#{linenum}\">#{linenum}</a>"
-      end
-    end
-
-    def template
-      open_asset('graph_printer.html.erb')
-    end
-  end
-end
+# encoding: utf-8
+
+require 'erb'
+
+module RubyProf
+  # Generates graph[link:files/examples/graph_html.html] profile reports as html.
+  # To use the graph html printer:
+  #
+  #   result = RubyProf.profile do
+  #     [code to profile]
+  #   end
+  #
+  #   printer = RubyProf::GraphHtmlPrinter.new(result)
+  #   printer.print(STDOUT, min_percent: 0)
+
+  class GraphHtmlPrinter < AbstractPrinter
+    include ERB::Util
+
+    def print(output = STDOUT, min_time: nil, nonzero: false,
+              min_percent: 0, max_percent: 100, filter_by: :self_time, sort_method: nil, **)
+      @min_percent = min_percent
+      @max_percent = max_percent
+      @filter_by = filter_by
+      @sort_method = sort_method
+      @min_time = min_time
+      @nonzero = nonzero
+      output << ERB.new(self.template).result(binding)
+    end
+
+    # Creates a link to a method.  Note that we do not create
+    # links to methods which are under the min_percent
+    # specified by the user, since they will not be
+    # printed out.
+    def create_link(thread, overall_time, method)
+      total_percent = (method.total_time/overall_time) * 100
+      if total_percent < min_percent
+        # Just return name
+        h method.full_name
+      else
+        href = '#' + method_href(thread, method)
+        "<a href=\"#{href}\">#{h method.full_name}</a>"
+      end
+    end
+
+    def method_href(thread, method)
+      h(method.full_name.gsub(/[><#\.\?=:]/,"_") + "_" + thread.fiber_id.to_s)
+    end
+
+    def file_link(path, linenum)
+      if path.nil?
+        ""
+      else
+        srcfile = File.expand_path(path)
+        "<a href=\"file://#{h srcfile}##{linenum}\" title=\"#{h srcfile}:#{linenum}\">#{linenum}</a>"
+      end
+    end
+
+    def template
+      open_asset('graph_printer.html.erb')
+    end
+  end
+end