scout_apm 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4c35583425f2cec75988d311df46da4b1cea195
-  data.tar.gz: 3e2b125f355a1a5e89037ecf20e2c2d71e7674e6
+  metadata.gz: ee80eaab8042686350c223a715ff7a12ff7b5eee
+  data.tar.gz: 13d93be3815d1b014716081d130466764a79aeed
 SHA512:
-  metadata.gz: f9a78acc7da99ee83c64974b0b32703016acf296855558c09bf7e72b640cef692d9e366f019e687b8d7cf1f337b8085712efa8d2e8a31b7530d314d8a4f483b2
-  data.tar.gz: 876fd43670907912db636a647cdc858205b73733a4f06ee739bf4c592f70aceb1ed3e153b4a58437cbe63146f2af28a44d15e08924d6f1ab6f58f8b0cc325db8
+  metadata.gz: bba413fa76099cdede351d9fa6263ea53e93448a8235918ddac4a9c1072174aff0fb084a5e3cd591079e656d779c369838bc6866b2644c75772e4ab0dc85442c
+  data.tar.gz: ccbc7c25bc0aae891b79563b14c4bc4d72ca8f1ebe92b1a32c19e7e74861e61a3003208117a5d9a26dba3c2d83f7b49b7fc351d5df3670ff189c59cacd865869

data/CHANGELOG.markdown

@@ -1,5 +1,14 @@
 # master
 
+# 2.1.3
+
+* Less noisy output on errors with Context
+  * Not logging errors w/nil keys or values
+  * Bumping log level down from WARN => INFO on errors
+* Fix error with complicated AR queries
+  * Caused high log noise
+* Sidekiq instrumentation changes to handle a variety of edge cases
+
 # 2.1.2
 
 * Applies `Rails.application.config.filter_parameters` settings to reported transaction trace uris

data/lib/scout_apm/background_job_integrations/sidekiq.rb

@@ -8,7 +8,7 @@ module ScoutApm
       end
 
       def present?
-        defined?(::Sidekiq) && (File.basename($0) =~ /\Asidekiq/)
+        defined?(::Sidekiq) && File.basename($PROGRAM_NAME).start_with?('sidekiq')
       end
 
       def forking?
@@ -16,22 +16,33 @@ module ScoutApm
       end
 
       def install
+        install_tracer
+        add_middleware
+        install_processor
+      end
+
+      def install_tracer
         # ScoutApm::Tracer is not available when this class is defined
         SidekiqMiddleware.class_eval do
           include ScoutApm::Tracer
         end
+      end
 
+      def add_middleware
         ::Sidekiq.configure_server do |config|
           config.server_middleware do |chain|
             chain.add SidekiqMiddleware
           end
         end
+      end
 
+      def install_processor
         require 'sidekiq/processor' # sidekiq v4 has not loaded this file by this point
 
         ::Sidekiq::Processor.class_eval do
           def initialize_with_scout(boss)
-            ::ScoutApm::Agent.instance.start_background_worker unless ::ScoutApm::Agent.instance.background_worker_running?
+            agent = ::ScoutApm::Agent.instance
+            agent.start_background_worker
             initialize_without_scout(boss)
           end
 
@@ -41,31 +52,53 @@ module ScoutApm
       end
     end
 
+    # We insert this middleware into the Sidekiq stack, to capture each job,
+    # and time them.
     class SidekiqMiddleware
-      def call(worker, msg, queue)
-        job_class = msg["class"] # TODO: Validate this across different versions of Sidekiq
-        if job_class == "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper" && msg.has_key?("wrapped")
-          job_class = msg["wrapped"]
-        end
-
-        latency = (Time.now.to_f - (msg['enqueued_at'] || msg['created_at']))
+      ACTIVE_JOB_KLASS = 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper'.freeze
 
+      def call(_worker, msg, queue)
         req = ScoutApm::RequestManager.lookup
         req.job!
-        req.annotate_request(:queue_latency => latency)
-
-        req.start_layer( ScoutApm::Layer.new("Queue", queue) )
-        req.start_layer( ScoutApm::Layer.new("Job", job_class) )
+        req.annotate_request(:queue_latency => latency(msg))
 
         begin
+          req.start_layer(ScoutApm::Layer.new('Queue', queue))
+          started_queue = true
+          req.start_layer(ScoutApm::Layer.new('Job', job_class(msg)))
+          started_job = true
+
           yield
         rescue
           req.error!
           raise
+        ensure
+          req.stop_layer if started_job
+          req.stop_layer if started_queue
+        end
+      end
+
+      UNKNOWN_CLASS_PLACEHOLDER = 'UnknownJob'.freeze
+
+      def job_class(msg)
+        job_class = msg.fetch('class', UNKNOWN_CLASS_PLACEHOLDER)
+        if job_class == ACTIVE_JOB_KLASS && msg.key?('wrapped')
+          job_class = msg['wrapped']
+        end
+        job_class
+      rescue
+        UNKNOWN_CLASS_PLACEHOLDER
+      end
+
+      def latency(msg, time = Time.now.to_f)
+        created_at = msg['enqueued_at'] || msg['created_at']
+        if created_at
+          (time - created_at)
+        else
+          0
         end
-      ensure
-        req.stop_layer # Job
-        req.stop_layer # Queue
+      rescue
+        0
       end
     end
   end

data/lib/scout_apm/context.rb

@@ -75,8 +75,10 @@ module ScoutApm
     def value_valid?(key_value)
       # ensure one of our accepted types.
       value = key_value.values.last
-      if !valid_type?([String, Symbol, Numeric, Time, Date, TrueClass, FalseClass],value)
-        ScoutApm::Agent.instance.logger.warn "The value for [#{key_value.keys.first}] is not a valid type [#{value.class}]."
+      if value.nil?
+        false # don't log this ... easy to happen
+      elsif !valid_type?([String, Symbol, Numeric, Time, Date, TrueClass, FalseClass],value)
+        ScoutApm::Agent.instance.logger.info "The value for [#{key_value.keys.first}] is not a valid type [#{value.class}]."
         false
       else
         true
@@ -86,14 +88,16 @@ module ScoutApm
     # for consistently with #value_valid?, takes a hash eventhough the value isn't yet used.
     def key_valid?(key_value)
       key = key_value.keys.first
+      if key.nil?
+        false # don't log this ... easy to happen
       # ensure a string or a symbol
-      if !valid_type?([String, Symbol],key)
-        ScoutApm::Agent.instance.logger.warn "The key [#{key}] is not a valid type [#{key.class}]."
+      elsif !valid_type?([String, Symbol],key)
+        ScoutApm::Agent.instance.logger.info "The key [#{key}] is not a valid type [#{key.class}]."
         return false
       end
       # only alphanumeric, dash, and underscore allowed.
       if key.to_s.match(/[^\w-]/)
-        ScoutApm::Agent.instance.logger.warn "They key name [#{key}] is not valid."
+        ScoutApm::Agent.instance.logger.info "They key name [#{key}] is not valid."
         return false
       end
       true

data/lib/scout_apm/tracked_request.rb

@@ -47,7 +47,7 @@ module ScoutApm
       @layers = []
       @call_set = Hash.new { |h, k| h[k] = CallSet.new }
       @annotations = {}
-      @ignoring_children = false
+      @ignoring_children = 0
       @context = Context.new
       @root_layer = nil
       @error = false
@@ -297,27 +297,41 @@ module ScoutApm
     # specific, and useful than the fact that InfluxDB happens to use Net::HTTP
     # internally
     #
-    # When enabled, new layers won't be added to the current Request.
+    # When enabled, new layers won't be added to the current Request, and calls
+    # to stop_layer will be ignored.
     #
     # Do not forget to turn if off when leaving a layer, it is the
     # instrumentation's task to do that.
+    #
+    # When you use this in code, be sure to use it in this order:
+    #
+    # start_layer
+    # ignore_children
+    #  -> call
+    # acknowledge_children
+    # stop_layer
+    #
+    # If you don't call it in this order, it's possible to get out of sync, and
+    # have an ignored start and an actually-executed stop, causing layers to
+    # get out of sync
 
     def ignore_children!
-      @ignoring_children = true
+      @ignoring_children += 1
     end
 
     def acknowledge_children!
-      @ignoring_children = false
+      if @ignoring_children > 0
+        @ignoring_children -= 1
+      end
     end
 
     def ignoring_children?
-      @ignoring_children
+      @ignoring_children > 0
     end
 
     # Grab backtraces more aggressively when running in dev trace mode
     def backtrace_threshold
       dev_trace ? 0.05 : 0.5 # the minimum threshold in seconds to record the backtrace for a metric.
     end
-
   end
 end

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "2.1.2"
+  VERSION = "2.1.3"
 end
 

data/scout_apm.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "rusage", '~> 0.2.0'
 
   s.add_development_dependency "minitest"
+  s.add_development_dependency 'mocha'
   s.add_development_dependency "pry"
   s.add_development_dependency "m"
   s.add_development_dependency "simplecov"

data/test/test_helper.rb

@@ -5,6 +5,7 @@ SimpleCov.start
 require 'minitest/autorun'
 require 'minitest/unit'
 require 'minitest/pride'
+require 'mocha/mini_test'
 require 'pry'
 
 
@@ -82,4 +83,3 @@ class Minitest::Test
   DATA_FILE_PATH = "#{DATA_FILE_DIR}/scout_apm.db"
 end
 
-

data/test/unit/background_job_integrations/sidekiq_test.rb

@@ -0,0 +1,104 @@
+require 'test_helper'
+require 'scout_apm/request_manager'
+require 'scout_apm/background_job_integrations/sidekiq'
+
+class SidekiqTest < Minitest::Test
+  SidekiqMiddleware = ScoutApm::BackgroundJobIntegrations::SidekiqMiddleware
+
+  ########################################
+  # Middleware
+  ########################################
+  def test_middleware_call_happy_path
+    fake_request = mock
+    fake_request.expects(:annotate_request)
+    fake_request.expects(:job!)
+    fake_request.expects(:start_layer).twice
+    fake_request.expects(:stop_layer).twice
+    fake_request.expects(:error!).never
+
+    ScoutApm::RequestManager.stubs(:lookup).returns(fake_request)
+
+    block_called = false
+    msg = { 'class' => 'MyJobClass',
+            'created_at' => Time.now }
+
+    SidekiqMiddleware.new.call(nil, msg, "defaultqueue") { block_called = true }
+    assert_equal true, block_called
+  end
+
+  def test_middleware_call_job_exception
+    fake_request = mock
+    fake_request.expects(:annotate_request)
+    fake_request.expects(:job!)
+    fake_request.expects(:start_layer).twice
+    fake_request.expects(:stop_layer).twice
+    fake_request.expects(:error!)
+
+    ScoutApm::RequestManager.stubs(:lookup).returns(fake_request)
+
+    msg = { 'class' => 'MyJobClass',
+            'created_at' => Time.now }
+
+    assert_raises RuntimeError do
+      SidekiqMiddleware.new.call(nil, msg, "defaultqueue") { raise "TheJobFailed" }
+    end
+  end
+
+  def test_middleware_call_edge_cases
+    fake_request = mock
+    fake_request.expects(:annotate_request)
+    fake_request.expects(:job!)
+    fake_request.expects(:start_layer).twice
+    fake_request.expects(:stop_layer).twice
+    fake_request.expects(:error!)
+
+    ScoutApm::RequestManager.stubs(:lookup).returns(fake_request)
+
+    # msg doesn't have anything
+    msg = { }
+
+    assert_raises RuntimeError do
+      SidekiqMiddleware.new.call(nil, msg, "defaultqueue") { raise "TheJobFailed" }
+    end
+  end
+
+  ########################################
+  # Job Class Determination
+  ########################################
+  def test_job_class_name_normally
+    msg = { 'class' => 'AGreatJob' }
+    assert_equal 'AGreatJob', SidekiqMiddleware.new.job_class(msg)
+  end
+
+  def test_job_class_name_activejob
+    msg = { 'class' => 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper',
+            'wrapped' => 'RealJobClass' }
+    assert_equal 'RealJobClass', SidekiqMiddleware.new.job_class(msg)
+  end
+
+  def test_job_class_name_error_default
+    msg = {}
+    assert_equal 'UnknownJob', SidekiqMiddleware.new.job_class(msg)
+  end
+
+  ########################################
+  # Latency Calculation
+  ########################################
+  def test_latency_from_created_at
+    # Created at time 80, but now it is 200. Latency was 120
+    msg = { 'created_at' => 80 }
+    assert_equal 120, SidekiqMiddleware.new.latency(msg, 200)
+  end
+
+  def test_latency_from_enqueued_at
+    # Created at time 80, but now it is 200. Latency was 120
+    msg = { 'enqueued_at' => 80 }
+    assert_equal 120, SidekiqMiddleware.new.latency(msg, 200)
+  end
+
+  def test_latency_fallback
+    # No created at time, so fall back to 0
+    msg = {}
+    assert_equal 0, SidekiqMiddleware.new.latency(msg, 200)
+  end
+end

data/test/unit/context_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+require 'scout_apm/context'
+
+class ContextText < Minitest::Test
+  def test_ignore_nil_value
+    context = ScoutApm::Context.new
+    assert hash = context.add(:nil_key => nil, :org => 'org')
+    assert_equal ({:org => 'org'}), hash
+  end
+
+  def test_ignore_nil_key
+    context = ScoutApm::Context.new
+    assert hash = context.add(nil => nil, :org => 'org')
+    assert_equal ({:org => 'org'}), hash
+  end
+
+  def test_ignore_unsupported_value_type
+    context = ScoutApm::Context.new
+    assert hash = context.add(:array => [1,2,3,4], :org => 'org')
+    assert_equal ({:org => 'org'}), hash
+  end
+
+  def test_ignore_unsupported_key_type
+    context = ScoutApm::Context.new
+    assert hash = context.add([1,2,3,4] => 'hey', :org => 'org')
+    assert_equal ({:org => 'org'}), hash
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-22 00:00:00.000000000 Z
+date: 2016-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rusage
@@ -39,6 +39,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -223,7 +237,9 @@ files:
 - test/data/config_test_1.yml
 - test/test_helper.rb
 - test/unit/agent_test.rb
+- test/unit/background_job_integrations/sidekiq_test.rb
 - test/unit/config_test.rb
+- test/unit/context_test.rb
 - test/unit/environment_test.rb
 - test/unit/histogram_test.rb
 - test/unit/ignored_uris_test.rb
@@ -267,7 +283,9 @@ test_files:
 - test/data/config_test_1.yml
 - test/test_helper.rb
 - test/unit/agent_test.rb
+- test/unit/background_job_integrations/sidekiq_test.rb
 - test/unit/config_test.rb
+- test/unit/context_test.rb
 - test/unit/environment_test.rb
 - test/unit/histogram_test.rb
 - test/unit/ignored_uris_test.rb