time_bandits 0.5.1 → 0.6.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWEyMTkyMzVmNzk4ZDRmM2ExMzg0NDlmZGM2NDlhZjg5NTM3YjQ1Yg==
+    NWQxOTYzZGM3NGMxMGM5NTc0ZmViNTIyMzJhNDA1ODNiNTExMjg0ZA==
   data.tar.gz: !binary |-
-    OTA2NjczNzVmZWMxYTMyMGZjZDZiMDU5MmU3YjY3YTQzZjBhOWEyYQ==
+    NmQ5MTdiMjNmNWRjNTgzYjA2OTNjM2ExYWI2YzcyNjdiZTI1ZDg1ZQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MTcwNTMwMDhkYjE2NmFiMDk1NGIwMTk4ZDY5M2RiMWNlMzJiNjJlMWRkNTRl
-    YTRiMDUwYjdmYjY5OTlmMzZlZDI2NWUyYmYzMzljY2FmNDYwODJkMmE1MWMw
-    ZTRkMDljMGY5OWQ5YzYzYTNmYWJlNzlmZDYxNjgxODliYWZkYzc=
+    NzAxOTQ2ZDBlNzMyN2IzMWYzYTExOTc3MjVkNmE3MWUyYzBmOTAzNjZiZDgw
+    NjY0Y2M3NjZmNDA2NzQ1Nzk2MmE4YzAzMmNjY2NkZWNhYWMzZTE1ZGMzYzk3
+    NTJhZGZhMzNkZGQ5ZDQ3MGZiMzdhNDEyMGQ3ODAyYjFjZjE3Mjg=
   data.tar.gz: !binary |-
-    Mzg0MzRiMWVkMTIxOWQ4MTg5MjU1MTczOWU0ZWFkNDc1NjYxMmI0ZmM3ODY1
-    NjIyM2U0YjI4ZmU4YjNkMTgyZDdhYTY3ODFjNjBjZjQ3NDQ4NzY0NTU3YWI4
-    YTg4NDg0MGU5YWVkYmFiNzNjNTdlZmRjNTU2ZDIyNjU5ZjZmYjA=
+    MmJjYWFiOGQxNDc1YjA5MWI1OTI1NWZlYTNmOGNlZTc1OWFlNWI1MDkxYmI5
+    N2YzNjEyMTRlMjc2MmFmZDFkZjIwNWJhMWE3Y2U0Y2Q2ZTAxN2EyZWIxYjhj
+    MDVjNjBkYjBmYjc5OTMwNmQ2ODU5ODM0ZDExZWU5ZjVhZmU5ZWQ=

data/README.rdoc

@@ -78,8 +78,20 @@ rvm and the railsexpress rvm patchsets (see https://github.com/skaes/rvm-patchse
 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.
 
+== Running Tests
+
+In order for the test to run you need a running memcached and redis-server
+
 == Release Notes
 
+version 0.5.2
+   - added redis time consumer
+   - fixed rails 4.0 problems with builtin mem_cache_store
+   - now only consumers which measured something are added to the completed line
+
+version 0.5.1
+   - added license file
+
 version 0.5:
    - has dropped rails 2 support
    - relies on ActiveSupport::Notifications

data/lib/time_bandits.rb

@@ -14,6 +14,7 @@ module TimeBandits
     autoload :MemCache,          'time_bandits/time_consumers/mem_cache'
     autoload :Memcached,         'time_bandits/time_consumers/memcached'
     autoload :Dalli,             'time_bandits/time_consumers/dalli'
+    autoload :Redis,             'time_bandits/time_consumers/redis'
   end
 
   require 'time_bandits/railtie' if defined?(Rails) && Rails::VERSION::STRING >= "3.0"
@@ -34,8 +35,12 @@ module TimeBandits
     time_bandits.map{|b| b.consumed}.sum
   end
 
+  def self.runtimes
+    time_bandits.map{|b| b.runtime}.reject{|t| t.blank?}
+  end
+
   def self.runtime
-    time_bandits.map{|b| b.runtime}.join("| ")
+    runtimes.join(" | ")
   end
 
   def self.metrics

data/lib/time_bandits/monkey_patches/action_controller.rb

@@ -124,11 +124,7 @@ module ActionController #:nodoc:
       def log_process_action(payload) #:nodoc:
         # need to call this to compute DB time/calls
         TimeBandits.consumed
-        messages = super
-        TimeBandits.time_bandits.each do |bandit|
-          messages << bandit.runtime
-        end
-        messages
+        super.concat(TimeBandits.runtimes)
       end
     end
 

data/lib/time_bandits/monkey_patches/active_support_cache_store.rb

@@ -0,0 +1,15 @@
+require "active_support/cache"
+
+# rails 4 builtin mem_cache_store broke hit reporting for fetch
+class ActiveSupport::Cache::Store
+  private
+  # only called by fetch
+  def find_cached_entry(key, name, options)
+    instrument(:read, name, options) do |payload|
+      payload[:super_operation] = :fetch if payload
+      res = read_entry(key, options)
+      payload[:hit] = !!res if payload
+      res
+    end
+  end
+end

data/lib/time_bandits/monkey_patches/redis.rb

@@ -0,0 +1,12 @@
+require 'redis'
+class Redis
+  class Client
+    alias :old_logging :logging
+
+    def logging(commands, &block)
+      ActiveSupport::Notifications.instrument('request.redis', commands: commands) do
+        old_logging(commands, &block)
+      end
+    end
+  end
+end

data/lib/time_bandits/time_consumers/base_consumer.rb

@@ -51,7 +51,12 @@ module TimeBandits::TimeConsumers
     end
 
     def runtime
-      self.class.runtime_format % metrics.values_at(*self.class.runtime_keys)
+      values = metrics.values_at(*self.class.runtime_keys)
+      if values.all?{|v|v==0}
+        ""
+      else
+        self.class.runtime_format % values
+      end
     end
   end
 end

data/lib/time_bandits/time_consumers/dalli.rb

@@ -1,8 +1,20 @@
+if Rails::VERSION::STRING >= "4.0"
+  require "time_bandits/monkey_patches/active_support_cache_store"
+end
+
 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
+    format "Dalli: %.3f(%dr,%dm,%dw,%dc)", :time, :reads, :misses, :writes, :calls
+
+    if Rails::VERSION::STRING >= "4.0"
+      def reset
+        # Rails 4 mem_cache_store (which uses dalli internally), unlike dalli_store, is not instrumented by default
+        Rails.cache.class.instrument = true
+        super
+      end
+    end
 
     class Subscriber < ActiveSupport::LogSubscriber
       # cache events are: read write fetch_hit generate delete read_multi increment decrement clear

data/lib/time_bandits/time_consumers/redis.rb

@@ -0,0 +1,43 @@
+# a time consumer implementation for redis
+# install into application_controller.rb with the line
+#
+#   time_bandit TimeBandits::TimeConsumers::Redis
+#
+require 'time_bandits/monkey_patches/redis'
+
+module TimeBandits
+  module TimeConsumers
+    class Redis < BaseConsumer
+      prefix :redis
+      fields :time, :calls
+      format "Redis: %.3f(%d)", :time, :calls
+
+      class Subscriber < ActiveSupport::LogSubscriber
+        def request(event)
+          i = Redis.instance
+          i.time += event.duration
+          i.calls += event.payload[:commands].size
+
+          return unless logger.debug?
+
+          name = "%s (%.2fms)" % ["Redis", event.duration]
+          cmds = event.payload[:commands]
+
+          # output = "  #{color(name, CYAN, true)}"
+          output = "  #{name}"
+
+          cmds.each do |cmd, *args|
+            if args.present?
+              output << " [ #{cmd.to_s.upcase} #{args.join(" ")} ]"
+            else
+              output << " [ #{cmd.to_s.upcase} ]"
+            end
+          end
+
+          debug output
+        end
+      end
+      Subscriber.attach_to(:redis)
+    end
+  end
+end

data/lib/time_bandits/version.rb

@@ -1,3 +1,3 @@
 module TimeBandits
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/test/test_helper.rb

@@ -13,6 +13,17 @@ require_relative '../lib/time_bandits'
 ActiveSupport::LogSubscriber.class_eval do
   # need a logger, otherwise no data will be collected
   def logger
-    @logger ||= Logger.new(STDOUT)
+    @logger ||= ::Logger.new("/dev/null")
+  end
+end
+
+# fake Rails
+module Rails
+  extend self
+  module VERSION
+    STRING = "4.0.0"
+  end
+  def cache
+    @cache ||= ActiveSupport::Cache.lookup_store(:mem_cache_store)
   end
 end

data/test/unit/active_support_notifications_test.rb

@@ -23,6 +23,7 @@ class ActiveSupportNotificationsTest < Test::Unit::TestCase
     TimeBandits.time_bandits = []
     TimeBandits.add SimpleConsumer
     TimeBandits.reset
+    @bandit = SimpleConsumer.instance
   end
 
   test "getting metrics" do
@@ -30,7 +31,8 @@ class ActiveSupportNotificationsTest < Test::Unit::TestCase
   end
 
   test "formatting" do
-    assert_equal "Simple: 0.0ms(0 calls)", TimeBandits.runtime
+    @bandit.calls = 1
+    assert_equal "Simple: 0.0ms(1 calls)", TimeBandits.runtime
   end
 
   test "foreground work gets accounted for in milliseconds" do

data/test/unit/dalli_test.rb

@@ -0,0 +1,63 @@
+require_relative '../test_helper'
+
+class DalliTest < Test::Unit::TestCase
+  def setup
+    TimeBandits.time_bandits = []
+    TimeBandits.add TimeBandits::TimeConsumers::Dalli
+    TimeBandits.reset
+    @cache = Rails.cache
+    @bandit = TimeBandits::TimeConsumers::Dalli.instance
+  end
+
+  test "getting metrics" do
+    nothing_measured = {
+      :memcache_time => 0,
+      :memcache_calls => 0,
+      :memcache_misses => 0,
+      :memcache_reads => 0,
+      :memcache_writes => 0
+    }
+    assert_equal nothing_measured, TimeBandits.metrics
+  end
+
+  test "formatting" do
+    @bandit.calls = 3
+    assert_equal "Dalli: 0.000(0r,0m,0w,3c)", TimeBandits.runtime
+  end
+
+  test "foreground work gets accounted for" do
+    work
+    check_work
+  end
+
+  test "background work is ignored" do
+    Thread.new do
+      work
+      check_work
+    end.join
+    m = TimeBandits.metrics
+    assert_equal 0, m[:memcache_calls]
+    assert_equal 0, m[:memcache_reads]
+    assert_equal 0, m[:memcache_misses]
+    assert_equal 0, m[:memcache_writes]
+    assert_equal 0, m[:memcache_time]
+  end
+
+  private
+  def work
+    TimeBandits.reset
+    2.times do
+      @cache.read("foo")
+      @cache.write("bar", 1)
+    end
+  end
+  def check_work
+    m = TimeBandits.metrics
+    assert_equal 4, m[:memcache_calls]
+    assert_equal 2, m[:memcache_reads]
+    assert_equal 2, m[:memcache_misses]
+    assert_equal 2, m[:memcache_writes]
+    assert 0 < m[:memcache_time]
+    assert_equal m[:memcache_time], TimeBandits.consumed
+  end
+end

data/test/unit/memcached_test.rb

@@ -6,21 +6,23 @@ class MemcachedTest < Test::Unit::TestCase
     TimeBandits.add TimeBandits::TimeConsumers::Memcached
     TimeBandits.reset
     @cache = Memcached.new
+    @bandit = TimeBandits::TimeConsumers::Memcached.instance
   end
 
   test "getting metrics" do
     nothing_measured = {
-      :memcache_time=>0,
-      :memcache_calls=>0,
-      :memcache_misses=>0,
-      :memcache_reads=>0,
-      :memcache_writes=>0
+      :memcache_time => 0,
+      :memcache_calls => 0,
+      :memcache_misses => 0,
+      :memcache_reads => 0,
+      :memcache_writes => 0
     }
     assert_equal nothing_measured, TimeBandits.metrics
   end
 
   test "formatting" do
-    assert_equal "MC: 0.000(0r,0m,0w,0c)", TimeBandits.runtime
+    @bandit.calls = 3
+    assert_equal "MC: 0.000(0r,0m,0w,3c)", TimeBandits.runtime
   end
 
   test "foreground work gets accounted for" do

data/test/unit/redis_test.rb

@@ -0,0 +1,54 @@
+require_relative '../test_helper'
+
+class RedisTest < Test::Unit::TestCase
+  def setup
+    TimeBandits.time_bandits = []
+    TimeBandits.add TimeBandits::TimeConsumers::Redis
+    TimeBandits.reset
+    @redis = Redis.new
+    @bandit = TimeBandits::TimeConsumers::Redis.instance
+  end
+
+  test "getting metrics" do
+    nothing_measured = {
+      :redis_time => 0,
+      :redis_calls => 0
+    }
+    assert_equal nothing_measured, TimeBandits.metrics
+  end
+
+  test "formatting" do
+    @bandit.calls = 3
+    assert_equal "Redis: 0.000(3)", TimeBandits.runtime
+  end
+
+  test "foreground work gets accounted for" do
+    work
+    check_work
+  end
+
+  test "background work is ignored" do
+    Thread.new do
+      work
+      check_work
+    end.join
+    m = TimeBandits.metrics
+    assert_equal 0, m[:redis_calls]
+    assert_equal 0, m[:redis_time]
+  end
+
+  private
+  def work
+    TimeBandits.reset
+    2.times do
+      @redis.get("foo")
+      @redis.set("bar", 1)
+    end
+  end
+  def check_work
+    m = TimeBandits.metrics
+    assert_equal 4, m[:redis_calls]
+    assert 0 < m[:redis_time]
+    assert_equal m[:redis_time], TimeBandits.consumed
+  end
+end

data/time_bandits.gemspec

@@ -23,5 +23,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency("rake")
   s.add_development_dependency("mocha")
   s.add_development_dependency("ansi")
+  s.add_development_dependency("dalli")
+  s.add_development_dependency("redis")
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_bandits
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Stefan Kaes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-11 00:00:00.000000000 Z
+date: 2013-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,34 @@ dependencies:
   type: :development
   prerelease: false
   name: ansi
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  name: dalli
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  name: redis
 description: Rails Completed Line on Steroids
 email:
 - skaes@railsexpress.de
@@ -96,8 +124,10 @@ files:
 - lib/time_bandits.rb
 - lib/time_bandits/monkey_patches/action_controller.rb
 - lib/time_bandits/monkey_patches/active_record.rb
+- lib/time_bandits/monkey_patches/active_support_cache_store.rb
 - lib/time_bandits/monkey_patches/memcache-client.rb
 - lib/time_bandits/monkey_patches/memcached.rb
+- lib/time_bandits/monkey_patches/redis.rb
 - lib/time_bandits/rack/logger.rb
 - lib/time_bandits/rack/logger40.rb
 - lib/time_bandits/railtie.rb
@@ -108,12 +138,15 @@ files:
 - 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/time_consumers/redis.rb
 - lib/time_bandits/version.rb
 - rails/init.rb
 - test/test_helper.rb
 - test/unit/active_support_notifications_test.rb
 - test/unit/base_test.rb
+- test/unit/dalli_test.rb
 - test/unit/memcached_test.rb
+- test/unit/redis_test.rb
 - time_bandits.gemspec
 homepage: https://github.com/skaes/time_bandits/
 licenses:
@@ -143,4 +176,6 @@ test_files:
 - test/test_helper.rb
 - test/unit/active_support_notifications_test.rb
 - test/unit/base_test.rb
+- test/unit/dalli_test.rb
 - test/unit/memcached_test.rb
+- test/unit/redis_test.rb