scout_apm 5.1.1 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a1da3776ca231a4d81c9ab5935e6b644ab46ae5609cef60402ccd5258e07795
-  data.tar.gz: f583776f39fa426aa43d1942bd83e4bcd23ca3a6f71a2e883df22a74cb2db868
+  metadata.gz: 81ad3b683899407ed049b7267d6d79a84d5afac011445d1078f4342c345c7ace
+  data.tar.gz: 29e141854923fa21c57ca3fcc7ca9e4cc96dbd741c36c0586e7fd2cd7a8186f8
 SHA512:
-  metadata.gz: bc2f10c76ea8abbb6f74cbe86cbd0e0d1265143a19008307609be35adb57737f474c9a2f59545e2f36b00b5006c5f1b9726f59e70c3e327e6487eb2445e07df6
-  data.tar.gz: 8863c891bbd5f1e87d56a06f8275cbcf711b15964116cbddbb648398825eed65fa6ce73cd3848815e8ab8a1eec1f8a2e4a878682e2d47d457778786532ee3db4
+  metadata.gz: a857678f6d91c709fbbdfb30409339f37e99cd83260cec9d3808f81638245de03cf4b0721270203f0ee619cc56b06fc3baa795a10e859c3068e0e2c36a2247b2
+  data.tar.gz: 972da0997d251c5704291e60e390916a417de3036aadcada469540acd20520f4edd95b3b76da9202734755bc37c3a9a22e44916c23e74c9199d3c6a7a2447797

data/.github/workflows/test.yml

@@ -36,6 +36,9 @@ jobs:
             bundler: 1.17.3
           - ruby: 2.7
           - ruby: 3.0
+          - ruby: 3.0
+            gemfile: gems/sidekiq.gemfile
+            test_features: "sidekiq_install"
 
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # Unreleased
 
+# 5.2.0
+
+* Use Sidekiq lifecycle hooks to start Scout agent on Sidekiq start. (#449)
+
 # 5.1.1
 
 * Improvements to SqlServer scrubbing in SqlSanitizer (#422)

data/gems/sidekiq.gemfile

@@ -0,0 +1,4 @@
+eval_gemfile("../Gemfile")
+
+# https://github.com/scoutapp/scout_apm_ruby/issues/449
+gem 'sidekiq', '>= 6.5.0'

data/lib/scout_apm/background_job_integrations/sidekiq.rb

@@ -37,17 +37,11 @@ module ScoutApm
       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(*args)
+        ::Sidekiq.configure_server do |config|
+          config.on(:startup) do
             agent = ::ScoutApm::Agent.instance
             agent.start
-            initialize_without_scout(*args)
           end
-
-          alias_method :initialize_without_scout, :initialize
-          alias_method :initialize, :initialize_with_scout
         end
       end
     end

data/lib/scout_apm/store.rb

@@ -217,6 +217,7 @@ module ScoutApm
 
     def initialize(timestamp, context)
       @timestamp = timestamp
+      @context = context
 
       @request_traces = ScoredItemSet.new(context.config.value('max_traces'))
       @job_traces = ScoredItemSet.new(context.config.value('max_traces'))
@@ -230,6 +231,11 @@ module ScoutApm
       @jobs = Hash.new
     end
 
+    def logger
+      @context.logger
+    end
+    private :logger
+
     # Merges another StoreReportingPeriod into this one
     def merge(other)
       self.

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "5.1.1"
+  VERSION = "5.2.0"
 end

data/test/unit/background_job_integrations/sidekiq_test.rb

@@ -3,8 +3,25 @@ require 'scout_apm/request_manager'
 require 'scout_apm/background_job_integrations/sidekiq'
 
 class SidekiqTest < Minitest::Test
+  SidekiqIntegration = ScoutApm::BackgroundJobIntegrations::Sidekiq
   SidekiqMiddleware = ScoutApm::BackgroundJobIntegrations::SidekiqMiddleware
 
+  ########################################
+  # Install
+  ########################################
+  if (ENV["SCOUT_TEST_FEATURES"] || "").include?("sidekiq_install")
+    require 'sidekiq'
+
+    # Sidekiq::CLI needs to be defined in order for `Sidekiq.configure_server` to work
+    Sidekiq::CLI = nil
+
+    def test_starts_on_startup
+      ::ScoutApm::Agent.any_instance.expects(:start)
+      SidekiqIntegration.new.install
+      Sidekiq.options[:lifecycle_events][:startup].map(&:call)
+    end
+  end
+
   ########################################
   # Middleware
   ########################################

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 5.1.1
+  version: 5.2.0
 platform: ruby
 authors:
 - Derek Haynes
 - Andre Lewis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-14 00:00:00.000000000 Z
+date: 2022-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -237,6 +237,7 @@ files:
 - gems/rails4.gemfile
 - gems/rails5.gemfile
 - gems/rails6.gemfile
+- gems/sidekiq.gemfile
 - gems/typhoeus.gemfile
 - lib/scout_apm.rb
 - lib/scout_apm/agent.rb
@@ -472,7 +473,7 @@ homepage: https://github.com/scoutapp/scout_apm_ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -488,8 +489,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Ruby application performance monitoring
 test_files: []