scout_apm 2.4.21 → 2.4.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7414d9bde0f829ed4cfc7975c5bdca2e5cda5910
-  data.tar.gz: 6a0ab71bfa23362adefb328f69a887bae5551b6b
+  metadata.gz: 9fa219a419aefb2e17c508ea1c337a2aeb336a21
+  data.tar.gz: bcedf91bcbac7ed3c111d0018af5f22123b54af3
 SHA512:
-  metadata.gz: 99e1906e5273202785cbd6c75acc4a833887f1a27240e7763b16d7296d1b4ba30a080729b67214372de08170c06541869b94c0d825726822be305ab05d12651b
-  data.tar.gz: 8f44f8874f66b75ac8e1146678a7c91964661422b9e3386eccc0bca115269d9874403dc042cfc771da48552636a23e33c219a0648400615e8fbbf49027117b86
+  metadata.gz: 1917e106d1ea9048bd9b68bfafbd3c24717db6827eee0510fc86d1e23da7f504df8dd2786b517420ac73e799ac38c83680635410de1100c901ecd3b8d895373a
+  data.tar.gz: 42ebd73a8e0048387ab628e9ae3e80186a7a548b0f75051b5f560bd529f893add7828f4747cb1fd9bb741a6d544a1fe1c8bcf27b61960d7dc4d4fdd3bf9ff7af

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+
 rvm:
   - "1.8.7"
   - "1.9.3"
@@ -6,10 +7,17 @@ rvm:
   - "2.2"
   - "2.4"
   - "2.5"
+
 cache: bundler
+
 before_install:
-  - gem update --system
-  - gem install bundler
+  # Don't gem update, since it tries to install RubyGems requiring 2.3+.
+  # - gem update --system
+
+  # Lock down the version. Newer versions only support Ruby 2.3+, but we need
+  # to test back further.
+  - gem install bundler -v '1.17.3'
+
 jobs:
   include:
     - script: bundle exec rake test

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+# 2.4.22
+
+* Support Rails 6.0 View Instruments (#251) 
+* Update documentation URLs (#236)
+
 # 2.4.21
 
 * App & Background Integrations only install when needed (#228)

data/README.markdown

@@ -12,8 +12,8 @@ The Scout agent is engineered to do some wonderful things:
 
 * A unique focus on identifying those hard-to-investigate outliers like memory bloat, N+1s, and user-specific problems. [See an example workflow](http://scoutapp.com/newrelic-alternative).
 * [Low-overhead](http://blog.scoutapp.com/articles/2016/02/07/overhead-benchmarks-new-relic-vs-scout)
-* View your performance metrics during development with [DevTrace](http://help.apm.scoutapp.com/#devtrace) and in production via [server_timing](https://github.com/scoutapp/ruby_server_timing).
-* Production-Safe profiling of custom code via [ScoutProf](http://help.apm.scoutapp.com/#scoutprof) (BETA).
+* View your performance metrics during development with [DevTrace](https://help.apm.scoutapp.com/#devtrace) and in production via [server_timing](https://github.com/scoutapp/ruby_server_timing).
+* Production-Safe profiling of custom code via [ScoutProf](https://help.apm.scoutapp.com/#scoutprof) (BETA).
 
 ## Getting Started
 
@@ -64,7 +64,7 @@ SCOUT_DEV_TRACE=true rails server
 ## Docs
 
 For the complete list of supported frameworks, Rubies, configuration options
-and more, see our [help site](http://help.apm.scoutapp.com/).
+and more, see our [help site](https://help.apm.scoutapp.com/).
 
 ## Help
 

data/lib/scout_apm/agent_context.rb

@@ -205,7 +205,7 @@ module ScoutApm
       if !@config.any_keys_found?
         logger.info("No configuration file loaded, and no configuration found in ENV. " +
                     "For assistance configuring Scout, visit " +
-                    "http://help.apm.scoutapp.com/#configuration-options")
+                    "https://help.apm.scoutapp.com/#ruby-configuration-options")
       end
     end
   end

data/lib/scout_apm/config.rb

@@ -6,7 +6,7 @@ require 'scout_apm/environment'
 # Valid Config Options:
 #
 # This list is complete, but some are old and unused, or for developers of
-# scout_apm itself. See the documentation at http://help.apm.scoutapp.com for
+# scout_apm itself. See the documentation at https://help.apm.scoutapp.com for
 # customer-focused documentation.
 #
 # application_root - override the detected directory of the application

data/lib/scout_apm/instruments/action_view.rb

@@ -1,6 +1,13 @@
+# Note, this instrument has the same logic in both Tracer and Module Prepend
+# versions. If you update, be sure you update in both spots.
+#
+# The prepend version was added for Rails 6 support - ActiveRecord prepends on
+# top of PartialRenderer#collection_with_template, which can (and does) cause
+# infinite loops with our alias_method approach
 module ScoutApm
   module Instruments
-    # instrumentation for Rails 3 and Rails 4 is the same.
+    # Instrumentation for Rails 3, 4, 5 is the same, using tracer.
+    # Rails 6 switches to using Module#prepend
     class ActionView
       attr_reader :context
 
@@ -18,36 +25,104 @@ module ScoutApm
       end
 
       def install
-        if defined?(::ActionView) && defined?(::ActionView::PartialRenderer)
-          @installed = true
-
-          logger.info "Instrumenting ActionView::PartialRenderer"
-          ::ActionView::PartialRenderer.class_eval do
-            include ScoutApm::Tracer
-
-            instrument_method :render_partial,
-              :type => "View",
-              :name => '#{@template.virtual_path rescue "Unknown Partial"}/Rendering',
-              :scope => true
-
-            instrument_method :collection_with_template,
-              :type => "View",
-              :name => '#{@template.virtual_path rescue "Unknown Collection"}/Rendering',
-              :scope => true
+        return unless defined?(::ActionView) && defined?(::ActionView::PartialRenderer)
+
+        if defined?(::Rails) && defined?(::Rails::VERSION) && defined?(::Rails::VERSION::MAJOR) && ::Rails::VERSION::MAJOR < 6
+          install_using_tracer
+        else
+          install_using_prepend
+        end
+        @installed = true
+      end
+
+      def install_using_tracer
+        logger.info "Instrumenting ActionView::PartialRenderer"
+        ::ActionView::PartialRenderer.class_eval do
+          include ScoutApm::Tracer
+
+          instrument_method :render_partial,
+            :type => "View",
+            :name => '#{@template.virtual_path rescue "Unknown Partial"}/Rendering',
+            :scope => true
+
+          instrument_method :collection_with_template,
+            :type => "View",
+            :name => '#{@template.virtual_path rescue "Unknown Collection"}/Rendering',
+            :scope => true
+        end
+
+        logger.info "Instrumenting ActionView::TemplateRenderer"
+        ::ActionView::TemplateRenderer.class_eval do
+          include ScoutApm::Tracer
+          instrument_method :render_template,
+            :type => "View",
+            :name => '#{args[0].virtual_path rescue "Unknown"}/Rendering',
+            :scope => true
+        end
+      end
+
+      def install_using_prepend
+        logger.info "Instrumenting ActionView::PartialRenderer"
+        ::ActionView::PartialRenderer.prepend(ActionViewPartialRendererInstruments)
+
+        logger.info "Instrumenting ActionView::TemplateRenderer"
+        ::ActionView::TemplateRenderer.prepend(ActionViewTemplateRendererInstruments)
+      end
+
+      module ActionViewPartialRendererInstruments
+        def render_partial(*args)
+          req = ScoutApm::RequestManager.lookup
+
+          template_name = @template.virtual_path rescue "Unknown Partial"
+          layer_name = template_name + "/Rendering"
+
+          layer = ScoutApm::Layer.new("View", layer_name)
+          layer.subscopable!
+
+          begin
+            req.start_layer(layer)
+            super(*args)
+          ensure
+            req.stop_layer
           end
+        end
+
+        def collection_with_template(*args)
+          req = ScoutApm::RequestManager.lookup
 
-          logger.info "Instrumenting ActionView::TemplateRenderer"
-          ::ActionView::TemplateRenderer.class_eval do
-            include ScoutApm::Tracer
-            instrument_method :render_template,
-              :type => "View",
-              :name => '#{args[0].virtual_path rescue "Unknown"}/Rendering',
-              :scope => true
+          template_name = @template.virtual_path rescue "Unknown Collection"
+          layer_name = template_name + "/Rendering"
+
+          layer = ScoutApm::Layer.new("View", layer_name)
+          layer.subscopable!
+
+          begin
+            req.start_layer(layer)
+            super(*args)
+          ensure
+            req.stop_layer
+          end
+        end
+      end
+
+      module ActionViewTemplateRendererInstruments
+        def render_template(*args)
+          req = ScoutApm::RequestManager.lookup
+
+          template_name = args[0].virtual_path rescue "Unknown"
+          layer_name = template_name + "/Rendering"
+
+          layer = ScoutApm::Layer.new("View", layer_name)
+          layer.subscopable!
+
+          begin
+            req.start_layer(layer)
+            super(*args)
+          ensure
+            req.stop_layer
           end
         end
       end
     end
   end
 end
-
-

data/lib/scout_apm/version.rb

@@ -1,4 +1,3 @@
 module ScoutApm
-  VERSION = "2.4.21"
+  VERSION = "2.4.22"
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.4.21
+  version: 2.4.22
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-28 00:00:00.000000000 Z
+date: 2019-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -392,7 +392,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: scout_apm
-rubygems_version: 2.4.5.2
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring