scout_apm 5.6.1 → 5.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 351ed300191874b86b1c402a2696897d05006266c2c88716a15d8588aefa00b2
-  data.tar.gz: dcdc4fb47007eb665f7a4df6a3a9a7bcde78550656692fc5023020739b0974d9
+  metadata.gz: 6825b0cb6be5706305fa47b48fe8f84a89f0bf6019deb5914547d720e13db875
+  data.tar.gz: 5a5163d1c0f05f6ebe87aa0948e426b9332ff66121bc04c33048cad1ddef5e89
 SHA512:
-  metadata.gz: 8fe62cd0646f58ad535d3912cf9c023fb8d7c52116dd30b3359e7f33f50f51ba3457090fe2df8f0bec5e5194b02bcccb44feaa466d76fa14938b91f11f1f74c0
-  data.tar.gz: cd20a788b47c33be24c8ee88eb00d443bf3d20990ba3fb769ca64353b14b090b931c121d6f07aa40bd366381f3f77646b41206e66cb9507cb204ee3eaadf62fe
+  metadata.gz: d2853cef258799e5330896df9a6af7ee979eef4288e8853207ea150d9e4b6d176a4626570795692ab2faf7a6c4790d07eaa3d927e8e2143e53b304748c08558f
+  data.tar.gz: ec7d60860118f0e8b46e2ae3d147e1065d548d891706cfc26f1d4d45f47fdf87dce130dd62e75763fe01dacca79d32a1a1a485f8b5f9da8a843b2b239a693a85

data/.github/workflows/test.yml

@@ -42,6 +42,12 @@ jobs:
           - ruby: "3.0"
             gemfile: gems/sidekiq.gemfile
             test_features: "sidekiq_install"
+          - ruby: "3.0"
+            gemfile: gems/sidekiq7.gemfile
+            test_features: "sidekiq_install"
+          - ruby: "3.3"
+            gemfile: gems/sidekiq8.gemfile
+            test_features: "sidekiq_install"
           - ruby: 3.1
           - ruby: 3.2
             gemfile: gems/sqlite3-v2.gemfile

data/CHANGELOG.markdown

@@ -1,10 +1,15 @@
 # Unreleased
 
+# 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)
+- Detect deployed SHA from Kamal (#528)
+
 # 5.6.1
 - Fix `job_sample_rate` and `endpoint_sample_rate` default configuration values (#529)
 
 # 5.6.0
-- New options for sampling and ignore configurationn (#521)
+- New options for sampling and ignore configuration (#521)
   - `sample_rate` - Set the rate at which requests are sampled globally (1-100, a percentage of requests to keep).
   - `ignore_endpoints` - Ignore endpoints by regex matching prefix (Same as and replaces `ignore`)
   - `sample_endpoints` - Sample endpoints by regex matching prefix (i.e. ['/foo:70']).

data/gems/rails7.gemfile

@@ -0,0 +1,4 @@
+eval_gemfile("../Gemfile")
+
+gem "rails", "~> 7.0"
+gem "sqlite3", "~> 1.4"

data/gems/sidekiq7.gemfile

@@ -0,0 +1,3 @@
+eval_gemfile("../Gemfile")
+
+gem 'sidekiq', '~> 7.0'

data/gems/sidekiq8.gemfile

@@ -0,0 +1,4 @@
+eval_gemfile("../Gemfile")
+
+gem 'sqlite3', '~> 2.0'
+gem 'sidekiq', '~> 8.0'

data/lib/scout_apm/auto_instrument/layer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module ScoutApm
   def self.AutoInstrument(name, backtrace)

data/lib/scout_apm/error_service/sidekiq.rb

@@ -28,7 +28,7 @@ module ScoutApm
 
       def install_sidekiq_with_error_handler
         ::Sidekiq.configure_server do |config|
-          config.error_handlers << proc { |exception, job_info|
+          config.error_handlers << proc { |exception, job_info, sidekiq_config|
             context = ScoutApm::Agent.instance.context
 
             # Bail out early, and reraise if the error is not interesting.

data/lib/scout_apm/git_revision.rb

@@ -20,6 +20,7 @@ module ScoutApm
       detect_from_config     ||
       detect_from_heroku     ||
       detect_from_capistrano ||
+      detect_from_kamal ||
       detect_from_mina ||
       detect_from_git
     end
@@ -44,8 +45,13 @@ module ScoutApm
       nil
     end
 
+    # https://github.com/basecamp/kamal
+    def detect_from_kamal
+      ENV['KAMAL_VERSION']
+    end
+
     # https://github.com/mina-deploy/mina
-    def detect_from_mina 
+    def detect_from_mina
       File.read(File.join(app_root, '.mina_git_revision')).strip
     rescue
       logger.debug "Unable to detect Git Revision from Mina: #{$!.message}"

data/lib/scout_apm/instruments/mongoid.rb

@@ -20,25 +20,12 @@ module ScoutApm
         @installed = true
 
         # Mongoid versions that use Moped should instrument Moped.
+        ### See moped instrument for Moped driven deploys
         if defined?(::Mongoid) and !defined?(::Moped)
-          logger.info "Instrumenting Mongoid 2.x"
           @installed = true
 
-          ### OLD (2.x) mongoids
-          if defined?(::Mongoid::Collection)
-            ::Mongoid::Collection.class_eval do
-              include ScoutApm::Tracer
-              (::Mongoid::Collections::Operations::ALL - [:<<, :[]]).each do |method|
-                instrument_method method, :type => "MongoDB", :name => '#{@klass}/' + method.to_s
-              end
-            end
-          end
-
-          ### See moped instrument for Moped driven deploys
-
-          ### 5.x Mongoid
-          if (mongoid_v5? || mongoid_v6? || mongoid_v7?) && defined?(::Mongoid::Contextual::Mongo)
-            logger.info "Instrumenting Mongoid 5.x/6.x/7.x"
+          if (mongoid_at_least_5?) && defined?(::Mongoid::Contextual::Mongo)
+            logger.info "Instrumenting Mongoid"
             # All the public methods from Mongoid::Contextual::Mongo.
             # TODO: Geo and MapReduce support (?). They are in other Contextual::* classes
             methods = [
@@ -88,31 +75,17 @@ module ScoutApm
                 ]
 
                 ::Mongoid::Contextual::Mongo.class_eval(with_scout_instruments)
+              else
+                logger.warn "Expected method #{method} not defined in Mongoid::Contextual::Mongo."
               end
             end
           end
         end
       end
 
-      def mongoid_v5?
-        if defined?(::Mongoid::VERSION)
-          ::Mongoid::VERSION =~ /\A5/
-        else
-          false
-        end
-      end
-
-      def mongoid_v6?
+      def mongoid_at_least_5?
         if defined?(::Mongoid::VERSION)
-          ::Mongoid::VERSION =~ /\A6/
-        else
-          false
-        end
-      end
-
-      def mongoid_v7?
-        if defined?(::Mongoid::VERSION)
-          ::Mongoid::VERSION =~ /\A7/
+          ::Mongoid::VERSION =~ /\A[56789]/
         else
           false
         end
@@ -134,4 +107,3 @@ module ScoutApm
     end
   end
 end
-

data/lib/scout_apm/tracked_request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A TrackedRequest is a stack of layers, where completed layers (go into, then
 # come out of a layer) are forgotten as they finish. Layers are attached to
 # their children as the process goes, building a tree structure within the

data/lib/scout_apm/version.rb

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

data/test/unit/background_job_integrations/sidekiq_test.rb

@@ -18,7 +18,9 @@ class SidekiqTest < Minitest::Test
     def test_starts_on_startup
       ::ScoutApm::Agent.any_instance.expects(:start)
       SidekiqIntegration.new.install
-      Sidekiq.options[:lifecycle_events][:startup].map(&:call)
+      ::Sidekiq.configure_server do |config|
+        config[:lifecycle_events][:startup].map(&:call)
+      end
     end
   end
 

data/test/unit/config_test.rb

@@ -89,7 +89,7 @@ class ConfigTest < Minitest::Test
     assert_equal 0, coercion.coerce("0")
     assert_equal 0, coercion.coerce(0)
     assert_equal 0, coercion.coerce("")
-    assert_equal nil, coercion.coerce(nil)
+    assert_nil coercion.coerce(nil)
   end
 
   def test_any_keys_found

data/test/unit/git_revision_test.rb

@@ -3,13 +3,75 @@ require 'test_helper'
 require 'scout_apm/git_revision'
 
 class GitRevisionTest < Minitest::Test
-  # TODO - other tests that would be nice:
-  # * ensure we only detect once, on initialize.
-  # * tests for reading cap files
+  def setup
+    @env = ENV.to_h
+  end
+
+  def teardown
+    ENV.replace(@env)
+  end
+
+  def test_sha_detected_once
+    ENV['HEROKU_SLUG_COMMIT'] = 'initial_slug'
+    revision = ScoutApm::GitRevision.new(ScoutApm::AgentContext.new)
+    assert_equal 'initial_slug', revision.sha
+
+    ENV['HEROKU_SLUG_COMMIT'] = 'new_slug'
+    assert_equal 'initial_slug', revision.sha
+  end
+
+  def test_sha_from_config
+    config = make_fake_config('revision_sha' => 'config_sha')
+    context = ScoutApm::AgentContext.new().tap { |c| c.config = config }
+    revision = ScoutApm::GitRevision.new(context)
+
+    assert_equal 'config_sha', revision.sha
+  end
 
   def test_sha_from_heroku
     ENV['HEROKU_SLUG_COMMIT'] = 'heroku_slug'
     revision = ScoutApm::GitRevision.new(ScoutApm::AgentContext.new)
     assert_equal 'heroku_slug', revision.sha
   end
+
+  def test_sha_from_capistrano
+    Dir.mktmpdir do |dir|
+      context = context_with_file_in_root(File.join(dir, 'REVISION'), 'capistrano_sha')
+      revision = ScoutApm::GitRevision.new(context)
+      assert_equal 'capistrano_sha', revision.sha
+    end
+  end
+
+  def test_sha_from_kamal
+    ENV['KAMAL_VERSION'] = 'kamal_sha'
+    revision = ScoutApm::GitRevision.new(ScoutApm::AgentContext.new)
+    assert_equal 'kamal_sha', revision.sha
+  end
+
+
+  def test_sha_from_mina
+    Dir.mktmpdir do |dir|
+      context = context_with_file_in_root(File.join(dir, '.mina_git_revision'), 'mina_sha')
+      revision = ScoutApm::GitRevision.new(context)
+      assert_equal 'mina_sha', revision.sha
+    end
+  end
+
+  def test_sha_from_git
+    short_sha = `git rev-parse --short HEAD`.strip
+    skip 'git not installed or not in a git repository' if short_sha.empty?
+
+    revision = ScoutApm::GitRevision.new(ScoutApm::AgentContext.new)
+    assert_equal short_sha, revision.sha
+  end
+
+  private
+
+  def context_with_file_in_root(file_name, contents)
+    config = make_fake_config({})
+    env = make_fake_environment(root: File.dirname(file_name))
+    File.write(file_name, contents)
+
+    ScoutApm::AgentContext.new().tap { |c| c.config = config; c.environment = env }
+  end
 end

data/test/unit/sampling_test.rb

@@ -26,7 +26,7 @@ class SamplingTest < Minitest::Test
       assert_equal({'/foo/bar' => 100, '/foo' => 50, '/bar/zap' => 80}, sampling.individual_sample_to_hash(@individual_config.value('sample_endpoints')))
 
       sampling = ScoutApm::Sampling.new(@global_sample_config)
-      assert_equal nil, sampling.individual_sample_to_hash(@global_sample_config.value('sample_endpoints'))
+      assert_nil sampling.individual_sample_to_hash(@global_sample_config.value('sample_endpoints'))
     end
 
     def test_uri_ignore
@@ -41,10 +41,10 @@ class SamplingTest < Minitest::Test
       assert_equal 50, rate
 
       rate = sampling.web_sample_rate('/bar')
-      assert_equal nil, rate
+      assert_nil rate
 
       rate = sampling.web_sample_rate('/baz/bap')
-      assert_equal nil, rate
+      assert_nil rate
 
       rate = sampling.web_sample_rate('/foo/bar/baz')
       assert_equal 100, rate
@@ -59,7 +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 nil, sampling.job_sample_rate('jobb')
+      assert_nil sampling.job_sample_rate('jobb')
     end
 
     def test_sample

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 5.6.1
+  version: 5.6.2
 platform: ruby
 authors:
 - Derek Haynes
 - Andre Lewis
 bindir: bin
 cert_chain: []
-date: 2025-02-21 00:00:00.000000000 Z
+date: 2025-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -238,7 +238,10 @@ files:
 - gems/rails4.gemfile
 - gems/rails5.gemfile
 - gems/rails6.gemfile
+- gems/rails7.gemfile
 - gems/sidekiq.gemfile
+- gems/sidekiq7.gemfile
+- gems/sidekiq8.gemfile
 - gems/sqlite3-v2.gemfile
 - gems/typhoeus.gemfile
 - lib/scout_apm.rb