time_bandits 0.4.1 → 0.5.0

data/lib/time_bandits/time_consumers/database.rb

@@ -8,42 +8,22 @@
 module TimeBandits
   module TimeConsumers
     # provide a time consumer interface to ActiveRecord
-    module Database
-      extend self
-
-      def info
-        Thread.current.thread_variable_get(:time_bandits_database_info) ||
-          Thread.current.thread_variable_set(:time_bandits_database_info, [0.0, 0, 0])
-      end
-
-      def info=(info)
-        Thread.current.thread_variable_set(:time_bandits_database_info, info)
-      end
+    class Database < TimeBandits::TimeConsumers::BaseConsumer
+      prefix :db
+      fields :time, :calls, :sql_query_cache_hits
+      format "ActiveRecord: %.3fms(%dq,%dh)", :time, :calls, :sql_query_cache_hits
 
       def reset
         reset_stats
-        self.info = [0.0, 0, 0]
+        super
       end
 
       def consumed
         time, calls, hits = reset_stats
-        i = self.info
-        i[2] += hits
-        i[1] += calls
-        i[0] += time
-      end
-
-      def runtime
-        time, calls, hits = *info
-        sprintf "ActiveRecord: %.3fms(%dq,%dh)", time*1000, calls, hits
-      end
-
-      def metrics
-        {
-          :db_time => info[0]*1000,
-          :db_calls => info[1],
-          :db_sql_query_cache_hits  => info[2]
-        }
+        i = Database.instance
+        i.sql_query_cache_hits += hits
+        i.calls += calls
+        i.time += time
       end
 
       private
@@ -53,7 +33,7 @@ module TimeBandits
         hits  = s.reset_query_cache_hits
         calls = s.reset_call_count
         time  = s.reset_runtime
-        [time.to_f/1000, calls, hits]
+        [time, calls, hits]
       end
     end
   end

data/lib/time_bandits/time_consumers/garbage_collection.rb

@@ -49,8 +49,8 @@ module TimeBandits
         0.0
       end
 
-      def consumed_gc_time
-        (GC.time - @consumed).to_f / 1_000_000
+      def consumed_gc_time # ms
+        (GC.time - @consumed).to_f / 1000
       end
 
       def collections
@@ -81,11 +81,7 @@ 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
+        GCFORMAT = "GC: %.3f(%d) | HP: %d(%d,%d,%d,%d)"
 
         def runtime
           heap_slots = GC.heap_slots
@@ -93,12 +89,12 @@ module TimeBandits
           allocated_objects = self.allocated_objects
           allocated_size = self.allocated_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]
+          GCFORMAT % [consumed_gc_time, collections, heap_growth, heap_slots, allocated_objects, allocated_size, live_data_set_size]
         end
 
         def metrics
           {
-            :gc_time => consumed_gc_time * 1000,
+            :gc_time => consumed_gc_time,
             :gc_calls => collections,
             :heap_growth => heap_growth,
             :heap_size => GC.heap_slots,
@@ -111,12 +107,12 @@ module TimeBandits
       else
 
         def runtime
-          "GC: %.3f(%d)" % [consumed_gc_time * 1000, collections]
+          "GC: %.3f(%d)" % [consumed_gc_time, collections]
         end
 
         def metrics
           {
-            :gc_time => consumed_gc_time * 1000,
+            :gc_time => consumed_gc_time,
             :gc_calls => collections
           }
         end

data/lib/time_bandits/time_consumers/mem_cache.rb

@@ -4,26 +4,23 @@
 #   time_bandit TimeBandits::TimeConsumers::MemCache
 #
 require 'time_bandits/monkey_patches/memcache-client'
+
 module TimeBandits
   module TimeConsumers
-    class MemCache
-      class << self
-        def reset
-          ::MemCache.reset_benchmarks
-        end
-
-        def consumed
-          ::MemCache.get_benchmarks.first
-        end
-
-        def runtime
-          ::MemCache.cache_runtime
-        end
+    class Memcache < BaseConsumer
+      prefix :memcache
+      fields :time, :calls, :misses
+      format "MC: %.3f(%dr,%dm)", :time, :calls, :misses
 
-        def metrics
-          ::MemCache.metrics
+      class Subscriber < ActiveSupport::LogSubscriber
+        def get(event)
+          i = Memcache.instance
+          i.time += event.duration
+          i.calls += 1
+          i.misses += event.payload[:misses]
         end
       end
+      Subscriber.attach_to :memcache
     end
   end
 end

data/lib/time_bandits/time_consumers/memcached.rb

@@ -4,26 +4,31 @@
 #   time_bandit TimeBandits::TimeConsumers::Memcached
 #
 require 'time_bandits/monkey_patches/memcached'
+
 module TimeBandits
   module TimeConsumers
-    class Memcached
-      class << self
-        def reset
-          ::Memcached.reset_benchmarks
-        end
+    class Memcached < BaseConsumer
+      prefix :memcache
+      fields :time, :calls, :misses, :reads, :writes
+      format "MC: %.3f(%dr,%dm,%dw,%dc)", :time, :reads, :misses, :writes, :calls
 
-        def consumed
-          ::Memcached.get_benchmarks.first
+      class Subscriber < ActiveSupport::LogSubscriber
+        def get(event)
+          i = Memcached.instance
+          i.time += event.duration
+          i.calls += 1
+          payload = event.payload
+          i.reads += payload[:reads]
+          i.misses += payload[:misses]
         end
-
-        def runtime
-          ::Memcached.cache_runtime
-        end
-
-        def metrics
-          ::Memcached.metrics
+        def set(event)
+          i = Memcached.instance
+          i.time += event.duration
+          i.calls += 1
+          i.writes += 1
         end
       end
+      Subscriber.attach_to :memcached
     end
   end
 end

data/lib/time_bandits/version.rb

@@ -1,3 +1,3 @@
 module TimeBandits
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require 'test/unit'
+require 'mocha/setup'
+require 'active_support/testing/declarative'
+
+require 'minitest/pride'
+
+class Test::Unit::TestCase
+  extend ActiveSupport::Testing::Declarative
+end
+
+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)
+  end
+end

data/test/unit/active_support_notifications_test.rb

@@ -0,0 +1,64 @@
+require_relative '../test_helper'
+require 'active_support/notifications'
+require 'active_support/log_subscriber'
+require 'thread_variables/access'
+
+class ActiveSupportNotificationsTest < Test::Unit::TestCase
+  class SimpleConsumer < TimeBandits::TimeConsumers::BaseConsumer
+    prefix :simple
+    fields :time, :calls
+    format "Simple: %.1fms(%d calls)", :time, :calls
+
+    class Subscriber < ActiveSupport::LogSubscriber
+      def work(event)
+        i = SimpleConsumer.instance
+        i.time += event.duration
+        i.calls += 1
+      end
+    end
+    Subscriber.attach_to :simple
+  end
+
+  def setup
+    TimeBandits.time_bandits = []
+    TimeBandits.add SimpleConsumer
+    TimeBandits.reset
+  end
+
+  test "getting metrics" do
+    assert_equal({:simple_calls => 0, :simple_time => 0}, TimeBandits.metrics)
+  end
+
+  test "formatting" do
+    assert_equal "Simple: 0.0ms(0 calls)", TimeBandits.runtime
+  end
+
+  test "foreground work gets accounted for in milliseconds" 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[:simple_calls]
+    assert_equal 0, m[:simple_time]
+  end
+
+  private
+  def work
+    2.times do
+      ActiveSupport::Notifications.instrument("work.simple") { sleep 0.1 }
+    end
+  end
+  def check_work
+    m = TimeBandits.metrics
+    assert_equal 2, m[:simple_calls]
+    assert 200 < m[:simple_time]
+    assert 300 > m[:simple_time]
+    assert_equal m[:simple_time], TimeBandits.consumed
+  end
+end

data/test/unit/base_test.rb

@@ -0,0 +1,63 @@
+require_relative '../test_helper'
+
+class NoTimeBanditsTest < Test::Unit::TestCase
+  def setup
+    TimeBandits.time_bandits = []
+  end
+
+  test "getting list of all time bandits" do
+    assert_equal [], TimeBandits.time_bandits
+    test_clean_state
+  end
+
+  test "reset" do
+    assert_nothing_raised { TimeBandits.reset }
+    test_clean_state
+  end
+
+  test "benchmarking" do
+    logger = mock("logger")
+    logger.expects(:info)
+    TimeBandits.benchmark("foo", logger) { }
+    test_clean_state
+  end
+
+  private
+  def test_clean_state
+    assert_equal Hash.new, TimeBandits.metrics
+    assert_equal 0, TimeBandits.consumed
+    assert_equal "", TimeBandits.runtime
+  end
+end
+
+class DummyConsumerTest < Test::Unit::TestCase
+  module DummyConsumer
+    extend self
+    def consumed; 0; end
+    def runtime; "Dummy: 0ms"; end
+    def metrics; {:dummy_time => 0, :dummy_calls => 0}; end
+    def reset; end
+  end
+
+  def setup
+    TimeBandits.time_bandits = []
+    TimeBandits.add DummyConsumer
+  end
+
+  test "getting list of all time bandits" do
+    assert_equal [DummyConsumer], TimeBandits.time_bandits
+  end
+
+  test "adding consumer a second time does not change the list of time bandits" do
+    TimeBandits.add DummyConsumer
+    assert_equal [DummyConsumer], TimeBandits.time_bandits
+  end
+
+  test "reset" do
+    assert_nothing_raised { TimeBandits.reset }
+  end
+
+  test "getting metrics" do
+    assert_equal({:dummy_time => 0, :dummy_calls => 0}, TimeBandits.metrics)
+  end
+end

data/test/unit/memcached_test.rb

@@ -0,0 +1,60 @@
+require_relative '../test_helper'
+
+class MemcachedTest < Test::Unit::TestCase
+  def setup
+    TimeBandits.time_bandits = []
+    TimeBandits.add TimeBandits::TimeConsumers::Memcached
+    TimeBandits.reset
+    @cache = Memcached.new
+  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
+    assert_equal "MC: 0.000(0r,0m,0w,0c)", 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
+    2.times do
+      @cache.get("foo")
+      @cache.set("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/time_bandits.gemspec

@@ -20,5 +20,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency("thread_variables")
   s.add_runtime_dependency("activesupport", [">= 2.3.2"])
   s.add_development_dependency("rake")
+  s.add_development_dependency("mocha")
+  s.add_development_dependency("ansi")
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_bandits
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Stefan Kaes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-21 00:00:00.000000000 Z
+date: 2013-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,34 @@ dependencies:
   type: :development
   prerelease: false
   name: rake
+- !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: mocha
+- !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: ansi
 description: Rails Completed Line on Steroids
 email:
 - skaes@railsexpress.de
@@ -65,25 +93,27 @@ files:
 - 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/rack/logger.rb
 - lib/time_bandits/rack/logger40.rb
 - lib/time_bandits/railtie.rb
+- lib/time_bandits/time_consumers/base_consumer.rb
+- lib/time_bandits/time_consumers/dalli.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
+- test/test_helper.rb
+- test/unit/active_support_notifications_test.rb
+- test/unit/base_test.rb
+- test/unit/memcached_test.rb
 - time_bandits.gemspec
 homepage: https://github.com/skaes/time_bandits/
 licenses: []
@@ -108,4 +138,8 @@ rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
 summary: Custom performance logging for Rails
-test_files: []
+test_files:
+- test/test_helper.rb
+- test/unit/active_support_notifications_test.rb
+- test/unit/base_test.rb
+- test/unit/memcached_test.rb