newrelic_rpm 8.2.0 → 9.0.0

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

@@ -1,6 +1,6 @@
-# encoding: utf-8
 # 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 'delayed_job/chain'
 require_relative 'delayed_job/prepend'
@@ -14,14 +14,14 @@ module NewRelic
         module Naming
           module_function
 
-          CLASS_METHOD_DELIMITER     = '.'.freeze
-          INSTANCE_METHOD_DELIMITER  = '#'.freeze
+          CLASS_METHOD_DELIMITER = '.'.freeze
+          INSTANCE_METHOD_DELIMITER = '#'.freeze
           LEGACY_DJ_FORMAT_DELIMITER = ';'.freeze
-          LEGACY_DJ_FORMAT_PREFIX    = 'LOAD'.freeze
-          LEGACY_DJ_DEFAULT_CLASS    = '(unknown class)'.freeze
+          LEGACY_DJ_FORMAT_PREFIX = 'LOAD'.freeze
+          LEGACY_DJ_DEFAULT_CLASS = '(unknown class)'.freeze
 
           def name_from_payload(payload_object)
-            if payload_object.is_a? ::Delayed::PerformableMethod
+            if payload_object.is_a?(::Delayed::PerformableMethod)
               # payload_object contains a reference to an object
               # that received an asynchronous method call via .delay or .handle_asynchronously
               "#{object_name(payload_object)}#{delimiter(payload_object)}#{method_name(payload_object)}"
@@ -79,18 +79,36 @@ DependencyDetection.defer do
   @name = :delayed_job
 
   depends_on do
-    defined?(::Delayed) && defined?(::Delayed::Worker)
+    defined?(Delayed) && defined?(Delayed::Worker)
   end
 
   executes do
-    ::NewRelic::Agent.logger.info 'Installing DelayedJob instrumentation [part 1/2]'
+    NewRelic::Agent.logger.info('Installing DelayedJob instrumentation [part 1/2]')
   end
 
   executes do
     if use_prepend?
-      prepend_instrument ::Delayed::Worker, ::NewRelic::Agent::Instrumentation::DelayedJob::Prepend
+      prepend_instrument Delayed::Worker, NewRelic::Agent::Instrumentation::DelayedJob::Prepend
     else
-      chain_instrument ::NewRelic::Agent::Instrumentation::DelayedJob::Chain
+      chain_instrument NewRelic::Agent::Instrumentation::DelayedJob::Chain
     end
   end
+
+  executes do
+    next unless delayed_job_version < Gem::Version.new('4.1.0')
+
+    deprecation_msg = 'Instrumentation for DelayedJob versions below 4.1.0 is deprecated.' \
+      'It will stop being monitored in version 9.0.0. ' \
+      'Please upgrade your DelayedJob version to continue receiving full support. ' \
+
+    NewRelic::Agent.logger.log_once(
+      :warn,
+      :deprecated_delayed_job_version,
+      deprecation_msg
+    )
+  end
+
+  def delayed_job_version
+    Gem.loaded_specs['delayed_job'].version if Gem.loaded_specs['delayed_job']
+  end
 end

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

@@ -0,0 +1,29 @@
+# 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 Elasticsearch
+    def self.instrument!
+      to_instrument = if ::Gem::Version.create(::Elasticsearch::VERSION) <
+          ::Gem::Version.create("8.0.0")
+        ::Elasticsearch::Transport::Client
+      else
+        ::Elastic::Transport::Client
+      end
+
+      to_instrument.class_eval do
+        include NewRelic::Agent::Instrumentation::Elasticsearch
+
+        alias_method(:perform_request_without_tracing, :perform_request)
+        alias_method(:perform_request, :perform_request_with_tracing)
+
+        def perform_request(*args)
+          perform_request_with_tracing(*args) do
+            perform_request_without_tracing(*args)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# 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 '../../datastores/nosql_obfuscator'
+
+module NewRelic::Agent::Instrumentation
+  module Elasticsearch
+    PRODUCT_NAME = 'Elasticsearch'
+    OPERATION = 'perform_request'
+
+    def perform_request_with_tracing(method, path, params = {}, body = nil, headers = nil)
+      return yield unless NewRelic::Agent::Tracer.tracing_enabled?
+
+      segment = NewRelic::Agent::Tracer.start_datastore_segment(
+        product: PRODUCT_NAME,
+        operation: nr_operation || OPERATION,
+        host: nr_hosts[:host],
+        port_path_or_id: path,
+        database_name: nr_cluster_name
+      )
+      begin
+        NewRelic::Agent::Tracer.capture_segment_error(segment) { yield }
+      ensure
+        if segment
+          segment.notice_nosql_statement(nr_reported_query(body || params))
+          segment.finish
+        end
+      end
+    end
+
+    private
+
+    def nr_operation
+      operation_index = caller_locations.index do |line|
+        string = line.to_s
+        string.include?('lib/elasticsearch/api') && !string.include?(OPERATION)
+      end
+      return nil unless operation_index
+
+      caller_locations[operation_index].to_s.split('`')[-1].gsub(/\W/, "")
+    end
+
+    def nr_reported_query(query)
+      return unless NewRelic::Agent.config[:'elasticsearch.capture_queries']
+      return query unless NewRelic::Agent.config[:'elasticsearch.obfuscate_queries']
+
+      NewRelic::Agent::Datastores::NosqlObfuscator.obfuscate_statement(query)
+    end
+
+    def nr_cluster_name
+      return @nr_cluster_name if @nr_cluster_name
+      return if nr_hosts.empty?
+
+      NewRelic::Agent.disable_all_tracing do
+        @nr_cluster_name ||= perform_request('GET', '_cluster/health').body["cluster_name"]
+      end
+    rescue StandardError => e
+      NewRelic::Agent.logger.error("Failed to get cluster name for elasticsearch", e)
+      nil
+    end
+
+    def nr_hosts
+      @nr_hosts ||= (transport.hosts.first || NewRelic::EMPTY_HASH)
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# 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 Elasticsearch::Prepend
+    include NewRelic::Agent::Instrumentation::Elasticsearch
+
+    def perform_request(*args)
+      perform_request_with_tracing(*args) { super }
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# 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 'elasticsearch/instrumentation'
+require_relative 'elasticsearch/chain'
+require_relative 'elasticsearch/prepend'
+
+DependencyDetection.defer do
+  named :elasticsearch
+
+  depends_on do
+    defined?(Elasticsearch)
+  end
+
+  executes do
+    NewRelic::Agent.logger.info('Installing Elasticsearch instrumentation')
+
+    to_instrument = if Gem::Version.create(Elasticsearch::VERSION) < Gem::Version.create("8.0.0")
+      Elasticsearch::Transport::Client
+    else
+      Elastic::Transport::Client
+    end
+
+    if use_prepend?
+      prepend_instrument to_instrument, NewRelic::Agent::Instrumentation::Elasticsearch::Prepend
+    else
+      chain_instrument NewRelic::Agent::Instrumentation::Elasticsearch
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
-# encoding: utf-8
 # 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 ::Excon
   module Middleware
@@ -11,7 +11,7 @@ module ::Excon
         @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
@@ -25,7 +25,7 @@ module ::Excon
               procedure: wrapped_request.method
             )
 
-            segment.add_request_headers wrapped_request
+            segment.add_request_headers(wrapped_request)
 
             datum[:connection].instance_variable_set(TRACE_DATA_IVAR, segment)
           end
@@ -45,7 +45,7 @@ module ::Excon
         @stack.error_call(datum)
       end
 
-      def finish_trace(datum) #THREAD_LOCAL_ACCESS
+      def finish_trace(datum) # THREAD_LOCAL_ACCESS
         segment = datum[:connection] && datum[:connection].instance_variable_get(TRACE_DATA_IVAR)
         if segment
           begin
@@ -54,10 +54,10 @@ module ::Excon
 
             if datum[:response]
               wrapped_response = ::NewRelic::Agent::HTTPClients::ExconHTTPResponse.new(datum[:response])
-              segment.process_response_headers wrapped_response
+              segment.process_response_headers(wrapped_response)
             end
           ensure
-            segment.finish if segment
+            ::NewRelic::Agent::Transaction::Segment.finish(segment)
           end
         end
       end

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

@@ -1,6 +1,6 @@
-# encoding: utf-8
 # 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
 
 DependencyDetection.defer do
   named :excon
@@ -17,21 +17,38 @@ DependencyDetection.defer do
   # so we could safely subscribe and not be clobbered by future subscribers,
   # but alas, it does not yet.
 
+  # 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 = Gem::Version.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/distributed_tracing/cross_app_tracing'
     require 'new_relic/agent/http_clients/excon_wrappers'
@@ -40,15 +57,14 @@ DependencyDetection.defer do
   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
 end
-

data/lib/new_relic/agent/instrumentation/fiber/chain.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
+    def self.instrument!
+      ::Fiber.class_eval do
+        include NewRelic::Agent::Instrumentation::MonitoredFiber
+
+        alias_method(:initialize_without_new_relic, :initialize)
+
+        def initialize(*args, &block)
+          traced_block = add_thread_tracing(*args, &block)
+          initialize_with_newrelic_tracing { initialize_without_new_relic(*args, &traced_block) }
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/fiber/instrumentation.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 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(*args, &block)
+      return block if !NewRelic::Agent::Tracer.thread_tracing_enabled?
+
+      NewRelic::Agent::Tracer.thread_block_with_current_transaction(
+        *args,
+        segment_name: 'Ruby/Fiber',
+        &block
+      )
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# 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
+
+      def initialize(*args, &block)
+        traced_block = add_thread_tracing(*args, &block)
+        initialize_with_newrelic_tracing { super(*args, &traced_block) }
+      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
+    end
+  end
+end

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

@@ -1,25 +1,24 @@
-# encoding: utf-8
 # 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
+          def call_with_new_relic(env)
             begin
-              call_without_new_relic env
+              call_without_new_relic(env)
             ensure
-              Grape::Instrumentation.capture_transaction env, self
+              Grape::Instrumentation.capture_transaction(env, self)
             end
           end
-    
-          alias_method :call_without_new_relic, :call
-          alias_method :call, :call_with_new_relic
+
+          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

@@ -1,13 +1,12 @@
-# encoding: utf-8
 # 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
 
       # 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`
@@ -16,7 +15,7 @@ module NewRelic::Agent::Instrumentation
         defined?(::Grape::API::Instance) ? ::Grape::API::Instance : ::Grape::API
       end
 
-      def capture_transaction env, context
+      def capture_transaction(env, context)
         begin
           endpoint = env[API_ENDPOINT]
           version = env[API_VERSION]
@@ -30,22 +29,23 @@ module NewRelic::Agent::Instrumentation
 
       def prepare!
         if defined?(::Grape::VERSION) && Gem::Version.new(::Grape::VERSION) >= Gem::Version.new("0.16.0")
-          send :remove_method, :name_for_transaction_deprecated
+          send(:remove_method, :name_for_transaction_deprecated)
         else
-          send :remove_method, :name_for_transaction
-          send :alias_method, :name_for_transaction, :name_for_transaction_deprecated
+          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
+      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
+
         name_transaction(route, class_name, version)
         capture_params(endpoint)
       end

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

@@ -1,15 +1,15 @@
-# encoding: utf-8
 # 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
+      def call(env)
         begin
-          super env
+          super(env)
         ensure
-          Grape::Instrumentation.capture_transaction env, self
+          Grape::Instrumentation.capture_transaction(env, self)
         end
       end
     end

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

@@ -1,6 +1,6 @@
-# encoding: utf-8
 # 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 'grape/instrumentation'
 require_relative 'grape/chain'
@@ -9,37 +9,36 @@ 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
-    defined?(::Grape::VERSION) &&
-      Gem::Version.new(::Grape::VERSION) >= ::NewRelic::Agent::Instrumentation::Grape::Instrumentation::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")
+        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", e)
+      NewRelic::Agent.logger.info("Could not determine if third party newrelic-grape gem is installed", e)
       true
     end
   end
 
   executes do
-    ::NewRelic::Agent::Instrumentation::Grape::Instrumentation.prepare!
+    NewRelic::Agent::Instrumentation::Grape::Instrumentation.prepare!
 
     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
+      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