scout_apm 5.7.1 → 5.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e96ebe1b7d9a1fb4bd1427ba0564e645cb9bed376da56bc92f9d86f0515adf7
-  data.tar.gz: d1c4692af9e37bb6107f14064ce89f94626d987bf55d845dea19b522fa910ce1
+  metadata.gz: 80d2cac0818a8487fe1e9ca2395faccbbbadf2be368151e636e39dd7188b34ea
+  data.tar.gz: 1c46ee7b70ac1bd2e9ff4ed4232c7304edc02088563df840619aedcb5e43384d
 SHA512:
-  metadata.gz: 958530e614d6ad7ac0ef8805d40843883fae446d5dbfdee7f982a504eff838e0f6abe9fc70e7ead42f0e3a7075540291954264704da73694f132674ef2edc48b
-  data.tar.gz: d35f05a9f2c6094b87e1df04a95fa54138c901b25b479ce5962c616d54806fea1a25ab5e89feb5d98c0ecf0d5e13163e97f990c3e74229544751f3b6e0d4fe9f
+  metadata.gz: da2b3e51bea0eb7198d76edd997ef62da6719b3e0df7bd7093f56cbd51d2f0426f6798ef57d641e786a3a16732ad6e9ad141ce977fce0d9888541ff72bfbb11d
+  data.tar.gz: 42e1bb5874b213da9c8be9b4024263737bf8c34ae7c968b2259939f87bb3f983a105036d6cd3222de02964b8f40aedab8f5e47f10248ed5053c517acddf67833

data/CHANGELOG.markdown

@@ -1,4 +1,12 @@
 # Unreleased
+- Enable Delayed Job error tracking (#565)
+
+# 5.8.0
+- Add error monitoring to SolidQueue, faktory, goodjob, que, shoryuken, sneakers (#571)
+- Treat exclusive time as total time for limited layers in background jobs (#576)
+- Remove unused time util conflict with DeviseTokenAuth (#575)
+- Add transaction ID to error records (#568)-
+- Adds request method to captured error context (#577)
 
 # 5.7.1
 - Update error capture API to use context (#560)

data/lib/scout_apm/background_job_integrations/delayed_job.rb

@@ -4,6 +4,7 @@ module ScoutApm
       ACTIVE_JOB_KLASS = 'ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper'.freeze
       DJ_PERFORMABLE_METHOD = 'Delayed::PerformableMethod'.freeze
 
+
       attr_reader :logger
 
       def name
@@ -69,8 +70,17 @@ module ScoutApm
 
                 # Call the job itself.
                 block.call(job, *args)
-              rescue
+              rescue Exception => exception
+                # Capture the error for further processing and shipping
                 req.error!
+                # Abusing this key to pass job info
+                params_key = 'action_dispatch.request.parameters'
+                env = {}
+                env[params_key] = job.payload_object.job_data
+                env[:custom_controller] = name
+                env[:custom_action] = queue
+                context = ScoutApm::Agent.instance.context
+                context.error_buffer.capture(exception, env)
                 raise
               ensure
                 req.stop_layer if started_job

data/lib/scout_apm/background_job_integrations/faktory.rb

@@ -60,8 +60,14 @@ module ScoutApm
           started_job = true
 
           yield
-        rescue
+        rescue Exception => exception
           req.error!
+          env = {
+            :custom_controller => job_class(job),
+            :custom_action => queue
+          }
+          context = ScoutApm::Agent.instance.context
+          context.error_buffer.capture(exception, env)
           raise
         ensure
           req.stop_layer if started_job

data/lib/scout_apm/background_job_integrations/good_job.rb

@@ -34,8 +34,14 @@ module ScoutApm
               started_job = true # Following Convention
 
               block.call
-            rescue
+            rescue Exception => exception
               req.error!
+              env = {
+                :custom_controller => job.class.name,
+                :custom_action => job.queue_name.presence || UNKNOWN_QUEUE_PLACEHOLDER
+              }
+              context = ScoutApm::Agent.instance.context
+              context.error_buffer.capture(exception, env)
               raise
             ensure
               req.stop_layer if started_job

data/lib/scout_apm/background_job_integrations/legacy_sneakers.rb

@@ -42,8 +42,14 @@ module ScoutApm
           else
             super
           end
-        rescue Exception
+        rescue Exception => exception
           req.error!
+          env = {
+            :custom_controller => job_class,
+            :custom_action => queue
+          }
+          context = ScoutApm::Agent.instance.context
+          context.error_buffer.capture(exception, env)
           raise
         ensure
           req.stop_layer if started_job

data/lib/scout_apm/background_job_integrations/que.rb

@@ -115,8 +115,14 @@ module ScoutApm
               started_job = true
 
               _run_without_scout(*args)
-            rescue Exception => e
+            rescue Exception => exception
               req.error!
+              env = {
+                :custom_controller => job_class,
+                :custom_action => queue
+              }
+              context = ScoutApm::Agent.instance.context
+              context.error_buffer.capture(exception, env)
               raise
             ensure
               req.stop_layer if started_job

data/lib/scout_apm/background_job_integrations/shoryuken.rb

@@ -79,8 +79,14 @@ module ScoutApm
           started_job = true
 
           yield
-        rescue Exception => e
+        rescue Exception => exception
           req.error!
+          env = {
+            :custom_controller => job_class,
+            :custom_action => queue
+          }
+          context = ScoutApm::Agent.instance.context
+          context.error_buffer.capture(exception, env)
           raise
         ensure
           req.stop_layer if started_job

data/lib/scout_apm/background_job_integrations/sneakers.rb

@@ -65,8 +65,14 @@ module ScoutApm
               started_job = true
 
               process_work_without_scout(*args)
-            rescue Exception => e
+            rescue Exception => exception
               req.error!
+              env = {
+                :custom_controller => job_class,
+                :custom_action => queue
+              }
+              context = ScoutApm::Agent.instance.context
+              context.error_buffer.capture(exception, env)
               raise
             ensure
               req.stop_layer if started_job

data/lib/scout_apm/background_job_integrations/solid_queue.rb

@@ -32,8 +32,26 @@ module ScoutApm
               started_job = true # Following Convention
 
               block.call
-            rescue
+            rescue Exception => exception
               req.error!
+              # Extract job parameters like DelayedJob does
+              params_key = 'action_dispatch.request.parameters'
+              job_args = begin
+                {
+                  arguments: job.arguments,
+                  job_id: job.job_id,
+                }
+              rescue => e
+                { error_extracting_params: e.message }
+              end
+              
+              env = {
+                params_key => job_args,
+                :custom_controller => job.class.name,
+                :custom_action => job.queue_name.presence || UNKNOWN_QUEUE_PLACEHOLDER
+              }
+              context = ScoutApm::Agent.instance.context
+              context.error_buffer.capture(exception, env)
               raise
             ensure
               req.stop_layer if started_job

data/lib/scout_apm/error_service/error_record.rb

@@ -22,6 +22,8 @@ module ScoutApm
         else
           {}
         end
+        # Add the transaction_id, as it won't be added to the context normally until the request has been recorded.
+        @context[:transaction_id] ||= RequestManager.lookup.transaction_id
 
         @exception_class = LengthLimit.new(exception.class.name).to_s
         @message = LengthLimit.new(exception.message, 100).to_s
@@ -46,6 +48,7 @@ module ScoutApm
         # For background workers like sidekiq
         # TODO: extract data creation for background jobs
         components[:controller] ||= env[:custom_controller]
+        components[:action] ||= env[:custom_action]
 
         components
       end
@@ -92,6 +95,7 @@ module ScoutApm
 
       # Capture params from env
       KEYS_TO_KEEP = [
+        "REQUEST_METHOD",
         "HTTP_USER_AGENT",
         "HTTP_REFERER",
         "HTTP_ACCEPT_ENCODING",

data/lib/scout_apm/limited_layer.rb

@@ -21,10 +21,13 @@ module ScoutApm
       @total_layers += 1
 
       @total_call_time += layer.total_call_time
-      @total_exclusive_time += layer.total_exclusive_time
+      # For limited layers, exclusive time should equal total time since limited layers
+      # report no children. As such, we need to consider all absorbed time as exclusive.
+      @total_exclusive_time += layer.total_call_time
 
       @total_allocations += layer.total_allocations
-      @total_exclusive_allocations += layer.total_exclusive_allocations
+      # Same logic applies to allocations
+      @total_exclusive_allocations += layer.total_allocations
     end
 
     def total_call_time

data/lib/scout_apm/logger.rb

@@ -145,7 +145,7 @@ module ScoutApm
       def call(severity, time, progname, msg)
         # since STDOUT isn't exclusive like the scout_apm.log file, apply a prefix.
         # XXX: Pass in context to the formatter
-        "[#{Utils::Time.to_s(time)} #{ScoutApm::Agent.instance.context.environment.hostname} (#{$$})] #{severity} : #{msg}\n"
+        "[#{time.strftime("%m/%d/%y %H:%M:%S %z")} #{ScoutApm::Agent.instance.context.environment.hostname} (#{$$})] #{severity} : #{msg}\n"
       end
     end
 

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "5.7.1"
+  VERSION = "5.8.0"
 end

data/lib/scout_apm.rb

@@ -118,7 +118,6 @@ require 'scout_apm/utils/installed_gems'
 require 'scout_apm/utils/klass_helper'
 require 'scout_apm/utils/scm'
 require 'scout_apm/utils/sql_sanitizer'
-require 'scout_apm/utils/time'
 require 'scout_apm/utils/unique_id'
 require 'scout_apm/utils/numbers'
 require 'scout_apm/utils/gzip_helper'

data/test/unit/background_job_integrations/faktory_test.rb

@@ -0,0 +1,109 @@
+require 'test_helper'
+require 'scout_apm/background_job_integrations/faktory'
+
+class FaktoryTest < Minitest::Test
+  FaktoryMiddleware = ScoutApm::BackgroundJobIntegrations::FaktoryMiddleware
+
+  def test_middleware_call_job_exception_with_error_monitoring
+    # Test that error buffer is called on exception
+    fake_request = mock
+    fake_request.expects(:annotate_request)
+    fake_request.expects(:start_layer).twice
+    fake_request.expects(:stop_layer).twice
+    fake_request.expects(:error!)
+
+    fake_context = mock
+    fake_error_buffer = mock
+    fake_context.expects(:error_buffer).returns(fake_error_buffer)
+    
+    expected_env = {
+      :custom_controller => "TestJob",
+      :custom_action => "critical"
+    }
+    fake_error_buffer.expects(:capture).with(kind_of(RuntimeError), expected_env)
+
+    ScoutApm::RequestManager.stubs(:lookup).returns(fake_request)
+    ScoutApm::Agent.instance.expects(:context).returns(fake_context)
+
+    worker_instance = mock
+    job = {
+      "queue" => "critical",
+      "jobtype" => "TestJob",
+      "enqueued_at" => Time.now.iso8601
+    }
+
+    assert_raises RuntimeError do
+      FaktoryMiddleware.new.call(worker_instance, job) do
+        raise RuntimeError, "Job failed"
+      end
+    end
+  end
+
+  def test_middleware_call_activejob_wrapper
+    # Test ActiveJob job class extraction
+    fake_request = mock
+    fake_request.expects(:annotate_request)
+    fake_request.expects(:start_layer).twice
+    fake_request.expects(:stop_layer).twice
+    fake_request.expects(:error!)
+
+    fake_context = mock
+    fake_error_buffer = mock
+    fake_context.expects(:error_buffer).returns(fake_error_buffer)
+    
+    expected_env = {
+      :custom_controller => "MyRealJob",  # Should extract from custom.wrapped
+      :custom_action => "default"
+    }
+    fake_error_buffer.expects(:capture).with(kind_of(RuntimeError), expected_env)
+
+    ScoutApm::RequestManager.stubs(:lookup).returns(fake_request)
+    ScoutApm::Agent.instance.expects(:context).returns(fake_context)
+
+    # ActiveJob wrapper scenario
+    worker_instance = mock
+    job = {
+      "queue" => "default", 
+      "jobtype" => "ActiveJob::QueueAdapters::FaktoryAdapter::JobWrapper",
+      "custom" => { "wrapped" => "MyRealJob" },
+      "created_at" => Time.now.iso8601
+    }
+
+    assert_raises RuntimeError do
+      FaktoryMiddleware.new.call(worker_instance, job) do
+        raise RuntimeError, "ActiveJob failed"
+      end
+    end
+  end
+
+  def test_middleware_call_missing_queue_fallback
+    # Test behavior when queue is missing
+    fake_request = mock
+    fake_request.expects(:annotate_request)
+    fake_request.expects(:start_layer).twice
+    fake_request.expects(:stop_layer).twice
+    fake_request.expects(:error!)
+
+    fake_context = mock
+    fake_error_buffer = mock
+    fake_context.expects(:error_buffer).returns(fake_error_buffer)
+    
+    expected_env = {
+      :custom_controller => "UnknownJob",  # Fallback when jobtype missing
+      :custom_action => nil  # No queue
+    }
+    fake_error_buffer.expects(:capture).with(kind_of(RuntimeError), expected_env)
+
+    ScoutApm::RequestManager.stubs(:lookup).returns(fake_request)
+    ScoutApm::Agent.instance.expects(:context).returns(fake_context)
+
+    worker_instance = mock
+    job = {}  # Empty job data
+
+    assert_raises RuntimeError do
+      FaktoryMiddleware.new.call(worker_instance, job) do
+        raise RuntimeError, "Job failed"
+      end
+    end
+  end
+end

data/test/unit/background_job_integrations/shoryuken_test.rb

@@ -0,0 +1,81 @@
+require 'test_helper'
+require 'scout_apm/background_job_integrations/shoryuken'
+
+class ShoryukenTest < Minitest::Test
+  ShoryukenIntegration = ScoutApm::BackgroundJobIntegrations::Shoryuken
+  ShoryukenMiddleware = ScoutApm::BackgroundJobIntegrations::ShoryukenMiddleware
+
+  def test_middleware_call_job_exception_with_error_monitoring
+    # Test that error buffer is called on exception
+    fake_request = mock
+    fake_request.expects(:annotate_request)
+    fake_request.expects(:start_layer).twice
+    fake_request.expects(:stop_layer).twice  
+    fake_request.expects(:error!)
+
+    fake_context = mock
+    fake_error_buffer = mock
+    fake_context.expects(:error_buffer).returns(fake_error_buffer)
+    
+    expected_env = {
+      :custom_controller => "TestWorker",
+      :custom_action => "test-queue"
+    }
+    fake_error_buffer.expects(:capture).with(kind_of(RuntimeError), expected_env)
+
+    ScoutApm::RequestManager.stubs(:lookup).returns(fake_request)
+    ScoutApm::Agent.instance.expects(:context).returns(fake_context)
+
+    worker_instance = mock
+    mock_class = mock
+    mock_class.expects(:to_s).twice.returns("TestWorker")
+    worker_instance.expects(:class).twice.returns(mock_class)
+    queue = "test-queue"
+    msg = mock
+    msg.expects(:attributes).returns({'SentTimestamp' => '1534873927868'})
+    body = {}
+
+    assert_raises RuntimeError do
+      ShoryukenMiddleware.new.call(worker_instance, queue, msg, body) do
+        raise RuntimeError, "Job failed"
+      end
+    end
+  end
+
+  def test_middleware_call_activejob_wrapper
+    # Test ActiveJob job class extraction
+    fake_request = mock
+    fake_request.expects(:annotate_request)
+    fake_request.expects(:start_layer).twice
+    fake_request.expects(:stop_layer).twice
+    fake_request.expects(:error!)
+
+    fake_context = mock
+    fake_error_buffer = mock
+    fake_context.expects(:error_buffer).returns(fake_error_buffer)
+    
+    expected_env = {
+      :custom_controller => "MyRealJob",  # Should extract from body
+      :custom_action => "priority-queue"
+    }
+    fake_error_buffer.expects(:capture).with(kind_of(RuntimeError), expected_env)
+
+    ScoutApm::RequestManager.stubs(:lookup).returns(fake_request)
+    ScoutApm::Agent.instance.expects(:context).returns(fake_context)
+
+    worker_instance = mock
+    mock_class = mock
+    mock_class.expects(:to_s).returns("ActiveJob::QueueAdapters::ShoryukenAdapter::JobWrapper")
+    worker_instance.expects(:class).returns(mock_class)
+    queue = "priority-queue"
+    msg = mock
+    msg.expects(:attributes).returns({'SentTimestamp' => '1534873927868'})
+    body = { "job_class" => "MyRealJob" }
+
+    assert_raises RuntimeError do
+      ShoryukenMiddleware.new.call(worker_instance, queue, msg, body) do
+        raise RuntimeError, "ActiveJob failed"
+      end
+    end
+  end
+end

data/test/unit/error_service/error_buffer_test.rb

@@ -25,6 +25,7 @@ class ErrorBufferTest < Minitest::Test
 
       exception = exceptions[0]
       expected_env_keys = [
+        "REQUEST_METHOD",
         "ANOTHER_HEADER",
         "HTTP_X_FORWARDED_FOR",
         "HTTP_USER_AGENT",

data/test/unit/error_test.rb

@@ -55,7 +55,7 @@ class ErrorTest < Minitest::Test
 
       assert_equal "No context or env", exceptions[3].message
       assert_equal "AnotherError", exceptions[3].exception_class
-      assert_equal assert_empty_context, exceptions[3].context
+      assert_equal assert_default_context, exceptions[3].context
 
       assert_equal "Whoops", exceptions[4].message
       assert_equal "ErrorTest::FakeError", exceptions[4].exception_class
@@ -84,8 +84,8 @@ class ErrorTest < Minitest::Test
     }
   end
 
-  def assert_empty_context
-    {user: {}}
+  def assert_default_context
+    {user: {}, transaction_id: ScoutApm::RequestManager.lookup.transaction_id}
   end
 
   def ex(msg="Whoops")

data/test/unit/limited_layer_test.rb

@@ -18,16 +18,16 @@ class LimitedLayerTest < Minitest::Test
     ll = ScoutApm::LimitedLayer.new("ActiveRecord")
 
     ll.absorb faux_layer("ActiveRecord", "User#Find", 2, 1, 200, 100)
-    assert_equal 1, ll.total_exclusive_time
+    assert_equal 2, ll.total_exclusive_time
     assert_equal 2, ll.total_call_time
-    assert_equal 100, ll.total_exclusive_allocations
+    assert_equal 200, ll.total_exclusive_allocations
     assert_equal 200, ll.total_allocations
 
 
     ll.absorb faux_layer("ActiveRecord", "User#Find", 4, 3, 400, 300)
-    assert_equal 4, ll.total_exclusive_time           # 3 + 1
+    assert_equal 6, ll.total_exclusive_time           # 4 + 2 (for limited layers, should equal total time)
     assert_equal 6, ll.total_call_time                # 4 + 2
-    assert_equal 400, ll.total_exclusive_allocations  # 300 + 100
+    assert_equal 600, ll.total_exclusive_allocations  # 400 + 200 (same goes for allocations)
     assert_equal 600, ll.total_allocations            # 400 + 200
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 5.7.1
+  version: 5.8.0
 platform: ruby
 authors:
 - Derek Haynes
@@ -413,7 +413,6 @@ files:
 - lib/scout_apm/utils/numbers.rb
 - lib/scout_apm/utils/scm.rb
 - lib/scout_apm/utils/sql_sanitizer.rb
-- lib/scout_apm/utils/time.rb
 - lib/scout_apm/utils/unique_id.rb
 - lib/scout_apm/version.rb
 - lib/tasks/doctor.rake
@@ -435,6 +434,8 @@ files:
 - test/unit/auto_instrument/rescue_from-instrumented.rb
 - test/unit/auto_instrument/rescue_from.rb
 - test/unit/auto_instrument_test.rb
+- test/unit/background_job_integrations/faktory_test.rb
+- test/unit/background_job_integrations/shoryuken_test.rb
 - test/unit/background_job_integrations/sidekiq_test.rb
 - test/unit/config_test.rb
 - test/unit/context_test.rb

data/lib/scout_apm/utils/time.rb

@@ -1,12 +0,0 @@
-module ScoutApm
-  module Utils
-    class Time
-      # Handles both integer (unix) time and Time objects
-      # example output:  "09/10/15 04:34:28 -0600"
-      def self.to_s(time)
-        return to_s(::Time.at(time)) if time.is_a? Integer
-        time.strftime("%m/%d/%y %H:%M:%S %z")
-      end
-    end
-  end
-end