strumbar 0.0.3 → 0.1.0

data/README.md

@@ -20,13 +20,23 @@ Or install it yourself as:
 ## Usage
 
 
-Configuration:
+Configuration (all options shown with default values):
 
 ``` ruby
 Strumbar.configure do |config|
-  config.port = 80
-  config.host = 'instrument.majorleaguegaming.com'
-  config.application = 'instrument'
+
+  # Application name as it should be stored by your Statsd backend.
+  config.application = 'statsd_appname'
+
+  # Statsd hostname
+  config.host = 'statsd.appname.example'
+
+  # Statsd port
+  config.port = 8125
+
+  # Default sample rate for all events.
+  config.default_rate = 1
+
 end
 ```
 
@@ -66,7 +76,19 @@ loading default instrumentation subscriptions.  Currently, this list includes:
 - ActiveRecord
 - Redis
 
-More default instrumentation defaults will be added.
+Alternatively, you can choose specific instrumentations to load
+and set your own sample rates for each by passing a block to config.instrumentation, like so:
+
+``` ruby
+Strumbar.configure do |config|
+  config.instrumentation do
+    Strumbar::Instrumentation::ActionController.load rate: 0.5
+    Strumbar::Instrumentation::ActiveRecord.load
+    Strumbar::Instrumentation::Redis.load
+
+    AppName::Instrumentation::ThirdPartyInstrument.load rate: 0.8
+  end
+end
 
 ## Authors
 

data/lib/strumbar/client.rb

@@ -7,15 +7,15 @@ module Strumbar
       @port = port
     end
 
-    def timing stat, time, sample_rate = 1
+    def timing stat, time, sample_rate = Strumbar.default_rate
       super "#{Strumbar.application}.#{stat}", time, sample_rate
     end
 
-    def increment stat, sample_rate = 1
+    def increment stat, sample_rate = Strumbar.default_rate
       super "#{Strumbar.application}.#{stat}", sample_rate
     end
 
-    def decrement stat, sample_rate = 1
+    def decrement stat, sample_rate = Strumbar.default_rate
       super "##{Strumbar.application}.#{stat}", sample_rate
     end
   end

data/lib/strumbar/configuration.rb

@@ -1,5 +1,13 @@
 module Strumbar
   class Configuration
-    attr_accessor :port, :host, :application
+    attr_accessor :port,
+                  :host,
+                  :application,
+                  :default_rate,
+                  :custom_load
+
+    def instrumentation(&block)
+      @custom_load = block
+    end
   end
 end

data/lib/strumbar/instrumentation/action_controller.rb

@@ -1,15 +1,17 @@
 module Strumbar
   module Instrumentation
     module ActionController
-      def self.load
+      def self.load(options={})
+        options[:rate] ||= Strumbar.default_rate
+
         Strumbar.subscribe /process_action.action_controller/ do |client, event|
           key = "#{event.payload[:controller]}.#{event.payload[:action]}"
 
-          client.timing     "#{key}.total_time", event.duration
-          client.timing     "#{key}.view_time",  event.payload[:view_runtime]
-          client.timing     "#{key}.db_time",    event.payload[: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.increment  "#{key}.status.#{event.payload[:status]}"
+          client.increment  "#{key}.status.#{event.payload[:status]}", options[:rate]
         end
       end
     end

data/lib/strumbar/instrumentation/active_record.rb

@@ -1,9 +1,11 @@
 module Strumbar
   module Instrumentation
     module ActiveRecord
-      def self.load
+      def self.load(options={})
+        options[:rate] ||= Strumbar.default_rate
+
         Strumbar.subscribe /sql.active_record/ do |client, event|
-          client.timing 'query_log', event.duration
+          client.timing 'query_log', event.duration, options[:rate]
         end
       end
     end

data/lib/strumbar/instrumentation/redis.rb

@@ -1,10 +1,12 @@
 module Strumbar
   module Instrumentation
     module Redis
-      def self.load
+      def self.load(options={})
+        options[:rate] ||= Strumbar.default_rate
+
         Strumbar.subscribe 'query.redis' do |client, event|
-          client.increment 'query.redis'
-          client.increment 'failure.redis' if event.payload[:failure]
+          client.increment 'query.redis', options[:rate]
+          client.increment('failure.redis', options[:rate]) if event.payload[:failure]
 
           command = case event.payload[:command]
             when NilClass then nil
@@ -14,7 +16,7 @@ module Strumbar
 
           command.gsub!(/:/, '_') unless command.nil?
 
-          client.timing "#{command}.redis", event.duration
+          client.timing "#{command}.redis", event.duration, options[:rate]
         end
 
         unless ::Redis::Client.instance_methods.include? :call_with_instrumentation

data/lib/strumbar/instrumentation.rb

@@ -5,9 +5,15 @@ module Strumbar
     autoload :ActiveRecord, 'strumbar/instrumentation/active_record'
 
     def self.load
-      Strumbar::Instrumentation::ActionController.load if defined? ::ActionController
-      Strumbar::Instrumentation::ActiveRecord.load if defined? ::ActiveRecord
-      Strumbar::Instrumentation::Redis.load if defined? ::Redis
+      custom_load = Strumbar.configuration.custom_load
+
+      if custom_load
+        custom_load.call
+      else
+        Strumbar::Instrumentation::ActionController.load if defined?(::ActionController)
+        Strumbar::Instrumentation::ActiveRecord.load if defined?(::ActiveRecord)
+        Strumbar::Instrumentation::Redis.load if defined?(::Redis)
+      end
     end
   end
 end

data/lib/strumbar/version.rb

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

data/lib/strumbar.rb

@@ -29,7 +29,11 @@ module Strumbar
     end
 
     def application
-      configuration.try(:application) || 'my_awesome_app'
+      configuration.try(:application) || 'statsd_appname'
+    end
+
+    def default_rate
+      configuration.try(:default_rate) || 1
     end
 
     def subscribe identifier

data/spec/instrumentation/redis_spec.rb

@@ -27,7 +27,7 @@ describe Strumbar::Instrumentation::Redis do
   end
 
   it 'subscribes to query.redis notifications' do
-    Strumbar.client.should_receive(:increment).with('query.redis')
+    Strumbar.client.should_receive(:increment).with('query.redis', 1)
     Strumbar.strum 'query.redis', {}
   end
 
@@ -35,4 +35,20 @@ describe Strumbar::Instrumentation::Redis do
     client = Redis::Client.new
     client.call 'foo'
   end
+
+  context 'with a user-defined redis sample rate' do
+    before do
+      Strumbar.configure do |config|
+        c.instrumentation do
+          Strumbar::Instrumentation::Redis.load rate: 0.5
+        end
+      end
+
+      it 'subscribes to query.redis notifications' do
+        Strumbar.client.should_receive(:increment).with('query.redis', 0.5)
+        Strumbar.strum 'query.redis', {}
+      end
+
+    end
+  end
 end

data/spec/instrumentation_spec.rb

@@ -6,51 +6,100 @@ describe Strumbar::Instrumentation do
       Object.send :remove_const, klass
     end
 
-    it 'loads the ActionController subscription if ActionController is defined' do
+    context 'without a custom instrumentation loader' do
+      before do
+        Strumbar.configure do |config|
+        end
+      end
 
-      ActionController = true
+      it 'loads the ActionController subscription if ActionController is defined' do
 
-      Strumbar::Instrumentation::ActionController.should_receive :load
-      Strumbar::Instrumentation.load
+        ActionController = true
 
-      undefine :ActionController
-    end
+        Strumbar::Instrumentation::ActionController.should_receive :load
+        Strumbar::Instrumentation.load
 
-    it 'does not load ActionController subscription if not defined' do
-      Strumbar::Instrumentation::ActionController.should_not_receive :load
-      Strumbar::Instrumentation.load
-    end
+        undefine :ActionController
+      end
 
-    it 'loads the ActiveRecord subscription if ActiveRecord is loaded' do
-      ActiveRecord = true
+      it 'does not load ActionController subscription if not defined' do
+        Strumbar::Instrumentation::ActionController.should_not_receive :load
+        Strumbar::Instrumentation.load
+      end
 
-      Strumbar::Instrumentation::ActiveRecord.should_receive :load
-      Strumbar::Instrumentation.load
+      it 'loads the ActiveRecord subscription if ActiveRecord is loaded' do
+        ActiveRecord = true
 
-      undefine :ActiveRecord
-    end
+        Strumbar::Instrumentation::ActiveRecord.should_receive :load
+        Strumbar::Instrumentation.load
 
-    it 'does not load ActiveRecord subscription if not defined' do
-      Strumbar::Instrumentation::ActiveRecord.should_not_receive :load
-      Strumbar::Instrumentation.load
-    end
+        undefine :ActiveRecord
+      end
+
+      it 'does not load ActiveRecord subscription if not defined' do
+        Strumbar::Instrumentation::ActiveRecord.should_not_receive :load
+        Strumbar::Instrumentation.load
+      end
 
-    it 'loads the Redis subscription if Redis is defined' do
-      class Redis
-        class Client
-          def process ; end
+      it 'loads the Redis subscription if Redis is defined' do
+        class Redis
+          class Client
+            def process ; end
+          end
         end
+
+        Strumbar::Instrumentation::Redis.should_receive :load
+        Strumbar::Instrumentation.load
+
+        undefine :Redis
       end
 
-      Strumbar::Instrumentation::Redis.should_receive :load
-      Strumbar::Instrumentation.load
+      it 'does not load Redis subscription if not defined' do
+        Strumbar::Instrumentation::Redis.should_not_receive :load
+        Strumbar::Instrumentation.load
+      end
 
-      undefine :Redis
     end
 
-    it 'does not load Redis subscription if not defined' do
-      Strumbar::Instrumentation::Redis.should_not_receive :load
-      Strumbar::Instrumentation.load
+    context 'with a custom instrumentations loader' do
+      before do
+        Strumbar.configure do |config|
+          config.instrumentation do
+            Strumbar::Instrumentation::ActionController.load
+          end
+        end
+      end
+
+      it 'does load the ActionController subscription' do
+        ActionController = true
+        Strumbar::Instrumentation::ActionController.should_receive :load
+        Strumbar::Instrumentation.load
+        undefine :ActionController
+      end
+
+      it 'does not load the ActiveRecord subscription even if ActiveRecord is loaded' do
+        ActiveRecord = true
+
+        Strumbar::Instrumentation::ActiveRecord.should_not_receive :load
+        Strumbar::Instrumentation.load
+
+        undefine :ActiveRecord
+      end
+
+      it 'does not load the Redis subscription even if Redis is defined' do
+        class Redis
+          class Client
+            def process ; end
+          end
+        end
+
+        Strumbar::Instrumentation::Redis.should_not_receive :load
+        Strumbar::Instrumentation.load
+
+        undefine :Redis
+      end
+
     end
+
   end
 end

data/spec/strumbar_spec.rb

@@ -59,19 +59,39 @@ describe Strumbar do
     end
   end
 
+  describe 'after #configure' do
+    context 'with default values' do
+      before { Strumbar.configure { } }
+      subject { Strumbar }
+
+      its(:default_rate) { should == 1 }
+    end
+
+    context 'with user values' do
+      before do
+        Strumbar.configure do |config|
+          config.default_rate = 0.5
+        end
+      end
+      subject { Strumbar }
+
+      its(:default_rate) { should == 0.5 }
+    end
+  end
+
   describe "#application" do
     it "returns the configured value" do
-      Strumbar.configure { |c| c.application = "foobar" }
+      Strumbar.configure { |config| config.application = "foobar" }
       Strumbar.application.should == "foobar"
     end
     it "defaults to something comically bad so you'll change it" do
-      Strumbar.application.should == "my_awesome_app"
+      Strumbar.application.should == "statsd_appname"
     end
   end
 
   describe "#host" do
     it "returns the configured value" do
-      Strumbar.configure { |c| c.host = "statsd.app" }
+      Strumbar.configure { |config| config.host = "statsd.app" }
       Strumbar.host.should == "statsd.app"
     end
     it "defaults to localhost" do
@@ -81,7 +101,7 @@ describe Strumbar do
 
   describe "#port" do
     it "returns the configured port" do
-      Strumbar.configure { |c| c.port = 9999 }
+      Strumbar.configure { |config| config.port = 9999 }
       Strumbar.port.should == 9999
     end
     it "defaults to 8125" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strumbar
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-06 00:00:00.000000000 Z
+date: 2012-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70199312049800 !ruby/object:Gem::Requirement
+  requirement: &70333463715220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70199312049800
+  version_requirements: *70333463715220
 - !ruby/object:Gem::Dependency
   name: statsd
-  requirement: &70199312048940 !ruby/object:Gem::Requirement
+  requirement: &70333463714500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70199312048940
+  version_requirements: *70333463714500
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70199312064100 !ruby/object:Gem::Requirement
+  requirement: &70333463713740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70199312064100
+  version_requirements: *70333463713740
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70199312060980 !ruby/object:Gem::Requirement
+  requirement: &70333463713100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70199312060980
+  version_requirements: *70333463713100
 description: An instrumentation utility.
 email:
 - anordman@majorleaguegaming.com
@@ -97,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -952329107978031015
+      hash: -4086101781260081787
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -106,10 +106,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -952329107978031015
+      hash: -4086101781260081787
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Helper library to strum along in your application.