strumbar 0.1.0 → 0.2.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Andrew Nordman
+Copyright (c) 2012-2013 Andrew Nordman
 
 MIT License
 

data/README.md

@@ -90,6 +90,8 @@ Strumbar.configure do |config|
   end
 end
 
+```
+
 ## Authors
 
 Written by [Andrew Nordman](https://github.com/cadwallion) and [Matthew Wilson](https://github.com/hypomodern)

data/lib/strumbar/client.rb

@@ -1,7 +1,7 @@
 require 'statsd'
 
 module Strumbar
-  class Client < ::Statsd::Client
+  class Client < ::Statsd
     def initialize host, port
       @host = host
       @port = port

data/lib/strumbar/instrumentation/action_controller.rb

@@ -3,13 +3,15 @@ module Strumbar
     module ActionController
       def self.load(options={})
         options[:rate] ||= Strumbar.default_rate
+        using_mongoid = options.fetch(:mongoid, false)
 
         Strumbar.subscribe /process_action.action_controller/ do |client, event|
           key = "#{event.payload[:controller]}.#{event.payload[:action]}"
+          db_runtime_key = using_mongoid ? :mongo_runtime : :db_runtime
 
           client.timing     "#{key}.total_time", event.duration, options[:rate]
           client.timing     "#{key}.view_time",  event.payload[:view_runtime], options[:rate]
-          client.timing     "#{key}.db_time",    event.payload[:db_runtime], options[:rate]
+          client.timing     "#{key}.db_time",    event.payload[db_runtime_key], options[:rate]
 
           client.increment  "#{key}.status.#{event.payload[:status]}", options[:rate]
         end

data/lib/strumbar/instrumentation/mongoid/controller_runtime.rb

@@ -0,0 +1,46 @@
+module Strumbar
+  module Instrumentation
+    module Mongoid
+      # Seems a little out of scope for Strumbar, but honestly you're probably going to want
+      # this if you want to get anything out of instrumenting Mongoid.
+      module ControllerRuntime
+        extend ActiveSupport::Concern
+
+        protected
+
+        attr_internal :mongo_runtime
+
+        def time_tracker
+          Strumbar::Instrumentation::Mongoid::RuntimeTracker
+        end
+
+        def process_action action, *args
+          time_tracker.reset
+          super
+        end
+
+        def cleanup_view_runtime
+          mongo_rt_before_render = time_tracker.reset
+          runtime = super
+          mongo_rt_after_render = time_tracker.reset
+          self.mongo_runtime = mongo_rt_before_render + mongo_rt_after_render
+
+          runtime - mongo_rt_after_render
+        end
+
+        def append_info_to_payload payload
+          super
+          payload[:mongo_runtime] = mongo_runtime
+        end
+
+        module ClassMethods
+          def log_process_action payload
+            messages, mongo_runtime = super, payload[:mongo_runtime]
+            messages << ("Mongo: %.1fms" % mongo_runtime.to_f) if mongo_runtime
+            messages
+          end
+        end
+      end
+    end
+  end
+end

data/lib/strumbar/instrumentation/mongoid/runtime_tracker.rb

@@ -0,0 +1,34 @@
+module Strumbar
+  module Instrumentation
+    module Mongoid
+      # This is basically how ActiveRecord instruments this, although they use a LogSubscriber,
+      # for no adequately explained reason. I'm not sure if we should include the controller mixin
+      # in Strumbar or not? Seems simultaneously in and out of scope.
+      class RuntimeTracker
+        RUNTIME_KEY = 'Mongoid::RuntimeTracker#runtime'
+        COUNT_KEY = 'Mongoid::RuntimeTracker#count'
+
+        def self.runtime= value
+          Thread.current[RUNTIME_KEY] = value
+        end
+
+        def self.runtime
+          Thread.current[RUNTIME_KEY] ||= 0
+        end
+
+        def self.count= value
+          Thread.current[COUNT_KEY] = value
+        end
+
+        def self.count
+          Thread.current[COUNT_KEY] ||= 0
+        end
+
+        def self.reset
+          time, self.runtime, self.count = runtime, 0, 0
+          time
+        end
+      end
+    end
+  end
+end

data/lib/strumbar/instrumentation/mongoid.rb

@@ -0,0 +1,42 @@
+require 'strumbar/instrumentation/mongoid/runtime_tracker'
+require 'strumbar/instrumentation/mongoid/controller_runtime'
+
+module Strumbar
+  module Instrumentation
+    module Mongoid
+      CALLS_TO_BE_INSTRUMENTED = [ :read, :write ]
+
+      def self.load(options={})
+        options[:rate] ||= Strumbar.default_rate
+
+        Strumbar.subscribe 'mongo.mongoid' do |client, event|
+          RuntimeTracker.runtime += event.duration
+          RuntimeTracker.count   += 1
+        end
+
+        if defined?(::ActionController)
+          ActiveSupport.on_load(:action_controller) do
+            include ControllerRuntime
+          end
+        end
+
+        unless ::Moped::Connection.instance_methods.include? :read_with_instrumentation
+          ::Moped::Connection.module_eval do
+            CALLS_TO_BE_INSTRUMENTED.each do |method|
+              class_eval <<-CODE, __FILE__, __LINE__ + 1
+                def #{method}_with_instrumentation(*args, &block)
+                  Strumbar.strum 'mongo.mongoid', name: "#{method}" do
+                    #{method}_without_instrumentation(*args, &block)
+                  end
+                end
+              CODE
+
+              alias_method_chain method, :instrumentation
+            end
+          end
+        end
+      end # of self.load
+
+    end
+  end
+end

data/lib/strumbar/instrumentation.rb

@@ -1,8 +1,9 @@
 module Strumbar
   module Instrumentation
-    autoload :Redis, 'strumbar/instrumentation/redis'
     autoload :ActionController, 'strumbar/instrumentation/action_controller'
     autoload :ActiveRecord, 'strumbar/instrumentation/active_record'
+    autoload :Mongoid, 'strumbar/instrumentation/mongoid'
+    autoload :Redis, 'strumbar/instrumentation/redis'
 
     def self.load
       custom_load = Strumbar.configuration.custom_load
@@ -12,6 +13,7 @@ module Strumbar
       else
         Strumbar::Instrumentation::ActionController.load if defined?(::ActionController)
         Strumbar::Instrumentation::ActiveRecord.load if defined?(::ActiveRecord)
+        Strumbar::Instrumentation::Mongoid.load if defined?(::Mongoid)
         Strumbar::Instrumentation::Redis.load if defined?(::Redis)
       end
     end

data/lib/strumbar/version.rb

@@ -1,3 +1,3 @@
 module Strumbar
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/instrumentation/mongoid/controller_runtime_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+class AbstractHarness
+  def process_action action, *args
+    "Processed."
+  end
+
+  def append_info_to_payload payload
+    payload
+  end
+
+  def self.log_process_action payload
+    []
+  end
+end
+
+module Strumbar
+  module Instrumentation
+    module Mongoid
+      describe ControllerRuntime do
+        let(:test_harness) {
+          Class.new(AbstractHarness) do
+            include ControllerRuntime
+
+            public :time_tracker, :process_action, :append_info_to_payload
+          end
+        }
+
+        describe "#time_tracker" do
+          it "is a convenient way access the RuntimeTracker class" do
+            test_harness.new.time_tracker.should == RuntimeTracker
+          end
+        end
+
+        describe "#process_action" do
+          it "resets the tracker" do
+            test_harness.new.time_tracker.runtime = 1000
+
+            test_harness.new.process_action :my_action
+            test_harness.new.time_tracker.runtime.should == 0
+          end
+        end
+
+        describe ".log_process_action" do
+          it "adds the Mongo runtime to the list of messages to be logged" do
+            messages = test_harness.log_process_action({ mongo_runtime: 1000 })
+            messages.should == ["Mongo: 1000.0ms"]
+          end
+        end
+
+      end
+    end
+  end
+end

data/spec/instrumentation/mongoid/runtime_tracker_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+module Strumbar
+  module Instrumentation
+    module Mongoid
+      describe RuntimeTracker do
+        %w(runtime count).each do |attribute|
+          describe ".#{attribute}" do
+            it "is a class attribute" do
+              RuntimeTracker.send("#{attribute}=", 100)
+              RuntimeTracker.send(attribute).should == 100
+            end
+          end
+        end
+      end
+
+      describe ".reset" do
+        it "returns the current runtime" do
+          RuntimeTracker.runtime = 1500
+
+          RuntimeTracker.reset.should == 1500
+        end
+
+        it "resets the count and runtime attributes" do
+          RuntimeTracker.runtime = 1000
+          RuntimeTracker.count = 2
+
+          RuntimeTracker.reset
+          RuntimeTracker.runtime.should == 0
+          RuntimeTracker.count.should == 0
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,10 @@
 $:.push File.join(File.dirname(__FILE__), '..', 'lib')
 
+# fake a Rails implementation detail
+class Module
+  def attr_internal name
+    attr_accessor name
+  end
+end
+
 require 'strumbar'

data/strumbar.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.version       = Strumbar::VERSION
 
   gem.add_dependency 'activesupport'
-  gem.add_dependency 'statsd'
+  gem.add_dependency 'statsd-ruby'
 
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'rake'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strumbar
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-10 00:00:00.000000000 Z
+date: 2013-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70333463715220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70333463715220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: statsd
-  requirement: &70333463714500 !ruby/object:Gem::Requirement
+  name: statsd-ruby
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +38,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70333463714500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70333463713740 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +54,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70333463713740
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70333463713100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +70,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70333463713100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: An instrumentation utility.
 email:
 - anordman@majorleaguegaming.com
@@ -76,8 +96,13 @@ files:
 - lib/strumbar/instrumentation.rb
 - lib/strumbar/instrumentation/action_controller.rb
 - lib/strumbar/instrumentation/active_record.rb
+- lib/strumbar/instrumentation/mongoid.rb
+- lib/strumbar/instrumentation/mongoid/controller_runtime.rb
+- lib/strumbar/instrumentation/mongoid/runtime_tracker.rb
 - lib/strumbar/instrumentation/redis.rb
 - lib/strumbar/version.rb
+- spec/instrumentation/mongoid/controller_runtime_spec.rb
+- spec/instrumentation/mongoid/runtime_tracker_spec.rb
 - spec/instrumentation/redis_spec.rb
 - spec/instrumentation_spec.rb
 - spec/spec_helper.rb
@@ -97,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4086101781260081787
+      hash: 4031522421417010496
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -106,14 +131,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4086101781260081787
+      hash: 4031522421417010496
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Helper library to strum along in your application.
 test_files:
+- spec/instrumentation/mongoid/controller_runtime_spec.rb
+- spec/instrumentation/mongoid/runtime_tracker_spec.rb
 - spec/instrumentation/redis_spec.rb
 - spec/instrumentation_spec.rb
 - spec/spec_helper.rb