canvas_statsd 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59016469f4db4d82cf1461666d4d7454821dc900
-  data.tar.gz: e45d90741f862de134f4e687d029e24f05f17856
+  metadata.gz: 88c09ebe7c39746f6df19a58da9a5edf13097cd7
+  data.tar.gz: eb620ecca522585ccef830258632c8a42dd40040
 SHA512:
-  metadata.gz: e4604014954d5f4a9db66e4de69d6cc97d3fa740dc541558e8bf0f00e4e34a6f0200865ab4d1c3984e432b651932674560a798752aa6465fd2d2a923b46cc29a
-  data.tar.gz: 3d8c4895afaecc1cd100124e0d69aa87a7df6532fc12c67e95350eaca225bd71053730e4d2ea4f33137e0d23c11492d6e666659b937388a837f73359dcef66c9
+  metadata.gz: bd1688d68e7891ff38f7dbc4594c30715cdc823a03d98ccc3ad94134c6f2dc68e896548c15b0d1555dfade7a572eb54b110410415a4af338f90e6aa4867902aa
+  data.tar.gz: c29c8778a1299b4be63a2b95f5cad2ee5a69c3c8562c74175570d805698620f499ffb941f32bedc283af6eb244b04eb4a3010328252cee43f5b7361551271a60

data/lib/canvas_statsd/default_tracking.rb

@@ -2,14 +2,16 @@ module CanvasStatsd
   class DefaultTracking
 
     @ar_counter = CanvasStatsd::Counter.new('ar_counter')
+    @cache_read_counter = CanvasStatsd::Counter.new('cache_read_counter')
     @sql_tracker = CanvasStatsd::SqlTracker.new(blocked_names: ['SCHEMA'])
 
     def self.track_default_metrics(options={})
-      options = {sql: true, active_record: true, logger: nil}.merge(options)
+      options = {sql: true, active_record: true, cache: true, logger: nil}.merge(options)
       @logger = RequestLogger.new(options[:logger])
       track_timing
       track_sql if !!options[:sql]
       track_active_record if !!options[:active_record]
+      track_cache if !!options[:cache]
     end
 
     def self.subscribe type, &block
@@ -23,24 +25,30 @@ module CanvasStatsd
     end
 
     def self.track_timing
-      subscribe(/start_processing.action_controller/) {|*args| start_processing(*args)}
-      subscribe(/process_action.action_controller/) {|*args| finalize_processing(*args)}
+      subscribe(/start_processing\.action_controller/) {|*args| start_processing(*args)}
+      subscribe(/process_action\.action_controller/) {|*args| finalize_processing(*args)}
     end
 
     def self.track_sql
       @tracking_sql = true
-      subscribe(/sql.active_record/) {|*args| update_sql_count(*args)}
+      subscribe(/sql\.active_record/) {|*args| update_sql_count(*args)}
     end
 
     def self.track_active_record
       instrument_active_record_creation
       @tracking_active_record = true
-      subscribe(/instance.active_record/) {|*args| update_active_record_count(*args)}
+      subscribe(/instance\.active_record/) {|*args| update_active_record_count(*args)}
+    end
+
+    def self.track_cache
+      @tracking_cache = true
+      subscribe(/cache_read\.active_support/) {|*args| update_cache_read_count(*args)}
     end
 
     def self.start_processing *args
       @sql_tracker.start
       @ar_counter.start
+      @cache_read_counter.start
     end
 
     def self.update_sql_count name, start, finish, id, payload
@@ -51,12 +59,17 @@ module CanvasStatsd
       @ar_counter.track payload.fetch(:name, '')
     end
 
+    def self.update_cache_read_count name, start, finish, id, payload
+      @cache_read_counter.track "read"
+    end
+
     def self.finalize_processing *args
       request_stat = CanvasStatsd::RequestStat.new(*args)
       request_stat.ar_count = @ar_counter.finalize_count if @tracking_active_record
       request_stat.sql_read_count = @sql_tracker.num_reads if @tracking_sql
       request_stat.sql_write_count = @sql_tracker.num_writes if @tracking_sql
       request_stat.sql_cache_count = @sql_tracker.num_caches if @tracking_sql
+      request_stat.cache_read_count = @cache_read_counter.finalize_count if @tracking_cache
       request_stat.report
       @logger.log(request_stat)
     end

data/lib/canvas_statsd/request_logger.rb

@@ -8,7 +8,8 @@ module CanvasStatsd
         sql_read: :sql_read_count,
         sql_write: :sql_write_count,
         sql_cache: :sql_cache_count,
-        active_record: :ar_count
+        active_record: :ar_count,
+        cache_read: :cache_read_count,
       }.freeze
 
 

data/lib/canvas_statsd/request_stat.rb

@@ -5,6 +5,7 @@ module CanvasStatsd
     attr_accessor :sql_write_count
     attr_accessor :sql_cache_count
     attr_accessor :ar_count
+    attr_accessor :cache_read_count
 
     def initialize(name, start, finish, id, payload, statsd=CanvasStatsd::Statsd)
       @name = name
@@ -25,6 +26,7 @@ module CanvasStatsd
         @statsd.timing("#{common_key}.sql.write", sql_write_count) if sql_write_count
         @statsd.timing("#{common_key}.sql.cache", sql_cache_count) if sql_cache_count
         @statsd.timing("#{common_key}.active_record", ar_count) if ar_count
+        @statsd.timing("#{common_key}.cache.read", cache_read_count) if cache_read_count
       end
     end
 

data/lib/canvas_statsd.rb

@@ -2,6 +2,7 @@ require 'statsd'
 require "aroi" if defined?(ActiveRecord)
 
 module CanvasStatsd
+  VALID_SETTINGS = [:host, :port, :namespace, :append_hostname]
 
   class ConfigurationError < StandardError; end
 
@@ -18,7 +19,21 @@ module CanvasStatsd
   end
 
   def self.settings=(value)
-    @settings = value
+    @settings = validate_settings(value)
+  end
+
+  def self.validate_settings(value)
+    return nil if value.nil?
+
+    validated = {}
+    value.each do |k,v|
+      if !VALID_SETTINGS.include?(k.to_sym)
+        raise CanvasStatsd::ConfigurationError, "Invalid key: #{k}"
+      end
+      validated[k.to_sym] = v
+    end
+
+    env_settings.merge(validated)
   end
 
   def self.env_settings(env=ENV)

data/spec/canvas_statsd/canvas_statsd_spec.rb

@@ -38,7 +38,7 @@ describe CanvasStatsd do
     end
 
     it "can be assigned a new value" do
-      settings = {foo: 'bar', baz: 'apple'}
+      settings = { host: 'bar', port: 1234 }
       CanvasStatsd.settings = settings
 
       expect(CanvasStatsd.settings).to eq settings
@@ -53,16 +53,28 @@ describe CanvasStatsd do
         namespace: 'canvas',
       }
       expect(CanvasStatsd.settings).to eq(expected)
-
     end
 
-    it 'configured settings take precedence over ENV settings' do
+    it 'configured settings are merged into and take precedence over any existing ENV settings' do
       ENV['CANVAS_STATSD_HOST'] = 'statsd.example.org'
       ENV['CANVAS_STATSD_NAMESPACE'] = 'canvas'
 
-      settings = {foo: 'bar', baz: 'apple'}
+      settings = { host: 'statsd.example-override.org' }
       CanvasStatsd.settings = settings
-      expect(CanvasStatsd.settings).to eq settings
+
+      expect(CanvasStatsd.settings).to eq(CanvasStatsd.env_settings.merge(settings))
+      expect(CanvasStatsd.settings[:host]).to eq(settings[:host])
+    end
+
+    it 'validates settings' do
+      settings = { foo: 'blah' }
+      expect { CanvasStatsd.settings = settings }.to raise_error(CanvasStatsd::ConfigurationError)
+    end
+
+    it 'converts string keys to symbols' do
+      settings = { 'host' => 'bar', 'port' => 1234 }
+      CanvasStatsd.settings = settings
+      expect(CanvasStatsd.settings).to eq({ host: 'bar', port: 1234 })
     end
   end
 

data/spec/canvas_statsd/default_tracking_spec.rb

@@ -21,6 +21,11 @@ describe CanvasStatsd::DefaultTracking do
       CanvasStatsd::DefaultTracking.track_default_metrics active_record: false
     end
 
+    it 'should not track cache when cache: false option' do
+      expect(CanvasStatsd::DefaultTracking).not_to receive(:track_cache)
+      CanvasStatsd::DefaultTracking.track_default_metrics cache: false
+    end
+
     it 'should delegate log messages to the optional logger' do
       log_double = double()
       expect(log_double).to receive(:info)
@@ -39,11 +44,10 @@ describe CanvasStatsd::DefaultTracking do
   describe '#subscribe' do
     it 'should subscribe via ActiveSupport::Notifications' do
       target = double()
-      CanvasStatsd::DefaultTracking.subscribe(/test.notification/) {|*args| target.callback(*args)}
+      CanvasStatsd::DefaultTracking.subscribe(/test\.notification/) {|*args| target.callback(*args)}
       expect(target).to receive(:callback)
       ActiveSupport::Notifications.instrument('test.notification') {}
     end
   end
 
 end
-

data/spec/canvas_statsd/request_logger_spec.rb

@@ -19,15 +19,15 @@ describe CanvasStatsd::RequestLogger do
     end
     it 'includes stats that are available' do
       request_stat = double('request_stat')
-      request_stat.stub(:ms).and_return(100.21)
-      request_stat.stub(:ar_count).and_return(24)
+      allow(request_stat).to receive(:ms).and_return(100.21)
+      allow(request_stat).to receive(:ar_count).and_return(24)
       results = @logger.build_log_message(request_stat)
       expect(results).to eq("[STATSD] (total: 100.21) (active_record: 24.00)")
     end
     it 'doesnt include nil stats' do
       request_stat = double('request_stat')
-      request_stat.stub(:ms).and_return(100.22)
-      request_stat.stub(:ar_count).and_return(nil)
+      allow(request_stat).to receive(:ms).and_return(100.22)
+      allow(request_stat).to receive(:ar_count).and_return(nil)
       results = @logger.build_log_message(request_stat)
       expect(results).to eq("[STATSD] (total: 100.22)")
     end
@@ -35,16 +35,16 @@ describe CanvasStatsd::RequestLogger do
     describe 'decimal precision' do
       it 'forces 2 decimal precision' do
         request_stat = double('request_stat')
-        request_stat.stub(:ms).and_return(72.1)
+        allow(request_stat).to receive(:ms).and_return(72.1)
         results = @logger.build_log_message(request_stat)
         expect(results).to eq("[STATSD] (total: 72.10)")
       end
       it 'rounds values to 2 decimals' do
         request_stat = double('request_stat')
-        request_stat.stub(:ms).and_return(72.1382928)
+        allow(request_stat).to receive(:ms).and_return(72.1382928)
         results = @logger.build_log_message(request_stat)
         expect(results).to eq("[STATSD] (total: 72.14)")
-        request_stat.stub(:ms).and_return(72.1348209)
+        allow(request_stat).to receive(:ms).and_return(72.1348209)
         results = @logger.build_log_message(request_stat)
         expect(results).to eq("[STATSD] (total: 72.13)")
       end
@@ -65,7 +65,7 @@ describe CanvasStatsd::RequestLogger do
       logger = CanvasStatsd::RequestLogger.new(std_out_logger)
       expect(std_out_logger).to receive(:info).with("[DEFAULT_METRICS] (total: 100.20)")
       request_stat = double('request_stat')
-      request_stat.stub(:ms).and_return(100.2)
+      allow(request_stat).to receive(:ms).and_return(100.2)
       logger.log(request_stat, "DEFAULT_METRICS")
     end
   end

data/spec/canvas_statsd/request_stat_spec.rb

@@ -121,6 +121,16 @@ describe CanvasStatsd::RequestStat do
       rs.report
     end
 
+    it 'sends cache_read_count when present' do
+      statsd = double
+      payload = {
+        params: {
+          'controller' => 'foo',
+          'action'     => 'index'
+        }
+      }
+    end
+
     describe 'sql stats' do
 
       before :each do
@@ -132,6 +142,8 @@ describe CanvasStatsd::RequestStat do
           }
         }
         @rs = create_subject(payload, @statsd)
+        @rs.cache_read_count = 25
+        expect(@statsd).to receive(:timing).with('request.foo.index.cache.read', 25)
       end
 
       it 'doesnt send sql stats when they dont exist' do

data/spec/canvas_statsd/statsd_spec.rb

@@ -21,11 +21,16 @@ require 'spec_helper'
 describe CanvasStatsd::Statsd do
   METHODS = %w(increment decrement count gauge timing)
 
+  after do
+    CanvasStatsd.settings = {}
+    CanvasStatsd::Statsd.reset_instance
+  end
+
   it "appends the hostname to stat names by default" do
-    CanvasStatsd::Statsd.stub(:hostname).and_return("testhost")
+    allow(CanvasStatsd::Statsd).to receive(:hostname).and_return("testhost")
     statsd = double
-    CanvasStatsd::Statsd.stub(:instance).and_return(statsd)
-    CanvasStatsd::Statsd.stub(:append_hostname?).and_return(true)
+    allow(CanvasStatsd::Statsd).to receive(:instance).and_return(statsd)
+    allow(CanvasStatsd::Statsd).to receive(:append_hostname?).and_return(true)
     METHODS.each do |method|
       expect(statsd).to receive(method).with("test.name.testhost", "test")
       CanvasStatsd::Statsd.send(method, "test.name", "test")
@@ -37,8 +42,8 @@ describe CanvasStatsd::Statsd do
   it "omits hostname if specified in config" do
     expect(CanvasStatsd::Statsd).to receive(:hostname).never
     statsd = double
-    CanvasStatsd::Statsd.stub(:instance).and_return(statsd)
-    CanvasStatsd::Statsd.stub(:append_hostname?).and_return(false)
+    allow(CanvasStatsd::Statsd).to receive(:instance).and_return(statsd)
+    allow(CanvasStatsd::Statsd).to receive(:append_hostname?).and_return(false)
     METHODS.each do |method|
       expect(statsd).to receive(method).with("test.name", "test")
       CanvasStatsd::Statsd.send(method, "test.name", "test")
@@ -48,7 +53,7 @@ describe CanvasStatsd::Statsd do
   end
 
   it "ignores all calls if statsd isn't enabled" do
-    CanvasStatsd::Statsd.stub(:instance).and_return(nil)
+    allow(CanvasStatsd::Statsd).to receive(:instance).and_return(nil)
     METHODS.each do |method|
       expect(CanvasStatsd::Statsd.send(method, "test.name")).to be_nil
     end
@@ -87,8 +92,4 @@ describe CanvasStatsd::Statsd do
       expect(result).to eq hash
     end
   end
-
-  after do
-    CanvasStatsd::Statsd.reset_instance
-  end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,10 @@
 require 'canvas_statsd'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 
+  config.raise_errors_for_deprecations!
+
   config.order = 'random'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canvas_statsd
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Nick Cloward
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-02 00:00:00.000000000 Z
+date: 2016-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statsd-ruby
@@ -128,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Statsd for Canvas
@@ -143,4 +143,3 @@ test_files:
 - spec/canvas_statsd/statsd_spec.rb
 - spec/spec_helper.rb
 - spec/support/test.log
-has_rdoc: