scout_apm 5.6.2 → 5.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6825b0cb6be5706305fa47b48fe8f84a89f0bf6019deb5914547d720e13db875
-  data.tar.gz: 5a5163d1c0f05f6ebe87aa0948e426b9332ff66121bc04c33048cad1ddef5e89
+  metadata.gz: 1a45c15600501200c54adb79600c0ff8c2c7229c6f4c8c6292804f2f10c716e2
+  data.tar.gz: d068883fec42f88524e0ccac0d84da6941a8c981c6eecb5b7e525affddb3ea77
 SHA512:
-  metadata.gz: d2853cef258799e5330896df9a6af7ee979eef4288e8853207ea150d9e4b6d176a4626570795692ab2faf7a6c4790d07eaa3d927e8e2143e53b304748c08558f
-  data.tar.gz: ec7d60860118f0e8b46e2ae3d147e1065d548d891706cfc26f1d4d45f47fdf87dce130dd62e75763fe01dacca79d32a1a1a485f8b5f9da8a843b2b239a693a85
+  metadata.gz: 92c538b493815dd07fed71cf43bf610c109b988a8aa597647e5b0d5c854120c13c9d8f96b8c04740ece120b952327ac920d41d18589422cfd23fe84ee1cded38
+  data.tar.gz: f69b0f43b36cc020600f91c97aafe3ed523225ac87bb9b62b2764d797e8d40380381b08032303a2d1c54d5a2f02164a8086a1b55bc7ad20d12e5ccf189db2921

data/CHANGELOG.markdown

@@ -1,5 +1,13 @@
 # Unreleased
 
+# 5.6.5
+- Improve error capture API (#555)
+- Add git sha and agent time tracking to error payloads (#554)
+- Add support for named spaced jobs in sampling (#549)
+
+# 5.6.4
+- Use new ActiveJob class name and timestamp units for Sidekiq 8+ (#544)
+
 # 5.6.2
 - Fix deprecation warning for Sidekiq 7.1.5+ (#535)
 - Add support for Mongoid 8 and 9. Remove support for old versions. (#538)

data/lib/scout_apm/background_job_integrations/sidekiq.rb

@@ -69,8 +69,21 @@ module ScoutApm
         end
       end
 
+      def self.sidekiq_version_8?
+        if defined?(::Sidekiq::VERSION)
+          ::Sidekiq::VERSION.to_i >= 8
+        else
+          false
+        end
+      end
+
       UNKNOWN_CLASS_PLACEHOLDER = 'UnknownJob'.freeze
-      ACTIVE_JOB_KLASS = 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper'.freeze
+      # This name was changed in Sidekiq 8
+      ACTIVE_JOB_KLASS = if sidekiq_version_8?
+                          'Sidekiq::ActiveJob::Wrapper'.freeze
+                        else
+                          'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper'.freeze
+                        end
       DELAYED_WRAPPER_KLASS = 'Sidekiq::Extensions::DelayedClass'.freeze
 
 
@@ -119,7 +132,14 @@ module ScoutApm
       def latency(msg, time = Time.now.to_f)
         created_at = msg['enqueued_at'] || msg['created_at']
         if created_at
-          (time - created_at)
+          # Sidekiq 8+ uses milliseconds, older versions use seconds.
+          # Do it this way because downstream expects seconds.
+          if self.class.sidekiq_version_8?
+            # Convert milliseconds to seconds for consistency.
+            (time - (created_at.to_f / 1000.0))
+          else
+            (time - created_at)
+          end
         else
           0
         end

data/lib/scout_apm/error.rb

@@ -5,23 +5,77 @@ module ScoutApm
   module Error
     # Capture an exception, optionally with an environment hash. This may be a
     # Rack environment, but is not required.
-    def self.capture(exception, env={})
-      context = ScoutApm::Agent.instance.context
+    class ScoutDefined < Exception; end
+    class Custom < ScoutDefined; end
+      
+    class << self
+      def capture(exception, env={}, name: "ScoutApm::Error::Custom")
+        context = ScoutApm::Agent.instance.context
 
-      # Skip if error monitoring isn't enabled at all
-      if ! context.config.value("errors_enabled")
-        return false
+        # Skip if error monitoring isn't enabled at all
+        if ! context.config.value("errors_enabled")
+          return false
+        end
+
+        exception = validate_or_create_exception(exception, name)
+        return false unless exception
+
+        # Skip if this one error is ignored
+        if context.ignored_exceptions.ignored?(exception)
+          return false
+        end
+
+        # Capture the error for further processing and shipping
+        context.error_buffer.capture(exception, env)
+
+        return true
+      end
+
+      private
+
+      def get_caller_location
+        caller_locations(0, 10)
+          .reject { |loc| loc.absolute_path == __FILE__ }
+          .map(&:to_s)
+      end
+      
+      def define_error_class(name_str)
+        # e.g., "some_error" → "SomeError", "some error" → "SomeError"
+        class_name = name_str.gsub(/(?:^|[_\s])([a-zA-Z])/) { $1.upcase }
+
+        if Object.const_defined?(class_name)
+          klass = Object.const_get(class_name)
+          return klass if klass.ancestors.include?(ScoutApm::Error::ScoutDefined)
+          
+          log_warning("Error class name '#{class_name}' is already defined. Falling back to ScoutApm::Error::Custom.")
+          return Custom
+        else
+          Object.const_set(class_name, Class.new(ScoutDefined))
+        end
       end
 
-      # Skip if this one error is ignored
-      if context.ignored_exceptions.ignored?(exception)
-        return false
+      def log_warning(message)
+        ScoutApm::Agent.instance.context.logger.warn(message)
       end
 
-      # Capture the error for further processing and shipping
-      context.error_buffer.capture(exception, env)
+      def validate_or_create_exception(exception, name)
+        return exception if exception.is_a?(Exception) && exception.backtrace
 
-      return true
+        if exception.is_a?(Exception)
+          exception.tap do |e| 
+            e.set_backtrace(get_caller_location)
+          end
+
+        elsif exception.is_a?(String)
+          define_error_class(name).new(exception).tap do |e|
+            e.set_backtrace(get_caller_location)
+          end
+
+        else
+          log_warning("Invalid exception type: #{exception.class}. Expected Exception or String.")
+          nil
+        end
+      end
     end
   end
 end

data/lib/scout_apm/error_service/error_record.rb

@@ -12,6 +12,8 @@ module ScoutApm
       attr_reader :trace
       attr_reader :request_components
       attr_reader :context
+      attr_reader :agent_time
+      attr_reader :git_sha
 
       def initialize(agent_context, exception, env, context=nil)
         @agent_context = agent_context
@@ -30,6 +32,8 @@ module ScoutApm
         @environment = clean_params(strip_env(env))
         @trace = clean_backtrace(exception.backtrace)
         @request_components = components(env)
+        @agent_time = Time.now.iso8601
+        @git_sha = @agent_context.environment.git_revision.sha.to_s
       end
 
       # TODO: This is rails specific

data/lib/scout_apm/error_service/payload.rb

@@ -40,6 +40,8 @@ module ScoutApm
           :trace => error_record.trace,
           :request_components => error_record.request_components,
           :context => error_record.context,
+          :agent_time => error_record.agent_time,
+          :git_sha => error_record.git_sha,
         }
       end
     end

data/lib/scout_apm/sampling.rb

@@ -58,7 +58,7 @@ module ScoutApm
       # config looks like ['/foo:50','/bar:100']. parse it into hash of string: integer
       sample_hash = {}
       sampling_config.each do |sample|
-        path, rate = sample.split(':')
+        path, _, rate = sample.rpartition(':')
         sample_hash[path] = rate.to_i
       end
       sample_hash

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "5.6.2"
+  VERSION = "5.6.5"
 end

data/test/unit/background_job_integrations/sidekiq_test.rb

@@ -102,13 +102,21 @@ class SidekiqTest < Minitest::Test
   ########################################
   def test_latency_from_created_at
     # Created at time 80, but now it is 200. Latency was 120
-    msg = { 'created_at' => 80 }
+    msg = if SidekiqMiddleware.sidekiq_version_8?
+            { 'created_at' => 80000 } # milliseconds for Sidekiq 8+
+          else
+            { 'created_at' => 80 }
+          end
     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 }
+    msg = if SidekiqMiddleware.sidekiq_version_8?
+            { 'enqueued_at' => 80000 } # milliseconds for Sidekiq 8+
+          else
+            { 'enqueued_at' => 80 }
+          end
     assert_equal 120, SidekiqMiddleware.new.latency(msg, 200)
   end
 

data/test/unit/error_test.rb

@@ -0,0 +1,69 @@
+require "test_helper"
+
+class ErrorTest < Minitest::Test
+  class FakeError < StandardError
+  end
+
+  def test_captures_and_stores_exceptions_and_env
+    config = make_fake_config(
+      'errors_enabled' => true,
+    )
+    test_context = ScoutApm::AgentContext.new().tap{|c| c.config = config }
+    ScoutApm::Agent.instance.stub(:context, test_context) do
+      exwbt = ex.tap do |e|
+        e.set_backtrace(["/path/to/file.rb:10:in `method_name'"])
+      end
+      assert_equal true, ScoutApm::Error.capture("Oh no an error") # Will be of type ScoutApm::Error::Custom
+      assert_equal true, ScoutApm::Error.capture("Oh no another error") # Will be of type ScoutApm::Error::Custom
+      assert_equal true, ScoutApm::Error.capture("Something went boom", {"boom" => "yes"}, name: "boom_error")
+      assert_equal true, ScoutApm::Error.capture("No env", name: "another error")
+      assert_equal true, ScoutApm::Error.capture(ex, env)
+      assert_equal true, ScoutApm::Error.capture(exwbt, env)
+      assert_equal false, ScoutApm::Error.capture(Class, env)
+      assert_equal true, ScoutApm::Error.capture("Name collision, but", env, name: "ScoutApm")
+      
+      begin
+        raise StandardError, "Whoops"
+      rescue StandardError => e
+        assert_equal true, ScoutApm::Error.capture(e, env)
+      end
+
+      exceptions = ScoutApm::Agent.instance.context.error_buffer.instance_variable_get(:@error_records)
+
+      assert_equal 8, exceptions.length
+      assert_equal "Oh no an error", exceptions[0].message
+      assert_equal "ScoutApm::Error::Custom", exceptions[0].exception_class
+
+      # Ensure we capture time and git sha
+      refute_nil exceptions[0].git_sha
+      assert exceptions[0].agent_time.is_a?(String)
+
+      assert_equal "Oh no another error", exceptions[1].message
+      assert_equal "ScoutApm::Error::Custom", exceptions[1].exception_class
+
+      assert_equal "Something went boom", exceptions[2].message
+      assert_equal "BoomError", exceptions[2].exception_class
+
+      assert_equal "No env", exceptions[3].message
+      assert_equal "AnotherError", exceptions[3].exception_class
+
+      assert_equal "Whoops", exceptions[4].message
+      assert_equal "ErrorTest::FakeError", exceptions[4].exception_class
+
+      assert_equal "/path/to/file.rb:10:in `method_name'", exceptions[5].trace.first
+
+      assert_equal "ScoutApm::Error::Custom", exceptions[6].exception_class
+
+      assert_equal "StandardError", exceptions[7].exception_class
+    end
+  end
+
+  #### Helpers
+  def env
+    {}
+  end
+
+  def ex(msg="Whoops")
+    FakeError.new(msg)
+  end
+end

data/test/unit/sampling_test.rb

@@ -15,7 +15,7 @@ class SamplingTest < Minitest::Test
         {
           'sample_endpoints' => ['/foo/bar:100', '/foo:50', '/bar/zap:80'],
           'ignore_endpoints' => ['/baz'],
-          'sample_jobs' => ['joba:50'],
+          'sample_jobs' => ['joba:50', 'Foo::BarJob:95'],
           'ignore_jobs' => 'jobb,jobc',
         }
       )
@@ -59,6 +59,7 @@ class SamplingTest < Minitest::Test
     def test_job_sample
       sampling = ScoutApm::Sampling.new(@individual_config)
       assert_equal 50, sampling.job_sample_rate('joba')
+      assert_equal 95, sampling.job_sample_rate('Foo::BarJob')
       assert_nil sampling.job_sample_rate('jobb')
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 5.6.2
+  version: 5.6.5
 platform: ruby
 authors:
 - Derek Haynes
 - Andre Lewis
 bindir: bin
 cert_chain: []
-date: 2025-03-20 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -443,6 +443,7 @@ files:
 - test/unit/environment_test.rb
 - test/unit/error_service/error_buffer_test.rb
 - test/unit/error_service/ignored_exceptions_test.rb
+- test/unit/error_test.rb
 - test/unit/extensions/periodic_callbacks_test.rb
 - test/unit/extensions/transaction_callbacks_test.rb
 - test/unit/external_service_metric_set_test.rb
@@ -508,7 +509,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby application performance monitoring
 test_files: []