scout_apm 2.5.2 → 2.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8715d4d303e068a7730e2ec2f788ee44c2bbd6762a3a3bd30cdcc9f167435b9
-  data.tar.gz: 58e17c6491c144b596a61501b01406b15da245b6ce517a7fdbcaddfa896b0929
+  metadata.gz: ef6a530f826be85aee200f178152090c96dc8f2bab731c0f5220fa95a4662f56
+  data.tar.gz: e8ab6688fec666ff02c76a996dff3daf84fa1ca84be19b2666ba13b256f9fa92
 SHA512:
-  metadata.gz: da8ddf5b4bb2a6d2223b49c1071dad0dd966234f2ed7b2e05747c67a0e3a9368b3831ef0496f5e6b57bd785ef486d12aade25db6815c2bf9a78ce1fce5f2acdf
-  data.tar.gz: 9fc04fcf1fa8350b1c95b00c936612a6dfc575905f22821d86e4fa01474c3cd9eab1343857ece2d7cd7e631b625c4e7e4f2e24dc895068f59f08c7fbe0e777c2
+  metadata.gz: 4b8d53395a108407d445d1c386c1234ddbfa90e7105249ce357d288b92c5c9727a9c110a6e3510a111b6a4a9788f5e5f3a3eaedc532683cecbc09a8261c2f572
+  data.tar.gz: 3a35a76ed54a96df86948ad486d5a86a9dffed67271c5efae229b80a8106c00eb3830be469875cd301f7a262fba34672a8db52a25d4e82cba5105ce80af26dde

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+dist: trusty
 cache: bundler
 
 matrix:

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+# 2.5.3
+
+* Add Que support (#265)
+
 # 2.5.2
 
 * Don't process limited layers in detailed traces (#268)

data/lib/scout_apm.rb

@@ -62,6 +62,7 @@ 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/background_job_integrations/que'
 
 require 'scout_apm/framework_integrations/rails_2'
 require 'scout_apm/framework_integrations/rails_3_or_4'
@@ -78,6 +79,7 @@ require 'scout_apm/instruments/net_http'
 require 'scout_apm/instruments/http_client'
 require 'scout_apm/instruments/moped'
 require 'scout_apm/instruments/mongoid'
+require 'scout_apm/instruments/memcached'
 require 'scout_apm/instruments/redis'
 require 'scout_apm/instruments/influxdb'
 require 'scout_apm/instruments/elasticsearch'

data/lib/scout_apm/background_job_integrations/que.rb

@@ -0,0 +1,134 @@
+module ScoutApm
+  module BackgroundJobIntegrations
+    class Que
+
+      UNKNOWN_CLASS_PLACEHOLDER = 'UnknownJob'.freeze
+      ACTIVE_JOB_KLASS = 'ActiveJob::QueueAdapters::QueAdapter::JobWrapper'.freeze
+      UNKNOWN_QUEUE_PLACEHOLDER = 'UnknownQueue'.freeze
+
+      attr_reader :logger
+
+      def name
+        :que
+      end
+
+      def present?
+        if defined?(::Que) && File.basename($PROGRAM_NAME).start_with?('que')
+          # 0.x releases used "Version" constant.
+          # 1.x releases used "VERSION" constant.
+          return defined?(::Que::Version)
+        end
+      end
+
+      def forking?
+        false
+      end
+
+      def install
+        install_tracer
+        install_worker
+        install_job
+      end
+
+      def install_tracer
+        ::Que::Job.class_eval do
+          include ScoutApm::Tracer
+        end
+      end
+
+      def install_worker
+        ::Que::Worker.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
+
+      def install_job
+        ::Que::Job.class_eval do
+          # attrs = {
+          #   "queue"=>"",
+          #   "priority"=>100,
+          #   "run_at"=>2018-12-19 15:12:32 -0700,
+          #   "job_id"=>4,
+          #   "job_class"=>"ExampleJob",
+          #   "args"=>[{"key"=>"value"}],
+          #   "error_count"=>0
+          # }
+          #
+          # With ActiveJob, v0.14.3:
+          # attrs = {
+          #   "queue"=>"",
+          #   "priority"=>100,
+          #   "run_at"=>2018-12-19 15:29:18 -0700,
+          #   "job_id"=>6,
+          #   "job_class"=>"ActiveJob::QueueAdapters::QueAdapter::JobWrapper",
+          #   "args"=> [{
+          #     "job_class"=>"ExampleJob",
+          #     "job_id"=>"60798b45-4b55-436e-806d-693939266c97",
+          #     "provider_job_id"=>nil,
+          #     "queue_name"=>"default",
+          #     "priority"=>nil,
+          #     "arguments"=>[],
+          #     "executions"=>0,
+          #     "locale"=>"en"
+          #   }],
+          #   "error_count"=>0
+          # }
+          #
+          # With ActiveJob, v1.0:
+          #   There are changes here to make Que more compatible with ActiveJob
+          #   and this probably needs to be revisited.
+
+          def _run_with_scout(*args)
+            # default queue unless specifed is a blank string
+            queue = attrs['queue'] || UNKNOWN_QUEUE_PLACEHOLDER
+
+            job_class = begin
+                          if self.class == ActiveJob::QueueAdapters::QueAdapter::JobWrapper
+                            Array(attrs['args']).first['job_class'] || UNKNOWN_CLASS_PLACEHOLDER
+                          else
+                            self.class.name
+                          end
+                        rescue => e
+                          UNKNOWN_CLASS_PLACEHOLDER
+                        end
+
+            latency = begin
+                        Time.now - attrs['run_at']
+                      rescue
+                        0
+                      end
+
+            req = ScoutApm::RequestManager.lookup
+            req.annotate_request(:queue_latency => latency)
+
+            begin
+              req.start_layer(ScoutApm::Layer.new('Queue', queue))
+              started_queue = true
+              req.start_layer(ScoutApm::Layer.new('Job', job_class))
+              started_job = true
+
+              _run_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 :_run_without_scout, :_run
+          alias_method :_run, :_run_with_scout
+        end
+      end
+    end
+
+  end
+end

data/lib/scout_apm/environment.rb

@@ -29,6 +29,7 @@ module ScoutApm
       ScoutApm::BackgroundJobIntegrations::Shoryuken.new,
       ScoutApm::BackgroundJobIntegrations::Sneakers.new,
       ScoutApm::BackgroundJobIntegrations::DelayedJob.new,
+      ScoutApm::BackgroundJobIntegrations::Que.new,
     ]
 
     FRAMEWORK_INTEGRATIONS = [

data/lib/scout_apm/instrument_manager.rb

@@ -31,6 +31,7 @@ module ScoutApm
       install_instrument(ScoutApm::Instruments::Mongoid)
       install_instrument(ScoutApm::Instruments::NetHttp)
       install_instrument(ScoutApm::Instruments::HttpClient)
+      install_instrument(ScoutApm::Instruments::Memcached)
       install_instrument(ScoutApm::Instruments::Redis)
       install_instrument(ScoutApm::Instruments::InfluxDB)
       install_instrument(ScoutApm::Instruments::Elasticsearch)

data/lib/scout_apm/instruments/memcached.rb

@@ -0,0 +1,43 @@
+module ScoutApm
+  module Instruments
+    class Memcached
+      attr_reader :context
+
+      def initialize(context)
+        @context = context
+        @installed = false
+      end
+
+      def logger
+        context.logger
+      end
+
+      def installed?
+        @installed
+      end
+
+      def install
+        if defined?(::Dalli) && defined?(::Dalli::Client)
+          @installed = true
+
+          logger.info "Instrumenting Memcached"
+
+          ::Dalli::Client.class_eval do
+            include ScoutApm::Tracer
+
+            def perform_with_scout_instruments(*args, &block)
+              command = args.first rescue "Unknown"
+
+              self.class.instrument("Memcached", command) do
+                perform_without_scout_instruments(*args, &block)
+              end
+            end
+
+            alias_method :perform_without_scout_instruments, :perform
+            alias_method :perform, :perform_with_scout_instruments
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "2.5.2"
+  VERSION = "2.5.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 2.5.3
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-13 00:00:00.000000000 Z
+date: 2019-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -231,6 +231,7 @@ files:
 - lib/scout_apm/app_server_load.rb
 - lib/scout_apm/attribute_arranger.rb
 - lib/scout_apm/background_job_integrations/delayed_job.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
@@ -269,6 +270,7 @@ files:
 - lib/scout_apm/instruments/grape.rb
 - lib/scout_apm/instruments/http_client.rb
 - lib/scout_apm/instruments/influxdb.rb
+- lib/scout_apm/instruments/memcached.rb
 - lib/scout_apm/instruments/middleware_detailed.rb
 - lib/scout_apm/instruments/middleware_summary.rb
 - lib/scout_apm/instruments/mongoid.rb
@@ -428,9 +430,52 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: scout_apm
-rubygems_version: 2.7.6
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring
-test_files: []
+test_files:
+- test/data/config_test_1.yml
+- test/test_helper.rb
+- test/tmp/README.md
+- test/unit/agent_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/extensions/periodic_callbacks_test.rb
+- test/unit/extensions/transaction_callbacks_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/active_record_test.rb
+- test/unit/instruments/net_http_test.rb
+- test/unit/instruments/percentile_sampler_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/test_message.rb
+- test/unit/remote/test_router.rb
+- test/unit/remote/test_server.rb
+- test/unit/scored_item_set_test.rb
+- test/unit/serializers/payload_serializer_test.rb
+- test/unit/slow_job_policy_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