stackprof 0.2.7 → 0.2.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8cdda351beb1c3d9ec3ea54b3b5ba337c7fee2b4
+  data.tar.gz: 723685a77ea3e6353415f450b01482a02a9cb2c5
+SHA512:
+  metadata.gz: cc644c9cff62e83ecb6f38e714b204780d5ca47e16293c9265eff6acbc2a242722ba035b135b9f2557fab9bc8c969f1a2a31ff8e02d9bbd45b2f62466e2949f4
+  data.tar.gz: 29d719e15d94559440af70bb0e02eafcad996cfeee37890377cd834cb81e01373378618c4aba60e727a81b5dffcf7511e37e35c0b5aae54cecdcf82a936017c8

data/.gitignore

@@ -1,3 +1,4 @@
 /tmp
 /lib/stackprof.bundle
 /lib/stackprof.so
+*.sw?

data/Gemfile.lock

@@ -1,22 +1,24 @@
 PATH
   remote: .
   specs:
-    stackprof (0.2.6)
+    stackprof (0.2.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    metaclass (0.0.1)
+    metaclass (0.0.4)
+    minitest (5.4.1)
     mocha (0.14.0)
       metaclass (~> 0.0.1)
-    rake (10.1.0)
-    rake-compiler (0.9.1)
+    rake (10.3.2)
+    rake-compiler (0.9.3)
       rake
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  minitest (~> 5.0)
   mocha (~> 0.14)
   rake-compiler (~> 0.9)
   stackprof!

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013-2015 Aman Gupta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -186,7 +186,7 @@ digraph profile {
 }
 ```
 
-#### `StackProf::Report.new(data).print_source(/pow|newobj|math/)`
+#### `StackProf::Report.new(data).print_method(/pow|newobj|math/)`
 
 ```
 A#pow (/Users/tmm1/code/stackprof/sample.rb:11)
@@ -265,11 +265,23 @@ multiple start/stop invocations.
 
 ``` ruby
 StackProf.running?
-StackProf.start
+StackProf.start(mode: :cpu)
 StackProf.stop
-StackProf.results
+StackProf.results('/tmp/some.file')
 ```
 
+### all options
+
+`StackProf.run` accepts an options hash. Currently, the following options are recognized:
+
+Option      | Meaning
+-------     | ---------
+`mode`      | mode of sampling: `:cpu`, `:wall`, `:object`, or `:custom` [c.f.](#sampling)
+`out`       | the target file, which will be overwritten
+`interval`  | mode-relative sample rate [c.f.](#sampling)
+`aggregate` | defaults: `true` - if `false` disables [aggregation](#aggregation)
+`raw`       | defaults `false` - if `true` collects the extra data required by the `--flamegraph` and `--stackcollapse` report types
+
 ### todo
 
 * file/iseq blacklist

data/bin/stackprof

@@ -2,23 +2,20 @@
 require 'optparse'
 require 'stackprof'
 
-options = {
-  :format => :text,
-  :sort => false,
-  :limit => 30
-}
+options = {}
 
 parser = OptionParser.new(ARGV) do |o|
   o.banner = "Usage: stackprof [file.dump]+ [--text|--method=NAME|--callgrind|--graphviz]"
 
   o.on('--text', 'Text summary per method (default)'){ options[:format] = :text }
   o.on('--files', 'List of files'){ |f| options[:format] = :files }
-  o.on('--limit [num]', Integer, 'Limit --text or --files output to N lines'){ |n| options[:limit] = n }
+  o.on('--limit [num]', Integer, 'Limit --text, --files, or --graphviz output to N entries'){ |n| options[:limit] = n }
   o.on('--sort-total', "Sort --text or --files output on total samples\n\n"){ options[:sort] = true }
   o.on('--method [grep]', 'Zoom into specified method'){ |f| options[:format] = :method; options[:filter] = f }
   o.on('--file [grep]', "Show annotated code for specified file\n\n"){ |f| options[:format] = :file; options[:filter] = f }
   o.on('--callgrind', 'Callgrind output (use with kcachegrind, stackprof-gprof2dot.py)'){ options[:format] = :callgrind }
   o.on('--graphviz', "Graphviz output (use with dot)"){ options[:format] = :graphviz }
+  o.on('--node-fraction [frac]', OptionParser::DecimalNumeric, 'Drop nodes representing less than [frac] fraction of samples'){ |n| options[:node_fraction] = n }
   o.on('--stackcollapse', 'stackcollapse.pl compatible output (use with stackprof-flamegraph.pl)'){ options[:format] = :stackcollapse }
   o.on('--flamegraph', "timeline-flamegraph output (js)"){ options[:format] = :flamegraph }
   o.on('--flamegraph-viewer [f.js]', String, "open html viewer for flamegraph output\n\n"){ |file|
@@ -43,6 +40,20 @@ while ARGV.size > 0
 end
 report = reports.inject(:+)
 
+default_options = {
+  :format => :text,
+  :sort => false,
+  :limit => 30
+}
+
+if options[:format] == :graphviz
+  default_options[:limit] = 120
+  default_options[:node_fraction] = 0.005
+end
+
+options = default_options.merge(options)
+options.delete(:limit) if options[:limit] == 0
+
 case options[:format]
 when :text
   report.print_text(options[:sort], options[:limit])
@@ -53,7 +64,7 @@ when :dump
 when :callgrind
   report.print_callgrind
 when :graphviz
-  report.print_graphviz
+  report.print_graphviz(options)
 when :stackcollapse
   report.print_stackcollapse
 when :flamegraph

data/ext/stackprof.c

@@ -436,8 +436,9 @@ stackprof_signal_handler(int sig, siginfo_t *sinfo, void *ucontext)
 static void
 stackprof_newobj_handler(VALUE tpval, void *data)
 {
-    /* TODO: implement interval */
     _stackprof.overall_signals++;
+    if (RTEST(_stackprof.interval) && _stackprof.overall_signals % NUM2LONG(_stackprof.interval))
+	return;
     stackprof_job_handler(0);
 }
 

data/lib/stackprof/middleware.rb

@@ -9,6 +9,7 @@ module StackProf
 
       Middleware.mode     = options[:mode] || :cpu
       Middleware.interval = options[:interval] || 1000
+      Middleware.raw      = options[:raw] || false
       Middleware.enabled  = options[:enabled]
       Middleware.path     = options[:path] || 'tmp'
       at_exit{ Middleware.save } if options[:save_at_exit]
@@ -16,7 +17,7 @@ module StackProf
 
     def call(env)
       enabled = Middleware.enabled?(env)
-      StackProf.start(mode: Middleware.mode, interval: Middleware.interval) if enabled
+      StackProf.start(mode: Middleware.mode, interval: Middleware.interval, raw: Middleware.raw) if enabled
       @app.call(env)
     ensure
       if enabled
@@ -29,7 +30,7 @@ module StackProf
     end
 
     class << self
-      attr_accessor :enabled, :mode, :interval, :path
+      attr_accessor :enabled, :mode, :interval, :raw, :path
 
       def enabled?(env)
         if enabled.respond_to?(:call)

data/lib/stackprof/report.rb

@@ -63,12 +63,12 @@ module StackProf
       pp @data
     end
 
-    def print_dump
-      puts Marshal.dump(@data.reject{|k,v| k == :files })
+    def print_dump(f=STDOUT)
+      f.puts Marshal.dump(@data.reject{|k,v| k == :files })
     end
 
     def print_stackcollapse
-      raise "profile does not include raw samples" unless raw = data[:raw]
+      raise "profile does not include raw samples (add `raw: true` to collecting StackProf.run)" unless raw = data[:raw]
 
       while len = raw.shift
         frames = raw.slice!(0, len)
@@ -80,7 +80,7 @@ module StackProf
     end
 
     def print_flamegraph(f=STDOUT, skip_common=true)
-      raise "profile does not include raw samples" unless raw = data[:raw]
+      raise "profile does not include raw samples (add `raw: true` to collecting StackProf.run)" unless raw = data[:raw]
 
       stacks = []
       max_x = 0
@@ -147,29 +147,43 @@ module StackProf
       f.puts %{{"x":#{x},"y":#{y},"width":#{weight},"frame_id":#{addr},"frame":#{frame[:name].dump},"file":#{frame[:file].dump}}}
     end
 
-    def print_graphviz(filter = nil, f = STDOUT)
-      if filter
+    def print_graphviz(options = {}, f = STDOUT)
+      if filter = options[:filter]
         mark_stack = []
-        list = frames
+        list = frames(true)
         list.each{ |addr, frame| mark_stack << addr if frame[:name] =~ filter }
         while addr = mark_stack.pop
           frame = list[addr]
           unless frame[:marked]
-            $stderr.puts frame[:edges].inspect
-            mark_stack += frame[:edges].map{ |addr, weight| addr.to_s if list[addr.to_s][:total_samples] <= weight*1.2 }.compact if frame[:edges]
+            mark_stack += frame[:edges].map{ |addr, weight| addr if list[addr][:total_samples] <= weight*1.2 }.compact if frame[:edges]
             frame[:marked] = true
           end
         end
         list = list.select{ |addr, frame| frame[:marked] }
-        list.each{ |addr, frame| frame[:edges] && frame[:edges].delete_if{ |k,v| list[k.to_s].nil? } }
+        list.each{ |addr, frame| frame[:edges] && frame[:edges].delete_if{ |k,v| list[k].nil? } }
         list
       else
-        list = frames
+        list = frames(true)
       end
 
+
+      limit = options[:limit]
+      fraction = options[:node_fraction]
+
+      included_nodes = {}
+      node_minimum = fraction ? (fraction * overall_samples).ceil : 0
+
       f.puts "digraph profile {"
-      list.each do |frame, info|
+      f.puts "Legend [shape=box,fontsize=24,shape=plaintext,label=\""
+      f.print "Total samples: #{overall_samples}\\l"
+      f.print "Showing top #{limit} nodes\\l" if limit
+      f.print "Dropped nodes with < #{node_minimum} samples\\l" if fraction
+      f.puts "\"];"
+
+      list.each_with_index do |(frame, info), index|
         call, total = info.values_at(:samples, :total_samples)
+        break if total < node_minimum || (limit && index >= limit)
+
         sample = ''
         sample << "#{call} (%2.1f%%)\\rof " % (call*100.0/overall_samples) if call < total
         sample << "#{total} (%2.1f%%)\\r" % (total*100.0/overall_samples)
@@ -177,8 +191,16 @@ module StackProf
         size = (1.0 * total / overall_samples) * 2.0 + 0.5
 
         f.puts "  \"#{frame}\" [size=#{size}] [fontsize=#{fontsize}] [penwidth=\"#{size}\"] [shape=box] [label=\"#{info[:name]}\\n#{sample}\"];"
+        included_nodes[frame] = true
+      end
+
+      list.each do |frame, info|
+        next unless included_nodes[frame]
+
         if edges = info[:edges]
           edges.each do |edge, weight|
+            next unless included_nodes[edge]
+
             size = (1.0 * weight / overall_samples) * 2.0 + 0.5
             f.puts "  \"#{frame}\" -> \"#{edge}\" [label=\"#{weight}\"] [weight=\"#{weight}\"] [penwidth=\"#{size}\"];"
           end
@@ -278,8 +300,7 @@ module StackProf
 
     def print_file(filter, f = STDOUT)
       filter = /#{Regexp.escape filter}/ unless Regexp === filter
-      list = files
-      list.select!{ |name, lines| name =~ filter }
+      list = files.select{ |name, lines| name =~ filter }
       list.sort_by{ |file, vals| -vals.values.inject(0){ |sum, n| sum + (n.is_a?(Array) ? n[1] : n) } }.each do |file, lines|
         source_display(f, file, lines)
       end

data/sample.rb

@@ -34,7 +34,7 @@ end
 
 result = StackProf::Report.new(profile)
 puts
-result.print_source(/pow|newobj|math/)
+result.print_method(/pow|newobj|math/)
 puts
 result.print_text
 puts

data/stackprof.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'stackprof'
-  s.version = '0.2.7'
+  s.version = '0.2.8'
   s.homepage = 'http://github.com/tmm1/stackprof'
 
   s.authors = 'Aman Gupta'
@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake-compiler', '~> 0.9'
   s.add_development_dependency 'mocha', '~> 0.14'
+  s.add_development_dependency 'minitest', '~> 5.0'
 end

data/test/test_middleware.rb

@@ -1,10 +1,10 @@
 $:.unshift File.expand_path('../../lib', __FILE__)
 require 'stackprof'
 require 'stackprof/middleware'
-require 'test/unit'
+require 'minitest/autorun'
 require 'mocha/setup'
 
-class StackProf::MiddlewareTest < Test::Unit::TestCase
+class StackProf::MiddlewareTest < MiniTest::Test
 
   def test_path_default
     StackProf::Middleware.new(Object.new)
@@ -55,9 +55,13 @@ class StackProf::MiddlewareTest < Test::Unit::TestCase
     StackProf::Middleware.new(Object.new, enabled: enable_proc)
     refute StackProf::Middleware.enabled?(env)
 
-    env = Hash.new { true}
+    env = Hash.new { true }
     StackProf::Middleware.new(Object.new, enabled: enable_proc)
     assert StackProf::Middleware.enabled?(env)
   end
 
+  def test_raw
+    StackProf::Middleware.new(Object.new, raw: true)
+    assert StackProf::Middleware.raw
+  end
 end

data/test/test_report.rb

@@ -0,0 +1,34 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'stackprof'
+require 'minitest/autorun'
+
+class ReportDumpTest < MiniTest::Test
+  require 'stringio'
+
+  def test_dump_to_stdout
+    data = {}
+    report = StackProf::Report.new(data)
+
+    out, _err = capture_subprocess_io do
+      report.print_dump
+    end
+
+    assert_dump data, out
+  end
+
+  def test_dump_to_file
+    data = {}
+    f = StringIO.new
+    report = StackProf::Report.new(data)
+
+    report.print_dump(f)
+
+    assert_dump data, f.string
+  end
+
+  private
+
+  def assert_dump(expected, marshal_data)
+    assert_equal expected, Marshal.load(marshal_data)
+  end
+end

data/test/test_stackprof.rb

@@ -1,9 +1,9 @@
 $:.unshift File.expand_path('../../lib', __FILE__)
 require 'stackprof'
-require 'test/unit'
+require 'minitest/autorun'
 require 'tempfile'
 
-class StackProfTest < Test::Unit::TestCase
+class StackProfTest < MiniTest::Test
   def test_info
     profile = StackProf.run{}
     assert_equal 1.1, profile[:version]
@@ -31,6 +31,7 @@ class StackProfTest < Test::Unit::TestCase
   end
 
   def test_object_allocation
+    profile_base_line = __LINE__+1
     profile = StackProf.run(mode: :object) do
       Object.new
       Object.new
@@ -42,28 +43,24 @@ class StackProfTest < Test::Unit::TestCase
     frame = profile[:frames].values.first
     assert_equal "block in StackProfTest#test_object_allocation", frame[:name]
     assert_equal 2, frame[:samples]
-    line = __LINE__
-    assert_equal line-11, frame[:line]
-    assert_equal [1, 1], frame[:lines][line-10]
-    assert_equal [1, 1], frame[:lines][line-9]
+    assert_equal profile_base_line, frame[:line]
+    assert_equal [1, 1], frame[:lines][profile_base_line+1]
+    assert_equal [1, 1], frame[:lines][profile_base_line+2]
 
     frame = profile[:frames].values[1]
-    assert_equal [2, 0], frame[:lines][line-11]
+    assert_equal [2, 0], frame[:lines][profile_base_line]
   end
 
-  def test_cputime
-    profile = StackProf.run(mode: :cpu, interval: 500) do
-      math
+  def test_object_allocation_interval
+    profile = StackProf.run(mode: :object, interval: 10) do
+      100.times { Object.new }
     end
-
-    assert_operator profile[:samples], :>, 1
-    frame = profile[:frames].values.first
-    assert_equal "block in StackProfTest#math", frame[:name]
+    assert_equal 10, profile[:samples]
   end
 
-  def test_cputime_bmethod
+  def test_cputime
     profile = StackProf.run(mode: :cpu, interval: 500) do
-      bmath
+      math
     end
 
     assert_operator profile[:samples], :>, 1
@@ -82,6 +79,7 @@ class StackProfTest < Test::Unit::TestCase
   end
 
   def test_custom
+    profile_base_line = __LINE__+1
     profile = StackProf.run(mode: :custom) do
       10.times do
         StackProf.sample
@@ -93,8 +91,8 @@ class StackProfTest < Test::Unit::TestCase
 
     frame = profile[:frames].values.first
     assert_equal "block (2 levels) in StackProfTest#test_custom", frame[:name]
-    assert_equal __LINE__-10, frame[:line]
-    assert_equal [10, 10], frame[:lines][__LINE__-10]
+    assert_equal profile_base_line+1, frame[:line]
+    assert_equal [10, 10], frame[:lines][profile_base_line+2]
   end
 
   def test_raw
@@ -142,7 +140,7 @@ class StackProfTest < Test::Unit::TestCase
     assert_equal tmpfile, ret
     tmpfile.rewind
     profile = Marshal.load(tmpfile.read)
-    assert_not_empty profile[:frames]
+    refute_empty profile[:frames]
   end
 
   def math
@@ -158,10 +156,4 @@ class StackProfTest < Test::Unit::TestCase
     r.close
     w.close
   end
-
-  define_method(:bmath) do
-    250_000.times do
-      2 ** 10
-    end
-  end
 end

metadata

@@ -1,48 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: stackprof
 version: !ruby/object:Gem::Version
-  version: 0.2.7
-  prerelease: 
+  version: 0.2.8
 platform: ruby
 authors:
 - Aman Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2016-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: stackprof is a fast sampling profiler for ruby code, with cpu, wallclock
   and object allocation samplers.
 email: aman@tmm1.net
@@ -54,9 +63,10 @@ extensions:
 - ext/extconf.rb
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - bin/stackprof
@@ -71,6 +81,7 @@ files:
 - sample.rb
 - stackprof.gemspec
 - test/test_middleware.rb
+- test/test_report.rb
 - test/test_stackprof.rb
 - vendor/FlameGraph/README
 - vendor/FlameGraph/flamegraph.pl
@@ -79,27 +90,25 @@ files:
 homepage: http://github.com/tmm1/stackprof
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: sampling callstack-profiler for ruby 2.1+
 test_files: []
-has_rdoc: