scout_apm 6.1.1 → 6.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08eb9e88e12ae5cee4b5ee2a2356f595f190591692d3a174cf91279f58fcc1a8'
-  data.tar.gz: 9c6cccd60e11ec456d315b9cff7e1f45f5779f626a53f175592f5c9f9ed30299
+  metadata.gz: c667c4b7279ecdc5107a30bb50ac2a42eda6403a257f6bf2a05a6452c1143f18
+  data.tar.gz: d5183ae2f3fb7fbdfabae56616543f99503f59bb65b154e6709ea278f42166d3
 SHA512:
-  metadata.gz: d74d8fbdc79fc43ae00d08dd11060959792cb64dac50d82ef92e5e9f0760a69fcedfe44a45f5b35eabbbf01f8a86c0730e5b3296152a9f6869cbb1051a20e615
-  data.tar.gz: 0ef1636e6523df96f822d9874f3b4b8597e14405722d8851ff1682e34653edeb5aa5fe993ea2d3502d30d912a132c6124790eace4e6226dd34f724cf4a8f22ba
+  metadata.gz: bdc045802aa3d9cc37c147f6fd5a866e4bc3a3a49de480711595b3ca5b6dd04c314c2085bd229ccaebc0dca3125a7463f2bf0a53552adbb2caef8b0a09102de2
+  data.tar.gz: 07a522e00f9d86d4d03a57c5e8965a9fd724104881429c8acddf603c0a0ad8829d098f998b3e551a6a0751ab1ba60af0f2c077bab1c3528d988138d2f4c2268e

data/CHANGELOG.markdown

@@ -1,5 +1,16 @@
 # Pending
 
+# 6.2.1
+
+- Fix `SystemStackError` with `grape >= 3.3.0` by falling back to `prepend` instrumentation when Grape owns `Endpoint#run` itself (#624)
+- Fix a GraphQL layer leak where an unhandled exception skipping `end_execute_field` could leave stale layers on the request (#626)
+- Honor `SCOUT_LOG_LEVEL` during agent bootstrap instead of always logging at the default level (#628)
+- Use `HEROKU_BUILD_COMMIT` for Heroku git revision detection, since `HEROKU_SLUG_COMMIT` is deprecated (#625)
+
+# 6.2.0
+
+- Fix compatibility with `http >= 6.0.0` (#613)
+
 # 6.1.1
 
 - Fix Redis 5 prepend interaction (#611)

data/gems/instruments-ruby4.gemfile

@@ -10,3 +10,4 @@ gem 'moped'
 gem 'actionpack'
 gem 'actionview'
 gem 'httpx'
+gem 'grape'

data/gems/instruments.gemfile

@@ -7,3 +7,4 @@ gem 'moped'
 gem 'actionpack'
 gem 'actionview'
 gem 'httpx'
+gem 'grape'

data/lib/scout_apm/agent_context.rb

@@ -259,7 +259,7 @@ module ScoutApm
     end
 
     def self.build_minimal_logger
-      ScoutApm::Logger.new(nil, :stdout => true)
+      ScoutApm::Logger.new(nil, :stdout => true, :log_level => ENV["SCOUT_LOG_LEVEL"])
     end
   end
 end

data/lib/scout_apm/git_revision.rb

@@ -26,7 +26,9 @@ module ScoutApm
     end
 
     def detect_from_heroku
-      ENV['HEROKU_SLUG_COMMIT']
+      # HEROKU_SLUG_COMMIT is deprecated in favor of HEROKU_BUILD_COMMIT.
+      # https://devcenter.heroku.com/articles/dyno-metadata#usage
+      ENV['HEROKU_BUILD_COMMIT'] || ENV['HEROKU_SLUG_COMMIT']
     end
 
     # Config will locate the value from:

data/lib/scout_apm/instrument_manager.rb

@@ -41,6 +41,7 @@ module ScoutApm
       install_instrument(ScoutApm::Instruments::Elasticsearch)
       install_instrument(ScoutApm::Instruments::OpenSearch)
       install_instrument(ScoutApm::Instruments::Grape)
+      install_instrument(ScoutApm::Instruments::GraphQL)
     rescue
       logger.warn "Exception loading instruments:"
       logger.warn $!.message

data/lib/scout_apm/instruments/grape.rb

@@ -20,16 +20,35 @@ module ScoutApm
         if defined?(::Grape) && defined?(::Grape::Endpoint)
           @installed = true
 
-          logger.info "Instrumenting Grape::Endpoint"
+          # Grape >= 3.3.0 prepends a module of its own (Grape::Testing::RunBeforeEach)
+          # in front of Grape::Endpoint#run. An alias-method chain built on a method
+          # owned by a prepended module recurses infinitely (SystemStackError), because
+          # the aliased copy's `super` resolves back into our wrapper. Whenever #run is
+          # not owned by Grape::Endpoint itself, prepend is the only safe option.
+          prepend = true unless endpoint_owns_run?
 
-          ::Grape::Endpoint.class_eval do
-            include ScoutApm::Instruments::GrapeEndpointInstruments
+          logger.info "Instrumenting Grape::Endpoint. Prepend: #{prepend}"
 
-            alias run_without_scout_instruments run
-            alias run run_with_scout_instruments
+          if prepend
+            ::Grape::Endpoint.send(:prepend, GrapeEndpointInstrumentsPrepend)
+          else
+            ::Grape::Endpoint.class_eval do
+              include ScoutApm::Instruments::GrapeEndpointInstruments
+
+              alias run_without_scout_instruments run
+              alias run run_with_scout_instruments
+            end
           end
         end
       end
+
+      private
+
+      def endpoint_owns_run?
+        ::Grape::Endpoint.instance_method(:run).owner == ::Grape::Endpoint
+      rescue NameError
+        true
+      end
     end
 
     module GrapeEndpointInstruments
@@ -68,6 +87,42 @@ module ScoutApm
         end
       end
     end
+
+    module GrapeEndpointInstrumentsPrepend
+      def run(*args)
+        request = ::Grape::Request.new(env || args.first)
+        req = ScoutApm::RequestManager.lookup
+
+        path = ScoutApm::Agent.instance.context.config.value("uri_reporting") == 'path' ? request.path : request.fullpath
+        req.annotate_request(:uri => path)
+
+        # IP Spoofing Protection can throw an exception, just move on w/o remote ip
+        req.context.add_user(:ip => request.ip) rescue nil
+
+        req.set_headers(request.headers)
+
+        begin
+          name = ["Grape",
+                  self.options[:method].first,
+                  self.options[:for].to_s,
+                  self.namespace.sub(%r{\A/}, ''), # removing leading slashes
+                  self.options[:path].first,
+          ].compact.map{ |n| n.to_s }.join("/")
+        rescue => e
+          ScoutApm::Agent.instance.context.logger.info("Error getting Grape Endpoint Name. Error: #{e.message}. Options: #{self.options.inspect}")
+          name = "Grape/Unknown"
+        end
+
+        req.start_layer( ScoutApm::Layer.new("Controller", name) )
+        begin
+          super(*args)
+        rescue
+          req.error!
+          raise
+        ensure
+          req.stop_layer
+        end
+      end
+    end
   end
 end
-

data/lib/scout_apm/instruments/graphql.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module ScoutApm
+  module Instruments
+    class GraphQL
+      attr_reader :context
+
+      def initialize(context)
+        @context = context
+        @installed = false
+      end
+
+      def logger
+        context.logger
+      end
+
+      def installed?
+        @installed
+      end
+
+      def install(prepend: false)
+        return unless defined?(::GraphQL::Tracing::ScoutTrace)
+
+        @installed = true
+        logger.info "Instrumenting GraphQL::Tracing::ScoutTrace"
+        ::GraphQL::Tracing::ScoutTrace.prepend(ScoutApm::Instruments::GraphQLExecuteFieldGuard)
+      end
+    end
+
+    # Prepended onto GraphQL::Tracing::ScoutTrace to guarantee that every
+    # Scout layer opened during a GraphQL multiplex is closed before control
+    # returns to the Scout Rack middleware.
+    #
+    # graphql-ruby's interpreter calls begin_execute_field / end_execute_field
+    # around each field resolver. When an unhandled exception causes
+    # end_execute_field to be skipped (runtime.rb lines 465-479), the
+    # corresponding ScoutApm::Layer is never popped from TrackedRequest#@layers.
+    # finalized? never returns true, record! is never called, and
+    # Thread.current[:scout_request] accumulates every subsequent request's
+    # layers without bound.
+    #
+    # This guard snapshots the open layer count before executing the multiplex
+    # and pops any excess layers in an ensure block, independent of whichever
+    # internal trace hooks graphql-ruby happens to use. It has no dependency on
+    # MonitorTrace's field-tracing condition or event slot architecture, so it
+    # remains correct even if those internals change.
+    module GraphQLExecuteFieldGuard
+      def execute_multiplex(multiplex:)
+        req = ScoutApm::RequestManager.lookup
+        layers_before = req.layer_count
+        super
+      ensure
+        extra = req.layer_count - layers_before
+        extra.times { req.stop_layer } if extra > 0
+      end
+    end
+  end
+end

data/lib/scout_apm/instruments/http.rb

@@ -24,30 +24,63 @@ module ScoutApm
 
           if prepend
             ::HTTP::Client.send(:include, ScoutApm::Tracer)
-            ::HTTP::Client.send(:prepend, HTTPInstrumentationPrepend)
+            if http_version_at_least?("6.0.0")
+              ::HTTP::Client.send(:prepend, HTTPInstrumentationPrependV6)
+            else
+              ::HTTP::Client.send(:prepend, HTTPInstrumentationPrepend)
+            end
           else
-            ::HTTP::Client.class_eval do
-              include ScoutApm::Tracer
+            if http_version_at_least?("6.0.0")
+              ::HTTP::Client.class_eval do
+                include ScoutApm::Tracer
 
-              def request_with_scout_instruments(verb, uri, opts = {})
-                self.class.instrument("HTTP", verb, :ignore_children => true, :desc => request_scout_description(verb, uri)) do
-                  request_without_scout_instruments(verb, uri, opts)
+                def request_with_scout_instruments(verb, uri, **opts)
+                  self.class.instrument("HTTP", verb, :ignore_children => true, :desc => request_scout_description(verb, uri)) do
+                    request_without_scout_instruments(verb, uri, **opts)
+                  end
+                end
+
+                def request_scout_description(verb, uri)
+                  max_length = ScoutApm::Agent.instance.context.config.value('instrument_http_url_length')
+                  (String(uri).split('?').first)[0..(max_length - 1)]
+                rescue
+                  ""
                 end
-              end
 
-              def request_scout_description(verb, uri)
-                max_length = ScoutApm::Agent.instance.context.config.value('instrument_http_url_length')
-                (String(uri).split('?').first)[0..(max_length - 1)]
-              rescue
-                ""
+                alias request_without_scout_instruments request
+                alias request request_with_scout_instruments
               end
+            else
+              ::HTTP::Client.class_eval do
+                include ScoutApm::Tracer
+
+                def request_with_scout_instruments(verb, uri, opts = {})
+                  self.class.instrument("HTTP", verb, :ignore_children => true, :desc => request_scout_description(verb, uri)) do
+                    request_without_scout_instruments(verb, uri, opts)
+                  end
+                end
 
-              alias request_without_scout_instruments request
-              alias request request_with_scout_instruments
+                def request_scout_description(verb, uri)
+                  max_length = ScoutApm::Agent.instance.context.config.value('instrument_http_url_length')
+                  (String(uri).split('?').first)[0..(max_length - 1)]
+                rescue
+                  ""
+                end
+
+                alias request_without_scout_instruments request
+                alias request request_with_scout_instruments
+              end
             end
           end
         end
       end
+
+      private
+
+      def http_version_at_least?(version)
+        defined?(::HTTP::VERSION) &&
+          Gem::Version.new(::HTTP::VERSION) >= Gem::Version.new(version)
+      end
     end
 
     module HTTPInstrumentationPrepend
@@ -64,5 +97,20 @@ module ScoutApm
         ""
       end
     end
+
+    module HTTPInstrumentationPrependV6
+      def request(verb, uri, **opts)
+        self.class.instrument("HTTP", verb, :ignore_children => true, :desc => request_scout_description(verb, uri)) do
+          super(verb, uri, **opts)
+        end
+      end
+
+      def request_scout_description(verb, uri)
+        max_length = ScoutApm::Agent.instance.context.config.value('instrument_http_url_length')
+        (String(uri).split('?').first)[0..(max_length - 1)]
+      rescue
+        ""
+      end
+    end
   end
 end

data/lib/scout_apm/tracked_request.rb

@@ -77,6 +77,10 @@ module ScoutApm
       ignore_request! if @recorder.nil?
     end
 
+    def layer_count
+      @layers.size
+    end
+
     def start_layer(layer)
       # If we're already stopping, don't do additional layers
       return if stopping?

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "6.1.1"
+  VERSION = "6.2.1"
 end

data/lib/scout_apm.rb

@@ -102,6 +102,7 @@ require 'scout_apm/instruments/middleware_summary'
 require 'scout_apm/instruments/middleware_detailed' # Disabled by default, see the file for more details
 require 'scout_apm/instruments/rails_router'
 require 'scout_apm/instruments/grape'
+require 'scout_apm/instruments/graphql'
 require 'scout_apm/instruments/sinatra'
 require 'allocations'
 

data/test/unit/agent_context_test.rb

@@ -3,6 +3,15 @@ require "test_helper"
 require "scout_apm/agent_context"
 
 class AgentContextTest < Minitest::Test
+  def test_bootstrap_logger_uses_scout_log_level
+    original_log_level = ENV["SCOUT_LOG_LEVEL"]
+    ENV["SCOUT_LOG_LEVEL"] = "error"
+
+    assert_equal ::Logger::ERROR, ScoutApm::AgentContext.new.logger.log_level
+  ensure
+    ENV["SCOUT_LOG_LEVEL"] = original_log_level
+  end
+
   def test_has_error_service_ignored_exceptions
     context = ScoutApm::AgentContext.new
     assert ScoutApm::ErrorService::IgnoredExceptions, context.ignored_exceptions.class
@@ -26,4 +35,4 @@ class AgentContextTest < Minitest::Test
     context.slow_request_policy.add(TestPolicy.new)
     assert 5, context.slow_request_policy.policies
   end
-end
+end

data/test/unit/git_revision_test.rb

@@ -34,6 +34,19 @@ class GitRevisionTest < Minitest::Test
     assert_equal 'heroku_slug', revision.sha
   end
 
+  def test_sha_from_heroku_build_commit
+    ENV['HEROKU_BUILD_COMMIT'] = 'heroku_build'
+    revision = ScoutApm::GitRevision.new(ScoutApm::AgentContext.new)
+    assert_equal 'heroku_build', revision.sha
+  end
+
+  def test_sha_from_heroku_prefers_build_commit_over_deprecated_slug_commit
+    ENV['HEROKU_BUILD_COMMIT'] = 'heroku_build'
+    ENV['HEROKU_SLUG_COMMIT'] = 'heroku_slug'
+    revision = ScoutApm::GitRevision.new(ScoutApm::AgentContext.new)
+    assert_equal 'heroku_build', revision.sha
+  end
+
   def test_sha_from_capistrano
     Dir.mktmpdir do |dir|
       context = context_with_file_in_root(File.join(dir, 'REVISION'), 'capistrano_sha')

data/test/unit/instruments/grape_test.rb

@@ -0,0 +1,83 @@
+if (ENV["SCOUT_TEST_FEATURES"] || "").include?("instruments")
+
+  require 'test_helper'
+
+  require 'grape'
+  require 'scout_apm/instruments/grape'
+
+  class GrapeTest < Minitest::Test
+    # Captured before the instrument is installed. On grape >= 3.3.0 #run is
+    # owned by the prepended Grape::Testing::RunBeforeEach module, not the
+    # Grape::Endpoint class itself.
+    GRAPE_ENDPOINT_OWNS_RUN = ::Grape::Endpoint.instance_method(:run).owner == ::Grape::Endpoint
+
+    class HelloAPI < ::Grape::API
+      format :json
+
+      get :hello do
+        { message: 'hello' }
+      end
+    end
+
+    # Install exactly once for the entire test run. Re-running an
+    # alias-method install would alias the wrapper onto itself.
+    def self.install_instruments
+      @install_instruments ||= begin
+        context = ScoutApm::AgentContext.new
+        instrument_manager = ScoutApm::InstrumentManager.new(context)
+        instance = ScoutApm::Instruments::Grape.new(context)
+        instance.install(prepend: instrument_manager.prepend_for_instrument?(instance.class))
+        instance
+      end
+    end
+
+    def setup
+      @instance = self.class.install_instruments
+    end
+
+    def test_installed
+      assert @instance.installed?
+    end
+
+    # Grape >= 3.3.0 prepends Grape::Testing::RunBeforeEach in front of
+    # Grape::Endpoint#run. Building an alias-method chain on top of the
+    # prepended method caused infinite recursion (SystemStackError) as soon
+    # as any endpoint was called.
+    def test_endpoint_runs_without_infinite_recursion
+      status, _headers, body = HelloAPI.call(Rack::MockRequest.env_for('/hello'))
+
+      assert_equal 200, status
+
+      body_content = "".dup
+      body.each { |chunk| body_content << chunk }
+      assert_includes body_content, 'hello'
+    end
+
+    # Either instrumentation method is valid: alias_method is the default,
+    # prepend is used when configured (`use_prepend`/`prepend_instruments`)
+    # or when the instrument falls back to it for safety.
+    def test_installs_using_prepend_or_alias_method
+      assert prepended? || aliased?, "expected Grape::Endpoint to be instrumented via prepend or alias_method"
+
+      unless GRAPE_ENDPOINT_OWNS_RUN
+        # On grape >= 3.3.0 #run is owned by a module prepended onto
+        # Grape::Endpoint, where an alias-method chain would recurse, so the
+        # instrument must have used prepend even though alias_method is the
+        # default.
+        assert prepended?, "grape >= 3.3.0 requires the prepend instrumentation method"
+        refute aliased?, "the alias-method chain must not be installed over a prepended #run"
+      end
+    end
+
+    private
+
+    def prepended?
+      ::Grape::Endpoint.ancestors.include?(ScoutApm::Instruments::GrapeEndpointInstrumentsPrepend)
+    end
+
+    def aliased?
+      ::Grape::Endpoint.method_defined?(:run_without_scout_instruments) ||
+        ::Grape::Endpoint.private_method_defined?(:run_without_scout_instruments)
+    end
+  end
+end

data/test/unit/instruments/http_test.rb

@@ -15,9 +15,14 @@ if (ENV["SCOUT_TEST_FEATURES"] || "").include?("instruments")
 
     def test_installs_using_proper_method
       if @instrument_manager.prepend_for_instrument?(@instance.class) == true
-        assert ::HTTP::Client.ancestors.include?(ScoutApm::Instruments::HTTPInstrumentationPrepend)
+        if Gem::Version.new(::HTTP::VERSION) >= Gem::Version.new("6.0.0")
+          assert ::HTTP::Client.ancestors.include?(ScoutApm::Instruments::HTTPInstrumentationPrependV6)
+        else
+          assert ::HTTP::Client.ancestors.include?(ScoutApm::Instruments::HTTPInstrumentationPrepend)
+        end
       else
         assert_equal false, ::HTTP::Client.ancestors.include?(ScoutApm::Instruments::HTTPInstrumentationPrepend)
+        assert_equal false, ::HTTP::Client.ancestors.include?(ScoutApm::Instruments::HTTPInstrumentationPrependV6)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 6.2.1
 platform: ruby
 authors:
 - Derek Haynes
@@ -314,6 +314,7 @@ files:
 - lib/scout_apm/instruments/active_record.rb
 - lib/scout_apm/instruments/elasticsearch.rb
 - lib/scout_apm/instruments/grape.rb
+- lib/scout_apm/instruments/graphql.rb
 - lib/scout_apm/instruments/http.rb
 - lib/scout_apm/instruments/http_client.rb
 - lib/scout_apm/instruments/httpx.rb
@@ -464,6 +465,7 @@ files:
 - 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/grape_test.rb
 - test/unit/instruments/http_client_test.rb
 - test/unit/instruments/http_test.rb
 - test/unit/instruments/httpx_test.rb
@@ -520,7 +522,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Ruby application performance monitoring
 test_files: []