nbogie-production_log_analyzer 1.5.1.1 → 1.5.1.2

data/History.txt

@@ -1,3 +1,7 @@
+=== 1.5.1.2
+
+* Add tool to diff reports, to see what actions got faster or slower, etc.
+
 === 1.5.1.1
 
 * Groups by http verb (GET/PUT/POST/DELETE/HEAD)

data/README.txt

@@ -138,6 +138,33 @@ In the future, pl_analyze will be able to read from STDIN.
           TeamsController#progress took 0.000s
           TeamsController#progress took 0.000s
 
+There's an experimental report-differ which you can invoke as follows:
+
+    ruby -Ilib report_differ.rb report_b.txt report_a.txt > report_diff.txt
+
+Sample diff output
+
+    Request_Times_Summary:                 Count                Avg                  Max                 
+    ALL_REQUESTS                           +1.4(16515->22909)   -2.2(0.405->0.18)    -1.6(59.678->37.721)
+
+    SleepwalkersController#update.PUT.xml  +1.4(6249->8793)     -1.1(0.079->0.07)    -2.7(8.328->3.103)  
+    SleepwalkersController#update.PUT.csv  +1.4(6245->8807)     -1.0(0.099->0.097)   +1.2(2.536->3.02)   
+    SleepwalkersController#show.GET        +1.4(509->710)       -1.2(0.072->0.061)   -2.3(3.505->1.504)  
+    SleepwalkersController#show.GET.json   +1.4(496->702)       -1.2(0.076->0.064)   -7.3(4.874->0.663)  
+    AccomplicesController#history.GET.csv  +1.4(470->680)       -3.3(5.35->1.618)    -1.5(20.681->13.692)
+    WindsController#feeds.GET              +1.4(237->320)       -1.1(0.201->0.183)   +1.5(1.304->1.989)  
+    ScamsController#show.GET               +1.3(236->317)       -3.0(11.793->3.869)  -1.6(59.678->37.721)
+    SleepwalkersController#update.PUT      -1.1(9->8)           -1.1(0.051->0.047)   -1.2(0.09->0.076)   
+    AccomplicesController#show.GET.xml      1.0(2->2)           -1.0(0.102->0.1)     -1.0(0.184->0.179)  
+    ScamsController#map.GET                +6.0(2->12)          -3.5(1.075->0.305)   +1.1(2.008->2.112)  
+    WindsController#feeds.GET.atom          1.0(1->1)           -1.1(0.061->0.058)   -1.1(0.061->0.058)  
+    ScamsController#tag.GET.rss             1.0(1->1)           -1.0(0.134->0.129)   -1.0(0.134->0.129)  
+
+    Unmatched_Actions: 
+
+    ScamsController#index.GET.json                               only in report_a.txt
+    Api::V1::MisinterpretationsController#destroy.DELETE.        only in report_a.txt
+
 == What's missing
 
 * More reports

data/Rakefile

@@ -8,7 +8,7 @@ Hoe.plugin :email, :perforce # not on minitest yet
 Hoe.spec 'nbogie-production_log_analyzer' do
   developer 'Eric Hodel', 'drbrain@segment7.net'
   self.name = 'nbogie-production_log_analyzer'
-  self.version = '1.5.1.1'
+  self.version = '1.5.1.2'
 
   extra_deps << ['rails_analyzer_tools', '>= 1.4.0']
 end

data/test/test_report_differ.rb

@@ -0,0 +1,178 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+
+require 'report/report_parser'
+require 'report/report_differ'
+
+class TestReportDiffer < Test::Unit::TestCase
+
+  def file_data(filename)
+    'test/example_data/' + filename
+  end
+
+  def setup
+    @differ = ReportDiffer.new
+    report_filenames = ['report_a', 'report_b'].map do |keyname|
+      "test/example_data/#{keyname}.txt"
+    end
+    create_reports()
+    #ReportDiffer.compare_files(report_filenames[0], report_filenames[1])
+  end
+
+
+  def test_initialization
+    differ = ReportDiffer.new
+  end
+  
+  def test_compute_difference_in_values()
+    data = [
+      #when increasing
+      [100, 1000, 10], 
+      [100, 200, 2], 
+      [100, 130, 1.3], 
+      #when same
+      [100, 100, 1], 
+      [0,0, 1], 
+      #when lessening
+      [100, 90, -1.11], 
+      [100, 50, -2], 
+      [100, 10, -10], 
+      #when one number is zero - not sure what we should return here.
+      [0.00, 1, 999999], 
+      [1, 0.00, -999999], 
+    ]
+    data.each do |group|
+      va, vb, expected = group
+      actual = @differ.compute_difference_in_values(va, vb)
+      assert_equal(expected, actual, "for #{va}->#{vb}")
+    end
+  end
+
+
+  def test_compare
+    threshold = 1.2
+    actual=@differ.compare(@report_a, @report_b, threshold)
+    assert_not_nil actual
+    expected = {
+      :summary_diff=>
+      {
+       :diff_count=>{:change => -1.11, :from => 100, :to => 90},
+       :diff_avg_time=>{:change => 1.5, :from => 10, :to => 15},
+       :diff_min_time=>{:change => 1, :from => 0.1, :to => 0.1},
+       :diff_max_time=>{:change => 2.0, :from => 20.0, :to => 40.0},
+       :diff_std_dev=>{:change => 3.0, :from => 2.0, :to => 6.0}},
+      :request_diffs=>
+      {"MyCon#MyAc.get.xml"=>
+        { 
+          :diff_count=>{:change => 1.1, :from => 100, :to => 110},
+          :diff_avg_time=>{:change => 1.2, :from => 100, :to => 120},
+          :diff_std_dev=>{:change => 1.3, :from => 100, :to => 130},
+          :diff_min_time=>{:change => 1.4, :from => 100, :to => 140},
+          :diff_max_time=>{:change => 1.5, :from => 100, :to => 150} }},
+      :unmatched_actions => [], 
+      :threshold => threshold
+    }
+
+
+    assert_equal(expected, actual)
+
+    ra1 = Request.create('MyCon','MyAc2',600,1,1,1,1)
+    rb1 = Request.create('MyCon','MyAc2',610,1,1,1,1)
+    ra2 = Request.create('MyCon','MyAc3',50,1,1,1,1)
+    rb2 = Request.create('MyCon','MyAc3',50,1,1,1,1)
+    @report_a.requests << ra1 << ra2
+    @report_b.requests << rb1 << rb2
+    assert_equal 3, @report_a.requests.size
+
+    actual=@differ.compare(@report_a, @report_b, threshold)
+  end
+  def test_prepare_report()
+    diff_data = @differ.compare(@report_a, @report_b)
+    report_text = @differ.prepare_report(diff_data)
+    #TODO: check report text as as we expect
+    ##puts report_text
+  end
+
+  def test_matched_requests_values_ab
+    matches = @differ.find_matched_actions(@report_a, @report_b)
+    assert_equal 1, matches.size
+    assert_equal [100, 110], matches.first.values_ab(:count)
+    assert_equal [100, 120], matches.first.values_ab(:avg_time)
+    assert_equal [100, 130], matches.first.values_ab(:std_dev)
+    assert_equal [100, 140], matches.first.values_ab(:min_time)
+    assert_equal [100, 150], matches.first.values_ab(:max_time)
+  end
+
+  def test_find_matched_actions
+    matches = @differ.find_matched_actions(@report_a, @report_b)
+    assert_equal 1, matches.size
+    the_match=matches.first
+    assert_equal [@report_a.requests.first, @report_b.requests.first], [the_match.request1, the_match.request2]
+    
+    #with one of the reports having NO requests
+    @report_a.requests.clear
+    assert_equal 0, @differ.find_matched_actions(@report_a, @report_b).size
+  end
+  
+  def test_find_unmatched_actions
+    #initially, should return empty list - all match
+    assert_equal [], @differ.find_unmatched_actions(@report_a, @report_b)
+    #add a request to only one report - should find it
+    odd_req = Request.create('MyCon','UniqueAction',110,120,130,140,150)
+    @report_a.requests << odd_req
+    unmatcheds = @differ.find_unmatched_actions(@report_a, @report_b)
+    assert_equal 1, unmatcheds.size
+    assert_equal 'UniqueAction', unmatcheds.first.request.action
+    assert_equal @report_a, unmatcheds.first.report
+    
+    #add another request (only to rep b)
+    odd_req2 = Request.create('UniqueCon','MyAc',110,120,130,140,150)
+    @report_b.requests << odd_req2
+    unmatcheds = @differ.find_unmatched_actions(@report_a, @report_b)
+    assert_equal 2, unmatcheds.size
+    assert_equal 'UniqueAction', unmatcheds.first.request.action
+    assert_equal @report_a, unmatcheds.first.report
+    assert_equal 'UniqueCon', unmatcheds.last.request.controller
+    assert_equal @report_b, unmatcheds.last.report
+  end
+
+  def test_compare_summaries
+    actual=@differ.compare_summaries(@report_a, @report_b)
+      assert_equal(
+      {
+       :diff_count=>{:change => -1.11, :from => 100, :to => 90},
+       :diff_avg_time=>{:change => 1.5, :from => 10, :to => 15},
+       :diff_std_dev=>{:change => 3.0, :from => 2.0, :to => 6.0},
+       :diff_min_time=>{:change => 1, :from => 0.1, :to => 0.1},
+       :diff_max_time=>{:change => 2.0, :from => 20.0, :to => 40.0},
+       }, actual)
+  end
+  
+  #populate @report_a, @report_b
+  def create_reports
+    ra = Report.new
+    ra.summary.count=100
+    ra.summary.avg_time=10.0
+    ra.summary.std_dev=2.0
+    ra.summary.min_time=0.1
+    ra.summary.max_time=20.0
+
+    ca1 = Request.create('MyCon','MyAc',100,100,100,100,100, {:verb=>'get',:format =>'xml'})
+    cb1 = Request.create('MyCon','MyAc',110,120,130,140,150, {:verb=>'get',:format =>'xml'})
+    ra.requests << ca1
+
+    rb = Report.new
+    rb.summary.count=90
+    rb.summary.avg_time=15.0
+    rb.summary.std_dev=6
+    rb.summary.min_time=0.1
+    rb.summary.max_time=40.0
+    rb.requests << cb1
+    @report_a = ra
+    @report_b = rb
+  end
+
+
+end
+

data/test/test_report_parser.rb

@@ -0,0 +1,140 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+
+require 'report/report_parser'
+
+class TestReportParser < Test::Unit::TestCase
+
+  def file_data(filename)
+    'test/example_data/' + filename
+  end
+
+  def setup
+    @parser = ReportParser.new
+  end
+
+  def test_initialization
+    parser = ReportParser.new
+  end
+
+  def test_can_parse_report
+    content = File.read(file_data('example.txt'))
+                       
+    result = @parser.parse("my report name", content)
+    assert_not_nil(result)
+    assert_equal("my report name", result.name)
+    assert_equal(8, result.requests.size)
+    expected_controllers= %w(
+                          FooController
+                          FooController
+                          FooController
+                          FooController
+                          BarController
+                          HealthController
+                          QuxController
+                          UsersController)
+    assert_equal(expected_controllers, result.requests.map{|rq| rq.controller})
+  end
+
+  def test_can_extract_from_all_requests
+    content = File.read(file_data('example.txt'))
+    result = @parser.parse("whatever", content)
+    assert_equal(11830,result.summary.count)
+    assert_equal(0.185,result.summary.avg_time)
+    assert_equal(0.212,result.summary.std_dev)
+    assert_equal(0.001,result.summary.min_time)
+    assert_equal(3.553,result.summary.max_time)
+  end
+
+  def test_can_parse_a_request
+    line = "ApiFooController#update.PUT.xml:       3557    0.144   0.137   0.059   3.212"
+    request = @parser.parse_request(line)
+    assert_equal("ApiFooController",request.controller)
+    assert_equal("update",request.action)
+    assert_equal("PUT",request.verb)
+    assert_equal("xml",request.format)
+    assert_equal(3557,request.count)
+    assert_equal(0.144,request.avg_time)
+    assert_equal(0.137,request.std_dev)
+    assert_equal(0.059,request.min_time)
+    assert_equal(3.212,request.max_time)
+  end
+
+  def test_should_normalize_request_format_to_lowercase
+    line = "ApiFooController#update.PUT.XmL:       3557    0.144   0.137   0.059   3.212"
+    request = @parser.parse_request(line)
+    assert_equal("xml",request.format)
+  end
+
+  def test_should_normalize_request_verb_to_uppercase
+    line = "ApiFooController#update.puT.xml:       3557    0.144   0.137   0.059   3.212"
+    request = @parser.parse_request(line)
+    assert_equal("PUT",request.verb)
+  end
+
+  def test_should_parse_request_having_no_format
+    line = "ApiFooController#update.GET:       3557    0.144   0.137   0.059   3.212"
+    request = @parser.parse_request(line)
+    assert_equal("GET",request.verb)
+    assert_nil(request.format)
+    assert_equal(0.144,request.avg_time)
+  end
+
+  def test_can_parse_a_request_having_module_named_controller_name
+    line = "Api::V1::FooController#show.GET:       11707   0.107   0.263   0.015   19.075"
+    request = @parser.parse_request(line)
+    assert_equal("Api::V1::FooController",request.controller)
+  end
+
+  def test_should_parse_a_few_lines
+   should_parse "QuxController#index.GET.rss:           	5	0.241	0.078	0.121	0.367" 
+  end
+
+  def should_parse(line)
+    @parser.parse_request(line)
+  end
+
+end
+  
+class TestRequest < Test::Unit::TestCase
+  def test_remembers_its_values
+    r = Request.new
+    r.controller = "somecontroller"
+    r.action = "someaction"
+    r.verb = "GET"
+    r.format = "xml"
+    r.count = 100
+    r.avg_time = 1.123
+    r.std_dev = 0.22
+    r.min_time = 3.33
+    r.max_time = 10.10
+    assert_equal("somecontroller",r.controller)
+    assert_equal("someaction",r.action)
+    assert_equal("GET",r.verb)
+    assert_equal("xml",r.format)
+    assert_equal(3.33,r.min_time)
+    assert_equal(10.10,r.max_time)
+    assert_equal(1.123,r.avg_time)
+    assert_equal(0.22,r.std_dev)
+  end
+
+  def test_create
+    req = Request.create('Con','Ac',1,2,3,4,5, {:verb=>'get',:format =>'xml'})
+    assert_equal('Con', req.controller)
+    assert_equal('Ac', req.action)
+    assert_equal(1, req.count)
+    assert_equal(2, req.avg_time)
+    assert_equal(3, req.std_dev)
+    assert_equal(4, req.min_time)
+    assert_equal(5, req.max_time)
+  end
+
+  def test_should_not_fixup_already_fixed_up_name
+    r = Request.new
+    r.controller =  "Api::V1::GraultController"
+    r.fixup_controller_name!
+    assert_equal("Api::V1::GraultController",r.controller)
+  end
+end
+

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: nbogie-production_log_analyzer
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 119
+  prerelease: 
   segments: 
   - 1
   - 5
   - 1
-  - 1
-  version: 1.5.1.1
+  - 2
+  version: 1.5.1.2
 platform: ruby
 authors: 
 - Eric Hodel
@@ -15,16 +16,17 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-10 00:00:00 +01:00
-default_executable: 
+date: 2011-07-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails_analyzer_tools
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 1
         - 4
@@ -33,33 +35,21 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rubyforge
+  name: hoe
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 35
         segments: 
         - 2
-        - 0
+        - 9
         - 4
-        version: 2.0.4
+        version: 2.9.4
   type: :development
   version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 6
-        - 0
-        version: 2.6.0
-  type: :development
-  version_requirements: *id003
 description: |-
   production_log_analyzer lets you find out which actions on a Rails
   site are slowing you down.
@@ -99,7 +89,9 @@ files:
 - test/test_action_grep.rb
 - test/test_analyzer.rb
 - test/test_parser.rb
-has_rdoc: true
+- test/test_report_differ.rb
+- test/test_report_parser.rb
+- .gemtest
 homepage: http://seattlerb.rubyforge.org/production_log_analyzer
 licenses: []
 
@@ -110,27 +102,33 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: nbogie-production_log_analyzer
-rubygems_version: 1.3.6
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: production_log_analyzer lets you find out which actions on a Rails site are slowing you down
 test_files: 
 - test/test_parser.rb
 - test/test_analyzer.rb
+- test/test_report_differ.rb
 - test/test_action_grep.rb
+- test/test_report_parser.rb