stackprof 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4d9be2e4ad16929b326e3a1e86c841ad0e13dc6
-  data.tar.gz: 826eff5e56b4ae6c03c613dd9937a5ae396efa98
+  metadata.gz: ba362f7b8c12e89a30cc376280443aef51ce7ac6
+  data.tar.gz: 561f31e9f8b90a728dec5c9d6090f4bd7701228a
 SHA512:
-  metadata.gz: 6153df14d977ffa0b1445950de2e779a8e8dd6606e665ad22bad348619b16659862bce078d1c12eb0d48f6bb90a5c0bd8ae73bc2c4d861466d6f16cda285d4c1
-  data.tar.gz: 06ccf3dc44113e69b544aab7d9c4820daec59ec4b0d3b5e9784960d52b6ead75907f320d66cf4084319567f890862e4ab6954211e1b5c09d114f8553942e51ad
+  metadata.gz: 85a79f6edbf81e520b90d4f35d615c475297acdfe7b5db4277b93bc1e342ac8cc2aebdd56990bca1e82258020f270d6c28bd2098df27f90f320c005da07e9cae
+  data.tar.gz: 7d17bca5d3f356f63d1eec962e40dd4e50520e4a7b2c602b748f94779a9fb147566cc4439ff3cc0c619a687e4eff6e2da5a997240f1542e09849802a4ee7e09a

data/README.md

@@ -5,6 +5,64 @@ a sampling call-stack profiler for ruby 2.1+
 inspired heavily by [gperftools](https://code.google.com/p/gperftools/),
 and written as a replacement for [perftools.rb](https://github.com/tmm1/perftools.rb)
 
+### getting started
+
+in ruby:
+
+``` ruby
+profile = StackProf.run(mode: :cpu) do
+  ...
+end
+File.open('tmp/stackprof-cpu-myapp.dump', 'wb'){ |f| f.write Marshal.dump(profile) }
+```
+
+via rack:
+
+``` ruby
+use StackProf::Middleware, enabled: true,
+                           mode: :cpu,
+                           interval: 1000,
+                           save_every: 5
+```
+
+reporting:
+
+```
+$ stackprof tmp/stackprof-cpu-*.dump --text --limit 1
+  ==================================
+    Mode: cpu(1000)
+    Samples: 60395 (1.09% miss rate)
+    GC: 2851 (4.72%)
+  ==================================
+       TOTAL    (pct)     SAMPLES    (pct)     FRAME
+        1660   (2.7%)        1595   (2.6%)     String#blank?
+
+$ stackprof tmp/stackprof-cpu-*.dump --method 'String#blank?'
+  String#blank? (gems/activesupport-2.3.14.github30/lib/active_support/core_ext/object/blank.rb:80)
+    samples:  1595 self (2.6%)  /   1660 total (2.7%)
+    callers:
+       373  (   41.0%)  ApplicationHelper#current_user
+       192  (   21.1%)  ApplicationHelper#current_repository
+    callers:
+       803  (   48.4%)  Object#present?
+    code:
+                                    |    80  |   def blank?
+   1225    (2.0%) /  1225   (2.0%)  |    81  |     self !~ /[^[:space:]]/
+                                    |    82  |   end
+
+$ stackprof tmp/stackprof-cpu-*.dump --method 'Object#present?'
+  Object#present? (gems/activesupport-2.3.14.github30/lib/active_support/core_ext/object/blank.rb:20)
+    samples:    59 self (0.1%)  /    910 total (1.5%)
+    callees (851 total):
+       803  (   94.4%)  String#blank?
+        32  (    3.8%)  Object#blank?
+        16  (    1.9%)  NilClass#blank?
+    code:
+                                    |    20  |   def present?
+    910    (1.5%) /    59   (0.1%)  |    21  |     !blank?
+                                    |    22  |   end
+```
+
 ### sampling
 
 four sampling modes are supported:
@@ -68,7 +126,7 @@ the sum of the outbound edge weights is equal to total samples collected on that
 
 ### reporting
 
-three reporting modes are supported:
+multiple reporting modes are supported:
   - text
   - dotgraph
   - source annotation

data/bin/stackprof

@@ -8,19 +8,22 @@ options = {
   :limit => 30
 }
 
-OptionParser.new(ARGV) do |o|
-  o.banner = 'stackprof-report [file.dump]+'
+parser = OptionParser.new(ARGV) do |o|
+  o.banner = "Usage: stackprof [file.dump]+ [--text|--method=NAME|--callgrind|--graphviz]"
 
-  o.on('--text', 'Text output (default)'){ options[:format] = :text }
-  o.on('--callgrind'){ options[:format] = :callgrind }
-  o.on('--graphviz'){ options[:format] = :graphviz }
-  o.on('--file [grep]'){ |f| options[:format] = :file; options[:filter] = f }
-  o.on('--files'){ |f| options[:format] = :files }
-  o.on('--method [grep]'){ |f| options[:format] = :method; options[:filter] = f }
+  o.on('--text', 'Text summary (default)'){ options[:format] = :text }
+  o.on('--method [grep]', 'Zoom into specified method'){ |f| options[:format] = :method; options[:filter] = f }
+  o.on('--files', 'List of files'){ |f| options[:format] = :files }
+  o.on('--file [grep]', 'Show annotated code for specified file'){ |f| options[:format] = :file; options[:filter] = f }
+  o.on('--callgrind', 'Callgrind output (use with kcachegrind, gprof2dot)'){ options[:format] = :callgrind }
+  o.on('--graphviz', 'Graphviz output (use with dot)'){ options[:format] = :graphviz }
   o.on('--debug'){ options[:format] = :debug }
-  o.on('--sort-total'){ options[:sort] = true }
-  o.on('--limit [num]', Integer){ |n| options[:limit] = n }
-end.parse!
+  o.on('--limit [num]', Integer, 'Limit --text output to N lines'){ |n| options[:limit] = n }
+  o.on('--sort-total', 'Sort --text output on total samples'){ options[:sort] = true }
+end
+
+parser.parse!
+parser.abort(parser.help) if ARGV.empty?
 
 reports = []
 while ARGV.size > 0
@@ -31,6 +34,8 @@ report = reports.inject(:+)
 case options[:format]
 when :text
   report.print_text(options[:sort], options[:limit])
+when :debug
+  report.print_debug
 when :callgrind
   report.print_callgrind
 when :graphviz

data/lib/stackprof/middleware.rb

@@ -2,26 +2,37 @@ require 'fileutils'
 
 module StackProf
   class Middleware
-    def initialize(app)
+    def initialize(app, options = {})
       @app = app
-      at_exit{ Middleware.save if Middleware.enabled? }
+      @options = options
+      @num_reqs = options[:save_every] || nil
+      Middleware.mode = options[:mode] || :cpu
+      Middleware.interval = options[:interval] || 1000
+      Middleware.enabled = options[:enabled]
+      at_exit{ Middleware.save? } if options[:save_at_exit]
     end
 
     def call(env)
-      StackProf.start(mode: :cpu, interval: 1000) if self.class.enabled?
+      StackProf.start(mode: Middleware.mode, interval: Middleware.interval) if Middleware.enabled?
       @app.call(env)
     ensure
-      StackProf.stop if self.class.enabled?
+      if Middleware.enabled?
+        StackProf.stop
+        if @num_reqs && (@num_reqs-=1) == 0
+          @num_reqs = @options[:save_every]
+          Middleware.save
+        end
+      end
     end
 
     class << self
-      attr_accessor :enabled
+      attr_accessor :enabled, :mode, :interval
       alias enabled? enabled
 
       def save
         if results = StackProf.results
           FileUtils.mkdir_p('tmp')
-          File.open("tmp/stackprof-#{results[:mode]}-#{Process.pid}-#{Time.now.to_i}.dump", 'w') do |f|
+          File.open("tmp/stackprof-#{results[:mode]}-#{Process.pid}-#{Time.now.to_i}.dump", 'wb') do |f|
             f.write Marshal.dump(results)
           end
         end

data/lib/stackprof/report.rb

@@ -5,10 +5,6 @@ module StackProf
   class Report
     def initialize(data)
       @data = data
-
-      frames = {}
-      @data[:frames].each{ |k,v| frames[k.to_s] = v }
-      @data[:frames] = frames
     end
     attr_reader :data
 
@@ -165,7 +161,7 @@ module StackProf
         f.printf "%s (%s:%d)\n", info[:name], file, line
         f.printf "  samples: % 5d self (%2.1f%%)  /  % 5d total (%2.1f%%)\n", info[:samples], 100.0*info[:samples]/overall_samples, info[:total_samples], 100.0*info[:total_samples]/overall_samples
 
-        if (callers = data[:frames].map{ |id, other| [other[:name], other[:edges][frame.to_i]] if other[:edges] && other[:edges].include?(frame.to_i) }.compact).any?
+        if (callers = data[:frames].map{ |id, other| [other[:name], other[:edges][frame]] if other[:edges] && other[:edges].include?(frame) }.compact).any?
           f.puts "  callers:"
           callers = callers.sort_by(&:last).reverse
           callers.each do |name, weight|
@@ -175,7 +171,7 @@ module StackProf
 
         if callees = info[:edges]
           f.printf "  callees (%d total):\n", info[:total_samples]-info[:samples]
-          callees = callees.map{ |k, weight| [data[:frames][k.to_s][:name], weight] }
+          callees = callees.map{ |k, weight| [data[:frames][k][:name], weight] }
           callees.each do |name, weight|
             f.printf "   % 5d  (% 8s)  %s\n", weight, "%3.1f%%" % (100.0*weight/(info[:total_samples]-info[:samples])), name
           end

data/stackprof.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'stackprof'
-  s.version = '0.2.0'
+  s.version = '0.2.1'
   s.homepage = 'http://github.com/tmm1/stackprof'
 
   s.authors = 'Aman Gupta'
@@ -17,6 +17,5 @@ Gem::Specification.new do |s|
 
   s.license = 'MIT'
 
-#  s.add_dependency 'yajl-ruby'
   s.add_development_dependency 'rake-compiler'
 end

data/test/test_stackprof.rb

@@ -58,7 +58,6 @@ class StackProfTest < Test::Unit::TestCase
     assert_operator profile[:samples], :>, 1
     frame = profile[:frames].values.first
     assert_equal "block in StackProfTest#math", frame[:name]
-    File.open('/tmp/cputime.dump','w'){|f| f.write Marshal.dump(profile) }
   end
 
   def test_walltime
@@ -99,8 +98,10 @@ class StackProfTest < Test::Unit::TestCase
   end
 
   def test_gc
-    profile = StackProf.run(mode: :cpu, interval: 100) do
-      GC.start
+    profile = StackProf.run(interval: 100) do
+      5.times do
+        GC.start
+      end
     end
 
     assert_empty profile[:frames]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackprof
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Aman Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-23 00:00:00.000000000 Z
+date: 2013-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -66,8 +66,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.0.rc.1
 signing_key: 
 specification_version: 4
 summary: sampling callstack-profiler for ruby 2.1+
 test_files: []
+has_rdoc: