custom_benchmarks 0.0.2 → 0.0.3

data/README

@@ -2,13 +2,21 @@
 
 == About
 
-Custom Benchmarks allow you to easily add your own information to the
+Custom Benchmarks allow you to easily add your own information to a
 benchmark line logged at the end of each request.  e.g.,
 
-Completed in 0.40306 (2 reqs/sec) | Rendering: 0.05003 (12%) | DB: 0.04571 (11%) | Search: 0.16429,1 (40%) | PID: 22426 | 200 OK [http://www.zvents.com/welcome/index]
+Finished JsonController#index in 0.40306 (2 reqs/sec) | Rendering: 0.05003 (12%) | DB: 0.04571 (11%) | Search: 0.16429,1 (40%) | Time: 1163542055 | PID: 22426 | 200 OK [http://www.zvents.com/welcome/index]
 
-Typically, the log line includes the latency associated with executing
-specific parts of a request.  In the example above, we have added a
+At present, this line appears in addition to the standard log line (described
+below) that starts with the "Completed in".  I was unable to replace the
+existing log line without incurring other side effects.  I believe the 
+problem is due to attempting to monkey patch a method (perform_action)
+that has been aliased several times by the Rails core.  Adding an extra
+line to the log file is not optimal, but it seems to be the best choice
+for now.
+
+Typically, the standard log line includes the latency associated with 
+executing specific parts of a request.  In the example above, we have added a
 measurement of search latency.  But you can use Custom Benchmarks to add
 any information to the log line.  The example above also shows the ID of
 the process (PID) that served this request.  The PID is useful when parsing
@@ -75,24 +83,9 @@ ApplicationController:
 
 custom_benchmark {|runtime| MySearch.get_timing_summary(runtime) }
 
-== Bugs, Code and Contributing
-
-There's a RubyForge project set up at:
-
-http://rubyforge.org/projects/zventstools/
-
-Anonymous SVN access:
-
-$ svn checkout svn://rubyforge.org/var/svn/zventstools
-
-Author: Tyler Kovacs (tyler dot kovacs at gmail dot com)
+== Default Integrations: Adapters
 
-== What's Next?
-* Default integrations: It would be great if the plugin shipped with a 
-  number of default integrations for logging things like acts_as_ferret 
-  and acts_as_solr, memcached latency and call count and activerecord SQL 
-  call count.
-* Log File Analyzer: One we have all this great data written to the log,
-  how do we consume it? It makes sense to write an analyzer similar to
-  the production_log_analyzer, but one that can adapt to arbitrary data
-  written to the log (provided it fits a certain format).
+custom_benchmarks now ships with default integrations with external
+libraries.  The first, and only, integration (as of 0.0.3 release) is
+with MemCacheClient.  Following the instructions in 
+vendor/plugins/custom_benchmarks/init.rb to enable adapters.

data/lib/adapters/memcache-client.rb

@@ -0,0 +1,33 @@
+# Add this line to your ApplicationController (app/controllers/application.rb)
+# to enable logging for memcache-client:
+# custom_benchmark {|runtime| MemCache.cache_runtime(runtime) }
+
+class MemCache
+  @@cache_latency = 0.0
+  @@cache_touches = 0
+
+  def self.reset_benchmarks
+    @@cache_latency = 0.0
+    @@cache_touches = 0
+  end
+
+  def self.get_benchmarks
+    [@@cache_latency, @@cache_touches]
+  end
+
+  def self.cache_runtime(runtime)
+    latency, touches = self.get_benchmarks
+    self.reset_benchmarks
+    " | memcache: #{sprintf("%.5f,%d",latency,touches)} (#{sprintf("%d", (latency * 100) / runtime)}%)"
+  end
+
+  def get_with_benchmark(key)
+    val = nil
+    @@cache_latency += Benchmark::measure{ val=get_without_benchmark(key) }.real
+    @@cache_touches += 1
+    val
+  end
+  alias_method :get_without_benchmark, :get
+  alias_method :get, :get_with_benchmark
+end
+

data/lib/custom_benchmarks.rb

@@ -92,15 +92,18 @@ module ActionController #:nodoc:
 
     def perform_action_with_custom_benchmark
       unless logger
-        perform_action_without_benchmark
+        perform_action_without_custom_benchmark
       else
-        runtime = [Benchmark::measure{ perform_action_without_benchmark }.real, 0.0001].max
-        log_message  = "Completed in #{sprintf("%.5f", runtime)} (#{(1 / runtime).floor} reqs/sec)"
+        runtime = [Benchmark::measure{ perform_action_without_custom_benchmark }.real, 0.0001].max
+        log_message  = "Finished #{controller_class_name}\##{action_name} in #{sprintf("%.5f", runtime)} (#{(1 / runtime).floor} reqs/sec)"
+        if Object.const_defined?("ActiveRecord") && ActiveRecord::Base.connected?
+          log_message << active_record_runtime(runtime)
+        end
         log_message << rendering_runtime(runtime) if @rendering_runtime
-        log_message << active_record_runtime(runtime) if Object.const_defined?("ActiveRecord") && ActiveRecord::Base.connected?
         self.class.custom_benchmarks.each do |benchmark|
           log_message << benchmark.call(runtime)
         end
+        log_message << " | Time: #{Time.now.to_i}"
         log_message << " | #{headers["Status"]}"
         log_message << " [#{complete_request_uri rescue "unknown"}]"
         logger.info(log_message)
@@ -108,3 +111,56 @@ module ActionController #:nodoc:
     end
   end
 end
+
+module ActiveRecord
+  module ConnectionAdapters # :nodoc:
+    class AbstractAdapter
+      def initialize(connection, logger = nil) #:nodoc:
+        @connection, @logger = connection, logger
+        @runtime = 0
+        @total_runtime = 0
+        @last_verification = 0
+      end
+
+      def reset_runtime(reset=false) #:nodoc:
+        if reset
+          rt, @runtime, @total_runtime = @total_runtime, 0, 0
+        else
+          rt, @runtime = @runtime, 0, 0
+        end
+
+        rt
+      end
+
+      protected
+        def log(sql, name)
+          if block_given?
+            if @logger and @logger.level <= Logger::INFO
+              result = nil
+              seconds = Benchmark.realtime { result = yield }
+              @runtime += seconds
+              @total_runtime += seconds
+              log_info(sql, name, seconds)
+              result
+            else
+              seconds = Benchmark.realtime { result = yield }
+              @runtime += seconds
+              @total_runtime += seconds
+              result
+            end
+          else
+            log_info(sql, name, 0)
+            nil
+          end
+        rescue Exception => e
+          # Log message and raise exception.
+          # Set last_verfication to 0, so that connection gets verified
+          # upon reentering the request loop
+          @last_verification = 0
+          message = "#{e.class.name}: #{e.message}: #{sql}"
+          log_info(message, name, 0)
+          raise ActiveRecord::StatementInvalid, message
+        end
+    end
+  end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: custom_benchmarks
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
-date: 2006-11-07
+  version: 0.0.3
+date: 2006-11-14
 summary: Easily allows custom information to be included in the benchmark log line at the end of each request.
 require_paths: 
 - lib
@@ -27,6 +27,8 @@ authors:
 - Tyler Kovacs
 files: 
 - lib/custom_benchmarks.rb
+- lib/adapters
+- lib/adapters/memcache-client.rb
 - README
 test_files: []