scout_apm 2.4.17 → 2.4.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed58dbdb3101d5cdc2b60a89a65e4c32b6917ca8
-  data.tar.gz: 7f9b855b1ccfb592f6b86c912a32d9ef22d64eba
+  metadata.gz: ad3c97e9c1dd1cad2376178ad19f534cf41e53d7
+  data.tar.gz: 8af7268cc654088d6bd1440c693e990e4d3d2c45
 SHA512:
-  metadata.gz: 782a5955c3cea0f7a8004d7cded41421463fc61d68dfcba15ea814be6f5b8dd9ba092e8ced672457a572bc841cdc97682f51739a27d5896177ce0da9caf7938a
-  data.tar.gz: dee4aba092de66d99fc91e9507568f2037352b3c2362a936404949f306296b0616e087a8f6b1b13d072b1ad77a47e49f139d577400450747d8f15c5186114b0d
+  metadata.gz: 620703274624cc21f1e4712b425a68abfde46fe80172e8e457f8b57ec95d6c53980dc9d1ad71b69defb610d43f6be4ad60652d30e08f15d9c1cd7761c60e4e93
+  data.tar.gz: 11aeff7c54b15e754c2ed425233a552a2065559b3f9d6c0402e7207e54db4cdfbe47aad9d32f8465c5cf378d5e45f543a2376591a22844b26869d607218694b9

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+# 2.4.18
+
+* Add Shoryuken Support (#215)
+* Add Sneakers Support (#216)
+
 # 2.4.17
 
 * Renames SQL `BEGIN` and `COMMIT` statements from `SQL#other` to `SQL#begin` and `SQL#commit`, respectively.

data/lib/scout_apm.rb

@@ -58,6 +58,8 @@ require 'scout_apm/server_integrations/null'
 require 'scout_apm/background_job_integrations/sidekiq'
 require 'scout_apm/background_job_integrations/delayed_job'
 require 'scout_apm/background_job_integrations/resque'
+require 'scout_apm/background_job_integrations/shoryuken'
+require 'scout_apm/background_job_integrations/sneakers'
 
 require 'scout_apm/framework_integrations/rails_2'
 require 'scout_apm/framework_integrations/rails_3_or_4'

data/lib/scout_apm/background_job_integrations/shoryuken.rb

@@ -0,0 +1,124 @@
+module ScoutApm
+  module BackgroundJobIntegrations
+    class Shoryuken
+      attr_reader :logger
+
+      def name
+        :shoryuken
+      end
+
+      def present?
+        defined?(::Shoryuken) && File.basename($PROGRAM_NAME).start_with?('shoryuken')
+      end
+
+      def forking?
+        false
+      end
+
+      def install
+        install_tracer
+        add_middleware
+        install_processor
+      end
+
+      def install_tracer
+        # ScoutApm::Tracer is not available when this class is defined
+        ShoryukenMiddleware.class_eval do
+          include ScoutApm::Tracer
+        end
+      end
+
+      def add_middleware
+        ::Shoryuken.configure_server do |config|
+          config.server_middleware do |chain|
+            chain.add ShoryukenMiddleware
+          end
+        end
+      end
+
+      def install_processor
+        require 'shoryuken/processor' # sidekiq v4 has not loaded this file by this point
+
+        ::Shoryuken::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 Shoryuken stack, to capture each job,
+    # and time them.
+    class ShoryukenMiddleware
+      def call(worker_instance, queue, msg, body)
+        job_class =
+          begin
+            if worker_instance.class.to_s == ACTIVE_JOB_KLASS
+              body["job_class"]
+            else
+              worker_instance.class.to_s
+            end
+          rescue
+            UNKNOWN_CLASS_PLACEHOLDER
+          end
+
+        req = ScoutApm::RequestManager.lookup
+        req.annotate_request(:queue_latency => latency(msg))
+
+        begin
+          req.start_layer(ScoutApm::Layer.new('Queue', queue))
+          started_queue = true
+          req.start_layer(ScoutApm::Layer.new('Job', job_class))
+          started_job = true
+
+          yield
+        rescue Exception => e
+          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::ShoryukenAdapter::JobWrapper'.freeze
+
+      def latency(msg, time = Time.now.to_f)
+        ms_since_epoch_str = msg.attributes.fetch('SentTimestamp', 0)
+        return 0 if ms_since_epoch_str.nil?
+
+        # Convert from ms to seconds as a float
+        created_at = ms_since_epoch_str.to_i / 1000.0
+
+        time - created_at
+      rescue => e
+        0
+      end
+    end
+  end
+end
+
+# MSG: #<Shoryuken::Message:0x007fb742a96950 @client=#<Aws::SQS::Client>
+# @data=#<struct Aws::SQS::Types::Message message_id="7a2ef0af-2bbd-4368-9c39-34cc89e4da15"
+# receipt_handle="AQEB8YK4+TCyvCM3p0EanmhZiTbBCM6uMeyCn7zibNn+XZcMnjZp2Z8D8yoUs4mMX9vJqlQvaS8gRUGBYG7ciq+BthmEqDWfxbcJ8jN+Vp/PXIyyTgYL3vvlnHcQajDz3H7Bd30UmLu80sqeLSjXXNEiKolcIxdGuIsIdSM4aUEPXsecr5eH7o8pZHcDV+bGcLuE7VbvKRZT3A2HeezW7wWwkYve/wt6asS1bYB+VJurAORY0y26xgCooEMNbs5yqxcnSD/CiNT822hkmw0eHNpTHOjF9WLgxLbkpITnQl1lsfK5TsM/ukE1oB1F9nN5ZkCBVCDeFYJDBAo81VvVV9G16knxyCYzjnmpwhvHg2BqTA56iV6r9KZYbiwOaMPdH5ealKLRnWhFoLOEPNA4yjG1yw=="
+# md5_of_body="8b3be018857a74f9e46b4c6ef3c3f515"
+# body="Unique Person #7532"
+# attributes={"SenderId"=>"AIDAJZXBVF26MLZPE6FOO"
+# "ApproximateFirstReceiveTimestamp"=>"1534873932213"
+# "ApproximateReceiveCount"=>"1"
+# "SentTimestamp"=>"1534873927868"}
+# md5_of_message_attributes="c70f52a6566cf42ec5e61e81877132dd"
+# message_attributes={"shoryuken_class"=>#<struct Aws::SQS::Types::MessageAttributeValue string_value="DummyWorker"
+    # binary_value=nil
+    # string_list_values=[]
+    # binary_list_values=[]
+    # data_type="String">}>
+# @queue_url="https://sqs.us-west-2.amazonaws.com/023109228371/shoryuken_test"
+# @queue_name="shoryuken_test">
+

data/lib/scout_apm/background_job_integrations/sneakers.rb

@@ -0,0 +1,87 @@
+module ScoutApm
+  module BackgroundJobIntegrations
+    class Sneakers
+      attr_reader :logger
+
+      def name
+        :sneakers
+      end
+
+      def present?
+        defined?(::Sneakers)
+      end
+
+      def forking?
+        false
+      end
+
+      def install
+        install_worker_override
+      end
+
+      def install_worker_override
+        ::Sneakers::Worker.module_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
+
+          def process_work_with_scout(*args)
+            delivery_info, _metadata, msg, _handler = args
+
+            queue = delivery_info[:routing_key] || UNKNOWN_QUEUE_PLACEHOLDER
+
+            job_class = begin
+              if self.class == ActiveJob::QueueAdapters::SneakersAdapter::JobWrapper
+                msg["job_class"] || UNKNOWN_CLASS_PLACEHOLDER
+              else
+                self.class.name
+              end
+            rescue => e
+              UNKNOWN_CLASS_PLACEHOLDER
+            end
+
+            req = ScoutApm::RequestManager.lookup
+
+            # RabbitMQ does not store a created-at timestamp
+            # req.annotate_request(:queue_latency => latency(msg))
+
+            begin
+              req.start_layer(ScoutApm::Layer.new('Queue', queue))
+              started_queue = true
+              req.start_layer(ScoutApm::Layer.new('Job', job_class))
+              started_job = true
+
+              process_work_without_scout(*args)
+            rescue Exception => e
+              req.error!
+              raise
+            ensure
+              req.stop_layer if started_job
+              req.stop_layer if started_queue
+            end
+          end
+
+          alias_method :process_work_without_scout, :process_work
+          alias_method :process_work, :process_work_with_scout
+        end
+
+        # msg = {
+        #   "job_class":"DummyWorker",
+        #   "job_id":"ea23ba1c-3022-4e05-870b-c3bcb1c4f328",
+        #   "queue_name":"default",
+        #   "arguments":["fjdkl"],
+        #   "locale":"en"
+        # }
+      end
+
+      ACTIVE_JOB_KLASS = 'ActiveJob::QueueAdapters::SneakersAdapter::JobWrapper'.freeze
+      UNKNOWN_CLASS_PLACEHOLDER = 'UnknownJob'.freeze
+      UNKNOWN_QUEUE_PLACEHOLDER = 'default'.freeze
+    end
+  end
+end

data/lib/scout_apm/environment.rb

@@ -26,6 +26,8 @@ module ScoutApm
     BACKGROUND_JOB_INTEGRATIONS = [
       ScoutApm::BackgroundJobIntegrations::Resque.new,
       ScoutApm::BackgroundJobIntegrations::Sidekiq.new,
+      ScoutApm::BackgroundJobIntegrations::Shoryuken.new,
+      ScoutApm::BackgroundJobIntegrations::Sneakers.new,
       ScoutApm::BackgroundJobIntegrations::DelayedJob.new,
     ]
 

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "2.4.17"
+  VERSION = "2.4.18"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.4.17
+  version: 2.4.18
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-20 00:00:00.000000000 Z
+date: 2018-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -198,7 +198,9 @@ files:
 - lib/scout_apm/attribute_arranger.rb
 - lib/scout_apm/background_job_integrations/delayed_job.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_recorder.rb
 - lib/scout_apm/background_worker.rb
 - lib/scout_apm/bucket_name_splitter.rb
@@ -390,7 +392,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: scout_apm
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.2
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring