newrelic_rpm 3.12.0.288 → 9.10.2

data/lib/new_relic/agent/instrumentation/ethon.rb

@@ -0,0 +1,39 @@
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+require_relative 'ethon/instrumentation'
+require_relative 'ethon/chain'
+require_relative 'ethon/prepend'
+
+DependencyDetection.defer do
+  named :ethon
+
+  # If Ethon is being used as a dependency of Typhoeus, allow the Typhoeus
+  # instrumentation to handle everything. Otherwise each external network call
+  # will confusingly result in "Ethon" segments duplicating the information
+  # already provided by "Typhoeus" segments.
+  depends_on do
+    !defined?(Typhoeus)
+  end
+
+  depends_on do
+    defined?(Ethon) && Gem::Version.new(Ethon::VERSION) >= Gem::Version.new('0.12.0')
+  end
+
+  executes do
+    NewRelic::Agent.logger.info('Installing ethon instrumentation')
+  end
+
+  executes do
+    if use_prepend?
+      # NOTE: by default prepend_instrument will go with the module name that
+      #       precedes 'Prepend' (so 'Easy' and 'Multi'), but we want to use
+      #       'Ethon::Easy' and 'Ethon::Multi' so 3rd argument is supplied
+      prepend_instrument Ethon::Easy, NewRelic::Agent::Instrumentation::Ethon::Easy::Prepend, Ethon::Easy.name
+      prepend_instrument Ethon::Multi, NewRelic::Agent::Instrumentation::Ethon::Multi::Prepend, Ethon::Multi.name
+    else
+      chain_instrument NewRelic::Agent::Instrumentation::Ethon::Chain
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/excon/middleware.rb

@@ -1,28 +1,36 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 module ::Excon
   module Middleware
     class NewRelicCrossAppTracing
       TRACE_DATA_IVAR = :@newrelic_trace_data
+      INSTRUMENTATION_NAME = 'Excon'
 
       def initialize(stack)
         @stack = stack
       end
 
-      def request_call(datum) #THREAD_LOCAL_ACCESS
+      def request_call(datum) # THREAD_LOCAL_ACCESS
         begin
           # Only instrument this request if we haven't already done so, because
           # we can get request_call multiple times for requests marked as
           # :idempotent in the options, but there will be only a single
           # accompanying response_call/error_call.
           if datum[:connection] && !datum[:connection].instance_variable_get(TRACE_DATA_IVAR)
+            NewRelic::Agent.record_instrumentation_invocation(INSTRUMENTATION_NAME)
+
             wrapped_request = ::NewRelic::Agent::HTTPClients::ExconHTTPRequest.new(datum)
-            state   = ::NewRelic::Agent::TransactionState.tl_get
-            t0      = Time.now
-            node = ::NewRelic::Agent::CrossAppTracing.start_trace(state, t0, wrapped_request)
-            datum[:connection].instance_variable_set(TRACE_DATA_IVAR, [t0, node, wrapped_request])
+            segment = NewRelic::Agent::Tracer.start_external_request_segment(
+              library: wrapped_request.type,
+              uri: wrapped_request.uri,
+              procedure: wrapped_request.method
+            )
+
+            segment.add_request_headers(wrapped_request)
+
+            datum[:connection].instance_variable_set(TRACE_DATA_IVAR, segment)
           end
         rescue => e
           NewRelic::Agent.logger.debug(e)
@@ -40,16 +48,21 @@ module ::Excon
         @stack.error_call(datum)
       end
 
-      def finish_trace(datum) #THREAD_LOCAL_ACCESS
-        trace_data = datum[:connection] && datum[:connection].instance_variable_get(TRACE_DATA_IVAR)
-        if trace_data
-          datum[:connection].instance_variable_set(TRACE_DATA_IVAR, nil)
-          t0, node, wrapped_request = trace_data
-          if datum[:response]
-            wrapped_response = ::NewRelic::Agent::HTTPClients::ExconHTTPResponse.new(datum[:response])
+      def finish_trace(datum) # THREAD_LOCAL_ACCESS
+        # The following line needs else branch coverage
+        segment = datum[:connection] && datum[:connection].instance_variable_get(TRACE_DATA_IVAR) # rubocop:disable Style/SafeNavigation
+        if segment
+          begin
+            segment.notice_error(datum[:error]) if datum[:error]
+            datum[:connection].instance_variable_set(TRACE_DATA_IVAR, nil)
+
+            if datum[:response]
+              wrapped_response = ::NewRelic::Agent::HTTPClients::ExconHTTPResponse.new(datum[:response])
+              segment.process_response_headers(wrapped_response)
+            end
+          ensure
+            ::NewRelic::Agent::Transaction::Segment.finish(segment)
           end
-          state = ::NewRelic::Agent::TransactionState.tl_get
-          ::NewRelic::Agent::CrossAppTracing.finish_trace(state, t0, node, wrapped_request, wrapped_response)
         end
       end
     end

data/lib/new_relic/agent/instrumentation/excon.rb

@@ -1,21 +1,13 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 DependencyDetection.defer do
   named :excon
 
-  # We have two ways of instrumenting Excon:
-  # - For newer versions, use the middleware mechanism Excon exposes
-  # - For older versions, monkey-patch Excon::Connection#request
+  # We instrument Excon 0.19.0 and above using the middleware mechanism
   #
   # EXCON_MIN_VERSION is the minimum version we attempt to instrument at all.
-  # EXCON_MIDDLEWARE_MIN_VERSION is the min version we use the newer
-  #   instrumentation for.
-  #
-  # Note that middlewares were added to Excon prior to 0.19, but we don't
-  # use middleware-based instrumentation prior to that version because it didn't
-  # expose a way for middlewares to know about request failures.
   #
   # Why don't we use Excon.defaults[:instrumentor]?
   # While this might seem a perfect fit, it unfortunately isn't suitable in
@@ -25,48 +17,54 @@ DependencyDetection.defer do
   # so we could safely subscribe and not be clobbered by future subscribers,
   # but alas, it does not yet.
 
-  EXCON_MIN_VERSION = ::NewRelic::VersionNumber.new("0.10.1")
-  EXCON_MIDDLEWARE_MIN_VERSION = ::NewRelic::VersionNumber.new("0.19.0")
+  # TODO: MAJOR VERSION - update min version to 0.56.0
+  EXCON_MIN_VERSION = Gem::Version.new('0.19.0')
 
   depends_on do
-    defined?(::Excon) && defined?(::Excon::VERSION)
+    defined?(Excon) && defined?(Excon::VERSION)
   end
 
   executes do
-    excon_version = NewRelic::VersionNumber.new(::Excon::VERSION)
+    excon_version = Gem::Version.new(Excon::VERSION)
     if excon_version >= EXCON_MIN_VERSION
       install_excon_instrumentation(excon_version)
     else
-      ::NewRelic::Agent.logger.warn("Excon instrumentation requires at least version #{EXCON_MIN_VERSION}")
+      NewRelic::Agent.logger.warn("Excon instrumentation requires at least version #{EXCON_MIN_VERSION}")
     end
   end
 
+  executes do
+    next unless Gem::Version.new(Excon::VERSION) < Gem::Version.new('0.56.0')
+
+    deprecation_msg = 'Instrumentation for Excon versions below 0.56.0 is deprecated.' \
+      'They will stop being monitored in version 9.0.0. ' \
+      'Please upgrade your Excon version to continue receiving full support. '
+
+    NewRelic::Agent.logger.log_once(
+      :warn,
+      :deprecated_excon_version,
+      deprecation_msg
+    )
+
+    NewRelic::Agent.record_metric('Supportability/Deprecated/Excon', 1)
+  end
+
   def install_excon_instrumentation(excon_version)
-    require 'new_relic/agent/cross_app_tracing'
+    require 'new_relic/agent/distributed_tracing/cross_app_tracing'
     require 'new_relic/agent/http_clients/excon_wrappers'
 
-    if excon_version >= EXCON_MIDDLEWARE_MIN_VERSION
-      install_middleware_excon_instrumentation
-    else
-      install_legacy_excon_instrumentation
-    end
+    install_middleware_excon_instrumentation
   end
 
   def install_middleware_excon_instrumentation
-    ::NewRelic::Agent.logger.info 'Installing middleware-based Excon instrumentation'
+    NewRelic::Agent.logger.info('Installing middleware-based Excon instrumentation')
     require 'new_relic/agent/instrumentation/excon/middleware'
     defaults = Excon.defaults
 
     if defaults[:middlewares]
-      defaults[:middlewares] << ::Excon::Middleware::NewRelicCrossAppTracing
+      defaults[:middlewares] << Excon::Middleware::NewRelicCrossAppTracing
     else
-      ::NewRelic::Agent.logger.warn("Did not find :middlewares key in Excon.defaults, skipping Excon instrumentation")
+      NewRelic::Agent.logger.warn('Did not find :middlewares key in Excon.defaults, skipping Excon instrumentation')
     end
   end
-
-  def install_legacy_excon_instrumentation
-    ::NewRelic::Agent.logger.info 'Installing legacy Excon instrumentation'
-    require 'new_relic/agent/instrumentation/excon/connection'
-    ::Excon::Connection.install_newrelic_instrumentation
-  end
 end

data/lib/new_relic/agent/instrumentation/fiber/chain.rb

@@ -0,0 +1,27 @@
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+module NewRelic::Agent::Instrumentation
+  module MonitoredFiber::Chain
+    def self.instrument!
+      ::Fiber.class_eval do
+        include NewRelic::Agent::Instrumentation::MonitoredFiber
+
+        alias_method(:initialize_without_new_relic, :initialize)
+
+        if RUBY_VERSION < '2.7.0'
+          def initialize(*_args, &block)
+            traced_block = add_thread_tracing(&block)
+            initialize_with_newrelic_tracing { initialize_without_new_relic(&traced_block) }
+          end
+        else
+          def initialize(**kwargs, &block)
+            traced_block = add_thread_tracing(&block)
+            initialize_with_newrelic_tracing { initialize_without_new_relic(**kwargs, &traced_block) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/fiber/instrumentation.rb

@@ -0,0 +1,20 @@
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+module NewRelic::Agent::Instrumentation
+  module MonitoredFiber
+    attr_reader :nr_parent_key
+
+    def initialize_with_newrelic_tracing
+      @nr_parent_key = NewRelic::Agent::Tracer.current_segment_key
+      yield
+    end
+
+    def add_thread_tracing(&block)
+      return block if !NewRelic::Agent::Tracer.thread_tracing_enabled?
+
+      NewRelic::Agent::Tracer.thread_block_with_current_transaction(&block)
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/fiber/prepend.rb

@@ -0,0 +1,25 @@
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+require_relative 'instrumentation'
+
+module NewRelic::Agent::Instrumentation
+  module MonitoredFiber
+    module Prepend
+      include NewRelic::Agent::Instrumentation::MonitoredFiber
+
+      if RUBY_VERSION < '2.7.0'
+        def initialize(*_args, &block)
+          traced_block = add_thread_tracing(&block)
+          initialize_with_newrelic_tracing { super(&traced_block) }
+        end
+      else
+        def initialize(**kawrgs, &block)
+          traced_block = add_thread_tracing(&block)
+          initialize_with_newrelic_tracing { super(**kawrgs, &traced_block) }
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/fiber.rb

@@ -0,0 +1,25 @@
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+require_relative 'fiber/instrumentation'
+require_relative 'fiber/chain'
+require_relative 'fiber/prepend'
+
+DependencyDetection.defer do
+  named :fiber
+
+  depends_on do
+    defined?(Fiber)
+  end
+
+  executes do
+    NewRelic::Agent.logger.info('Installing Fiber instrumentation')
+
+    if use_prepend?
+      prepend_instrument Fiber, NewRelic::Agent::Instrumentation::MonitoredFiber::Prepend
+    else
+      chain_instrument NewRelic::Agent::Instrumentation::MonitoredFiber::Chain
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/grape/chain.rb

@@ -0,0 +1,24 @@
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+module NewRelic::Agent::Instrumentation
+  module Grape
+    module Chain
+      def self.instrument!
+        Grape::Instrumentation.instrumented_class.class_eval do
+          def call_with_new_relic(env)
+            begin
+              call_without_new_relic(env)
+            ensure
+              Grape::Instrumentation.capture_transaction(env, self)
+            end
+          end
+
+          alias_method(:call_without_new_relic, :call)
+          alias_method(:call, :call_with_new_relic)
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/grape/instrumentation.rb

@@ -0,0 +1,104 @@
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+require 'new_relic/agent/parameter_filtering'
+
+module NewRelic::Agent::Instrumentation
+  module Grape
+    module Instrumentation
+      extend self
+
+      INSTRUMENTATION_NAME = NewRelic::Agent.base_name(name)
+
+      # Since 1.2.0, the class `Grape::API` no longer refers to an API instance, rather, what used to be `Grape::API` is `Grape::API::Instance`
+      # https://github.com/ruby-grape/grape/blob/c20a73ac1e3f3ba1082005ed61bf69452373ba87/UPGRADING.md#upgrading-to--120
+      def instrumented_class
+        defined?(::Grape::API::Instance) ? ::Grape::API::Instance : ::Grape::API
+      end
+
+      def capture_transaction(env, context)
+        begin
+          endpoint = env[API_ENDPOINT]
+          version = env[API_VERSION]
+
+          api_class = (context.class.respond_to?(:base) && context.class.base) || context.class
+          handle_transaction(endpoint, api_class.name, version)
+        rescue => e
+          ::NewRelic::Agent.logger.warn('Error in Grape instrumentation', e)
+        end
+      end
+
+      def prepare!
+        if defined?(::Grape::VERSION) && Gem::Version.new(::Grape::VERSION) >= Gem::Version.new('0.16.0')
+          send(:remove_method, :name_for_transaction_deprecated)
+        else
+          send(:remove_method, :name_for_transaction)
+          send(:alias_method, :name_for_transaction, :name_for_transaction_deprecated)
+        end
+      end
+
+      API_ENDPOINT = 'api.endpoint'.freeze
+      API_VERSION = 'api.version'.freeze
+      FORMAT_REGEX = /\(\/?\.[\:\w]*\)/.freeze # either :format (< 0.12.0) or .ext (>= 0.12.0)
+      VERSION_REGEX = /:version(\/|$)/.freeze
+      MIN_VERSION = Gem::Version.new('0.2.0')
+      PIPE_STRING = '|'.freeze
+
+      def handle_transaction(endpoint, class_name, version)
+        return unless endpoint && route = endpoint.route
+
+        NewRelic::Agent.record_instrumentation_invocation(INSTRUMENTATION_NAME)
+
+        name_transaction(route, class_name, version)
+        capture_params(endpoint)
+      end
+
+      def name_transaction(route, class_name, version)
+        txn_name = name_for_transaction(route, class_name, version)
+        segment_name = "Middleware/Grape/#{class_name}/call"
+        NewRelic::Agent::Transaction.set_default_transaction_name(txn_name, :grape)
+        txn = NewRelic::Agent::Transaction.tl_current
+        txn.segments.last.name = segment_name
+      end
+
+      def name_for_transaction(route, class_name, version)
+        action_name = route.path.sub(FORMAT_REGEX, NewRelic::EMPTY_STR)
+        method_name = route.request_method
+        version ||= route.version
+
+        # defaulting does not set rack.env['api.version'] and route.version may return Array
+        #
+        version = version.join(PIPE_STRING) if Array === version
+
+        if version
+          action_name = action_name.sub(VERSION_REGEX, NewRelic::EMPTY_STR)
+          "#{class_name}-#{version}#{action_name} (#{method_name})"
+        else
+          "#{class_name}#{action_name} (#{method_name})"
+        end
+      end
+
+      def name_for_transaction_deprecated(route, class_name, version)
+        action_name = route.route_path.sub(FORMAT_REGEX, NewRelic::EMPTY_STR)
+        method_name = route.route_method
+        version ||= route.route_version
+        if version
+          action_name = action_name.sub(VERSION_REGEX, NewRelic::EMPTY_STR)
+          "#{class_name}-#{version}#{action_name} (#{method_name})"
+        else
+          "#{class_name}#{action_name} (#{method_name})"
+        end
+      end
+
+      def capture_params(endpoint)
+        txn = ::NewRelic::Agent::Transaction.tl_current
+        env = endpoint.request.env
+        params = ::NewRelic::Agent::ParameterFiltering::apply_filters(env, endpoint.params)
+        params.delete('route_info')
+        txn.filtered_params = params
+        txn.merge_request_parameters(params)
+      end
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/grape/prepend.rb

@@ -0,0 +1,17 @@
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+module NewRelic::Agent::Instrumentation
+  module Grape
+    module Prepend
+      def call(env)
+        begin
+          super(env)
+        ensure
+          Grape::Instrumentation.capture_transaction(env, self)
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/grape.rb

@@ -1,111 +1,44 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
-require 'new_relic/agent/parameter_filtering'
-
-module NewRelic
-  module Agent
-    module Instrumentation
-      module GrapeInstrumentation
-        extend self
-
-        API_ENDPOINT   = 'api.endpoint'.freeze
-        FORMAT_REGEX   = /\(\/?\.:format\)/.freeze
-        VERSION_REGEX  = /:version(\/|$)/.freeze
-        EMPTY_STRING   = ''.freeze
-        MIN_VERSION    = VersionNumber.new("0.2.0")
-
-        def handle_transaction(endpoint, class_name)
-          return unless endpoint && route = endpoint.route
-          name_transaction(route, class_name)
-          capture_params(endpoint)
-        end
-
-        def name_transaction(route, class_name)
-          txn_name = name_for_transaction(route, class_name)
-          node_name = "Middleware/Grape/#{class_name}/call"
-          Transaction.set_default_transaction_name(txn_name, :grape, node_name)
-        end
-
-        def name_for_transaction(route, class_name)
-          action_name = route.route_path.sub(FORMAT_REGEX, EMPTY_STRING)
-          method_name = route.route_method
-
-          if route.route_version
-            action_name = action_name.sub(VERSION_REGEX, EMPTY_STRING)
-            "#{class_name}-#{route.route_version}#{action_name} (#{method_name})"
-          else
-            "#{class_name}#{action_name} (#{method_name})"
-          end
-        end
-
-        def capture_params(endpoint)
-          txn = Transaction.tl_current
-          env = endpoint.request.env
-          params = ParameterFiltering::apply_filters(env, endpoint.params)
-          params.delete("route_info")
-          txn.filtered_params = params
-          txn.merge_request_parameters(params)
-        end
-      end
-    end
-  end
-end
+require_relative 'grape/instrumentation'
+require_relative 'grape/chain'
+require_relative 'grape/prepend'
 
 DependencyDetection.defer do
   # Why not just :grape? newrelic-grape used that name already, and while we're
   # not shipping yet, overloading the name interferes with the plugin.
-  named :grape_instrumentation
+  @name = :grape_instrumentation
+  configure_with :grape
 
   depends_on do
-    ::NewRelic::Agent.config[:disable_grape] == false
-  end
-
-  depends_on do
-    defined?(::Grape::VERSION) &&
-      ::NewRelic::VersionNumber.new(::Grape::VERSION) >= ::NewRelic::Agent::Instrumentation::GrapeInstrumentation::MIN_VERSION
+    defined?(Grape::VERSION) &&
+      Gem::Version.new(Grape::VERSION) >= NewRelic::Agent::Instrumentation::Grape::Instrumentation::MIN_VERSION
   end
 
   depends_on do
     begin
-      if defined?(Bundler) && Bundler.rubygems.all_specs.map(&:name).include?("newrelic-grape")
-        ::NewRelic::Agent.logger.info("Not installing New Relic supported Grape instrumentation because the third party newrelic-grape gem is present")
+      if defined?(Bundler) && Bundler.rubygems.all_specs.map(&:name).include?('newrelic-grape')
+        NewRelic::Agent.logger.info('Not installing New Relic supported Grape instrumentation because the third party newrelic-grape gem is present')
         false
       else
         true
       end
     rescue => e
-      ::NewRelic::Agent.logger.info("Could not determine if third party newrelic-grape gem is installed")
+      NewRelic::Agent.logger.info('Could not determine if third party newrelic-grape gem is installed', e)
       true
     end
   end
 
   executes do
-    NewRelic::Agent.logger.info 'Installing New Relic supported Grape instrumentation'
-    instrument_call
-  end
+    NewRelic::Agent::Instrumentation::Grape::Instrumentation.prepare!
 
-  def instrument_call
-    ::Grape::API.class_eval do
-      def call_with_new_relic(env)
-        begin
-          response = call_without_new_relic(env)
-        ensure
-          begin
-            endpoint = env[::NewRelic::Agent::Instrumentation::GrapeInstrumentation::API_ENDPOINT]
-            ::NewRelic::Agent::Instrumentation::GrapeInstrumentation.handle_transaction(endpoint, self.class.name)
-          rescue => e
-            ::NewRelic::Agent.logger.warn("Error in Grape instrumentation", e)
-          end
-        end
-
-        response
-      end
-
-      alias_method :call_without_new_relic, :call
-      alias_method :call, :call_with_new_relic
+    if use_prepend?
+      instrumented_class = NewRelic::Agent::Instrumentation::Grape::Instrumentation.instrumented_class
+      prepend_instrument instrumented_class, NewRelic::Agent::Instrumentation::Grape::Prepend
+    else
+      chain_instrument NewRelic::Agent::Instrumentation::Grape::Chain
     end
   end
-
 end