production_log_analyzer 1.2.0 → 1.2.1

data/README

@@ -70,81 +70,81 @@ In the future, pl_analyze will be able to read from STDIN.
 
 = Sample output
 
-Request Times Summary:          Count   Avg     Std Dev Min     Max
-ALL REQUESTS:                   11      0.576   0.508   0.000   1.470
-
-ThingsController#view:          3       0.716   0.387   0.396   1.260
-TeamsController#progress:       2       0.841   0.629   0.212   1.470
-RssController#uber:             2       0.035   0.000   0.035   0.035
-PeopleController#progress:      2       0.489   0.489   0.000   0.977
-PeopleController#view:          2       0.731   0.371   0.360   1.102
-
-Average Request Time: 0.634
-Request Time Std Dev: 0.498
-
-Slowest Request Times:
-        TeamsController#progress took 1.470s
-        ThingsController#view took 1.260s
-        PeopleController#view took 1.102s
-        PeopleController#progress took 0.977s
-        ThingsController#view took 0.492s
-        ThingsController#view took 0.396s
-        PeopleController#view took 0.360s
-        TeamsController#progress took 0.212s
-        RssController#uber took 0.035s
-        RssController#uber took 0.035s
-
-------------------------------------------------------------------------
-
-DB Times Summary:               Count   Avg     Std Dev Min     Max
-ALL REQUESTS:                   11      0.366   0.393   0.000   1.144
-
-ThingsController#view:          3       0.403   0.362   0.122   0.914
-TeamsController#progress:       2       0.646   0.497   0.149   1.144
-RssController#uber:             2       0.008   0.000   0.008   0.008
-PeopleController#progress:      2       0.415   0.415   0.000   0.830
-PeopleController#view:          2       0.338   0.149   0.189   0.486
-
-Average DB Time: 0.402
-DB Time Std Dev: 0.394
-
-Slowest Total DB Times:
-        TeamsController#progress took 1.144s
-        ThingsController#view took 0.914s
-        PeopleController#progress took 0.830s
-        PeopleController#view took 0.486s
-        PeopleController#view took 0.189s
-        ThingsController#view took 0.173s
-        TeamsController#progress took 0.149s
-        ThingsController#view took 0.122s
-        RssController#uber took 0.008s
-        RssController#uber took 0.008s
-
-------------------------------------------------------------------------
-
-Render Times Summary:           Count   Avg     Std Dev Min     Max
-ALL REQUESTS:                   11      0.219   0.253   0.000   0.695
-
-ThingsController#view:          3       0.270   0.171   0.108   0.506
-TeamsController#progress:       2       0.000   0.000   0.000   0.000
-RssController#uber:             2       0.012   0.000   0.012   0.012
-PeopleController#progress:      2       0.302   0.302   0.000   0.604
-PeopleController#view:          2       0.487   0.209   0.278   0.695
-
-Average Render Time: 0.302
-Render Time Std Dev: 0.251
-
-Slowest Total Render Times:
-        PeopleController#view took 0.695s
-        PeopleController#progress took 0.604s
-        ThingsController#view took 0.506s
-        PeopleController#view took 0.278s
-        ThingsController#view took 0.197s
-        ThingsController#view took 0.108s
-        RssController#uber took 0.012s
-        RssController#uber took 0.012s
-        TeamsController#progress took 0.000s
-        TeamsController#progress took 0.000s
+  Request Times Summary:          Count   Avg     Std Dev Min     Max
+  ALL REQUESTS:                   11      0.576   0.508   0.000   1.470
+  
+  ThingsController#view:          3       0.716   0.387   0.396   1.260
+  TeamsController#progress:       2       0.841   0.629   0.212   1.470
+  RssController#uber:             2       0.035   0.000   0.035   0.035
+  PeopleController#progress:      2       0.489   0.489   0.000   0.977
+  PeopleController#view:          2       0.731   0.371   0.360   1.102
+  
+  Average Request Time: 0.634
+  Request Time Std Dev: 0.498
+  
+  Slowest Request Times:
+          TeamsController#progress took 1.470s
+          ThingsController#view took 1.260s
+          PeopleController#view took 1.102s
+          PeopleController#progress took 0.977s
+          ThingsController#view took 0.492s
+          ThingsController#view took 0.396s
+          PeopleController#view took 0.360s
+          TeamsController#progress took 0.212s
+          RssController#uber took 0.035s
+          RssController#uber took 0.035s
+  
+  ------------------------------------------------------------------------
+  
+  DB Times Summary:               Count   Avg     Std Dev Min     Max
+  ALL REQUESTS:                   11      0.366   0.393   0.000   1.144
+  
+  ThingsController#view:          3       0.403   0.362   0.122   0.914
+  TeamsController#progress:       2       0.646   0.497   0.149   1.144
+  RssController#uber:             2       0.008   0.000   0.008   0.008
+  PeopleController#progress:      2       0.415   0.415   0.000   0.830
+  PeopleController#view:          2       0.338   0.149   0.189   0.486
+  
+  Average DB Time: 0.402
+  DB Time Std Dev: 0.394
+  
+  Slowest Total DB Times:
+          TeamsController#progress took 1.144s
+          ThingsController#view took 0.914s
+          PeopleController#progress took 0.830s
+          PeopleController#view took 0.486s
+          PeopleController#view took 0.189s
+          ThingsController#view took 0.173s
+          TeamsController#progress took 0.149s
+          ThingsController#view took 0.122s
+          RssController#uber took 0.008s
+          RssController#uber took 0.008s
+  
+  ------------------------------------------------------------------------
+  
+  Render Times Summary:           Count   Avg     Std Dev Min     Max
+  ALL REQUESTS:                   11      0.219   0.253   0.000   0.695
+  
+  ThingsController#view:          3       0.270   0.171   0.108   0.506
+  TeamsController#progress:       2       0.000   0.000   0.000   0.000
+  RssController#uber:             2       0.012   0.000   0.012   0.012
+  PeopleController#progress:      2       0.302   0.302   0.000   0.604
+  PeopleController#view:          2       0.487   0.209   0.278   0.695
+  
+  Average Render Time: 0.302
+  Render Time Std Dev: 0.251
+  
+  Slowest Total Render Times:
+          PeopleController#view took 0.695s
+          PeopleController#progress took 0.604s
+          ThingsController#view took 0.506s
+          PeopleController#view took 0.278s
+          ThingsController#view took 0.197s
+          ThingsController#view took 0.108s
+          RssController#uber took 0.012s
+          RssController#uber took 0.012s
+          TeamsController#progress took 0.000s
+          TeamsController#progress took 0.000s
 
 = What's missing
 

data/Rakefile

@@ -9,7 +9,7 @@ $VERBOSE = nil
 
 spec = Gem::Specification.new do |s|
     s.name = "production_log_analyzer"
-    s.version = "1.2.0"
+    s.version = "1.2.1"
     s.summary = "Extracts statistics from Rails production logs"
     s.author = "Eric Hodel"
     s.email = "hodel@robotcoop.com"
@@ -40,8 +40,8 @@ end
 
 desc "Build Gem"
 Rake::GemPackageTask.new spec do |pkg|
-    pkg.need_zip = false
-    pkg.need_tar = false
+    pkg.need_zip = true
+    pkg.need_tar = true
 end
 
 desc "Sends RDoc to RubyForge"

data/lib/production_log/analyzer.rb

@@ -133,12 +133,12 @@ class Analyzer
 
     ##
     # Generates and sends an email report with lots of fun stuff in it.  This
-    # way, Mail.app will behave when given tabs (I hope).
+    # way, Mail.app will behave when given tabs.
 
     def self.email(file_name, recipient, subject, count = 10)
         analyzer = self.new file_name
         analyzer.process
-        body = analyzer.report(count)
+        body = analyzer.report count
 
         email = self.envelope(recipient, subject)
         email << nil
@@ -279,9 +279,6 @@ class Analyzer
 
         text << request_times_summary
         text << nil
-        text << "Average Request Time: #{'%0.3f' % average_request_time}"
-        text << "Request Time Std Dev: #{'%0.3f' % request_time_std_dev}"
-        text << nil
         text << "Slowest Request Times:"
         slowest_request_times(count).each do |time, name|
             text << "\t#{name} took #{'%0.3f' % time}s"
@@ -292,9 +289,6 @@ class Analyzer
 
         text << db_times_summary
         text << nil
-        text << "Average DB Time: #{'%0.3f' % average_db_time}"
-        text << "DB Time Std Dev: #{'%0.3f' % db_time_std_dev}"
-        text << nil
         text << "Slowest Total DB Times:"
         slowest_db_times(count).each do |time, name|
             text << "\t#{name} took #{'%0.3f' % time}s"
@@ -303,12 +297,8 @@ class Analyzer
         text << "-" * 72
         text << nil
 
-
         text << render_times_summary
         text << nil
-        text << "Average Render Time: #{'%0.3f' % average_render_time}"
-        text << "Render Time Std Dev: #{'%0.3f' % render_time_std_dev}"
-        text << nil
         text << "Slowest Total Render Times:"
         slowest_render_times(count).each do |time, name|
             text << "\t#{name} took #{'%0.3f' % time}s"
@@ -324,6 +314,21 @@ class Analyzer
         record = nil
         list = []
 
+        # header
+        record = [pad_request_name("#{title} Summary"), 'Count', 'Avg',
+                  'Std Dev', 'Min', 'Max']
+        list << record.join("\t")
+
+        # all requests
+        times = records.values.flatten
+        record = [times.average, times.standard_deviation, times.min, times.max]
+        record.map! { |v| "%0.3f" % v }
+        record.unshift [pad_request_name('ALL REQUESTS'), times.size]
+        list << record.join("\t")
+
+        # spacer
+        list << nil
+
         records.sort_by { |k,v| v.size}.reverse_each do |req, times|
             record = [times.average, times.standard_deviation,
                       times.min, times.max]
@@ -332,18 +337,6 @@ class Analyzer
             list << record.join("\t")
         end
 
-        list.unshift nil
-
-        times = records.values.flatten
-        record = [times.average, times.standard_deviation, times.min, times.max]
-        record.map! { |v| "%0.3f" % v }
-        record.unshift [pad_request_name('ALL REQUESTS'), times.size]
-        list.unshift record.join("\t")
-
-        record = [pad_request_name("#{title} Summary"), 'Count', 'Avg',
-                  'Std Dev', 'Min', 'Max']
-        list.unshift record.join("\t")
-
         return list.join("\n")
     end
 
@@ -372,11 +365,19 @@ class Analyzer
     end
 
     def longest_request_name # :nodoc:
-        @longest_req ||= @request_times.keys.map { |name| name.length + 1 }.max
+        return @longest_req if defined? @longest_req
+
+        names = @request_times.keys.map do |name|
+            (name||'Unknown').length + 1 # + : - HACK where does nil come from?
+        end
+
+        @longest_req = names.max
+
+        return @longest_req
     end
 
     def pad_request_name(name) # :nodoc:
-        name = name.dup << ':'
+        name = (name||'Unknown') + ':' # HACK where does nil come from?
         name += (' ' * (longest_request_name - name.length))
     end
 

data/lib/production_log/syslog_logger.rb

@@ -1,4 +1,5 @@
 require 'syslog'
+require 'logger'
 
 ##
 # This Logger logs messages to syslogd.  Add it to your production environment
@@ -56,7 +57,7 @@ require 'syslog'
 class SyslogLogger
 
     ##
-    # Faked log level for Rails' Logger compatibility.
+    # Log level for Logger compatibility.
 
     attr_accessor :level
 
@@ -66,7 +67,7 @@ class SyslogLogger
     SYSLOG = Syslog.open "rails"
 
     ##
-    # Map Logger warning types to syslog(3) warning types.
+    # Maps Logger warning types to syslog(3) warning types.
 
     LOGGER_MAP = {
         :fatal => :err,
@@ -77,17 +78,47 @@ class SyslogLogger
     }
 
     ##
-    # Fill in dummy variables for Logger compatibility.
+    # Maps Logger log levels to their values so we can silence.
 
-    def initialize(*args)
-        @level = 0
+    LOGGER_LEVEL_MAP = {}
+
+    LOGGER_MAP.each_key do |key|
+        LOGGER_LEVEL_MAP[key] = Logger.const_get key.to_s.upcase
+    end
+
+    ##
+    # Builds a logging method for level +meth+.
+
+    def self.log_method(meth)
+        eval <<-EOF
+            def #{meth}(message)
+                SYSLOG.#{LOGGER_MAP[meth]} clean(message) if #{LOGGER_LEVEL_MAP[meth]} >= @level
+            end
+        EOF
+    end
+
+    LOGGER_MAP.each_key do |level|
+        log_method level
     end
 
     ##
-    # Dispatch to the correct syslog warning type.
+    # Fill in variables for Logger compatibility.
+
+    def initialize(*args)
+        @level = Logger::DEBUG
+    end
 
-    def method_missing(meth, message)
-        SYSLOG.send LOGGER_MAP[meth], clean(message)
+    ##
+    # Allows messages of a particular log level to be ignored temporarily.
+    #
+    # Can you say "Broken Windows"?
+
+    def silence(temporary_level = Logger::ERROR)
+        old_logger_level = @level
+        @level = temporary_level 
+        yield
+    ensure
+        @level = old_logger_level
     end
 
     private
@@ -110,11 +141,9 @@ if __FILE__ == $0 then
 
     message = "message from syslog_logger.rb logged using"
 
-    logger.info "info #{message} #{SyslogLogger::LOGGER_MAP[:info]}"
-    logger.fatal "fatal #{message} #{SyslogLogger::LOGGER_MAP[:fatal]}"
-    logger.warn "warn #{message} #{SyslogLogger::LOGGER_MAP[:warn]}"
-    logger.error "error #{message} #{SyslogLogger::LOGGER_MAP[:error]}"
-    logger.debug "debug #{message} #{SyslogLogger::LOGGER_MAP[:debug]}"
+    SyslogLogger::LOGGER_MAP.each do |logger_level, syslog_level|
+        logger.send logger_level, "#{logger_level} #{message} #{syslog_level}"
+    end
 end
 
 # vim: ts=4 sts=4 sw=4

data/test/test_analyzer.rb

@@ -104,9 +104,6 @@ RssController#uber:       	2	0.035	0.000	0.035	0.035
 PeopleController#progress:	2	0.489	0.489	0.000	0.977
 PeopleController#view:    	2	0.731	0.371	0.360	1.102
 
-Average Request Time: 0.634
-Request Time Std Dev: 0.498
-
 Slowest Request Times:
 	TeamsController#progress took 1.470s
 
@@ -121,9 +118,6 @@ RssController#uber:       	2	0.008	0.000	0.008	0.008
 PeopleController#progress:	2	0.415	0.415	0.000	0.830
 PeopleController#view:    	2	0.338	0.149	0.189	0.486
 
-Average DB Time: 0.402
-DB Time Std Dev: 0.394
-
 Slowest Total DB Times:
 	TeamsController#progress took 1.144s
 
@@ -138,9 +132,6 @@ RssController#uber:       	2	0.012	0.000	0.012	0.012
 PeopleController#progress:	2	0.302	0.302	0.000	0.604
 PeopleController#view:    	2	0.487	0.209	0.278	0.695
 
-Average Render Time: 0.302
-Render Time Std Dev: 0.251
-
 Slowest Total Render Times:
 	PeopleController#view took 0.695s
 </pre>
@@ -205,6 +196,34 @@ EOF
         assert_equal 'test/test.syslog.log', @analyzer.logfile_name
     end
 
+    def test_longest_request_name
+      assert_equal false, @analyzer.instance_variables.include?('@longest_req')
+
+      request_times = {
+          "ThingsController#view"     => [0],
+          "TeamsController#progress"  => [1],
+          "RssController#uber"        => [0],
+          "PeopleController#progress" => [0],
+          nil                         => [0],
+      }
+
+      @analyzer.instance_variable_set('@request_times', request_times)
+
+      assert_equal 26, @analyzer.longest_request_name
+    end
+
+    def test_pad_request_name
+      assert_equal 26, @analyzer.longest_request_name
+      assert_equal("PeopleController#view:    ",
+                   @analyzer.pad_request_name("PeopleController#view"))
+    end
+
+    def test_pad_request_name_nil
+      assert_equal 26, @analyzer.longest_request_name
+      assert_equal("Unknown:                  ",
+                   @analyzer.pad_request_name(nil))
+    end
+
     def test_process
         expected_request_times = {
             "PeopleController#view"     => [1.102098, 0.36021],
@@ -268,9 +287,6 @@ RssController#uber:       	2	0.035	0.000	0.035	0.035
 PeopleController#progress:	2	0.489	0.489	0.000	0.977
 PeopleController#view:    	2	0.731	0.371	0.360	1.102
 
-Average Request Time: 0.634
-Request Time Std Dev: 0.498
-
 Slowest Request Times:
 	TeamsController#progress took 1.470s
 	ThingsController#view took 1.260s
@@ -294,9 +310,6 @@ RssController#uber:       	2	0.008	0.000	0.008	0.008
 PeopleController#progress:	2	0.415	0.415	0.000	0.830
 PeopleController#view:    	2	0.338	0.149	0.189	0.486
 
-Average DB Time: 0.402
-DB Time Std Dev: 0.394
-
 Slowest Total DB Times:
 	TeamsController#progress took 1.144s
 	ThingsController#view took 0.914s
@@ -320,9 +333,6 @@ RssController#uber:       	2	0.012	0.000	0.012	0.012
 PeopleController#progress:	2	0.302	0.302	0.000	0.604
 PeopleController#view:    	2	0.487	0.209	0.278	0.695
 
-Average Render Time: 0.302
-Render Time Std Dev: 0.251
-
 Slowest Total Render Times:
 	PeopleController#view took 0.695s
 	PeopleController#progress took 0.604s

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: production_log_analyzer
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
-date: 2005-05-10
+  version: 1.2.1
+date: 2005-05-16
 summary: Extracts statistics from Rails production logs
 require_paths: 
   - lib