stackprof 0.2.11 → 0.2.25

data/lib/stackprof/autorun.rb

@@ -0,0 +1,19 @@
+require "stackprof"
+
+options = {}
+options[:mode] = ENV["STACKPROF_MODE"].to_sym if ENV.key?("STACKPROF_MODE")
+options[:interval] = Integer(ENV["STACKPROF_INTERVAL"]) if ENV.key?("STACKPROF_INTERVAL")
+options[:raw] = true if ENV["STACKPROF_RAW"]
+options[:ignore_gc] = true if ENV["STACKPROF_IGNORE_GC"]
+
+at_exit do
+  StackProf.stop
+  output_path = ENV.fetch("STACKPROF_OUT") do
+    require "tempfile"
+    Tempfile.create(["stackprof", ".dump"]).path
+  end
+  StackProf.results(output_path)
+  $stderr.puts("StackProf results dumped at: #{output_path}")
+end
+
+StackProf.start(**options)

data/lib/stackprof/middleware.rb

@@ -11,13 +11,20 @@ module StackProf
       Middleware.interval = options[:interval] || 1000
       Middleware.raw      = options[:raw] || false
       Middleware.enabled  = options[:enabled]
-      Middleware.path     = options[:path] || 'tmp'
+      options[:path]      = 'tmp/' if options[:path].to_s.empty?
+      Middleware.path     = options[:path]
+      Middleware.metadata = options[:metadata] || {}
       at_exit{ Middleware.save } if options[:save_at_exit]
     end
 
     def call(env)
       enabled = Middleware.enabled?(env)
-      StackProf.start(mode: Middleware.mode, interval: Middleware.interval, raw: Middleware.raw) if enabled
+      StackProf.start(
+        mode:     Middleware.mode,
+        interval: Middleware.interval,
+        raw:      Middleware.raw,
+        metadata: Middleware.metadata,
+      ) if enabled
       @app.call(env)
     ensure
       if enabled
@@ -30,7 +37,7 @@ module StackProf
     end
 
     class << self
-      attr_accessor :enabled, :mode, :interval, :raw, :path
+      attr_accessor :enabled, :mode, :interval, :raw, :path, :metadata
 
       def enabled?(env)
         if enabled.respond_to?(:call)
@@ -40,11 +47,20 @@ module StackProf
         end
       end
 
-      def save(filename = nil)
+      def save
         if results = StackProf.results
-          FileUtils.mkdir_p(Middleware.path)
-          filename ||= "stackprof-#{results[:mode]}-#{Process.pid}-#{Time.now.to_i}.dump"
-          File.open(File.join(Middleware.path, filename), 'wb') do |f|
+          path = Middleware.path
+          is_directory = path != path.chomp('/')
+
+          if is_directory
+            filename = "stackprof-#{results[:mode]}-#{Process.pid}-#{Time.now.to_i}.dump"
+          else
+            filename = File.basename(path)
+            path = File.dirname(path)
+          end
+
+          FileUtils.mkdir_p(path)
+          File.open(File.join(path, filename), 'wb') do |f|
             f.write Marshal.dump(results)
           end
           filename

data/lib/stackprof/report.rb

@@ -1,8 +1,44 @@
+# frozen_string_literal: true
+
 require 'pp'
-require 'digest/md5'
+require 'digest/sha2'
+require 'json'
 
 module StackProf
   class Report
+    MARSHAL_SIGNATURE = "\x04\x08"
+
+    class << self
+      def from_file(file)
+        if (content = IO.binread(file)).start_with?(MARSHAL_SIGNATURE)
+          new(Marshal.load(content))
+        else
+          from_json(JSON.parse(content))
+        end
+      end
+
+      def from_json(json)
+        new(parse_json(json))
+      end
+
+      def parse_json(json)
+        json.keys.each do |key|
+          value = json.delete(key)
+          from_json(value) if value.is_a?(Hash)
+
+          new_key = case key
+          when /\A[0-9]*\z/
+            key.to_i
+          else
+            key.to_sym
+          end
+
+          json[new_key] = value
+        end
+        json
+      end
+    end
+
     def initialize(data)
       @data = data
     end
@@ -16,7 +52,7 @@ module StackProf
     def normalized_frames
       id2hash = {}
       @data[:frames].each do |frame, info|
-        id2hash[frame.to_s] = info[:hash] = Digest::MD5.hexdigest("#{info[:name]}#{info[:file]}#{info[:line]}")
+        id2hash[frame.to_s] = info[:hash] = Digest::SHA256.hexdigest("#{info[:name]}#{info[:file]}#{info[:line]}")
       end
       @data[:frames].inject(Hash.new) do |hash, (frame, info)|
         info = hash[id2hash[frame.to_s]] = info.dup
@@ -38,7 +74,7 @@ module StackProf
     end
 
     def max_samples
-      @data[:max_samples] ||= frames.max_by{ |addr, frame| frame[:samples] }.last[:samples]
+      @data[:max_samples] ||= @data[:frames].values.max_by{ |frame| frame[:samples] }[:samples]
     end
 
     def files
@@ -55,8 +91,8 @@ module StackProf
 
     def add_lines(a, b)
       return b if a.nil?
-      return a+b if a.is_a? Fixnum
-      return [ a[0], a[1]+b ] if b.is_a? Fixnum
+      return a+b if a.is_a? Integer
+      return [ a[0], a[1]+b ] if b.is_a? Integer
       [ a[0]+b[0], a[1]+b[1] ]
     end
 
@@ -68,6 +104,11 @@ module StackProf
       f.puts Marshal.dump(@data.reject{|k,v| k == :files })
     end
 
+    def print_json(f=STDOUT)
+      require "json"
+      f.puts JSON.generate(@data, max_nesting: false)
+    end
+
     def print_stackcollapse
       raise "profile does not include raw samples (add `raw: true` to collecting StackProf.run)" unless raw = data[:raw]
 
@@ -80,18 +121,20 @@ module StackProf
       end
     end
 
-    def print_flamegraph(f=STDOUT, skip_common=true)
+    def print_timeline_flamegraph(f=STDOUT, skip_common=true)
+      print_flamegraph(f, skip_common, false)
+    end
+
+    def print_alphabetical_flamegraph(f=STDOUT, skip_common=true)
+      print_flamegraph(f, skip_common, true)
+    end
+
+    def print_flamegraph(f, skip_common, alphabetical=false)
       raise "profile does not include raw samples (add `raw: true` to collecting StackProf.run)" unless raw = data[:raw]
 
-      stacks = []
-      max_x = 0
-      max_y = 0
-      while len = raw.shift
-        max_y = len if len > max_y
-        stack = raw.slice!(0, len+1)
-        stacks << stack
-        max_x += stack.last
-      end
+      stacks, max_x, max_y = flamegraph_stacks(raw)
+
+      stacks.sort! if alphabetical
 
       f.puts 'flamegraph(['
       max_y.times do |y|
@@ -141,13 +184,233 @@ module StackProf
       f.puts '])'
     end
 
+    def flamegraph_stacks(raw)
+      stacks = []
+      max_x = 0
+      max_y = 0
+      idx = 0
+
+      while len = raw[idx]
+        idx += 1
+        max_y = len if len > max_y
+        stack = raw.slice(idx, len+1)
+        idx += len+1
+        stacks << stack
+        max_x += stack.last
+      end
+
+      return stacks, max_x, max_y
+    end
+
     def flamegraph_row(f, x, y, weight, addr)
-      frame = frames[addr]
+      frame = @data[:frames][addr]
       f.print ',' if @rows_started
       @rows_started = true
       f.puts %{{"x":#{x},"y":#{y},"width":#{weight},"frame_id":#{addr},"frame":#{frame[:name].dump},"file":#{frame[:file].dump}}}
     end
 
+    def convert_to_d3_flame_graph_format(name, stacks, depth)
+      weight = 0
+      children = []
+      stacks.chunk do |stack|
+        if depth == stack.length - 1
+          :leaf
+        else
+          stack[depth]
+        end
+      end.each do |val, child_stacks|
+        if val == :leaf
+          child_stacks.each do |stack|
+            weight += stack.last
+          end
+        else
+          frame = @data[:frames][val]
+          child_name = "#{ frame[:name] } : #{ frame[:file] } : #{ frame[:line] }"
+          child_data = convert_to_d3_flame_graph_format(child_name, child_stacks, depth + 1)
+          weight += child_data["value"]
+          children << child_data
+        end
+      end
+
+      {
+        "name" => name,
+        "value" => weight,
+        "children" => children,
+      }
+    end
+
+    def print_d3_flamegraph(f=STDOUT, skip_common=true)
+      raise "profile does not include raw samples (add `raw: true` to collecting StackProf.run)" unless raw = data[:raw]
+
+      stacks, * = flamegraph_stacks(raw)
+
+      # d3-flame-grpah supports only alphabetical flamegraph
+      stacks.sort!
+
+      require "json"
+      json = JSON.generate(convert_to_d3_flame_graph_format("<root>", stacks, 0), max_nesting: false)
+
+      # This html code is almost copied from d3-flame-graph sample code.
+      # (Apache License 2.0)
+      # https://github.com/spiermar/d3-flame-graph/blob/gh-pages/index.html
+
+      f.print <<-END
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
+    <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/gh/spiermar/d3-flame-graph@2.0.3/dist/d3-flamegraph.css">
+
+    <style>
+
+    /* Space out content a bit */
+    body {
+      padding-top: 20px;
+      padding-bottom: 20px;
+    }
+
+    /* Custom page header */
+    .header {
+      padding-bottom: 20px;
+      padding-right: 15px;
+      padding-left: 15px;
+      border-bottom: 1px solid #e5e5e5;
+    }
+
+    /* Make the masthead heading the same height as the navigation */
+    .header h3 {
+      margin-top: 0;
+      margin-bottom: 0;
+      line-height: 40px;
+    }
+
+    /* Customize container */
+    .container {
+      max-width: 990px;
+    }
+
+    address {
+      text-align: right;
+    }
+    </style>
+
+    <title>stackprof (mode: #{ data[:mode] })</title>
+
+    <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+    <!--[if lt IE 9]>
+      <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+      <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+    <![endif]-->
+  </head>
+  <body>
+    <div class="container">
+      <div class="header clearfix">
+        <nav>
+          <div class="pull-right">
+            <form class="form-inline" id="form">
+              <a class="btn" href="javascript: resetZoom();">Reset zoom</a>
+              <a class="btn" href="javascript: clear();">Clear</a>
+              <div class="form-group">
+                <input type="text" class="form-control" id="term">
+              </div>
+              <a class="btn btn-primary" href="javascript: search();">Search</a>
+            </form>
+          </div>
+        </nav>
+        <h3 class="text-muted">stackprof (mode: #{ data[:mode] })</h3>
+      </div>
+      <div id="chart">
+      </div>
+      <address>
+        powered by <a href="https://github.com/spiermar/d3-flame-graph">d3-flame-graph</a>
+      </address>
+      <hr>
+      <div id="details">
+      </div>
+    </div>
+
+    <!-- D3.js -->
+    <script src="https://d3js.org/d3.v4.min.js" charset="utf-8"></script>
+
+    <!-- d3-tip -->
+    <script type="text/javascript" src=https://cdnjs.cloudflare.com/ajax/libs/d3-tip/0.9.1/d3-tip.min.js></script>
+
+    <!-- d3-flamegraph -->
+    <script type="text/javascript" src="https://cdn.jsdelivr.net/gh/spiermar/d3-flame-graph@2.0.3/dist/d3-flamegraph.min.js"></script>
+
+    <script type="text/javascript">
+    var flameGraph = d3.flamegraph()
+      .width(960)
+      .cellHeight(18)
+      .transitionDuration(750)
+      .minFrameSize(5)
+      .transitionEase(d3.easeCubic)
+      .sort(true)
+      //Example to sort in reverse order
+      //.sort(function(a,b){ return d3.descending(a.name, b.name);})
+      .title("")
+      .onClick(onClick)
+      .differential(false)
+      .selfValue(false);
+
+
+    // Example on how to use custom tooltips using d3-tip.
+    // var tip = d3.tip()
+    //   .direction("s")
+    //   .offset([8, 0])
+    //   .attr('class', 'd3-flame-graph-tip')
+    //   .html(function(d) { return "name: " + d.data.name + ", value: " + d.data.value; });
+
+    // flameGraph.tooltip(tip);
+
+    var details = document.getElementById("details");
+    flameGraph.setDetailsElement(details);
+
+    // Example on how to use custom labels
+    // var label = function(d) {
+    //  return "name: " + d.name + ", value: " + d.value;
+    // }
+    // flameGraph.label(label);
+
+    // Example of how to set fixed chart height
+    // flameGraph.height(540);
+
+    d3.select("#chart")
+        .datum(#{ json })
+        .call(flameGraph);
+
+    document.getElementById("form").addEventListener("submit", function(event){
+      event.preventDefault();
+      search();
+    });
+
+    function search() {
+      var term = document.getElementById("term").value;
+      flameGraph.search(term);
+    }
+
+    function clear() {
+      document.getElementById('term').value = '';
+      flameGraph.clear();
+    }
+
+    function resetZoom() {
+      flameGraph.resetZoom();
+    }
+
+    function onClick(d) {
+      console.info("Clicked on " + d.data.name);
+    }
+    </script>
+  </body>
+</html>
+      END
+    end
+
     def print_graphviz(options = {}, f = STDOUT)
       if filter = options[:filter]
         mark_stack = []
@@ -185,7 +448,7 @@ module StackProf
         call, total = info.values_at(:samples, :total_samples)
         break if total < node_minimum || (limit && index >= limit)
 
-        sample = ''
+        sample = ''.dup
         sample << "#{call} (%2.1f%%)\\rof " % (call*100.0/overall_samples) if call < total
         sample << "#{total} (%2.1f%%)\\r" % (total*100.0/overall_samples)
         fontsize = (1.0 * call / max_samples) * 28 + 10
@@ -429,7 +692,8 @@ module StackProf
           end
         end
       end
+    rescue SystemCallError
+      f.puts "        SOURCE UNAVAILABLE"
     end
-
   end
 end

data/lib/stackprof/truffleruby.rb

@@ -0,0 +1,37 @@
+module StackProf
+  # Define the same methods as stackprof.c
+  class << self
+    def running?
+      false
+    end
+
+    def run(*args)
+      unimplemented
+    end
+
+    def start(*args)
+      unimplemented
+    end
+
+    def stop
+      unimplemented
+    end
+
+    def results(*args)
+      unimplemented
+    end
+
+    def sample
+      unimplemented
+    end
+
+    def use_postponed_job!
+      # noop
+    end
+
+    private def unimplemented
+      raise "Use --cpusampler=flamegraph or --cpusampler instead of StackProf on TruffleRuby.\n" \
+            "See https://www.graalvm.org/tools/profiling/ and `ruby --help:cpusampler` for more details."
+    end
+  end
+end

data/lib/stackprof.rb

@@ -1,4 +1,21 @@
-require "stackprof/stackprof"
+if RUBY_ENGINE == 'truffleruby'
+  require "stackprof/truffleruby"
+else
+  require "stackprof/stackprof"
+end
+
+if defined?(RubyVM::YJIT) && RubyVM::YJIT.enabled?
+  StackProf.use_postponed_job!
+elsif RUBY_VERSION == "3.2.0"
+  # 3.2.0 crash is the signal is received at the wrong time.
+  # Fixed in https://github.com/ruby/ruby/pull/7116
+  # The fix is backported in 3.2.1: https://bugs.ruby-lang.org/issues/19336
+  StackProf.use_postponed_job!
+end
+
+module StackProf
+  VERSION = '0.2.25'
+end
 
 StackProf.autoload :Report, "stackprof/report.rb"
 StackProf.autoload :Middleware, "stackprof/middleware.rb"

data/stackprof.gemspec

@@ -1,11 +1,18 @@
 Gem::Specification.new do |s|
   s.name = 'stackprof'
-  s.version = '0.2.11'
+  s.version = '0.2.25'
   s.homepage = 'http://github.com/tmm1/stackprof'
 
   s.authors = 'Aman Gupta'
   s.email   = 'aman@tmm1.net'
 
+  s.metadata = {
+    'bug_tracker_uri'   => 'https://github.com/tmm1/stackprof/issues',
+    'changelog_uri'     => "https://github.com/tmm1/stackprof/blob/v#{s.version}/CHANGELOG.md",
+    'documentation_uri' => "https://www.rubydoc.info/gems/stackprof/#{s.version}",
+    'source_code_uri'   => "https://github.com/tmm1/stackprof/tree/v#{s.version}"
+  }
+
   s.files = `git ls-files`.split("\n")
   s.extensions = 'ext/stackprof/extconf.rb'
 
@@ -14,9 +21,11 @@ Gem::Specification.new do |s|
   s.executables << 'stackprof-flamegraph.pl'
   s.executables << 'stackprof-gprof2dot.py'
 
-  s.summary = 'sampling callstack-profiler for ruby 2.1+'
+  s.summary = 'sampling callstack-profiler for ruby 2.2+'
   s.description = 'stackprof is a fast sampling profiler for ruby code, with cpu, wallclock and object allocation samplers.'
 
+  s.required_ruby_version = '>= 2.2'
+
   s.license = 'MIT'
 
   s.add_development_dependency 'rake-compiler', '~> 0.9'

data/test/fixtures/profile.dump

@@ -0,0 +1 @@
+{:	modeI"cpu:ET

data/test/fixtures/profile.json

@@ -0,0 +1 @@
+{ "mode": "cpu" }

data/test/test_middleware.rb

@@ -9,31 +9,31 @@ class StackProf::MiddlewareTest < MiniTest::Test
   def test_path_default
     StackProf::Middleware.new(Object.new)
 
-    assert_equal 'tmp', StackProf::Middleware.path
+    assert_equal 'tmp/', StackProf::Middleware.path
   end
 
   def test_path_custom
-    StackProf::Middleware.new(Object.new, { path: '/foo' })
+    StackProf::Middleware.new(Object.new, { path: 'foo/' })
 
-    assert_equal '/foo', StackProf::Middleware.path
+    assert_equal 'foo/', StackProf::Middleware.path
   end
 
   def test_save_default
     StackProf::Middleware.new(Object.new)
 
     StackProf.stubs(:results).returns({ mode: 'foo' })
-    FileUtils.expects(:mkdir_p).with('tmp')
+    FileUtils.expects(:mkdir_p).with('tmp/')
     File.expects(:open).with(regexp_matches(/^tmp\/stackprof-foo/), 'wb')
 
     StackProf::Middleware.save
   end
 
   def test_save_custom
-    StackProf::Middleware.new(Object.new, { path: '/foo' })
+    StackProf::Middleware.new(Object.new, { path: 'foo/' })
 
     StackProf.stubs(:results).returns({ mode: 'foo' })
-    FileUtils.expects(:mkdir_p).with('/foo')
-    File.expects(:open).with(regexp_matches(/^\/foo\/stackprof-foo/), 'wb')
+    FileUtils.expects(:mkdir_p).with('foo/')
+    File.expects(:open).with(regexp_matches(/^foo\/stackprof-foo/), 'wb')
 
     StackProf::Middleware.save
   end
@@ -64,4 +64,10 @@ class StackProf::MiddlewareTest < MiniTest::Test
     StackProf::Middleware.new(Object.new, raw: true)
     assert StackProf::Middleware.raw
   end
+
+  def test_metadata
+    metadata = { key: 'value' }
+    StackProf::Middleware.new(Object.new, metadata: metadata)
+    assert_equal metadata, StackProf::Middleware.metadata
+  end
 end

data/test/test_report.rb

@@ -32,3 +32,27 @@ class ReportDumpTest < MiniTest::Test
     assert_equal expected, Marshal.load(marshal_data)
   end
 end
+
+class ReportReadTest < MiniTest::Test
+  require 'pathname'
+
+  def test_from_file_read_json
+    file = fixture("profile.json")
+    report = StackProf::Report.from_file(file)
+
+    assert_equal({ mode: "cpu" }, report.data)
+  end
+
+  def test_from_file_read_marshal
+    file = fixture("profile.dump")
+    report = StackProf::Report.from_file(file)
+
+    assert_equal({ mode: "cpu" }, report.data)
+  end
+
+  private
+
+  def fixture(name)
+    Pathname.new(__dir__).join("fixtures", name)
+  end
+end