canvas_statsd 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4616d02f4c3c8ef8030b703e6bbf5d838af47a19
-  data.tar.gz: 605ae45df5f43db4fb9935bc9183d3e37461d9be
+  metadata.gz: f4d82332ae38bf5817fccb8a0bc7558427e9bc1c
+  data.tar.gz: b007d80588d91577b3997008fe236386e86551c5
 SHA512:
-  metadata.gz: 3ee48720a9b97a96c005f612e8b1b1eb3fc530e0677686d24acd8cc0109936f5d9bdd75079ec0bc36cae90423c9eeec7bcb81e32b500c905236b76cb497f839f
-  data.tar.gz: b3a03993abfc29f5c500e33d14e3bbbf619bcb31d2fc6dc3efb27525a8db5e463d7c1d25dfc472e7d2aab73b5ad49e0439e70048a7293ad76467d414482a28f1
+  metadata.gz: 623fdba2e7573d930fa7ae361703957e32ad476a270e3ca6b27116e1ca63e6b2866a55c76cfb2c53f56416e3453133d3055de62153719350d5d6753727f077e2
+  data.tar.gz: c4b10a26a2bdec126571e3128ae68a68060f550eb05178e25c30a99b595a17f715110d73244e35bd024ec64814840c2944ad6846c23d564bcd44ef1692819656

data/lib/canvas_statsd.rb

@@ -8,6 +8,8 @@ module CanvasStatsd
   require "canvas_statsd/counter"
   require "canvas_statsd/sql_tracker"
   require "canvas_statsd/default_tracking"
+  require "canvas_statsd/request_logger"
+  require "canvas_statsd/null_logger"
 
   def self.settings
     @settings || env_settings

data/lib/canvas_statsd/default_tracking.rb

@@ -5,7 +5,8 @@ module CanvasStatsd
     @sql_tracker = CanvasStatsd::SqlTracker.new(blocked_names: ['SCHEMA'])
 
     def self.track_default_metrics(options={})
-      options = {sql: true, active_record: true}.merge(options)
+      options = {sql: true, active_record: true, logger: nil}.merge(options)
+      @logger = RequestLogger.new(options[:logger])
       track_timing
       track_sql if !!options[:sql]
       track_active_record if !!options[:active_record]
@@ -57,6 +58,7 @@ module CanvasStatsd
       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.report
+      @logger.log(request_stat)
     end
 
   end

data/lib/canvas_statsd/null_logger.rb

@@ -0,0 +1,11 @@
+require 'logger'
+
+module CanvasStatsd
+  class NullLogger < Logger
+    def initialize(*args)
+    end
+
+    def add(*args, &block)
+    end
+  end
+end

data/lib/canvas_statsd/request_logger.rb

@@ -0,0 +1,34 @@
+module CanvasStatsd
+  class RequestLogger
+
+    VALUES_MAP = {
+        total: :ms,
+        view: :view_runtime,
+        db: :db_runtime,
+        sql_read: :sql_read_count,
+        sql_write: :sql_write_count,
+        sql_cache: :sql_cache_count,
+        active_record: :ar_count
+      }.freeze
+
+
+    def initialize(logger)
+      @logger = logger || CanvasStatsd::NullLogger.new
+    end
+
+    def log(request_stat, header=nil)
+      @logger.info(build_log_message(request_stat, header))
+    end
+
+    def build_log_message(request_stat, header=nil)
+      header ||= "STATSD"
+      message = "[#{header}]"
+      VALUES_MAP.each do |k,v|
+        value = request_stat.respond_to?(v) ? request_stat.send(v) : nil
+        message += " (#{k}: #{value})" if value
+      end
+      message
+    end
+
+  end
+end

data/spec/canvas_statsd/default_tracking_spec.rb

@@ -20,6 +20,13 @@ describe CanvasStatsd::DefaultTracking do
       expect(CanvasStatsd::DefaultTracking).not_to receive(:track_active_record)
       CanvasStatsd::DefaultTracking.track_default_metrics active_record: false
     end
+
+    it 'should delegate log messages to the optional logger' do
+      log_double = double()
+      expect(log_double).to receive(:info)
+      CanvasStatsd::DefaultTracking.track_default_metrics logger: log_double
+      CanvasStatsd::DefaultTracking.finalize_processing('name', 1000, 10001, 1234, {})
+    end
   end
 
   describe '#track_active_record' do

data/spec/canvas_statsd/null_logger_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe CanvasStatsd::NullLogger do
+
+  describe 'initialize' do
+    it 'takes any arguments' do
+      expect{CanvasStatsd::NullLogger.new}.to_not raise_error
+      expect{CanvasStatsd::NullLogger.new(1, 2, 3)}.to_not raise_error
+    end
+  end
+
+  describe 'debug, info, warn, fatal, and unknown' do
+    it 'should all no-op instead of logging' do
+      log_path = 'spec/support/test.log'
+      File.open(log_path, 'w') { |f| f.write('') } # empty log file
+      logger = CanvasStatsd::NullLogger.new(log_path)
+      %w[debug info warn error fatal unknown].each { |m| logger.send(m, 'foo') }
+      log_contents = File.read(log_path)
+      expect(log_contents).to eq ''
+    end
+  end
+
+end

data/spec/canvas_statsd/request_logger_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'logger'
+
+describe CanvasStatsd::RequestLogger do
+
+  describe '#build_log_message' do
+    before :all do
+      @logger = CanvasStatsd::RequestLogger.new(Logger.new(STDOUT))
+    end
+    it 'should include the supplied header' do
+      request_stat = double('request_stat')
+      results = @logger.build_log_message(request_stat, 'FOO_STATS')
+      expect(results).to eq("[FOO_STATS]")
+    end
+    it 'should fallback to the default header' do
+      request_stat = double('request_stat')
+      results = @logger.build_log_message(request_stat)
+      expect(results).to eq("[STATSD]")
+    end
+    it 'should include stats that are available' do
+      request_stat = double('request_stat')
+      request_stat.stub(:ms).and_return(100.2)
+      request_stat.stub(:ar_count).and_return(24)
+      results = @logger.build_log_message(request_stat)
+      expect(results).to eq("[STATSD] (total: 100.2) (active_record: 24)")
+    end
+    it 'should not include nil stats' do
+      request_stat = double('request_stat')
+      request_stat.stub(:ms).and_return(100.2)
+      request_stat.stub(:ar_count).and_return(nil)
+      results = @logger.build_log_message(request_stat)
+      expect(results).to eq("[STATSD] (total: 100.2)")
+    end
+  end
+
+  describe '#log' do
+    it 'should send info method to logger if logger exists' do
+      std_out_logger = Logger.new(STDOUT)
+      logger = CanvasStatsd::RequestLogger.new(std_out_logger)
+      expect(std_out_logger).to receive(:info)
+      request_stat = double('request_stat')
+      logger.log(request_stat)
+    end
+    it 'should send info method with build_log_message output if logger exists' do
+      std_out_logger = Logger.new(STDOUT)
+      logger = CanvasStatsd::RequestLogger.new(std_out_logger)
+      expect(std_out_logger).to receive(:info).with("[DEFAULT_METRICS] (total: 100.2)")
+      request_stat = double('request_stat')
+      request_stat.stub(:ms).and_return(100.2)
+      logger.log(request_stat, "DEFAULT_METRICS")
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canvas_statsd
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Nick Cloward
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-16 00:00:00.000000000 Z
+date: 2015-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statsd-ruby
@@ -90,16 +90,21 @@ files:
 - lib/canvas_statsd.rb
 - lib/canvas_statsd/counter.rb
 - lib/canvas_statsd/default_tracking.rb
+- lib/canvas_statsd/null_logger.rb
+- lib/canvas_statsd/request_logger.rb
 - lib/canvas_statsd/request_stat.rb
 - lib/canvas_statsd/sql_tracker.rb
 - lib/canvas_statsd/statsd.rb
 - spec/canvas_statsd/canvas_statsd_spec.rb
 - spec/canvas_statsd/counter_spec.rb
 - spec/canvas_statsd/default_tracking_spec.rb
+- spec/canvas_statsd/null_logger_spec.rb
+- spec/canvas_statsd/request_logger_spec.rb
 - spec/canvas_statsd/request_stat_spec.rb
 - spec/canvas_statsd/sql_tracker_spec.rb
 - spec/canvas_statsd/statsd_spec.rb
 - spec/spec_helper.rb
+- spec/support/test.log
 - test.sh
 homepage: https://github.com/instructure/canvas_statsd
 licenses:
@@ -129,8 +134,11 @@ test_files:
 - spec/canvas_statsd/canvas_statsd_spec.rb
 - spec/canvas_statsd/counter_spec.rb
 - spec/canvas_statsd/default_tracking_spec.rb
+- spec/canvas_statsd/null_logger_spec.rb
+- spec/canvas_statsd/request_logger_spec.rb
 - spec/canvas_statsd/request_stat_spec.rb
 - spec/canvas_statsd/sql_tracker_spec.rb
 - spec/canvas_statsd/statsd_spec.rb
 - spec/spec_helper.rb
+- spec/support/test.log
 has_rdoc: