scout_apm 4.0.3 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b992479d1f96a3acca3f9cdbbafad0eb87e6fc88ec53e5de8f6360d01fe21eae
-  data.tar.gz: 2bd72c79abe8628029ac8c541e0fccff18e54fe5d43558148daebe95e7418e0c
+  metadata.gz: 16b10ca7e3c7474546feb2b367438e9fabeb2c799e85608b96afb3ddea37b647
+  data.tar.gz: 044ced73909cff452e59bccf14e7dfcf344fd8f6262c5b633b0d3239995609fd
 SHA512:
-  metadata.gz: edf84c2a3b8a60961e9f3452b2ca0f10b963501becd9d30889a0acb671ac39267ee44e31279a78ae6a6375365e9c06c9f8d24b8c8f426fa2e512be6c5b141a1f
-  data.tar.gz: 713bd41d14c74e0655e38002195355263f9413fab013deddb67019437c193169968d26b6a33a058cf8480b8249bd7cf87a6ccf530f2a9b319c8fd1b5875af8e7
+  metadata.gz: c2ae77ef620e77bce7b267fe8c39ff2f91945dfffc3ad008dd01cbd3b45268a8b44624713652d1df2bdeb2789bedb1fdb98aa58742b48326b1821ea01482132d
+  data.tar.gz: c533bf6cf2822f7688b4377e9f69e005eb1255c0c03cd000dd5d4edaef74b7761b4b8af9b8d39d1229480fd7f2cd0b0f6bcaf1890be5b3f6a9540bf7f8e03f64

data/CHANGELOG.markdown

@@ -1,3 +1,9 @@
+# 4.0.4
+
+* Add Faktory Support (#385)
+* Remove Regexp hack for 1.8.7 (no longer supported) (#384)
+* More robust DelayedJob detection (#382)
+* Fix kwargs handling in Tracing module (#381)
 # 4.0.3
 
 * Handle edge case with nil Typhoeus current-layer (#380)

data/lib/scout_apm.rb

@@ -58,6 +58,7 @@ require 'scout_apm/server_integrations/webrick'
 require 'scout_apm/server_integrations/null'
 
 require 'scout_apm/background_job_integrations/sidekiq'
+require 'scout_apm/background_job_integrations/faktory'
 require 'scout_apm/background_job_integrations/delayed_job'
 require 'scout_apm/background_job_integrations/resque'
 require 'scout_apm/background_job_integrations/shoryuken'

data/lib/scout_apm/background_job_integrations/delayed_job.rb

@@ -11,7 +11,7 @@ module ScoutApm
       end
 
       def present?
-        defined?(::Delayed::Job)
+        defined?(::Delayed::Worker)
       end
 
       def forking?

data/lib/scout_apm/background_job_integrations/faktory.rb

@@ -0,0 +1,103 @@
+module ScoutApm
+  module BackgroundJobIntegrations
+    class Faktory
+      attr_reader :logger
+
+      def name
+        :faktory
+      end
+
+      def present?
+        defined?(::Faktory)
+      end
+
+      def forking?
+        false
+      end
+
+      def install
+        add_middleware
+        install_processor
+      end
+
+      def add_middleware
+        ::Faktory.configure_worker do |config|
+          config.worker_middleware do |chain|
+            chain.add FaktoryMiddleware
+          end
+        end
+      end
+
+      def install_processor
+        require 'faktory/processor' # sidekiq v4 has not loaded this file by this point
+
+        ::Faktory::Processor.class_eval do
+          def initialize_with_scout(*args)
+            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
+
+    # We insert this middleware into the Sidekiq stack, to capture each job,
+    # and time them.
+    class FaktoryMiddleware
+      def call(worker_instance, job)
+        queue = job["queue"]
+
+        req = ScoutApm::RequestManager.lookup
+        req.annotate_request(:queue_latency => latency(job))
+
+        begin
+          req.start_layer(ScoutApm::Layer.new('Queue', queue))
+          started_queue = true
+          req.start_layer(ScoutApm::Layer.new('Job', job_class(job)))
+          started_job = true
+
+          yield
+        rescue
+          req.error!
+          raise
+        ensure
+          req.stop_layer if started_job
+          req.stop_layer if started_queue
+        end
+      end
+
+      UNKNOWN_CLASS_PLACEHOLDER = 'UnknownJob'.freeze
+      ACTIVE_JOB_KLASS = 'ActiveJob::QueueAdapters::FaktoryAdapter::JobWrapper'.freeze
+
+      def job_class(job)
+        job_class = job.fetch('jobtype', UNKNOWN_CLASS_PLACEHOLDER)
+
+        if job_class == ACTIVE_JOB_KLASS && job.key?('custom') && job['custom'].key?('wrapped')
+          begin
+            job_class = job['custom']['wrapped']
+          rescue
+            ACTIVE_JOB_KLASS
+          end
+        end
+
+        job_class
+      rescue
+        UNKNOWN_CLASS_PLACEHOLDER
+      end
+
+      def latency(job, time = Time.now)
+        created_at = Time.parse(job['enqueued_at'] || job['created_at'])
+        if created_at
+          (time - created_at)
+        else
+          0
+        end
+      rescue
+        0
+      end
+    end
+  end
+end

data/lib/scout_apm/environment.rb

@@ -30,6 +30,7 @@ module ScoutApm
       ScoutApm::BackgroundJobIntegrations::Sneakers.new,
       ScoutApm::BackgroundJobIntegrations::DelayedJob.new,
       ScoutApm::BackgroundJobIntegrations::Que.new,
+      ScoutApm::BackgroundJobIntegrations::Faktory.new,
     ]
 
     FRAMEWORK_INTEGRATIONS = [
@@ -197,7 +198,7 @@ module ScoutApm
       ruby_2? || ruby_3?
     end
 
-    # Returns true if this Ruby version supports Module#prepend.
+    # Returns true if this Ruby version makes positional and keyword arguments incompatible
     def supports_kwarg_delegation?
       ruby_3? || (ruby_2? && ruby_minor >= 7)
     end

data/lib/scout_apm/serializers/payload_serializer_to_json.rb

@@ -45,31 +45,17 @@ module ScoutApm
           "{#{str_parts.join(",")}}"
         end
 
-        # Ruby 1.8.7 seems to be fundamentally different in how gsub or regexes
-        # work. This is a hack and will be removed as soon as we can drop
-        # support
-        if RUBY_VERSION == "1.8.7"
-          ESCAPE_MAPPINGS = {
-            "\b" => '\\b',
-            "\t" => '\\t',
-            "\n" => '\\n',
-            "\f" => '\\f',
-            "\r" => '\\r',
-            '"'  => '\\"',
-            '\\' => '\\\\',
-          }
-        else
-          ESCAPE_MAPPINGS = {
-            # Stackoverflow answer on gsub matches and backslashes - https://stackoverflow.com/a/4149087/2705125
-            '\\' => '\\\\\\\\',
-            "\b" => '\\b',
-            "\t" => '\\t',
-            "\n" => '\\n',
-            "\f" => '\\f',
-            "\r" => '\\r',
-            '"'  => '\\"',
-          }
-        end
+        ESCAPE_MAPPINGS = {
+          # Stackoverflow answer on gsub matches and backslashes
+          # https://stackoverflow.com/a/4149087/2705125
+          '\\' => '\\\\\\\\',
+          "\b" => '\\b',
+          "\t" => '\\t',
+          "\n" => '\\n',
+          "\f" => '\\f',
+          "\r" => '\\r',
+          '"'  => '\\"',
+        }
 
         def escape(string)
           ESCAPE_MAPPINGS.inject(string.to_s) {|s, (bad, good)| 

data/lib/scout_apm/tracer.rb

@@ -91,7 +91,7 @@ module ScoutApm
 
       def _instrumented_method_string(instrumented_name, uninstrumented_name, type, name, options={})
         method_str = <<-EOF
-        def #{instrumented_name}(*args, &block)
+        def #{instrumented_name}(*args#{", **kwargs" if ScoutApm::Agent.instance.context.environment.supports_kwarg_delegation?}, &block)
           name = begin
                    "#{name}"
                  rescue => e
@@ -103,7 +103,7 @@ module ScoutApm
                                name,
                                {:scope => #{options[:scope] || false}}
                              ) do
-            #{uninstrumented_name}(*args, &block)
+            #{uninstrumented_name}(*args#{", **kwargs" if ScoutApm::Agent.instance.context.environment.supports_kwarg_delegation?}, &block)
           end
         end
         EOF

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "4.0.3"
+  VERSION = "4.0.4"
 end

data/test/unit/tracer_test.rb

@@ -65,6 +65,31 @@ class TracerTest < Minitest::Test
     assert_recorded(recorder, "Test", "name")
   end
 
+  if ScoutApm::Agent.instance.context.environment.supports_kwarg_delegation?
+    def test_instrument_method_with_keyword_args
+      initial_value = Warning[:deprecated]
+      Warning[:deprecated] = true
+      recorder = FakeRecorder.new
+      ScoutApm::Agent.instance.context.recorder = recorder
+
+      klass = Class.new { include ScoutApm::Tracer }
+
+      invoked = false
+      klass.send(:define_method, :work) { |run:| invoked = true }
+      klass.instrument_method(:work, :type => "Test", :name => "name")
+
+      args = { run: false }
+      assert_output(nil, '') do
+        klass.new.work(**args)
+      end
+
+      assert invoked, "instrumented code was not invoked"
+      assert_recorded(recorder, "Test", "name")
+    ensure
+      Warning[:deprecated] = initial_value
+    end
+  end
+
   private
 
   def assert_recorded(recorder, type, name)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.0.4
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -251,6 +251,7 @@ files:
 - lib/scout_apm/auto_instrument/parser.rb
 - 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/legacy_sneakers.rb
 - lib/scout_apm/background_job_integrations/que.rb
 - lib/scout_apm/background_job_integrations/resque.rb
@@ -479,7 +480,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring