flamegraph 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5843c5d2ae0e8009e59a7b2ae1be5866801f7f2
-  data.tar.gz: 2c8783c5494d36e030917705e56469f22bb7ad33
+  metadata.gz: 1d6f147215ccb958640e914e56d3bd1ec6130228
+  data.tar.gz: 4b5ba1debf723c7337b7d124d5d6dad981aaa9b6
 SHA512:
-  metadata.gz: 5eb5c07f7b53389bad117144637dced3282e0db7d8b16fec95b293e3f7d30ea53fe3908fa27cf27fa487099c19745d858ac51fb0a53a60577063cc9ba25e1ccf
-  data.tar.gz: 23c5aff03a944b3658dd7ec3beba84c9e5ce3439d1012a5e26c68e796b30800276e38143e07e7bc47e1f0201f8c54602e68f2991858cce45728fba708ff35346
+  metadata.gz: 0003bcb764added6799e674c4f03682c1bd2ed578fd34c3fabd8384dd62133e2b5e8f713289a7d1809d4d57871fd463d444aaef352ee67b9f1f9dc6e627a94bb
+  data.tar.gz: 1219aa97e31f1c2e0243a14846cced5338499bd71321a4d624cc2548a9102e0fa3e9747d7ddbc3f4c66865baa4e68fe7e37b9f449d3acbb92ed0e8f4a5da3631

data/CHANGELOG

@@ -0,0 +1,3 @@
+3-Sep-2013
+
+- Added fast_stack for more accurate graphing

data/Guardfile

@@ -0,0 +1,7 @@
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+end

data/README.md

@@ -20,6 +20,33 @@ Or install it yourself as:
 
 Note: Only supported on Ruby 2.0. Gathering stack traces is too slow on earlier versions of Ruby or JRuby
 
+```ruby
+
+require 'flamegraph'
+html = Flamegraph.generate do
+  # your work here
+end
+
+# or
+
+
+Flamegraph.generate(filename) do
+  # your work here
+end
+
+```
+
+## Demo
+
+Demo of: https://github.com/SamSaffron/flamegraph/blob/master/demo/demo.rb
+
+http://samsaffron.github.io/flamegraph/demo.html
+
+Demo of Discourse startup using: https://github.com/SamSaffron/flamegraph/blob/master/demo/rails_startup.rb
+
+**WARNING VERY SLOW, MAY CRASH BROWSER TAB**
+http://samsaffron.github.io/flamegraph/rails-startup.html
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end
+
+

data/demo/demo.rb

@@ -11,9 +11,9 @@ def ack(m, n)
   end
 end
 
-graph = Flamegraph.generate do
-  ack(3,7)
-end
+# graph = Flamegraph.generate do
+#   ack(3,7)
+# end
 
 Flamegraph.generate("graph.html") do
   ack(3,7)

data/demo/rails_startup.rb

@@ -0,0 +1,8 @@
+require 'flamegraph'
+
+Flamegraph.generate("graph.html") do
+  ENV['RAILS_ENV'] = 'profile'
+  require File.expand_path(File.dirname(__FILE__) + "/config/environment")
+
+  I18n.t("test")
+end

data/flamegraph.gemspec

@@ -18,6 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "fast_stack"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-minitest"
 end

data/lib/flamegraph.rb

@@ -1,23 +1,24 @@
 require "json"
+require "fast_stack"
 require "flamegraph/version"
-require "flamegraph/sampler"
 require "flamegraph/renderer"
 
 module Flamegraph
-  def self.generate(filename=nil)
-    sampler = Flamegraph::Sampler.new
-    sampler.start
-    yield
-    results = sampler.finish
+  def self.generate(filename=nil, opts = {})
+    fidelity = opts[:fidelity]  || 0.5
 
-    renderer = Flamegraph::Renderer.new(results)
-    result = renderer.graph_html
+    backtraces = FastStack.profile(fidelity) do
+      yield
+    end
+
+    renderer = Flamegraph::Renderer.new(backtraces)
+    rendered = renderer.graph_html
 
     if filename
       File.open(filename,"w") do |f|
-        f.write(result)
+        f.write(rendered)
       end
     end
-    result
+    rendered
   end
 end

data/lib/flamegraph/fast_stack_sampler.rb

@@ -0,0 +1,7 @@
+class Flamegraph::FastStackSampler
+  def self.collect(fidelity=0.5)
+    FastStack.profile(fidelity) do
+      yield
+    end
+  end
+end

data/lib/flamegraph/flamegraph.html

@@ -1,8 +1,8 @@
 <!DOCTYPE html>
 <html>
 <head>
-<script src="http://code.jquery.com/jquery-1.9.1.min.js"></script>
-<script src="http://cdnjs.cloudflare.com/ajax/libs/d3/3.0.8/d3.min.js"></script>
+<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
+<script src="//cdnjs.cloudflare.com/ajax/libs/d3/3.0.8/d3.min.js"></script>
 <meta charset=utf-8 />
 <title>Flame Graph of Page</title>
 <style>
@@ -167,15 +167,21 @@ Array.prototype.getUnique = function() {
     return a
 }
 
-var samplePercent = function(samples){
-  return "(" + samples +
+var samplePercent = function(samples, exclusive){
+  var info = " (" + samples +
     " sample" + (samples == 1 ? "" : "s") + " - " +
-    ((samples / maxX) * 100).toFixed(2) + "%)";
+    ((samples / maxX) * 100).toFixed(2) + "%) ";
+  if (exclusive) {
+    info += " (" + exclusive +
+      " exclusive - " +
+    ((exclusive / maxX) * 100).toFixed(2) + "%) ";
+  }
+  return info;
 }
 
 var mouseover =  function(d) {
   var i = info[d.frame];
-  $('.info').text( d.frame + " " + samplePercent(i.samples.length));
+  $('.info').text( d.frame + " " + samplePercent(i.samples.length, d.topFrame ? d.topFrame.exclusiveCount : 0));
   d3.selectAll(i.nodes)
      .attr('opacity',0.5);
 };
@@ -211,6 +217,8 @@ var rainbow = function(numOfSteps, step) {
 
 // assign some colors, analyze samples per gem
 var gemStats = {}
+var topFrames = {}
+var lastFrame = {frame: 'd52e04d-df28-41ed-a215-b6ec840a8ea5', x: -1}
 
 $.each(data, function(){
 
@@ -225,8 +233,26 @@ $.each(data, function(){
   for(var j=0; j < this.width; j++){
     stat.samples.push(this.x + j);
   }
+  // This assumes the traversal is in order
+  if (lastFrame.x != this.x) {
+    var topFrame = topFrames[lastFrame.frame]
+    if (!topFrame) {
+      topFrames[lastFrame.frame] = topFrame = {exclusiveCount: 0}
+    }
+    topFrame.exclusiveCount += 1;
+    lastFrame.topFrame = topFrame;
+  }
+  lastFrame = this;
+
 });
 
+var topFrame = topFrames[lastFrame.frame]
+if (!topFrame) {
+  topFrames[lastFrame.frame] = topFrame = {exclusiveCount: 0}
+}
+topFrame.exclusiveCount += 1;
+lastFrame.topFrame = topFrame;
+
 var totalGems = 0;
 $.each(gemStats, function(){totalGems++;});
 
@@ -321,5 +347,3 @@ $.each(gemStats, function(k,v){
   </script>
 </body>
 </html>
-
-

data/lib/flamegraph/sampler.rb

@@ -1,32 +1,26 @@
 class Flamegraph::Sampler
-
-  def initialize
-    @backtraces = []
-    @done_samplint = false
-  end
-
-  def start
-    @backtraces = []
-    @done_samplint = false
+  def self.collect(fidelity=0.5)
+    backtraces = []
+    done = false
 
     t = Thread.current
-    @thread = Thread.new do
-      begin
-        while !@done_sampling
-          @backtraces << t.backtrace_locations
+    thread = Thread.new do
+      until done
+        backtraces << t.backtrace_locations
 
-          # On my machine using Ruby 2.0 this give me excellent fidelity of stack trace per 1.2ms
-          #   with this fidelity analysis becomes very powerful
-          sleep 0.0005
-        end
+        # On my machine using Ruby 2.0 this give me excellent fidelity of stack trace per 1.2ms
+        #   with this fidelity analysis becomes very powerful
+        sleep (fidelity / 1000.0)
       end
     end
-  end
 
-  def finish
-    @done_sampling = true
-    @thread.join
-    @backtraces
-  end
+    begin
+      yield
+    ensure
+      done = true
+      thread.join
+    end
 
+    backtraces
+  end
 end

data/lib/flamegraph/version.rb

@@ -1,3 +1,3 @@
 module Flamegraph
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/test_fast_stack_sampler.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+require 'fast_stack'
+require 'flamegraph/fast_stack_sampler'
+
+class TestFastStackSampler < Minitest::Test
+
+  def test_sample_collection
+    samples = Flamegraph::FastStackSampler.collect do
+      sleep 0.005
+    end
+
+    assert(samples.count > 3, "Should get more than 3 samples in 5 millisecs")
+  end
+
+  def test_fidelity
+    samples = Flamegraph::FastStackSampler.collect(10) do
+      sleep 0.005
+    end
+
+    assert(samples.count <= 1, "Should get a max of 1 sample got #{samples.count}")
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'flamegraph'
+require 'minitest/pride'
+
+

data/test/test_renderer.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+class TestRenderer < Minitest::Test
+
+  def test_builds_table_correctly
+    stacks = [["3","2","1"],["4","1"],["4","5"]]
+
+    g = Flamegraph::Renderer.new(stacks)
+    assert_equal([
+        {:x => 1, :y => 1, :frame => "1", :width => 2},
+        {:x => 1, :y => 2, :frame => "2", :width => 1},
+        {:x => 1, :y => 3, :frame => "3", :width => 1},
+        {:x => 2, :y => 2, :frame => "4", :width => 2},
+        {:x => 3, :y => 1, :frame => "5", :width => 1}
+    ], g.graph_data)
+
+  end
+
+  def test_avoids_bridges
+    stacks = [["3","2","1"],["4","1"],["4","5"]]
+
+    g = Flamegraph::Renderer.new(stacks)
+
+    assert_equal([
+        {:x => 1, :y => 1, :frame => "1", :width => 2},
+        {:x => 1, :y => 2, :frame => "2", :width => 1},
+        {:x => 1, :y => 3, :frame => "3", :width => 1},
+        {:x => 2, :y => 2, :frame => "4", :width => 2},
+        {:x => 3, :y => 1, :frame => "5", :width => 1}
+    ], g.graph_data)
+
+
+  end
+
+end
+

data/test/test_sampler.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+require 'flamegraph/sampler'
+
+class TestSampler < Minitest::Test
+
+  def test_sample_collection
+    samples = Flamegraph::Sampler.collect do
+      sleep 0.005
+    end
+
+    assert(samples.count > 3, "Should get more than 3 samples in 5 millisecs")
+  end
+
+  def test_fidelity
+    samples = Flamegraph::Sampler.collect(10) do
+      sleep 0.005
+    end
+
+    assert(samples.count <= 1, "Should get a max of 1 sample got #{samples.count}")
+  end
+
+end
+

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: flamegraph
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-10 00:00:00.000000000 Z
+date: 2013-09-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: fast_stack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,48 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Flamegraph support for arbitrary ruby apps
 email:
 - sam.saffron@gmail.com
@@ -46,17 +102,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - demo/demo.rb
+- demo/rails_startup.rb
 - flamegraph.gemspec
 - lib/flamegraph.rb
+- lib/flamegraph/fast_stack_sampler.rb
 - lib/flamegraph/flamegraph.html
 - lib/flamegraph/renderer.rb
 - lib/flamegraph/sampler.rb
 - lib/flamegraph/version.rb
+- test/test_fast_stack_sampler.rb
+- test/test_helper.rb
+- test/test_renderer.rb
+- test/test_sampler.rb
 homepage: ''
 licenses:
 - MIT
@@ -77,8 +141,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Flamegraph support for arbitrary ruby apps
-test_files: []
+test_files:
+- test/test_fast_stack_sampler.rb
+- test/test_helper.rb
+- test/test_renderer.rb
+- test/test_sampler.rb
+has_rdoc: