time_bandits 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35f89fba835aab0fa8499beaa01ec8f407d8f91c
-  data.tar.gz: 89209eb4f594b1365907ee4d0c3f2206595f35af
+  metadata.gz: 1c02c0496a8f416f2a02bd4ca1c95d45c5f16d72
+  data.tar.gz: fae74e56ca2de98be7cd3baffea5e55c960d795e
 SHA512:
-  metadata.gz: 17989ad515a1eae58cae1b6410ad20726852d3e8c12fbdd45c0c1ed3a001ea2b02b1024eb37b72ad4519c8a5015fe41848c00f75cbf29c98d38f703c59937bf4
-  data.tar.gz: de288045a8ff9f03503485a24b63a138d68e024ff2cbf232cad1ef927e45b19371cf77980243fa2c23283a1559bf7bcf94f74896a153aa5ddc085cd432ea7f39
+  metadata.gz: 8667e3d1e7469130c909bdd62b6e28cda05ff499eef7c94cef32967e689405e5e7e4021151c8afb690d1e401886aae58df3d08624eed42f2abea4fc7f9379ee1
+  data.tar.gz: 4e44865ab865d5406190c7437323ec2f0f3bd957ccd8296c7293cfe27bca26e5d39bdc5cdf8b017c5fd11f4115846cf62c963674187dd4692c64b7d35cdf35b6

data/README.rdoc

@@ -80,10 +80,13 @@ changed so much of the code that is is practically a full rewrite, hence we chan
 
 == Running Tests
 
-In order for the test to run you need a running memcached and redis-server
+In order for the test to run you need a running memcached, redis-server and mysql
 
 == Release Notes
 
+version 0.7.1
+  - support measuring sequel gem
+
 version 0.7.0
    - switched to byebug (debugger does not fully support 2.0 and 2.1 not at all)
    - adapted garbage collection statistics to work for 2.1

data/lib/time_bandits.rb

@@ -15,6 +15,7 @@ module TimeBandits
     autoload :Memcached,         'time_bandits/time_consumers/memcached'
     autoload :Dalli,             'time_bandits/time_consumers/dalli'
     autoload :Redis,             'time_bandits/time_consumers/redis'
+    autoload :Sequel,            'time_bandits/time_consumers/sequel'
   end
 
   require 'time_bandits/railtie' if defined?(Rails) && Rails::VERSION::STRING >= "3.0"
@@ -44,8 +45,12 @@ module TimeBandits
   end
 
   def self.metrics
-    metrics = {}
-    time_bandits.each{|b| metrics.merge! b.metrics}
+    metrics = Hash.new(0)
+    time_bandits.each do |bandit|
+      bandit.metrics.each do |k,v|
+        metrics[k] += v
+      end
+    end
     metrics
   end
 

data/lib/time_bandits/monkey_patches/sequel.rb

@@ -0,0 +1,19 @@
+require 'sequel'
+
+major, minor, _ = Sequel.version.split('.').map(&:to_i)
+if major < 4 || (major == 4 && minor < 15)
+  raise "time_bandits Sequel monkey patch is not compatible with your sequel version"
+end
+
+Sequel::Database.class_eval do
+  alias :_orig_log_yield :log_yield
+
+  def log_yield(*args)
+    begin
+      start = Time.now
+      _orig_log_yield(args) { yield if block_given? }
+    ensure
+      ActiveSupport::Notifications.instrument('duration.sequel', durationInSeconds: Time.now - start)
+    end
+  end
+end

data/lib/time_bandits/time_consumers/sequel.rb

@@ -0,0 +1,25 @@
+# a time consumer implementation for sequel
+# install into application_controller.rb with the line
+#
+#   time_bandit TimeBandits::TimeConsumers::Sequel
+#
+require 'time_bandits/monkey_patches/sequel'
+
+module TimeBandits
+  module TimeConsumers
+    class Sequel < BaseConsumer
+      prefix :db
+      fields :time, :calls
+      format "Sequel: %.3fms(%dq)", :time, :calls
+
+      class Subscriber < ActiveSupport::LogSubscriber
+        def duration(event)
+          i = Sequel.instance
+          i.time  += (event.payload[:durationInSeconds] * 1000)
+          i.calls += 1
+        end
+      end
+      Subscriber.attach_to(:sequel)
+    end
+  end
+end

data/lib/time_bandits/version.rb

@@ -1,3 +1,3 @@
 module TimeBandits
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

data/test/unit/duplicate_bandits.rb

@@ -0,0 +1,58 @@
+require_relative '../test_helper'
+
+class DuplicateBandits < Test::Unit::TestCase
+  class FooConsumer < TimeBandits::TimeConsumers::BaseConsumer
+    prefix :simple
+    fields :time, :calls
+    format "SimpleFoo: %.1fms(%d calls)", :time, :calls
+  end
+
+  class BarConsumer < TimeBandits::TimeConsumers::BaseConsumer
+    prefix :simple
+    fields :time, :calls
+    format "SimpleBar: %.1fms(%d calls)", :time, :calls
+  end
+
+  def setup
+    TimeBandits.time_bandits = []
+    TimeBandits.add FooConsumer
+    TimeBandits.add BarConsumer
+    TimeBandits.reset
+  end
+
+  test "nothing measured" do
+    assert_equal({
+      :simple_time => 0,
+      :simple_calls => 0
+    }, TimeBandits.metrics)
+  end
+
+  test "only one consumer measured sth (the one)" do
+    FooConsumer.instance.calls = 3
+    FooConsumer.instance.time  = 0.123
+    assert_equal({
+      :simple_time => 0.123,
+      :simple_calls => 3
+    }, TimeBandits.metrics)
+  end
+
+  test "only one consumer measured sth (the other)" do
+    BarConsumer.instance.calls = 2
+    BarConsumer.instance.time  = 0.321
+    assert_equal({
+      :simple_time => 0.321,
+      :simple_calls => 2
+    }, TimeBandits.metrics)
+  end
+
+  test "both consumer measured sth" do
+    FooConsumer.instance.calls = 3
+    FooConsumer.instance.time  = 0.123
+    BarConsumer.instance.calls = 2
+    BarConsumer.instance.time  = 0.321
+    assert_equal({
+      :simple_time => 0.444,
+      :simple_calls => 5
+    }, TimeBandits.metrics)
+  end
+end

data/test/unit/sequel_test.rb

@@ -0,0 +1,43 @@
+require_relative '../test_helper'
+require 'sequel'
+
+class SequelTest < Test::Unit::TestCase
+  def setup
+    TimeBandits.time_bandits = []
+    TimeBandits.add TimeBandits::TimeConsumers::Sequel
+    TimeBandits.reset
+  end
+
+  test "getting metrics" do
+    nothing_measured = {
+      :db_time => 0,
+      :db_calls => 0
+    }
+    assert_equal nothing_measured, metrics
+  end
+
+  test "formatting" do
+    bandit.calls = 3
+    assert_equal "Sequel: 0.000ms(3q)", TimeBandits.runtime
+  end
+
+  test "metrics" do
+    (1..4).each { sequel['SELECT 1'].all }
+
+    assert_equal 6, metrics[:db_calls] # +2 for set wait_timeout and set SQL_AUTO_IS_NULL=0
+    assert 0 < metrics[:db_time]
+    assert_equal metrics[:db_time], TimeBandits.consumed
+  end
+
+  def sequel
+    @sequel ||= Sequel.connect('mysql2://localhost:3601')
+  end
+
+  def metrics
+    TimeBandits.metrics
+  end
+
+  def bandit
+    TimeBandits::TimeConsumers::Sequel.instance
+  end
+end

data/time_bandits.gemspec

@@ -26,6 +26,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency("dalli")
   s.add_development_dependency("redis")
   s.add_development_dependency("memcached")
+  s.add_development_dependency("sequel")
+  s.add_development_dependency("mysql2")
   s.add_development_dependency("minitest", '~> 4.7.5')
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_bandits
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Stefan Kaes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-02 00:00:00.000000000 Z
+date: 2014-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thread_variables
@@ -122,6 +122,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -146,7 +174,6 @@ files:
 - ".gitignore"
 - Gemfile
 - README.rdoc
-- README_RAILS2.rdoc
 - Rakefile
 - TODO
 - lib/time_bandits.rb
@@ -156,6 +183,7 @@ files:
 - 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/monkey_patches/sequel.rb
 - lib/time_bandits/rack/logger.rb
 - lib/time_bandits/rack/logger40.rb
 - lib/time_bandits/railtie.rb
@@ -167,15 +195,18 @@ files:
 - 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/time_consumers/sequel.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/duplicate_bandits.rb
 - test/unit/gc_consumer_test.rb
 - test/unit/memcached_test.rb
 - test/unit/redis_test.rb
+- test/unit/sequel_test.rb
 - time_bandits.gemspec
 homepage: https://github.com/skaes/time_bandits/
 licenses:
@@ -206,6 +237,8 @@ test_files:
 - test/unit/active_support_notifications_test.rb
 - test/unit/base_test.rb
 - test/unit/dalli_test.rb
+- test/unit/duplicate_bandits.rb
 - test/unit/gc_consumer_test.rb
 - test/unit/memcached_test.rb
 - test/unit/redis_test.rb
+- test/unit/sequel_test.rb

data/README_RAILS2.rdoc

@@ -1,98 +0,0 @@
-= 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.
-