analyzer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db0ce1c214e7feed07483dd08de6bbdbc7cb9161
+  data.tar.gz: f233a3477a1295f3264cef66df74c093e887d2c2
+SHA512:
+  metadata.gz: 338cafc259ccd43b47185da1dabbe9ff1a35a36d79c846c851da72302055a169f43cbddf2170a7d2d28fcf2e64868c9df1f89d41f25acefbbf24f0753bd54386
+  data.tar.gz: 65331528d9a72d2e0ccba60521db9673063d25bd177f5349200500b1791cb8a06d339340dcc6f46b68da42e45adf4629372e698d1540dc0adde881430dffd1af

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Jon Bracy
+
+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

@@ -0,0 +1,36 @@
+# Analyzer
+A Performance analyzer for Ruby
+
+Synopsis
+--------
+
+```bash
+$ analyze test.rb ...
+```
+
+Description
+-----------
+
+Analyzer runs the provided ruby file(s) to test Iterations per second,
+allocations and memory usage.
+
+The scripts can be a normal ruby script or can be split into two parts by the
+line `__SETUP__`, everything before will be run once and everything after will
+be what is tested.
+
+Options
+-------
+
+`-b`, `--bootstrap`: A ruby script to run once before all the test.
+
+`-l`, `--lib`: A script to be included before the `bootstrap` script and all `test` scripts.
+
+`-o`, `--output`: The destination for the results. The result is a `png` file.
+
+
+Example Report
+--------------
+
+This report was generated by the command: `analyzer turbostreamer.rb jbuilder.rb -l setup.rb`
+
+![Viking.js](/example_report.png)

data/analyzer.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path("../lib/analyzer/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "analyzer"
+  s.version     = Analyzer::VERSION
+  s.licenses    = ['MIT']
+  s.authors     = ["Jon Bracy"]
+  s.email       = ["jonbracy@gmail.com"]
+  s.homepage    = "https://github.com/malomalo/analyzer"
+  s.summary     = %q{A Performance analyzer for Ruby}
+  s.metadata    = { "source_code_uri" => "https://github.com/malomalo/analyzer" }
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '>= 2'
+  s.requirements << 'gnuplot'
+  
+  s.add_runtime_dependency 'benchmark-ips', '~> 2.7'
+end

data/bin/analyze

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require File.expand_path('./../../lib/analyzer', __FILE__)
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: analyze [switches] script [script] ... [report.png]"
+
+  opts.on("-b", "--bootstrap SCRIPT", "Script to run before all test") do |v|
+    options[:bootstrap] = v
+  end
+
+  opts.on("-l", "--lib SCRIPT", "Script require before the bootstrap and all test scripts") do |v|
+    options[:lib] = v
+  end
+
+  opts.on("-n x,y,z", Array, "Example 'list' of arguments") do |list|
+    options[:n] = list.map(&:to_i)
+  end
+  
+  opts.on('-o', '--output DESTINATION', 'File where output will be placed') do |v|
+    options[:output] = v
+  end
+end.parse!
+files = ARGV.clone
+
+analyzer = Analyzer.new(*files, **options)
+analyzer.plot(File.expand_path(options[:output] || 'report.png'))

data/lib/analyzer.rb

@@ -0,0 +1,107 @@
+require 'erb'
+require 'json'
+require 'tmpdir'
+
+class Analyzer
+  
+  def initialize(*test_files, bootstrap: nil, lib: nil, n: nil)
+    @bootstrap = bootstrap
+    @lib = lib
+    @n = n
+    @test_files = test_files
+  end
+  
+  def key(value)
+    File.basename(value, ".*")
+  end
+  
+  def tests
+    @test_files.map{ |f| key(f) }
+  end
+  
+  def bootstrap
+    if @bootstrap
+      system("ruby", "-r", "#{File.expand_path(@lib)}", File.expand_path(@bootstrap))
+      if $?.exitstatus > 0
+        exit 1
+      end
+    end
+  end
+
+  def write_results_for(type, dir)
+    Dir.mkdir(File.join(dir, type))
+    @test_files.each do |src|
+      File.open(File.join(dir, type, key(src)), 'w') do |file|
+        send(:"output_#{type}_results", calculate_results_for(type, File.read(src)), file)
+      end
+    end
+  end
+
+  def calculate_results_for(type, src)
+    lib = @lib ? File.read(File.expand_path(@lib)) : ''
+    
+    if src.index("\n__SETUP__\n")
+      src = src.split("\n__SETUP__\n")
+      setup = src[0]
+      src = src[1]
+    else
+      setup = ''
+    end
+    
+    analyzer_dir = File.expand_path("../", __FILE__)
+    template = File.read(File.expand_path("../templates/#{type}.rb.erb", __FILE__))
+    _script = ''
+    ERB.new(template, nil, nil, "_script").result(binding)
+    results = `ruby <<'TESTSCRIPT'\n#{_script}\nTESTSCRIPT`
+  
+    if $? == 0
+      JSON.parse(results)
+    else
+      puts results
+      exit
+    end
+  end
+  
+  def output_ips_results(results, output)
+    output.write(results.join("\n"))
+  end
+  
+  def output_gc_results(results, output)
+    last_row = results.shift
+    first_row = last_row
+    results.each do |row|
+      output.puts [row[0], row[0] - first_row[0], row[1], row[2], row[1] - last_row[1], row[2] - last_row[2], row[3], row[4], row[3] - last_row[3], row[4] - last_row[4]].join(' ')
+      last_row = row
+    end
+  end
+
+  def output_rss_results(results, output)
+    last_row = results.shift
+    first_row = last_row
+    results.each do |row|
+      output.puts [row[0], row[0] - first_row[0], row[1], row[1] - last_row[1]].join(' ')
+      last_row = row
+    end
+  end
+
+  def escape(value)
+    value.gsub('_', '\\\\_')
+  end
+  
+  def plot(output)
+    Dir.mktmpdir do |dir|
+      write_results_for('ips', dir)
+      write_results_for('gc', dir)
+      write_results_for('rss', dir)
+      
+      template = File.read(File.expand_path('../templates/gnuplot.sh.erb', __FILE__))
+      _script = ''
+      data_dir = dir
+      ERB.new(template, nil, nil, "_script").result(binding)
+      `gnuplot <<-GNUPLOT\n#{_script}\nGNUPLOT`
+    end
+  end
+
+  # ttfb
+  # ttlb
+end

data/lib/analyzer/rss.rb

@@ -0,0 +1,46 @@
+require 'bigdecimal'
+
+class Analyzer
+  class Rss
+
+    KB_TO_BYTE = 1024          # 2**10   = 1024
+    MB_TO_BYTE = 1_048_576     # 1024**2 = 1_048_576
+    GB_TO_BYTE = 1_073_741_824 # 1024**3 = 1_073_741_824
+    CONVERSION = { "kb" => KB_TO_BYTE, "mb" => MB_TO_BYTE, "gb" => GB_TO_BYTE }
+  
+    def initialize(pid = Process.pid)
+      @pid          = pid
+      @status_file  = "/proc/#{@pid}/status"
+      @linux        = File.exists?(@status_file)
+    end
+  
+    def bytes
+      @linux ? (linux_status_memory || ps_memory) : ps_memory
+    end
+  
+    def inspect
+      "#<#{self.class}:0x%08x @bytes=#{bytes}>" % (object_id * 2)
+    end
+  
+    # linux stores memory info in a file "/proc/#{@pid}/status"
+    # If it's available it uses less resources than shelling out to ps
+    def linux_status_memory
+      line = File.new(@status_file).each_line.detect { |l| l.start_with?('VmRSS'.freeze) }
+      if line
+        line = line.split(nil)
+        if line.length == 3
+          CONVERSION[line[1].downcase!] * line[2].to_i
+        end
+      end
+    rescue Errno::EACCES, Errno::ENOENT
+      0
+    end
+  
+    # Pull memory from `ps` command, takes more resources and can freeze
+    # in low memory situations
+    def ps_memory
+      KB_TO_BYTE * BigDecimal.new(`ps -o rss= -p #{@pid}`)
+    end
+  
+  end
+end

data/lib/analyzer/version.rb

@@ -0,0 +1,3 @@
+class Analyzer
+  VERSION = '1.0.0'
+end

data/lib/templates/gc.rb.erb

@@ -0,0 +1,61 @@
+<%= lib %>
+<%= setup %>
+
+__analyzer_not_done = true
+__analyzer_t = Time.now.to_f
+__analyzer_gc_stat = GC.stat
+
+STDOUT.write("[[".freeze)
+STDOUT.write(__analyzer_t.to_s)
+STDOUT.write(",".freeze)
+STDOUT.write(__analyzer_gc_stat[:total_allocated_objects].to_s)
+STDOUT.write(",".freeze)
+STDOUT.write(__analyzer_gc_stat[:total_freed_objects].to_s)
+STDOUT.write(",".freeze)
+STDOUT.write(__analyzer_gc_stat[:minor_gc_count].to_s)
+STDOUT.write(",".freeze)
+STDOUT.write(__analyzer_gc_stat[:major_gc_count].to_s)
+STDOUT.write("]".freeze)
+
+__analyzer_mt = Thread.new do
+  while __analyzer_not_done do
+    __analyzer_sleep_t = 0.02 - (Time.now.to_f - __analyzer_t)
+    sleep(__analyzer_sleep_t) if __analyzer_sleep_t > 0
+
+    __analyzer_t = Time.now.to_f
+    __analyzer_gc_stat = GC.stat
+    STDOUT.write(",[".freeze)
+    STDOUT.write(__analyzer_t.to_s)
+    STDOUT.write(",".freeze)
+    STDOUT.write(__analyzer_gc_stat[:total_allocated_objects].to_s)
+    STDOUT.write(",".freeze)
+    STDOUT.write(__analyzer_gc_stat[:total_freed_objects].to_s)
+    STDOUT.write(",".freeze)
+    STDOUT.write(__analyzer_gc_stat[:minor_gc_count].to_s)
+    STDOUT.write(",".freeze)
+    STDOUT.write(__analyzer_gc_stat[:major_gc_count].to_s)
+    STDOUT.write("]".freeze)
+  end
+  
+  __analyzer_t = Time.now.to_f
+  __analyzer_gc_stat = GC.stat
+  STDOUT.write(",[".freeze)
+  STDOUT.write(__analyzer_t.to_s)
+  STDOUT.write(",".freeze)
+  STDOUT.write(__analyzer_gc_stat[:total_allocated_objects].to_s)
+  STDOUT.write(",".freeze)
+  STDOUT.write(__analyzer_gc_stat[:total_freed_objects].to_s)
+  STDOUT.write(",".freeze)
+  STDOUT.write(__analyzer_gc_stat[:minor_gc_count].to_s)
+  STDOUT.write(",".freeze)
+  STDOUT.write(__analyzer_gc_stat[:major_gc_count].to_s)
+  STDOUT.write("]]".freeze)
+
+end
+
+__analyzer_start = Time.now.to_f
+while Time.now.to_f - __analyzer_start < 5
+  <%= src %>
+end
+__analyzer_not_done = false
+__analyzer_mt.join

data/lib/templates/gnuplot.sh.erb

@@ -0,0 +1,76 @@
+reset
+set terminal pngcairo enhanced font "arial,12" fontscale 1.0 size 900, 1300
+set output '<%= output %>'
+
+# define axis
+# remove border on top and right and set color to gray
+set style line 11 lc rgb '#808080' lt 1
+set border 3 back ls 11
+set tics nomirror
+# define grid
+set style line 12 lc rgb '#808080' lt 0 lw 1
+set grid back ls 12
+
+set key center bottom horizontal
+
+set style line 1 linetype 1 linecolor rgb '#5e64ff' pointtype 1 pointsize 1 linewidth 1 # blue
+set style line 2 linetype 1 linecolor rgb '#ffa00a' pointtype 1 pointsize 1 linewidth 1 # orange
+set style line 3 linetype 1 linecolor rgb '#28a745' pointtype 1 pointsize 1 linewidth 1 # green
+set style line 4 linetype 1 linecolor rgb '#b554ff' pointtype 1 pointsize 1 linewidth 1 # purple
+set style line 5 linetype 1 linecolor rgb '#ff5858' pointtype 1 pointsize 1 linewidth 1 # red
+set style line 6 linetype 1 linecolor rgb '#FEEF72' pointtype 1 pointsize 1 linewidth 1 # yellow
+set style line 7 linetype 1 linecolor rgb '#7CD6FD' pointtype 1 pointsize 1 linewidth 1 # light-blue
+set style line 8 linetype 1 linecolor rgb '#8b1a0e' pointtype 1 pointsize 1 linewidth 1 # dark-red
+
+
+set multiplot layout 5, 1
+set tmargin 4
+set bmargin 4
+
+set title "Iterations / Sec" font ",14"
+set key off
+set format y '%.1s %c'
+
+
+
+set boxwidth 0.15 absolute
+
+set style data boxplot
+set style boxplot range 2 nooutliers candlesticks
+set style fill solid 0.2
+set xtics (<%= tests.map.with_index { |f, i| "'#{escape(f)}' #{i+1}"}.join(', ') %>) scale 0,0
+
+plot <%= tests.map.with_index { |t, i| "'#{File.join(data_dir, 'ips', t)}' using (#{i+1}.0):1 with boxplot linestyle #{i+1}" }.join(', ') %>
+
+
+set title "GC Objects Allocated"
+set key on
+set yrange [0:*]
+set xrange [0:5]
+set xtics autofreq
+
+
+plot <%= tests.map.with_index { |k, i| "'#{File.join(data_dir, 'gc', k)}' using 2:5 title '#{escape(k)}' with steps linestyle #{i+1}" }.join(', ') %>
+
+set title "GC Objects Freed"
+set key on
+set yrange [0:*]
+set xrange [0:5]
+
+plot <%= tests.map.with_index { |k, i| "'#{File.join(data_dir, 'gc', k)}' using 2:6 title '#{escape(k)}' with steps linestyle #{i+1}" }.join(', ') %>
+
+set title "GC Retained"
+set key on
+set yrange [0:*]
+set xrange [0:5]
+
+plot <%= tests.map.with_index { |k, i| "'#{File.join(data_dir, 'gc', k)}' using 2:(\\$3-\\$4) title '#{escape(k)}' with steps linestyle #{i+1}" }.join(', ') %>
+
+# , \\$alloc#{k} using 1:8 with impulses linestyle 7 title 'minor' axes x1y2, \\$alloc#{k} using 1:9 with impulses linestyle 8 title 'major' axes x1y2
+
+set title "RSS"
+set key on
+set yrange [0:*]
+set xrange [0:5]
+
+plot <%= tests.map.with_index { |k, i| "'#{File.join(data_dir, 'rss', k)}' using 2:3 title '#{escape(k)}' with steps linestyle #{i+1}" }.join(', ') %>

data/lib/templates/ips.rb.erb

@@ -0,0 +1,23 @@
+<%= lib %>
+<%= setup %>
+
+require 'benchmark/ips'
+
+class Benchmark::IPS::Job
+  def create_stats(samples)
+    samples
+  end
+  
+  def create_report(label, measured_us, iter, samples, cycles)
+    require 'json'
+    STDOUT.puts JSON.generate(samples)
+    @full_report.add_entry label, measured_us, iter, Benchmark::IPS::Stats::SD.new(samples), cycles
+  end
+end
+
+Benchmark.ips(quiet: true) do |x|
+  x.config(stats: :bootstrap, confidence: 98)
+  x.report("analyze", <<-CODEFILE)
+    <%= src %>
+  CODEFILE
+end

data/lib/templates/rss.rb.erb

@@ -0,0 +1,49 @@
+<%= lib %>
+<%= setup %>
+
+__analyzer_read, __analyzer_write = IO.pipe
+if child_pid = fork
+  __analyzer_read.close
+  require '<%= File.join(analyzer_dir, 'analyzer/rss') %>'
+
+  not_done = true
+  bytes = 0
+  monitor = Analyzer::Rss.new(child_pid)
+  
+  
+  
+  time = Time.now.to_f
+  bytes = monitor.bytes
+  
+  STDOUT.write("[[".freeze)
+  STDOUT.write(time.to_s)
+  STDOUT.write(",".freeze)
+  STDOUT.write(bytes.to_s)
+  STDOUT.write("]".freeze)
+  
+  __analyzer_write.puts "go".freeze
+  __analyzer_write.close
+  while bytes != 0 do
+    sleep_time = 0.02 - (Time.now.to_f - time)
+    sleep(sleep_time) if sleep_time > 0
+    
+    time = Time.now.to_f
+    bytes = monitor.bytes
+    STDOUT.write(",[".freeze)
+    STDOUT.write(time.to_s)
+    STDOUT.write(",".freeze)
+    STDOUT.write(bytes.to_s)
+    STDOUT.write("]".freeze)
+  end
+  
+  STDOUT.write("]".freeze)
+else
+  __analyzer_write.close
+  raise 'fail' if __analyzer_read.gets != "go\n".freeze
+  __analyzer_read.close
+  
+  __analyzer_start = Time.now.to_f
+  while Time.now.to_f - __analyzer_start < 5
+    <%= src %>
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: analyzer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jon Bracy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: 
+email:
+- jonbracy@gmail.com
+executables:
+- analyze
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- analyzer.gemspec
+- bin/analyze
+- example_report.png
+- lib/analyzer.rb
+- lib/analyzer/rss.rb
+- lib/analyzer/version.rb
+- lib/templates/gc.rb.erb
+- lib/templates/gnuplot.sh.erb
+- lib/templates/ips.rb.erb
+- lib/templates/rss.rb.erb
+homepage: https://github.com/malomalo/analyzer
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/malomalo/analyzer
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- gnuplot
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A Performance analyzer for Ruby
+test_files: []