stackprof 0.2.9 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccd65300839e0302d1ce83344815ab9ceb5bf00c
-  data.tar.gz: 693f5630f930e10ae29e0b2eb906749a379fb326
+  metadata.gz: afa4ecbd5eba7e06625bb12c770da033682539f4
+  data.tar.gz: fc0f0ad1bcc0e1d726c82437a57aa6c0beb8b3e2
 SHA512:
-  metadata.gz: ad05091d5ee959c900b12d3bf659b021a51082e99bea2e52d99a35ec2c7b55363a32673f6a9cdc952074e021ff61066c83a43381c5b4d64e41345b2e0bee2853
-  data.tar.gz: f2dad38ea0bdb1bcb4ad52df7ae3997e8e7e40689eee14f62a255cac1a8449dce032cfb06fee6e522b3d5bbf3dfd971ce5cdcba4d6411237b3e0af4a410b4f3c
+  metadata.gz: ddb8ed15ef2275231790a475a770a72753fe87aee98fc77d2c7a19d9405228f72832b76f941c84db94bf62fd5a445fb9d3b8e3521f2bc016f6dc170229d56a0e
+  data.tar.gz: b911543ceb1e019086adda7780aa72b48dc6bede83ee99cf746b5cac557f5f9a395c5f88ac3a5f34414e1c1dc8f56c5559e770e8eb355cc9a0c9f7071bb144fe

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+  - ruby-head
+script: "bundle exec rake test"
+sudo: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stackprof (0.2.7)
+    stackprof (0.2.9)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -24,7 +24,7 @@ in ruby:
 
 ``` ruby
 StackProf.run(mode: :cpu, out: 'tmp/stackprof-cpu-myapp.dump') do
-  ...
+  #...
 end
 ```
 
@@ -77,6 +77,22 @@ $ stackprof tmp/stackprof-cpu-*.dump --method 'Object#present?'
 
 For an experimental version of WebUI reporting of stackprof, see [stackprof-webnav](https://github.com/alisnic/stackprof-webnav)
 
+You can generate a flamegraph however additional data must be collected using the `raw: true` flag. Once you've collected results with this flag enabled you can generate a flamegraph:
+
+```
+$ stackprof --flamegraph tmp/stackprof-cpu-myapp.dump > tmp/flamegraph
+```
+
+Once the flamegraph has been generated you can generate a viewer command with:
+
+```
+$ stackprof --flamegraph-viewer=tmp/flamegraph
+```
+
+The `--flamegraph-viewer` command will output the exact shell command you need to run to open the `tmp/flamegraph` you generated with the built in stackprof flamegraph viewer:
+
+![](http://i.imgur.com/EwndrgD.png)
+
 ### sampling
 
 four sampling modes are supported:
@@ -89,9 +105,30 @@ four sampling modes are supported:
 samplers have a tuneable interval which can be used to reduce overhead or increase granularity:
 
   - wall time: sample every _interval_ microseconds of wallclock time (default: 1000)
+
+```ruby
+StackProf.run(mode: :wall, out: 'tmp/stackprof.dump', interval: 1000) do
+  #...
+end
+```
+
   - cpu time: sample every _interval_ microseconds of cpu activity (default: 1000 = 1 millisecond)
+
+```ruby
+StackProf.run(mode: :cpu, out: 'tmp/stackprof.dump', interval: 1000) do
+  #...
+end
+```
+
   - object allocation: sample every _interval_ allocations (default: 1)
 
+
+```ruby
+StackProf.run(mode: :object, out: 'tmp/stackprof.dump', interval: 1) do
+  #...
+end
+```
+
 samples are taken using a combination of three new C-APIs in ruby 2.1:
 
   - signal handlers enqueue a sampling job using `rb_postponed_job_register_one`.
@@ -105,7 +142,7 @@ samples are taken using a combination of three new C-APIs in ruby 2.1:
   - in allocation mode, samples are taken via `rb_tracepoint_new(RUBY_INTERNAL_EVENT_NEWOBJ)`,
     which provides a notification every time the VM allocates a new object.
 
-### aggregation
+### Aggregation
 
 each sample consists of N stack frames, where a frame looks something like `MyClass#method` or `block in MySingleton.method`.
 for each of these frames in the sample, the profiler collects a few pieces of metadata:

data/Rakefile

@@ -16,7 +16,7 @@ end
 
 require 'rake/extensiontask'
 Rake::ExtensionTask.new('stackprof', GEMSPEC) do |ext|
-  ext.ext_dir = 'ext'
+  ext.lib_dir = 'lib/stackprof'
 end
 task :build => :compile
 

data/bin/stackprof

@@ -22,6 +22,10 @@ parser = OptionParser.new(ARGV) do |o|
     puts("open file://#{File.expand_path('../../lib/stackprof/flamegraph/viewer.html', __FILE__)}?data=#{File.expand_path(file)}")
     exit
   }
+  o.on('--select-files []', String, 'Show results of matching files'){ |path| (options[:select_files] ||= []) << File.expand_path(path) }
+  o.on('--reject-files []', String, 'Exclude results of matching files'){ |path| (options[:reject_files] ||= []) << File.expand_path(path) }
+  o.on('--select-names []', Regexp, 'Show results of matching method names'){ |regexp| (options[:select_names] ||= []) << regexp }
+  o.on('--reject-names []', Regexp, 'Exclude results of matching method names'){ |regexp| (options[:reject_names] ||= []) << regexp }
   o.on('--dump', 'Print marshaled profile dump (combine multiple profiles)'){ options[:format] = :dump }
   o.on('--debug', 'Pretty print raw profile data'){ options[:format] = :debug }
 end
@@ -56,7 +60,7 @@ options.delete(:limit) if options[:limit] == 0
 
 case options[:format]
 when :text
-  report.print_text(options[:sort], options[:limit])
+  report.print_text(options[:sort], options[:limit], options[:select_files], options[:reject_files], options[:select_names], options[:reject_names])
 when :debug
   report.print_debug
 when :dump

data/ext/{extconf.rb → stackprof/extconf.rb}

@@ -3,7 +3,7 @@ if have_func('rb_postponed_job_register_one') &&
    have_func('rb_profile_frames') &&
    have_func('rb_tracepoint_new') &&
    have_const('RUBY_INTERNAL_EVENT_NEWOBJ')
-  create_makefile('stackprof')
+  create_makefile('stackprof/stackprof')
 else
   fail 'missing API: are you using ruby 2.1+?'
 end

data/ext/{stackprof.c → stackprof/stackprof.c}

@@ -2,7 +2,7 @@
 
   stackprof.c - Sampling call-stack frame profiler for MRI.
 
-  vim: setl noexpandtab shiftwidth=4 tabstop=8 softtabstop=4
+  vim: noexpandtab shiftwidth=4 tabstop=8 softtabstop=4
 
 **********************************************************************/
 
@@ -540,8 +540,5 @@ Init_stackprof(void)
     rb_define_singleton_method(rb_mStackProf, "results", stackprof_results, -1);
     rb_define_singleton_method(rb_mStackProf, "sample", stackprof_sample, 0);
 
-    rb_autoload(rb_mStackProf, rb_intern_const("Report"), "stackprof/report.rb");
-    rb_autoload(rb_mStackProf, rb_intern_const("Middleware"), "stackprof/middleware.rb");
-
     pthread_atfork(stackprof_atfork_prepare, stackprof_atfork_parent, stackprof_atfork_child);
 }

data/lib/stackprof.rb

@@ -0,0 +1,4 @@
+require "stackprof/stackprof"
+
+StackProf.autoload :Report, "stackprof/report.rb"
+StackProf.autoload :Middleware, "stackprof/middleware.rb"

data/lib/stackprof/report.rb

@@ -9,7 +9,8 @@ module StackProf
     attr_reader :data
 
     def frames(sort_by_total=false)
-      @data[:frames].sort_by{ |iseq, stats| -stats[sort_by_total ? :total_samples : :samples] }.inject({}){|h, (k, v)| h[k] = v; h}
+      @data[:"sorted_frames_#{sort_by_total}"] ||=
+        @data[:frames].sort_by{ |iseq, stats| -stats[sort_by_total ? :total_samples : :samples] }.inject({}){|h, (k, v)| h[k] = v; h}
     end
 
     def normalized_frames
@@ -209,7 +210,7 @@ module StackProf
       f.puts "}"
     end
 
-    def print_text(sort_by_total=false, limit=nil, f = STDOUT)
+    def print_text(sort_by_total=false, limit=nil, select_files= nil, reject_files=nil, select_names=nil, reject_names=nil, f = STDOUT)
       f.puts "=================================="
       f.printf "  Mode: #{modeline}\n"
       f.printf "  Samples: #{@data[:samples]} (%.2f%% miss rate)\n", 100.0*@data[:missed_samples]/(@data[:missed_samples]+@data[:samples])
@@ -217,6 +218,10 @@ module StackProf
       f.puts "=================================="
       f.printf "% 10s    (pct)  % 10s    (pct)     FRAME\n" % ["TOTAL", "SAMPLES"]
       list = frames(sort_by_total)
+      list.select!{|_, info| select_files.any?{|path| info[:file].start_with?(path)}} if select_files
+      list.select!{|_, info| select_names.any?{|reg| info[:name] =~ reg}} if select_names
+      list.reject!{|_, info| reject_files.any?{|path| info[:file].start_with?(path)}} if reject_files
+      list.reject!{|_, info| reject_names.any?{|reg| info[:name] =~ reg}} if reject_names
       list = list.first(limit) if limit
       list.each do |frame, info|
         call, total = info.values_at(:samples, :total_samples)

data/stackprof.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
   s.name = 'stackprof'
-  s.version = '0.2.9'
+  s.version = '0.2.10'
   s.homepage = 'http://github.com/tmm1/stackprof'
 
   s.authors = 'Aman Gupta'
   s.email   = 'aman@tmm1.net'
 
   s.files = `git ls-files`.split("\n")
-  s.extensions = 'ext/extconf.rb'
+  s.extensions = 'ext/stackprof/extconf.rb'
 
   s.bindir = 'bin'
   s.executables << 'stackprof'

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: stackprof
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.10
 platform: ruby
 authors:
 - Aman Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2016-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     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
@@ -60,10 +60,11 @@ executables:
 - stackprof-flamegraph.pl
 - stackprof-gprof2dot.py
 extensions:
-- ext/extconf.rb
+- ext/stackprof/extconf.rb
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -72,8 +73,9 @@ files:
 - bin/stackprof
 - bin/stackprof-flamegraph.pl
 - bin/stackprof-gprof2dot.py
-- ext/extconf.rb
-- ext/stackprof.c
+- ext/stackprof/extconf.rb
+- ext/stackprof/stackprof.c
+- lib/stackprof.rb
 - lib/stackprof/flamegraph/flamegraph.js
 - lib/stackprof/flamegraph/viewer.html
 - lib/stackprof/middleware.rb
@@ -97,17 +99,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: sampling callstack-profiler for ruby 2.1+