scout_apm 5.3.7 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a0f837b1786c1e41925b01d4f2c03964c3541bf92666920f0bb8a0ba7cbdb89
-  data.tar.gz: 050c8858b43539abf92b893f8a1664e448d860fef2a3aa28f03af23e95941dd3
+  metadata.gz: 6e125a347fd3bbfa0b52f6dde597daf1dc95d97ba95cb6c44553bc36fae71b82
+  data.tar.gz: 9f0c708e386be527f255582195a791938c1663b418999816b79f25e4f7caaf6f
 SHA512:
-  metadata.gz: 05cf25c9161a0d2e1a5b5a0f5bffd9dfb27d05d9adc17e39a860ff55653c307e7815315b978bc75aa8f7e77fee8ba7a4f57e9a67009472ea40a9f80d02857f47
-  data.tar.gz: 54198b64b284943f81384fc992f0446e871f8630f4693ecce8d774728cdc20e02d078dc77213496b7b581af73cd7566c224557f319b6134056c32b5975e78041
+  metadata.gz: d7e079bde40861cf673834ec606f8a09fc84bd4416eddccd22abd29d5cd64dbf071347d832549f840dd3b07026c8a3d4e6788f458587128482a1b44682479ec4
+  data.tar.gz: e20c7d5fadbfe008f1febb62e3e31e5aa23cc4410f02634329493b10159603fb467e4ae66d504709f247ff457b0bf5d386f62baa0835010e7e5a0954160f7b97

data/.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release Gem
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+# Directly from https://github.com/rubygems/release-gem/tree/v1
+# Predicated on Tag Ruleset preventing arbitrary tag creation and
+# requiring checks to pass for commit before tag creation
+jobs:
+  push:
+    name: Push gem to RubyGems.org
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+      contents: write # IMPORTANT: this permission is required for `rake release` to push the release tag
+
+    steps:
+      # Set up
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      # Release
+      - uses: rubygems/release-gem@v1

data/.github/workflows/test.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
@@ -23,7 +23,9 @@ jobs:
             gemfile: gems/rails3.gemfile
           - ruby: 2.2
           - ruby: 2.3
+            gemfile: gems/sqlite3-1.3.gemfile
           - ruby: 2.4
+            gemfile: gems/sqlite3-1.3.gemfile
           - ruby: 2.5
           - ruby: 2.6
           - ruby: 2.6
@@ -31,9 +33,6 @@ jobs:
             test_features: "typhoeus"
           - ruby: 2.6
             gemfile: gems/octoshark.gemfile
-          - ruby: 2.6
-            gemfile: gems/rails3.gemfile
-            bundler: 1.17.3
           - ruby: 2.7
           - ruby: 2.7
             prepend: true
@@ -61,7 +60,7 @@ jobs:
     runs-on: ${{ matrix.ruby == '2.2' && 'ubuntu-20.04' || 'ubuntu-latest' }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true

data/CHANGELOG.markdown

@@ -1,5 +1,12 @@
 # Unreleased
 
+# 5.4.0
+* Add support for GoodJob (#506)
+* Add support for Solid Queue (#508)
+
+# 5.3.8
+* Avoid inaccurate websocket queue time capturing (#494)
+
 # 5.3.7
 * Fix parser dependency issue
 

data/gems/sqlite3-1.3.gemfile

@@ -0,0 +1,3 @@
+eval_gemfile("../Gemfile")
+
+gem "sqlite3", "~> 1.3.5"

data/lib/scout_apm/background_job_integrations/good_job.rb

@@ -0,0 +1,49 @@
+module ScoutApm
+  module BackgroundJobIntegrations
+    class GoodJob
+      UNKNOWN_QUEUE_PLACEHOLDER = 'default'.freeze
+      attr_reader :logger
+
+      def name
+        :good_job
+      end
+
+      def present?
+        defined?(::GoodJob::VERSION)
+      end
+
+      def forking?
+        false
+      end
+
+      def install
+        ActiveSupport.on_load(:active_job) do
+          include ScoutApm::Tracer
+
+          around_perform do |job, block|
+            # I have a sneaking suspicion there is a better way to handle Agent starting
+            # Maybe hook into GoodJob lifecycle events?
+            req = ScoutApm::RequestManager.lookup
+            latency = Time.now - (job.scheduled_at || job.enqueued_at) rescue 0
+            req.annotate_request(queue_latency: latency)
+
+            begin
+              req.start_layer ScoutApm::Layer.new("Queue", job.queue_name.presence || UNKNOWN_QUEUE_PLACEHOLDER)
+              started_queue = true # Following Convention
+              req.start_layer ScoutApm::Layer.new("Job", job.class.name)
+              started_job = true # Following Convention
+
+              block.call
+            rescue
+              req.error!
+              raise
+            ensure
+              req.stop_layer if started_job
+              req.stop_layer if started_queue
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scout_apm/background_job_integrations/solid_queue.rb

@@ -0,0 +1,47 @@
+module ScoutApm
+  module BackgroundJobIntegrations
+    class SolidQueue
+      UNKNOWN_QUEUE_PLACEHOLDER = 'default'.freeze
+      attr_reader :logger
+
+      def name
+        :solid_queue
+      end
+
+      def present?
+        defined?(::SolidQueue::VERSION)
+      end
+
+      def forking?
+        false
+      end
+
+      def install
+        ActiveSupport.on_load(:active_job) do
+          include ScoutApm::Tracer
+
+          around_perform do |job, block|
+            req = ScoutApm::RequestManager.lookup
+            latency = Time.now - (job.scheduled_at || job.enqueued_at) rescue 0
+            req.annotate_request(queue_latency: latency)
+
+            begin
+              req.start_layer ScoutApm::Layer.new("Queue", job.queue_name.presence || UNKNOWN_QUEUE_PLACEHOLDER)
+              started_queue = true # Following Convention
+              req.start_layer ScoutApm::Layer.new("Job", job.class.name)
+              started_job = true # Following Convention
+
+              block.call
+            rescue
+              req.error!
+              raise
+            ensure
+              req.stop_layer if started_job
+              req.stop_layer if started_queue
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scout_apm/environment.rb

@@ -31,6 +31,8 @@ module ScoutApm
       ScoutApm::BackgroundJobIntegrations::DelayedJob.new,
       ScoutApm::BackgroundJobIntegrations::Que.new,
       ScoutApm::BackgroundJobIntegrations::Faktory.new,
+      ScoutApm::BackgroundJobIntegrations::GoodJob.new,
+      ScoutApm::BackgroundJobIntegrations::SolidQueue.new,
     ]
 
     FRAMEWORK_INTEGRATIONS = [

data/lib/scout_apm/layer_converters/request_queue_time_converter.rb

@@ -15,6 +15,9 @@ module ScoutApm
 
         return unless headers
 
+        # When an application uses Turbo Streams, we capture very innaccurate queue times.
+        return if request_over_websocket?
+
         raw_start = locate_timestamp
         return unless raw_start
 
@@ -38,6 +41,10 @@ module ScoutApm
 
       private
 
+      def request_over_websocket?
+        headers["Upgrade"] == "websocket"
+      end
+
       # Looks through the possible headers with this data, and extracts the raw
       # value of the header
       # Returns nil if not found

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "5.3.7"
+  VERSION = "5.4.0"
 end

data/lib/scout_apm.rb

@@ -67,6 +67,8 @@ require 'scout_apm/background_job_integrations/shoryuken'
 require 'scout_apm/background_job_integrations/sneakers'
 require 'scout_apm/background_job_integrations/que'
 require 'scout_apm/background_job_integrations/legacy_sneakers'
+require 'scout_apm/background_job_integrations/good_job'
+require 'scout_apm/background_job_integrations/solid_queue'
 
 require 'scout_apm/framework_integrations/rails_2'
 require 'scout_apm/framework_integrations/rails_3_or_4'

data/scout_apm.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
   # tests. Specific versions are pulled in using specific gemfiles, e.g.
   # `gems/rails3.gemfile`.
   s.add_development_dependency "activerecord"
-  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "sqlite3",  "~> 1.4"
 
   s.add_development_dependency "rubocop"
   s.add_development_dependency "guard"

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 5.3.7
+  version: 5.4.0
 platform: ruby
 authors:
 - Derek Haynes
 - Andre Lewis
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-07 00:00:00.000000000 Z
+date: 2024-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -141,16 +141,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -216,6 +216,7 @@ extensions:
 - ext/rusage/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -239,6 +240,7 @@ files:
 - gems/rails5.gemfile
 - gems/rails6.gemfile
 - gems/sidekiq.gemfile
+- gems/sqlite3-1.3.gemfile
 - gems/typhoeus.gemfile
 - lib/scout_apm.rb
 - lib/scout_apm/agent.rb
@@ -254,12 +256,14 @@ files:
 - lib/scout_apm/auto_instrument/rails.rb
 - lib/scout_apm/background_job_integrations/delayed_job.rb
 - lib/scout_apm/background_job_integrations/faktory.rb
+- lib/scout_apm/background_job_integrations/good_job.rb
 - lib/scout_apm/background_job_integrations/legacy_sneakers.rb
 - lib/scout_apm/background_job_integrations/que.rb
 - lib/scout_apm/background_job_integrations/resque.rb
 - lib/scout_apm/background_job_integrations/shoryuken.rb
 - lib/scout_apm/background_job_integrations/sidekiq.rb
 - lib/scout_apm/background_job_integrations/sneakers.rb
+- lib/scout_apm/background_job_integrations/solid_queue.rb
 - lib/scout_apm/background_recorder.rb
 - lib/scout_apm/background_worker.rb
 - lib/scout_apm/bucket_name_splitter.rb
@@ -485,7 +489,7 @@ homepage: https://github.com/scoutapp/scout_apm_ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -501,78 +505,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubygems_version: 3.5.16
+signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring
-test_files:
-- test/data/config_test_1.yml
-- test/test_helper.rb
-- test/tmp/README.md
-- test/unit/agent_context_test.rb
-- test/unit/agent_test.rb
-- test/unit/auto_instrument/anonymous_block_value.rb
-- test/unit/auto_instrument/assignments-instrumented.rb
-- test/unit/auto_instrument/assignments.rb
-- test/unit/auto_instrument/controller-ast.txt
-- test/unit/auto_instrument/controller-instrumented.rb
-- test/unit/auto_instrument/controller.rb
-- test/unit/auto_instrument/hanging_method.rb
-- test/unit/auto_instrument/hash_shorthand_controller-instrumented.rb
-- test/unit/auto_instrument/hash_shorthand_controller.rb
-- 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/sidekiq_test.rb
-- test/unit/config_test.rb
-- test/unit/context_test.rb
-- test/unit/db_query_metric_set_test.rb
-- test/unit/db_query_metric_stats_test.rb
-- test/unit/environment_test.rb
-- test/unit/error_service/error_buffer_test.rb
-- test/unit/error_service/ignored_exceptions_test.rb
-- test/unit/extensions/periodic_callbacks_test.rb
-- test/unit/extensions/transaction_callbacks_test.rb
-- test/unit/external_service_metric_set_test.rb
-- test/unit/external_service_metric_stats_test.rb
-- test/unit/fake_store_test.rb
-- test/unit/git_revision_test.rb
-- test/unit/histogram_test.rb
-- test/unit/ignored_uris_test.rb
-- test/unit/instruments/action_view_test.rb
-- test/unit/instruments/active_record_test.rb
-- test/unit/instruments/fixtures/test/_test_partial.html.erb
-- test/unit/instruments/fixtures/test/_test_partial_collection.html.erb
-- test/unit/instruments/fixtures/test_view.html.erb
-- test/unit/instruments/http_client_test.rb
-- test/unit/instruments/http_test.rb
-- test/unit/instruments/moped_test.rb
-- test/unit/instruments/net_http_test.rb
-- test/unit/instruments/percentile_sampler_test.rb
-- test/unit/instruments/redis_test.rb
-- test/unit/instruments/typhoeus_test.rb
-- test/unit/layaway_test.rb
-- test/unit/layer_children_set_test.rb
-- test/unit/layer_converters/depth_first_walker_test.rb
-- test/unit/layer_converters/metric_converter_test.rb
-- test/unit/layer_converters/stubs.rb
-- test/unit/limited_layer_test.rb
-- test/unit/logger_test.rb
-- test/unit/metric_set_test.rb
-- test/unit/remote/message_test.rb
-- test/unit/remote/route_test.rb
-- test/unit/remote/server_test.rb
-- test/unit/request_histograms_test.rb
-- test/unit/scored_item_set_test.rb
-- test/unit/serializers/payload_serializer_test.rb
-- test/unit/slow_request_policy_test.rb
-- test/unit/sql_sanitizer_test.rb
-- test/unit/store_test.rb
-- test/unit/tracer_test.rb
-- test/unit/tracked_request_test.rb
-- test/unit/transaction_test.rb
-- test/unit/transaction_time_consumed_test.rb
-- test/unit/utils/active_record_metric_name_test.rb
-- test/unit/utils/backtrace_parser_test.rb
-- test/unit/utils/numbers_test.rb
-- test/unit/utils/scm.rb
+test_files: []