time_bandits 0.4.1 → 0.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmFhZDNkN2U1OTY3NDExMWE1YTU3M2QxNDEyNWU3NGY3YmI0OGE4ZA==
+    NWE3YzllNzNjMGYzNmZiYWFlNTc4ODNjNzE2NTc4MTJiNDM2ODFlMA==
   data.tar.gz: !binary |-
-    YjM2MjQ2YTdmMDQwNGJkNzQ0M2VmMDExY2FiN2U4NzI2MjBjNTdmOQ==
+    MDRiZmU5NDZjZjkzNWVlMTg4NDVhNjk1MWRlZTAyMjg0NGI4NDNhYg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NDE1Mjc2NWZhMjgxZWYzMDc2NTBlNTcxNTBjNTYyNWZiN2ZhM2MyYTVmYjYy
-    OTU0MzkyMjRlYTY0YTU0YjQzZTMxZjdjNDY2NDAzNDBiOWU0YzgxMDE0OTY5
-    ZWRjYzY1N2NlMmUwOGY1YzJmMGViYjhkYmY1NGM2ZDE5ZDdlMDg=
+    MGFjMjNkNWNjOGY4NjA5YTM0MTZmMmQwMzIwZDU2MzEyNjk4Y2QzN2EzM2Qy
+    ZjA3ZmE1NDZkN2Y5ODM0NDViNTMzNzc1M2NmZTM4Nzk2ZmQ2YmRlZTg5MGEy
+    MmJmNGUyZWZhMDAzMWMzNmNlMjIwNjg1ZDNiMTlkMTc3OTk0OGU=
   data.tar.gz: !binary |-
-    MzlkMjA5MmM0MzJkYTNmOGFiYmJiNDRkMWFkNmRjMTU5NDBjOWQ5MGUzMzU3
-    ZjU1YjE4YTA2MDhmODYwOWE3Y2FiZmY2YzEzMWQ1MGIwZGU2ODVlYWNkZDc3
-    N2ExOWNjZWJmZDM2MzExYTRkYzBkYmI1NDcxMWNmNmYwOTA5MjQ=
+    YzgzYjM2ZjMxMTUyMTNlOTJhMDY3MjBjMmZkY2E4OTExMGQ3Nzg0NjUyYWRk
+    MTdhM2UzNzY3MmE1YWMxYTk0MmYxNTc2YWM2NTQ1ZjBhNDQyYTg0MDExYjg5
+    MmE0OWUxZjE2OGNjMWRmZTRkYTg1NDljMTFmMWVhNmQzYjcwZjQ=

data/Gemfile

@@ -2,3 +2,9 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in time_bandits.gemspec
 gemspec
+
+# gem "activesupport", "3.2.13"
+gem "activesupport", "4.0.0"
+
+gem "debugger"
+gem "memcached"

data/README.rdoc

@@ -55,33 +55,42 @@ With these two new time consumers, the log line changes to
 
 Sidenote for Germans: you can use the word "Gesabbel" (eng: drivel) as a mnemonic here ;-)
 
-It's pretty easy to write additional time consumers; please refer to the source code.
+It's realtively straightforward to write additional time consumers; the more difficult part of this is
+monkey patching the code which you want to instrument. Have a look at consumers under
+lib/time_bandits/time_consumers and the corresponding patches under lib/time_bandits/monkey_patches.
 
 
 == Prerequisites
 
-Rails 3.x is required. The plugin will raise an error if you try to use it with a
-different version.
+Rails >= 3.x is required. The gem will raise an error if you try to use it with an incompatible
+version.
 
-You'll need a ruby with the railsexpress 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/).
+You'll need a ruby with the railsexpress 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/skaes/logjam/).
 
-Ruby Enterprise Edition contains a subset of the railsexpress patches. To get the full
-monty, you can use for example rvm and the railsexpress rvm patchsets (see
-https://github.com/skaes/rvm-patchsets).
+Ruby only contains a subset of the railsexpress patches. To get the full monty, you can use for example
+rvm and the railsexpress rvm patchsets (see https://github.com/skaes/rvm-patchsets).
 
 
 == 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.
+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.
 
+== Release Notes
+
+version 0.5:
+   - has dropped rails 2 support
+   - relies on ActiveSupport::Notifications
+   - is suposedly thread safe
+   - all measurements are thread local (except GC statistics)
+   - times are all measured in milliseconds internally
+   - added class TimeBandits::TimeConsumers::BaseConsumer to simplify writing custom consumers
 
 == License
 
-Copyright (c) 2009, 2011 Stefan Kaes <skaes@railsexpress.de>
+Copyright (c) 2009-2012 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/Rakefile

@@ -1,2 +1,16 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+include Rake::DSL
+
+$:.unshift 'lib'
+require 'time_bandits'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end

data/lib/time_bandits.rb

@@ -13,9 +13,11 @@ module TimeBandits
     autoload :JMX,               'time_bandits/time_consumers/jmx'
     autoload :MemCache,          'time_bandits/time_consumers/mem_cache'
     autoload :Memcached,         'time_bandits/time_consumers/memcached'
+    autoload :Dalli,             'time_bandits/time_consumers/dalli'
   end
 
   require 'time_bandits/railtie' if defined?(Rails) && Rails::VERSION::STRING >= "3.0"
+  require 'time_bandits/time_consumers/base_consumer'
 
   mattr_accessor :time_bandits
   self.time_bandits = []
@@ -33,7 +35,7 @@ module TimeBandits
   end
 
   def self.runtime
-    time_bandits.map{|b| b.runtime}.join(", ")
+    time_bandits.map{|b| b.runtime}.join("| ")
   end
 
   def self.metrics

data/lib/time_bandits/monkey_patches/action_controller.rb

@@ -8,7 +8,6 @@ module ActionController #:nodoc:
     # patch to ensure that the completed line is always written to the log.
     # this is not necessary anymore with rails 4.
     def process_action(action, *args)
-
       raw_payload = get_raw_payload
       ActiveSupport::Notifications.instrument("start_processing.action_controller", raw_payload.dup)
 
@@ -48,8 +47,7 @@ module ActionController #:nodoc:
       consumed_before_rendering = TimeBandits.consumed
       runtime = yield
       consumed_during_rendering = TimeBandits.consumed - consumed_before_rendering
-      # TODO: time bandits all measure in seconds a.t.m.; this should be changed
-      runtime - consumed_during_rendering*1000
+      runtime - consumed_during_rendering
     end
 
     private
@@ -92,14 +90,29 @@ module ActionController #:nodoc:
 
   class LogSubscriber
     # the original method logs the completed line.
-    # but we do it in the middleware.
+    # but we do it in the middleware, unless we're in test mode. don't ask.
     def process_action(event)
       payload   = event.payload
       additions = ActionController::Base.log_process_action(payload)
+
       Thread.current.thread_variable_set(
         :time_bandits_completed_info,
         [ event.duration, additions, payload[:view_runtime], "#{payload[:controller]}##{payload[:action]}" ]
       )
+
+      # this an ugly hack to encure completed lines show up in the test logs
+      # TODO: move this code to some other place
+      return unless Rails.env.test? && Rails::VERSION::STRING >= "3.2"
+
+      status = payload[:status]
+      if status.nil? && payload[:exception].present?
+        exception_class_name = payload[:exception].first
+        status = ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
+      end
+      message = "Completed #{status} #{Rack::Utils::HTTP_STATUS_CODES[status]} in %.1fms" % event.duration
+      message << " (#{additions.join(" | ")})" unless additions.blank?
+
+      info(message)
     end
   end
 

data/lib/time_bandits/monkey_patches/memcache-client.rb

@@ -6,48 +6,23 @@ require 'memcache'
 raise "MemCache needs to be loaded before monkey patching it" unless defined?(MemCache)
 
 class MemCache
-  @@cache_latency = 0.0
-  @@cache_touches = 0
-  @@cache_misses = 0
-
-  def self.reset_benchmarks
-    @@cache_latency = 0.0
-    @@cache_touches = 0
-    @@cache_misses = 0
-  end
-
-  def self.get_benchmarks
-    [@@cache_latency, @@cache_touches, @@cache_misses]
-  end
-
-  def self.cache_runtime
-    sprintf "MC: %.3f(%dr,%dm)", @@cache_latency * 1000, @@cache_touches, @@cache_misses
-  end
-
-  def self.metrics
-    {
-      :memcache_time => @@cache_latency * 1000,
-      :memcache_calls => @@cache_touches,
-      :memcache_misses => @@cache_misses
-    }
-  end
 
   def get_with_benchmark(key, raw = false)
-    val = nil
-    @@cache_latency += Benchmark.realtime{ val=get_without_benchmark(key, raw) }
-    @@cache_touches += 1
-    @@cache_misses += 1 if val.nil?
-    val
+    ActiveSupport::Notifications.instrument("get.memcache") do |payload|
+      val = get_without_benchmark(key, raw)
+      payload[:misses] = val.nil? ? 1 : 0
+      val
+    end
   end
   alias_method :get_without_benchmark, :get
   alias_method :get, :get_with_benchmark
 
   def get_multi_with_benchmark(*keys)
-    results = nil
-    @@cache_latency += Benchmark.realtime{ results=get_multi_without_benchmark(*keys) }
-    @@cache_touches += 1
-    @@cache_misses += keys.size - results.size
-    results
+    ActiveSupport::Notifications.instrument("get.memcache") do |payload|
+      results = get_multi_without_benchmark(*keys)
+       payload[:misses] = keys.size - results.size
+      results
+    end
   end
   alias_method :get_multi_without_benchmark, :get_multi
   alias_method :get_multi, :get_multi_with_benchmark

data/lib/time_bandits/monkey_patches/memcached.rb

@@ -6,79 +6,38 @@ require 'memcached'
 raise "Memcached needs to be loaded before monkey patching it" unless defined?(Memcached)
 
 class Memcached
-
-  def self.reset_benchmarks
-    @@cache_latency = 0.0
-    @@cache_calls = 0
-    @@cache_misses = 0
-    @@cache_reads = 0
-    @@cache_writes = 0
-  end
-  self.reset_benchmarks
-
-  def self.get_benchmarks
-    [@@cache_latency, @@cache_calls, @@cache_reads, @@cache_misses, @@cache_writes]
-  end
-
-  def self.cache_runtime
-    sprintf "MC: %.3f(%dr,%dm,%dw,%dc)", @@cache_latency * 1000, @@cache_reads, @@cache_misses, @@cache_writes, @@cache_calls
-  end
-
-  def self.metrics
-    {
-      :memcache_time   => @@cache_latency * 1000,
-      :memcache_calls  => @@cache_calls,
-      :memcache_misses => @@cache_misses,
-      :memcache_reads  => @@cache_reads,
-      :memcache_writes => @@cache_writes
-    }
-  end
-
   def get_with_benchmark(key, marshal = true)
-    @@cache_calls += 1
-    if key.is_a?(Array)
-      @@cache_reads += (num_keys = key.size)
-      results = []
-      @@cache_latency += Benchmark.realtime do
+    ActiveSupport::Notifications.instrument("get.memcached") do |payload|
+      if key.is_a?(Array)
+        payload[:reads] = (num_keys = key.size)
+        results = []
         begin
           results = get_without_benchmark(key, marshal)
         rescue Memcached::NotFound
         end
-      end
-      @@cache_misses += num_keys - results.size
-      results
-    else
-      val = nil
-      @@cache_reads += 1
-      @@cache_latency += Benchmark.realtime do
+        payload[:misses] = num_keys - results.size
+        results
+      else
+        val = nil
+        payload[:reads] = 1
         begin
           val = get_without_benchmark(key, marshal)
         rescue Memcached::NotFound
         end
+        payload[:misses] = val.nil? ? 1 : 0
+        val
       end
-      @@cache_misses += 1 if val.nil?
-      val
     end
   end
   alias_method :get_without_benchmark, :get
   alias_method :get, :get_with_benchmark
 
   def set_with_benchmark(*args)
-    @@cache_calls += 1
-    @@cache_writes += 1
-    result = nil
-    exception = nil
-    @@cache_latency += Benchmark.realtime do
-      begin
-        set_without_benchmark(*args)
-      rescue Exception => exception
-      end
+    ActiveSupport::Notifications.instrument("set.memcached") do
+      set_without_benchmark(*args)
     end
-    raise exception if exception
-    result
   end
   alias_method :set_without_benchmark, :set
   alias_method :set, :set_with_benchmark
 
 end
-

data/lib/time_bandits/rack/logger.rb

@@ -55,7 +55,7 @@ module TimeBandits
         completed_info = Thread.current.thread_variable_get(:time_bandits_completed_info)
         additions = completed_info[1] if completed_info
 
-        message = "Completed #{status} #{::Rack::Utils::HTTP_STATUS_CODES[status]} in %.1fms" % (run_time*1000)
+        message = "Completed #{status} #{::Rack::Utils::HTTP_STATUS_CODES[status]} in %.1fms" % run_time
         message << " (#{additions.join(' | ')})" unless additions.blank?
         info message
       ensure

data/lib/time_bandits/rack/logger40.rb

@@ -77,7 +77,7 @@ module TimeBandits
         status = resp ? resp.first.to_i : 500
         completed_info = Thread.current.thread_variable_get(:time_bandits_completed_info)
         additions = completed_info[1] if completed_info
-        message = "Completed #{status} #{::Rack::Utils::HTTP_STATUS_CODES[status]} in %.1fms" % (run_time*1000)
+        message = "Completed #{status} #{::Rack::Utils::HTTP_STATUS_CODES[status]} in %.1fms" % run_time
         message << " (#{additions.join(' | ')})" unless additions.blank?
         logger.info message
       end

data/lib/time_bandits/railtie.rb

@@ -13,16 +13,21 @@ module TimeBandits
     initializer "time_bandits" do |app|
       app.config.middleware.swap("Rails::Rack::Logger", "TimeBandits::Rack::Logger")
 
-      # rails 4 inserts Rack::Lock in development, but not in production.
-      # time bandits are not thread safe yet, so we insert the Rack::Lock middleware in production.
-      # TODO: make time_bandits thread safe
-      if Rails::VERSION::STRING >= "4.0" && Rails.env.production?
-        app.config.middleware.insert_before("TimeBandits::Rack::Logger", "Rack::Lock")
-      end
-
       ActiveSupport.on_load(:action_controller) do
         require 'time_bandits/monkey_patches/action_controller'
         include ActionController::TimeBanditry
+
+        # make sure TimeBandits.reset is called in test environment as middlewares are not executed
+        if Rails.env.test?
+          require 'action_controller/test_case'
+          module ActionController::TestCase::Behavior
+            def process_with_time_bandits(*args)
+              TimeBandits.reset
+              process_without_time_bandits(*args)
+            end
+            alias_method_chain :process, :time_bandits
+          end
+        end
       end
 
       ActiveSupport.on_load(:active_record) do

data/lib/time_bandits/time_consumers/base_consumer.rb

@@ -0,0 +1,57 @@
+module TimeBandits::TimeConsumers
+  class BaseConsumer
+    class << self
+      def instance
+        Thread.current.thread_variable_get(name) ||
+          Thread.current.thread_variable_set(name, new)
+      end
+
+      def prefix(sym)
+        @metrics_prefix = sym
+      end
+
+      # first symbol is used as time measurement
+      def fields(*symbols)
+        @struct = Struct.new(*(symbols.map{|s| "#{@metrics_prefix}_#{s}".to_sym}))
+        symbols.each do |name|
+          class_eval(<<-"EVA", __FILE__, __LINE__ + 1)
+            def #{name}; @counters.#{@metrics_prefix}_#{name}; end
+            def #{name}=(v); @counters.#{@metrics_prefix}_#{name} = v; end
+          EVA
+        end
+      end
+
+      def format(f, *keys)
+        @runtime_format = f
+        @runtime_keys = keys.map{|s| "#{@metrics_prefix}_#{s}".to_sym}
+      end
+
+      attr_reader :metrics_prefix, :struct, :timer_name, :runtime_format, :runtime_keys
+
+      def method_missing(m, *args)
+        (i = instance).respond_to?(m) ? i.send(m,*args) : super
+      end
+    end
+
+    def initialize
+      @counters = self.class.struct.new
+      reset
+    end
+
+    def reset
+      @counters.length.times{|i| @counters[i] = 0}
+    end
+
+    def metrics
+      @counters.members.each_with_object({}){|m,h| h[m] = @counters.send(m)}
+    end
+
+    def consumed
+      @counters[0]
+    end
+
+    def runtime
+      self.class.runtime_format % metrics.values_at(*self.class.runtime_keys)
+    end
+  end
+end

data/lib/time_bandits/time_consumers/dalli.rb

@@ -0,0 +1,51 @@
+module TimeBandits::TimeConsumers
+  class Dalli < BaseConsumer
+    prefix :memcache
+    fields :time, :calls, :misses, :reads, :writes
+    format "DALLI: %.3f(%dr,%dm,%dw,%dc)", :time, :reads, :misses, :writes, :calls
+
+    class Subscriber < ActiveSupport::LogSubscriber
+      # cache events are: read write fetch_hit generate delete read_multi increment decrement clear
+      def cache_read(event)
+        i = cache(event)
+        i.reads += 1
+        i.misses += 1 unless event.payload[:hit]
+      end
+
+      def cache_read_multi(event)
+        i = cache(event)
+        i.reads += event.payload[:key].size
+      end
+
+      def cache_write(event)
+        i = cache(event)
+        i.writes += 1
+      end
+
+      def cache_increment(event)
+        i = cache(event)
+        i.writes += 1
+      end
+
+      def cache_decrement(event)
+        i = cache(event)
+        i.writes += 1
+      end
+
+      def cache_delete(event)
+        i = cache(event)
+        i.writes += 1
+      end
+
+      private
+      def cache(event)
+        i = Dalli.instance
+        i.time += event.duration
+        i.calls += 1
+        i
+      end
+    end
+    Subscriber.attach_to :active_support
+  end
+
+end