custom_benchmarks 0.0.1

data/README

@@ -0,0 +1,88 @@
+=Custom Benchmarks
+
+== About
+
+Custom Benchmarks allow you to easily add your own information to the
+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]
+
+Typically, the 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
+information from logs that contain data from multiple processes.
+
+== Installation
+
+1. Install the plugin or the gem
+   $ script/plugin install svn://rubyforge.org/var/svn/zventstools/projects/custom_benchmarks
+- OR -
+   # gem install custom_benchmarks
+
+== Simple Example: Logging the Process ID
+
+To add the PID as a custom benchmark field, simply add a custom_benchmark
+line like the following to your ApplicationController:
+
+class ApplicationController < ActionController::Base
+  custom_benchmark {|runtime| " | PID: #{$$}" }
+  ...
+end
+
+Declare your custom_benchmark with a block that expects an input parameter
+called runtime.  runtime, which isn't used in this example, contains the
+overall latency of the entire request.  Later, we'll show you an example
+of using runtime to calculate percentage latency below.  custom_benchmark
+expects your block to return a string - which will be inserted in the
+log file immediate before the status (e.g., 200 OK [http://www.zvents.com/])
+
+== Complex Example: Logging Arbitrary Latency
+
+Let's say that your application includes a search function that is powered
+by Lucene.  Like SQL calls issued to a database, calls to Lucene can take
+a while so you want to log your search latency.
+
+The first step is to set up a mechanism that allows you to record your
+search latency for each request.  You can do that with something like this:
+
+class MySearch
+  @@latency = 0.0
+  cattr_accessor :latency
+
+  def run_search
+    @@latency = Benchmark::measure{
+      # execute the call to Lucene here
+    }.real
+  end
+
+  def self.get_timing_summary(runtime)
+    summary = " | Search: #{sprintf("%.5f",@@latency)} (#{sprintf("%d", (@@latency * 100) / runtime)}%)"
+    @@latency = 0.0
+    summary
+  end
+end
+
+The run_search method uses Benchmark::measure to record the latency of the
+search.  The get_timing_summary class method, which will be invoked by
+a custom_benchmark, returns a formatted string summarizing the search
+latency in absolute and percentage terms.  It also resets the value
+of @@latency to avoid affecting subsequent queries.
+
+Finally, we just need to add a custom_benchmark statement to the
+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)

data/lib/custom_benchmarks.rb

@@ -0,0 +1,108 @@
+# Custom Benchmarks
+#
+# Custom Benchmarks allow you to easily add your own information to the 
+# 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]
+# 
+# Typically, the 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 
+# information from logs that contain data from multiple processes.
+#
+# Simple Example: Logging the Process ID
+#
+# To add the PID as a custom benchmark field, simply add a custom_benchmark 
+# line like the following to your ApplicationController:
+#
+# class ApplicationController < ActionController::Base
+#   custom_benchmark {|runtime| " | PID: #{$$}" }
+#   ...
+# end
+#
+# Declare your custom_benchmark with a block that expects an input parameter
+# called runtime.  runtime, which isn't used in this example, contains the
+# overall latency of the entire request.  Later, we'll show you an example 
+# of using runtime to calculate percentage latency below.  custom_benchmark
+# expects your block to return a string - which will be inserted in the 
+# log file immediate before the status (e.g., 200 OK [http://www.zvents.com/])
+#
+# Complex Example: Logging Arbitrary Latency
+#
+# Let's say that your application includes a search function that is powered
+# by Lucene.  Like SQL calls issued to a database, calls to Lucene can take
+# a while so you want to log your search latency.
+#
+# The first step is to set up a mechanism that allows you to record your
+# search latency for each request.  You can do that with something like this:
+#
+# class MySearch
+#   @@latency = 0.0
+#   cattr_accessor :latency
+#  
+#   def run_search
+#     @@latency = Benchmark::measure{
+#       # execute the call to Lucene here
+#     }.real
+#   end
+#
+#   def self.get_timing_summary(runtime)
+#     summary = " | Search: #{sprintf("%.5f",@@latency)} (#{sprintf("%d", (@@latency * 100) / runtime)}%)"
+#     @@latency = 0.0
+#     summary
+#   end
+# end
+#
+# The run_search method uses Benchmark::measure to record the latency of the
+# search.  The get_timing_summary class method, which will be invoked by
+# a custom_benchmark, returns a formatted string summarizing the search
+# latency in absolute and percentage terms.  It also resets the value
+# of @@latency to avoid affecting subsequent queries.
+#  
+# Finally, we just need to add a custom_benchmark statement to the
+# ApplicationController:
+#
+# custom_benchmark {|runtime| MySearch.get_timing_summary(runtime) }
+
+module ActionController #:nodoc:
+  module CustomBenchmarking #:nodoc:
+    def self.included(base)
+      base.class_eval do
+        alias_method :perform_action, :perform_action_with_custom_benchmark
+      end
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def custom_benchmark(*benchmark, &block)
+        if block_given?
+          write_inheritable_attribute(:custom_benchmarks, 
+            (read_inheritable_attribute(:custom_benchmarks) || []) << block)
+        end
+      end
+
+      def custom_benchmarks
+        @custom_benchmarks ||= read_inheritable_attribute(:custom_benchmarks) || []
+      end
+    end
+
+    def perform_action_with_custom_benchmark
+      unless logger
+        perform_action_without_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)"
+        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 << " | #{headers["Status"]}"
+        log_message << " [#{complete_request_uri rescue "unknown"}]"
+        logger.info(log_message)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.10
+specification_version: 1
+name: custom_benchmarks
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2006-10-31
+summary: Easily allows custom information to be included in the benchmark log line at the end of each request.
+require_paths: 
+- lib
+email: tyler.kovacs@zvents.com
+homepage: http://blog.zvents.com/2006/10/31/rails-plugin-custom-benchmarks
+rubyforge_project: 
+description: 
+autorequire: custom_benchmarks
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+authors: 
+- Tyler Kovacs
+files: 
+- lib/custom_benchmarks.rb
+- README
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+