time_bandits 0.0.7 → 0.0.8

data/README.rdoc

@@ -2,7 +2,7 @@
 
 == About
 
-Time Bandits is a plugin which enhances Rails' controller/view/db benchmark logging.
+Time Bandits is a gem plugin for Rails which enhances Rails' controller/view/db benchmark logging.
 
 == Usage
 
@@ -81,9 +81,7 @@ rewrite, hence we changed the name.
 
 == License
 
-Copyright (c) 2009,2011 Stefan Kaes <skaes@railsexpress.de>
-
-Some portions Copyright (c) 2008 tylerkovacs
+Copyright (c) 2009, 2011 Stefan Kaes <skaes@railsexpress.de>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README_RAILS2.rdoc

@@ -0,0 +1,98 @@
+= Time Bandits
+
+== About
+
+Time Bandits is a plugin which enhances Rails' controller/view/db benchmark logging.
+
+== Usage
+
+Without configuration, the standard Rails 'Completed line' will change
+from its default format
+
+    Completed in 56ms (View: 28, DB: 5) | 200 OK [http://127.0.0.1/jobs/info]
+
+to:
+
+    Completed in 56.278ms (View: 28.488, DB: 5.111(2,0)) | 200 OK [http://127.0.0.1/jobs/info]
+
+Here "DB: 5.111(2,0)" means that 2 DB queries were executed and there were 0 SQL query cache hits.
+
+However, non-trivial applications also rather often use external services, which consume time that adds
+to your total response time, and sometimes these external services are not under your control. In these
+cases, it's very helpful to have an entry in your log file that records the time spent in the exterrnal
+service (so that you can prove that it wasn't your rails app that slowed down during your slashdotting,
+for example ;-).
+
+Additional TimeConsumers can be added to the log using the "Timebandits.add" method.
+
+Example:
+
+    TimeBandits.add TimeBandits::TimeConsumers::Memcached
+    TimeBandits.add TimeBandits::TimeConsumers::GarbageCollection.instance if GC.respond_to? :enable_stats
+
+Here we've added two additional consumers, which are already provided with the plugin. (Note that GC
+information requires a patched ruby, (e.g. http://github.com/skaes/matzruby, branch ruby187pl202patched
+or Ruby Enterprise Edition).
+
+With these two new time consumers, the log line changes to
+
+    Completed in 680.378ms (View: 28.488, DB: 5.111(2,0), MC: 5.382(6r,0m), GC: 120.100(1), HP: 0(2000000,546468,18682541,934967)) | 200 OK [http://127.0.0.1/jobs/info]
+
+"MC: 5.382(6r,0m)" means that 6 memcache reads were performed and all keys were found in the cache (0 misses).
+
+"GC: 120.100(1)" tells us that 1 garbage collection was triggered during the request, taking 120.100 milliseconds.
+
+"HP: 0(2000000,546468,18682541,934967)" shows statistics on heap usage. The format is g(s,a,m,l), where
+
+   g: heap growth during the request (#slots)
+   s: size of the heap after request processing was completed (#slots)
+   a: number of object allocations during the request (#slots)
+   m: number of bytes allocated by the ruby x_malloc call (#bytes)
+   l: live data set size after last GC (#slots)
+
+It's pretty easy to write additional time consumers; please refer to the source code.
+
+
+== Prerequisites
+
+Rails 2.3.2, 2.3.3 or 2.3.4 The plugin will raise an error if you try
+to use it with a different version.
+
+A ruby with the railsbench GC patches applied, if you want to include
+GC and heap size information in the completed line. This is very
+useful, especially if you want to analyze your rails logs using logjam
+(see http://github.com/alpinegizmo/logjam/).
+
+
+== History
+
+This plugin started from the code of the 'custom_benchmark' plugin
+written by tylerkovacs. However, we changed so much of the code that
+is is practically a full rewrite, hence we changed the name.
+
+
+== License
+
+Copyright (c) 2009 Stefan Kaes <skaes@railsexpress.de>
+
+Some portions Copyright (c) 2008 tylerkovacs
+
+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/init.rb

@@ -0,0 +1,12 @@
+# this file gets only loaded for rails2
+require 'time_bandits'
+require 'time_bandits/monkey_patches/active_record_rails2'
+require 'time_bandits/monkey_patches/action_controller_rails2'
+
+ActionController::Base.send :include, ActionController::TimeBanditry
+
+TimeBandits::TimeConsumers::GarbageCollection.heap_dumps_enabled = %w(production development).include?(RAILS_ENV)
+
+# TimeBandits.add TimeBandits::TimeConsumers::Memcached if defined?(Memcached)
+# TimeBandits.add TimeBandits::TimeConsumers::GarbageCollection.instance if GC.respond_to? :enable_stats
+# TimeBandits.add TimeBandits::TimeConsumers::JMX.instance if defined? JRUBY_VERSION

data/lib/time_bandits.rb

@@ -3,14 +3,18 @@ require 'active_support/core_ext'
 module TimeBandits
 
   module TimeConsumers
-    autoload :Database,          'time_bandits/time_consumers/database'
+    if defined?(Rails) && Rails::VERSION::STRING < "3.0"
+      autoload :Database,          'time_bandits/time_consumers/database_rails2'
+    else
+      autoload :Database,          'time_bandits/time_consumers/database'
+    end
     autoload :GarbageCollection, 'time_bandits/time_consumers/garbage_collection'
     autoload :JMX,               'time_bandits/time_consumers/jmx'
     autoload :MemCache,          'time_bandits/time_consumers/mem_cache'
     autoload :Memcached,         'time_bandits/time_consumers/memcached'
   end
 
-  require 'time_bandits/railtie' if defined?(Rails)
+  require 'time_bandits/railtie' if defined?(Rails) && Rails::VERSION::STRING >= "3.0"
 
   mattr_accessor :time_bandits
   self.time_bandits = []

data/lib/time_bandits/monkey_patches/action_controller_rails2.rb

@@ -0,0 +1,129 @@
+# =========================================================================================================
+# IMPORTANT: the plugin changes the ActionController#process method chain
+#
+# the original rails stack looks like this:
+#
+# ApplicationController#process_with_unload_user
+# ActionController::SessionManagement#process_with_session_management_support
+# ActionController::Filters#process_with_filters
+# ActionController::Base#process
+# ActionController::Caching::SqlCache#perform_action_with_caching
+# ActionController::Rescue#perform_action_with_rescue
+# *** ActionController::Benchmarking#perform_action_with_benchmark ***
+# ActionController::Filters#perform_action_with_filters (==> this runs the filters)
+# ActionController::Base#perform_action (==> run the action and eventually call render)
+# ActionController::Benchmarking#render_with_benchmark (==> this is where the rendering time gets computed)
+# ActionController::Base::render
+#
+# with the plugin installed, the stack looks like this:
+#
+# ApplicationController#process_with_unload_user
+# ActionController::SessionManagement#process_with_session_management_support
+# ActionController::Filters#process_with_filters
+# ActionController::Base#process
+# *** ActionController::Benchmarking#perform_action_with_time_bandits ***   <=========== !!!!
+# ActionController::Caching::SqlCache#perform_action_with_caching
+# ActionController::Rescue#perform_action_with_rescue
+# ActionController::Filters#perform_action_with_filters (==> this runs the filters)
+# ActionController::Base#perform_action (==> run the action and eventually call render)
+# ActionController::Benchmarking#render_with_benchmark (==> this is where the rendering time gets computed)
+# ActionController::Base::render
+# =========================================================================================================
+
+module ActionController #:nodoc:
+  module TimeBanditry #:nodoc:
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :perform_action, :time_bandits
+        alias_method_chain :rescue_action, :time_bandits
+
+        # if timebandits are used, the default benchmarking is
+        # disabled. As alias_method_chain is unfriendly to extensions,
+        # this is done by skipping perform_action_with_benchmarks by
+        # calling perform_action_without_benchmarks at the appropriate
+        # place.
+        def perform_action_without_rescue
+          perform_action_without_benchmark
+        end
+
+        alias_method :render, :render_with_benchmark
+      end
+
+      TimeBandits.add TimeBandits::TimeConsumers::Database.instance
+    end
+
+    def render_with_benchmark(options = nil, extra_options = {}, &block)
+      if logger
+        before_rendering = TimeBandits.consumed
+
+        render_output = nil
+        @view_runtime = Benchmark::realtime { render_output = render_without_benchmark(options, extra_options, &block) }
+
+        other_time_consumed_during_rendering = TimeBandits.consumed - before_rendering
+        @view_runtime -= other_time_consumed_during_rendering
+
+        render_output
+      else
+        render_without_benchmark(options, extra_options, &block)
+      end
+    end
+
+    def perform_action_with_time_bandits
+      if logger
+        TimeBandits.reset
+
+        seconds = [ Benchmark::measure{ perform_action_without_time_bandits }.real, 0.0001 ].max
+
+        log_message  = "Completed in #{sprintf("%.3f", seconds * 1000)}ms"
+
+        log_message << " ("
+        log_message << view_runtime
+        TimeBandits.time_bandits.each do |bandit|
+          log_message << ", #{bandit.runtime}"
+        end
+        log_message << ")"
+
+        log_message << " | #{response.status}"
+        log_message << " [#{complete_request_uri rescue "unknown"}]"
+
+        logger.info(log_message)
+        response.headers["X-Runtime"] = "#{sprintf("%.0f", seconds * 1000)}ms"
+      else
+        perform_action_without_time_bandits
+      end
+    end
+
+    def rescue_action_with_time_bandits(exception)
+      # HACK!
+      if logger && !caller.any?{|c| c =~ /perform_action_without_time_bandits/ }
+        TimeBandits.reset
+
+        seconds = [ Benchmark::measure{ rescue_action_without_time_bandits(exception) }.real, 0.0001 ].max
+
+        log_message  = "Completed in #{sprintf("%.3f", seconds * 1000)}ms"
+
+        log_message << " ("
+        log_message << view_runtime
+        TimeBandits.time_bandits.each do |bandit|
+          log_message << ", #{bandit.runtime}"
+        end
+        log_message << ")"
+
+        log_message << " | #{response.status}"
+        log_message << " [#{complete_request_uri rescue "unknown"}]"
+
+        logger.info(log_message)
+        response.headers["X-Runtime"] = "#{sprintf("%.0f", seconds * 1000)}ms"
+      else
+        rescue_action_without_time_bandits(exception)
+      end
+    end
+
+    private
+
+    def view_runtime
+      "View: %.3f" % ((@view_runtime||0) * 1000)
+    end
+
+  end
+end

data/lib/time_bandits/monkey_patches/active_record_rails2.rb

@@ -0,0 +1,86 @@
+# this file monkey patches class ActiveRecord::ConnectionAdapters::AbstractAdapter
+# and the module module ActiveRecord::ConnectionAdapters::QueryCache
+# to count the number of sql statements being executed.
+# it needs to be adapted to each new rails version
+
+raise "AR abstract adapter monkey patch for custom benchmarking is not compatible with your rails version" unless
+  %w(2.3.2 2.3.3 2.3.4 2.3.8 2.3.9 2.3.10).include?(Rails::VERSION::STRING)
+
+module ActiveRecord
+  module ConnectionAdapters
+    class ConnectionPool
+      attr_reader :connections
+    end
+
+    class AbstractAdapter
+      attr_accessor :call_count, :query_cache_hits
+
+      def initialize(connection, logger = nil) #:nodoc:
+        @connection, @logger = connection, logger
+        @runtime = 0
+        @call_count = 0
+        @last_verification = 0
+        @query_cache_enabled = false
+        @query_cache_hits = 0
+      end
+
+      def reset_call_count
+        calls = @call_count
+        @call_count = 0
+        calls
+      end
+
+      def reset_query_cache_hits
+        hits = @query_cache_hits
+        @query_cache_hits = 0
+        hits
+      end
+
+      protected
+      def log(sql, name)
+        if block_given?
+          result = nil
+          seconds = Benchmark.realtime { result = yield }
+          @runtime += seconds
+          @call_count += 1
+          log_info(sql, name, seconds * 1000)
+          result
+        else
+          log_info(sql, name, 0)
+          nil
+        end
+      rescue Exception => e
+        # Log message and raise exception.
+        # Set last_verification 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
+
+    module QueryCache
+      private
+      def cache_sql(sql)
+        result =
+          if @query_cache.has_key?(sql)
+            @query_cache_hits += 1
+            log_info(sql, "CACHE", 0.0)
+            @query_cache[sql]
+          else
+            @query_cache[sql] = yield
+          end
+
+        if Array === result
+          result.collect { |row| row.dup }
+        else
+          result.duplicable? ? result.dup : result
+        end
+      rescue TypeError
+        result
+      end
+    end
+  end
+end
+

data/lib/time_bandits/time_consumers/database_rails2.rb

@@ -0,0 +1,53 @@
+# Database time consumer for Rails2. You need to add it via
+#
+# TimeBandits.add TimeBandits::TimeConsumers::Database.instance
+#
+
+module TimeBandits
+  module TimeConsumers
+    # provide a time consumer interface to ActiveRecord for perform_action_with_benchmark and render_with_benchmark
+    class Database
+      def initialize
+        @consumed = 0.0
+        @call_count = 0
+        @query_cache_hits = 0
+      end
+      private :initialize
+
+      def self.instance
+        @instance ||= new
+      end
+
+      def reset
+        reset_stats
+        @call_count = 0
+        @consumed = 0.0
+        @query_cache_hits = 0
+      end
+
+      def consumed
+        hits, calls, time = reset_stats
+        @query_cache_hits += hits
+        @call_count += calls
+        @consumed += time
+      end
+
+      def runtime
+        sprintf "DB: %.3f(%d,%d)", @consumed * 1000, @call_count, @query_cache_hits
+      end
+
+      private
+      def all_connections
+        ActiveRecord::Base.connection_handler.connection_pools.values.map{|pool| pool.connections}.flatten
+      end
+
+      def reset_stats
+        connections = all_connections
+        hits  = connections.map{|c| c.reset_query_cache_hits}.sum
+        calls = connections.map{|c| c.reset_call_count}.sum
+        time  = connections.map{|c| c.reset_runtime}.sum
+        [hits, calls, time]
+      end
+    end
+  end
+end

data/lib/time_bandits/time_consumers/garbage_collection.rb

@@ -72,14 +72,19 @@ module TimeBandits
           end
         end
 
+        if defined?(Rails) && Rails::VERSION::STRING >= "3.0"
+          GCFORMAT = "GC: %.3f(%d) | HP: %d(%d,%d,%d,%d)"
+        else
+          GCFORMAT= "GC: %.3f(%d), HP: %d(%d,%d,%d,%d)"
+        end
+
         def runtime
           heap_slots = GC.heap_slots
           heap_growth = self.heap_growth
           allocated_objects = self.allocated_objects
           allocated_size = self.allocated_size
-          GCHacks.heap_dump if heap_growth > 0 && @@heap_dumps_enabled
-          "GC: %.3f(%d) | HP: %d(%d,%d,%d,%d)" %
-            [consumed_gc_time * 1000, collections, heap_growth, heap_slots, allocated_objects, allocated_size, live_data_set_size]
+          GCHacks.heap_dump if heap_growth > 0 && @@heap_dumps_enabled && defined?(GCHacks)
+          GCFORMAT % [consumed_gc_time * 1000, collections, heap_growth, heap_slots, allocated_objects, allocated_size, live_data_set_size]
         end
 
       else

data/lib/time_bandits/time_consumers/jmx.rb

@@ -1,4 +1,4 @@
-# a time consumer implementation for jruby, using jxm
+# a time consumer implementation for jruby, using jmx
 #
 # the gc counts and times reported are summed over all the garbage collectors
 # heap_growth reflects changes in the committed size of the java heap
@@ -6,6 +6,8 @@
 # allocated_size reflects changes in the active (used) part of the java heap
 # java non-heap memory is not reported
 
+require 'jmx' if defined? JRUBY_VERSION
+
 module TimeBandits
   module TimeConsumers
     class JMX
@@ -28,7 +30,7 @@ module TimeBandits
       def gc_time
         @collectors.to_array.map {|gc| @server[gc].collection_time}.sum
       end
-      
+
       def gc_collections
         @collectors.to_array.map {|gc| @server[gc].collection_count}.sum
       end
@@ -36,7 +38,7 @@ module TimeBandits
       def heap_size
         @memory_bean.heap_memory_usage.committed
       end
-      
+
       def heap_usage
         @memory_bean.heap_memory_usage.used
       end
@@ -47,7 +49,7 @@ module TimeBandits
         @heap_committed = heap_size
         @heap_used = heap_usage
       end
-      
+
       def collections_delta
         gc_collections - @collections
       end
@@ -63,7 +65,7 @@ module TimeBandits
       def usage_growth
         heap_usage - @heap_used
       end
-      
+
       def allocated_objects
         0
       end

data/lib/time_bandits/version.rb

@@ -1,3 +1,3 @@
 module TimeBandits
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/rails/init.rb

@@ -0,0 +1 @@
+require File.expand_path('../../init.rb', __FILE__)

data/time_bandits.gemspec

@@ -8,15 +8,15 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Stefan Kaes"]
   s.email       = ["skaes@railsexpress.de"]
-  s.homepage    = "https://github.com/skaes/time_bandits/tree/rails3"
+  s.homepage    = "https://github.com/skaes/time_bandits/"
   s.summary     = "Custom performance logging for Rails"
-  s.description = "Rails 3 Completed Line on Steroids"
+  s.description = "Rails Completed Line on Steroids"
 
   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.add_runtime_dependency("activesupport",         ["~> 3.0"])
+  s.add_runtime_dependency("activesupport",         [">= 2.3.2"])
 end
 

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: time_bandits
 version: !ruby/object:Gem::Version 
+  hash: 15
   prerelease: 
-  version: 0.0.7
+  segments: 
+  - 0
+  - 0
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Stefan Kaes
@@ -10,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-05 00:00:00 +02:00
+date: 2011-08-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -19,12 +24,17 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: "3.0"
+        hash: 7
+        segments: 
+        - 2
+        - 3
+        - 2
+        version: 2.3.2
   type: :runtime
   version_requirements: *id001
-description: Rails 3 Completed Line on Steroids
+description: Rails Completed Line on Steroids
 email: 
 - skaes@railsexpress.de
 executables: []
@@ -37,24 +47,30 @@ files:
 - .gitignore
 - Gemfile
 - README.rdoc
+- README_RAILS2.rdoc
 - Rakefile
 - TODO
+- init.rb
 - lib/time_bandits.rb
 - lib/time_bandits/monkey_patches/action_controller.rb
+- lib/time_bandits/monkey_patches/action_controller_rails2.rb
 - lib/time_bandits/monkey_patches/active_record.rb
+- lib/time_bandits/monkey_patches/active_record_rails2.rb
 - lib/time_bandits/monkey_patches/memcache-client.rb
 - lib/time_bandits/monkey_patches/memcached.rb
 - lib/time_bandits/monkey_patches/rails_rack_logger.rb
 - lib/time_bandits/railtie.rb
 - lib/time_bandits/time_consumers/database.rb
+- lib/time_bandits/time_consumers/database_rails2.rb
 - lib/time_bandits/time_consumers/garbage_collection.rb
 - lib/time_bandits/time_consumers/jmx.rb
 - lib/time_bandits/time_consumers/mem_cache.rb
 - lib/time_bandits/time_consumers/memcached.rb
 - lib/time_bandits/version.rb
+- rails/init.rb
 - time_bandits.gemspec
 has_rdoc: true
-homepage: https://github.com/skaes/time_bandits/tree/rails3
+homepage: https://github.com/skaes/time_bandits/
 licenses: []
 
 post_install_message: 
@@ -67,17 +83,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   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: 
-rubygems_version: 1.5.3
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Custom performance logging for Rails