newrelic_rpm 8.11.0 → 8.12.0

data/lib/new_relic/agent/error_collector.rb

@@ -123,11 +123,13 @@ module NewRelic
 
       def exception_tagged_with?(ivar, exception)
         return false if exception_is_java_object?(exception)
+
         exception.instance_variable_defined?(ivar)
       end
 
       def tag_exception_using(ivar, exception)
         return if exception_is_java_object?(exception) || exception.frozen?
+
         begin
           exception.instance_variable_set(ivar, true)
         rescue => e
@@ -137,6 +139,7 @@ module NewRelic
 
       def tag_exception(exception)
         return if exception_is_java_object?(exception) || exception.frozen?
+
         begin
           exception.instance_variable_set(EXCEPTION_TAG_IVAR, true)
         rescue => e

data/lib/new_relic/agent/error_filter.rb

@@ -155,6 +155,7 @@ module NewRelic
         result = []
         code_list.each do |code|
           result << code && next if code.is_a?(Integer)
+
           m = code.match(/(\d{3})(-\d{3})?/)
           if m.nil? || m[1].nil?
             ::NewRelic::Agent.logger.warn("Invalid HTTP status code: '#{code}'; ignoring config")

data/lib/new_relic/agent/error_trace_aggregator.rb

@@ -44,6 +44,7 @@ module NewRelic
       # floor after logging a warning.
       def add_to_error_queue(noticed_error)
         return unless enabled?
+
         @lock.synchronize do
           if !over_queue_limit?(noticed_error.message) && !@errors.include?(noticed_error)
             @errors << noticed_error

data/lib/new_relic/agent/event_aggregator.rb

@@ -136,6 +136,7 @@ module NewRelic
 
       def notify_if_full
         return unless !@notified_full && @buffer.full?
+
         NewRelic::Agent.logger.debug("#{self.class.named} capacity of #{@buffer.capacity} reached, beginning sampling")
         @notified_full = true
       end

data/lib/new_relic/agent/event_loop.rb

@@ -34,6 +34,7 @@ module NewRelic
         def calculate_next_fire_time
           now = Process.clock_gettime(Process::CLOCK_REALTIME)
           return now if @interval == 0
+
           fire_time = @last_fired_at || now
           while fire_time <= now
             fire_time += @interval
@@ -80,6 +81,7 @@ module NewRelic
 
       def next_timeout
         return nil if @timers.empty?
+
         timeout = @timers.values.map(&:next_fire_time).min - Process.clock_gettime(Process::CLOCK_REALTIME)
         timeout < 0 ? 0 : timeout
       end

data/lib/new_relic/agent/http_clients/abstract.rb

@@ -47,6 +47,7 @@ module NewRelic
           if wrapped_response.nil?
             raise ArgumentError, WHINY_NIL_ERROR % self.class
           end
+
           @wrapped_response = wrapped_response
         end
 
@@ -64,6 +65,7 @@ module NewRelic
 
         def get_status_code_using(method_name)
           return unless @wrapped_response.respond_to?(method_name)
+
           code = @wrapped_response.send(method_name).to_i
           code == 0 ? nil : code
         end

data/lib/new_relic/agent/http_clients/typhoeus_wrappers.rb

@@ -67,6 +67,7 @@ module NewRelic
 
         def [](key)
           return nil unless @request.options && @request.options[:headers]
+
           @request.options[:headers][key]
         end
 

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

@@ -38,6 +38,7 @@ DependencyDetection.defer do
 
   executes do
     next unless Gem::Version.new(ActiveMerchant::VERSION) < Gem::Version.new('1.65.0')
+
     deprecation_msg = 'The Ruby Agent is dropping support for ActiveMerchant versions below 1.65.0 ' \
       'in version 9.0.0. Please upgrade your ActiveMerchant version to continue receiving full support. ' \
 

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

@@ -10,6 +10,7 @@ module NewRelic
       class ActiveStorageSubscriber < NotificationsSubscriber
         def start(name, id, payload)
           return unless state.is_execution_traced?
+
           start_segment(name, id, payload)
         rescue => e
           log_notification_error(e, name, 'start')
@@ -17,6 +18,7 @@ module NewRelic
 
         def finish(name, id, payload)
           return unless state.is_execution_traced?
+
           finish_segment(id, payload)
         rescue => e
           log_notification_error(e, name, 'finish')

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

@@ -14,6 +14,7 @@ module NewRelic
               parse_query_without_newrelic(*args)
             ensure
               return unless txn = ::NewRelic::Agent::Tracer.current_transaction
+
               txn.current_segment.params[:statement] = ::NewRelic::Agent::Database.truncate_query(args.first.inspect) rescue nil
             end
           end

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

@@ -273,6 +273,7 @@ module NewRelic
 
           def self.class_name(traced_obj, options = {})
             return options[:class_name] if options[:class_name]
+
             if traced_obj.is_a?(Class) || traced_obj.is_a?(Module)
               traced_obj.name
             else

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

@@ -96,6 +96,7 @@ DependencyDetection.defer do
 
   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. ' \

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/grape/instrumentation.rb

@@ -45,6 +45,7 @@ module NewRelic::Agent::Instrumentation
 
       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/logger/instrumentation.rb

@@ -15,21 +15,25 @@ module NewRelic
         # and AuditLogger without them having to know the inner details.
         def self.mark_skip_instrumenting(logger)
           return if logger.frozen?
+
           logger.instance_variable_set(:@skip_instrumenting, true)
         end
 
         def self.clear_skip_instrumenting(logger)
           return if logger.frozen?
+
           logger.instance_variable_set(:@skip_instrumenting, false)
         end
 
         def mark_skip_instrumenting
           return if frozen?
+
           @skip_instrumenting = true
         end
 
         def clear_skip_instrumenting
           return if frozen?
+
           @skip_instrumenting = false
         end
 

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

@@ -14,6 +14,7 @@ module NewRelic
         def started(event)
           begin
             return unless NewRelic::Agent::Tracer.tracing_enabled?
+
             segments[event.operation_id] = start_segment(event)
           rescue Exception => e
             log_notification_error('started', e)
@@ -33,6 +34,7 @@ module NewRelic
         def completed(event)
           begin
             return unless NewRelic::Agent::Tracer.tracing_enabled?
+
             segment = segments.delete(event.operation_id)
             return unless segment
 

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

@@ -76,6 +76,7 @@ module NewRelic
           # defensive.
           return if defined?(exception_object)
           return unless defined?(::ActiveSupport::VERSION)
+
           if ::ActiveSupport::VERSION::STRING < "5.0.0"
             # Earlier versions of Rails did not add the exception itself to the
             # payload accessible via :exception_object, so we create a stand-in
@@ -85,6 +86,7 @@ module NewRelic
             def exception_object(payload)
               exception_class, message = payload[:exception]
               return nil unless exception_class
+
               NewRelic::Agent::NoticeableError.new(exception_class, message)
             end
           else

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

@@ -23,6 +23,7 @@ module NewRelic
 
         def check_for_late_instrumentation(app)
           return if defined?(@checked_for_late_instrumentation) && @checked_for_late_instrumentation
+
           @checked_for_late_instrumentation = true
           if middleware_instrumentation_enabled?
             if ::NewRelic::Agent::Instrumentation::MiddlewareProxy.needs_wrapping?(app)
@@ -49,12 +50,14 @@ module NewRelic
 
         def run_with_tracing(app)
           return yield(app) unless middleware_instrumentation_enabled?
+
           yield(::NewRelic::Agent::Instrumentation::MiddlewareProxy.wrap(app, true))
         end
 
         def use_with_tracing(middleware_class)
           return if middleware_class.nil?
           return yield(middleware_class) unless middleware_instrumentation_enabled?
+
           yield(::NewRelic::Agent::Instrumentation::MiddlewareProxy.for_class(middleware_class))
         end
       end

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

@@ -37,6 +37,7 @@ module NewRelic
 
         def safe_from_third_party_gem?
           return true unless NewRelic::LanguageSupport.bundled_gem?("newrelic-rake")
+
           ::NewRelic::Agent.logger.info("Not installing New Relic supported Rake instrumentation because the third party newrelic-rake gem is present")
           false
         end

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

@@ -103,6 +103,7 @@ DependencyDetection.defer do
 
   executes do
     next unless Gem::Version.new(Sidekiq::VERSION) < Gem::Version.new('5.0.0')
+
     deprecation_msg = 'Instrumentation for Sidekiq versions below 5.0.0 is deprecated.' \
       'They will stop being monitored in version 9.0.0. ' \
       'Please upgrade your Sidekiq version to continue receiving full support. '

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

@@ -45,6 +45,7 @@ DependencyDetection.defer do
 
   executes do
     next unless Gem::Version.new(Sinatra::VERSION) < Gem::Version.new('2.0.0')
+
     deprecation_msg = 'The Ruby Agent is dropping support for Sinatra versions below 2.0.0 ' \
       'in version 9.0.0. Please upgrade your Sinatra version to continue receiving full compatibility. ' \
 

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

@@ -15,6 +15,7 @@ module NewRelic
 
         def add_thread_tracing(*args, &block)
           return block if skip_tracing?
+
           NewRelic::Agent::Tracer.thread_block_with_current_transaction(*args, &block)
         end
 

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

@@ -14,6 +14,7 @@ module NewRelic
         # So here we are only grabbing the file name and name of directory it is in
         def create_filename_for_metric(file)
           return file unless defined?(::Sinatra) && defined?(::Sinatra::Base)
+
           file.split('/')[-2..-1].join('/')
         rescue NoMethodError
           file

data/lib/new_relic/agent/javascript_instrumentor.rb

@@ -118,6 +118,7 @@ module NewRelic
 
       def create_nonce(nonce = nil)
         return '' unless nonce
+
         " nonce=\"#{nonce.to_s}\""
       end
 

data/lib/new_relic/agent/local_log_decorator.rb

@@ -29,6 +29,7 @@ module NewRelic
 
       def escape_entity_name(entity_name)
         return unless entity_name
+
         URI::DEFAULT_PARSER.escape(entity_name)
       end
     end

data/lib/new_relic/agent/log_event_aggregator.rb

@@ -227,6 +227,7 @@ module NewRelic
 
       def truncate_message(message)
         return message if message.bytesize <= MAX_BYTES
+
         message.byteslice(0...MAX_BYTES)
       end
     end

data/lib/new_relic/agent/messaging.rb

@@ -121,6 +121,7 @@ module NewRelic
 
         state = Tracer.state
         return yield if state.current_transaction
+
         txn = nil
 
         begin

data/lib/new_relic/agent/method_tracer.rb

@@ -86,6 +86,7 @@ module NewRelic
       def trace_execution_unscoped(metric_names, options = NewRelic::EMPTY_HASH) # THREAD_LOCAL_ACCESS
         NewRelic::Agent.record_api_supportability_metric(:trace_execution_unscoped) unless options[:internal]
         return yield unless NewRelic::Agent.tl_is_execution_traced?
+
         t0 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
         begin
           yield
@@ -251,6 +252,7 @@ module NewRelic
         # may get removed as well.
         def remove_method_tracer(method_name) # :nodoc:
           return unless Agent.config[:agent_enabled]
+
           if _nr_traced_method_module.method_defined?(method_name)
             _nr_traced_method_module.send(:remove_method, method_name)
             ::NewRelic::Agent.logger.debug("removed method tracer #{method_name}\n")
@@ -264,6 +266,7 @@ module NewRelic
         def _nr_add_method_tracer_now(method_name, metric_name, options)
           NewRelic::Agent.record_api_supportability_metric(:add_method_tracer)
           return unless newrelic_method_exists?(method_name)
+
           remove_method_tracer(method_name) if method_traced?(method_name)
 
           options = _nr_validate_method_tracer_options(method_name, options)
@@ -304,6 +307,7 @@ module NewRelic
           _nr_traced_method_module.module_eval do
             define_method(method_name) do |*args, &block|
               return super(*args, &block) unless NewRelic::Agent.tl_is_execution_traced?
+
               scoped_metric_eval, unscoped_metrics_eval = nil, []
 
               scoped_metric_eval = case scoped_metric

data/lib/new_relic/agent/monitors/distributed_tracing_monitor.rb

@@ -8,6 +8,7 @@ module NewRelic
       class Monitor < InboundRequestMonitor
         def on_finished_configuring(events)
           return unless NewRelic::Agent.config[:'distributed_tracing.enabled']
+
           events.subscribe(:before_call, &method(:on_before_call))
         end
 

data/lib/new_relic/agent/new_relic_service.rb

@@ -524,6 +524,7 @@ module NewRelic
         uri = String.new('/agent_listener/invoke_raw_method?')
         uri << params.map do |k, v|
           next unless v
+
           "#{k}=#{v}"
         end.compact.join('&')
         uri
@@ -592,6 +593,7 @@ module NewRelic
       # than the limit configured in the control object
       def check_post_size(post_string, endpoint)
         return if post_string.size < Agent.config[:max_payload_size_in_bytes]
+
         ::NewRelic::Agent.logger.debug("Tried to send too much data: #{post_string.size} bytes")
         NewRelic::Agent.increment_metric("Supportability/Agent/Collector/#{endpoint}/MaxPayloadSizeLimit")
         raise UnrecoverableServerException.new('413 Request Entity Too Large')

data/lib/new_relic/agent/pipe_channel_manager.rb

@@ -160,6 +160,7 @@ module NewRelic
 
         def start
           return if @started == true
+
           @started = true
           @thread = NewRelic::Agent::Threading::AgentThread.create('Pipe Channel Manager') do
             now = nil
@@ -207,6 +208,7 @@ module NewRelic
 
         def stop
           return unless @started == true
+
           stop_listener_thread
           close_all_pipes
           @wake.close

data/lib/new_relic/agent/rules_engine.rb

@@ -72,6 +72,7 @@ module NewRelic
       def rename(original_string)
         renamed = apply_rules(@rules, original_string)
         return nil unless renamed
+
         renamed = apply_rules(@segment_term_rules, renamed)
         renamed
       end

data/lib/new_relic/agent/samplers/cpu_sampler.rb

@@ -44,6 +44,7 @@ module NewRelic
           if defined?(JRuby)
             return JRUBY_VERSION >= '1.7.0'
           end
+
           true
         end
 

data/lib/new_relic/agent/samplers/memory_sampler.rb

@@ -75,12 +75,14 @@ module NewRelic
 
           def can_run?
             return false if @broken
+
             m = get_memory rescue nil
             m && m > 0
           end
 
           def get_sample
             return nil if @broken
+
             begin
               m = get_memory
               if m.nil?
@@ -99,6 +101,7 @@ module NewRelic
         class JavaHeapSampler < Base
           def get_memory
             raise "Can't sample Java heap unless running in JRuby" unless defined? JRuby
+
             java.lang.Runtime.getRuntime.totalMemory / (1024 * 1024).to_f rescue nil
           end
 
@@ -121,6 +124,7 @@ module NewRelic
             # if for some reason the ps command doesn't work on the resident os,
             # then don't execute it any more.
             raise "Faulty command: `#{@command} #{process}`" if memory.nil? || memory <= 0
+
             memory
           end
 
@@ -140,6 +144,7 @@ module NewRelic
             if proc_status =~ /RSS:\s*(\d+) kB/i
               return $1.to_f / 1024.0
             end
+
             raise "Unable to find RSS in #{proc_status_file}"
           end
 

data/lib/new_relic/agent/span_event_primitive.rb

@@ -52,6 +52,7 @@ module NewRelic
       # an error is present.  Otherwise, returns nil when no error present.
       def error_attributes(segment)
         return if Agent.config[:high_security] || !segment.noticed_error
+
         segment.noticed_error.build_error_attributes
         segment.noticed_error_attributes
       end

data/lib/new_relic/agent/stats.rb

@@ -159,6 +159,7 @@ module NewRelic
       def marshal_dump
         instance_variables.each_with_object({}) do |name, instance_copy|
           next if SKIP_MARSHALLING.include?(name)
+
           instance_copy[name] = instance_variable_get(name)
         end
       end

data/lib/new_relic/agent/stats_engine/gc_profiler.rb

@@ -11,6 +11,7 @@ module NewRelic
         def self.init
           @initialized ||= nil
           return @profiler if @initialized
+
           @profiler = if RailsBenchProfiler.enabled?
             RailsBenchProfiler.new
           elsif CoreGCProfiler.enabled?

data/lib/new_relic/agent/system_info.rb

@@ -224,6 +224,7 @@ module NewRelic
         cgroup_info.split("\n").each do |line|
           parts = line.split(':')
           next unless parts.size == 3
+
           _, subsystems, cgroup_id = parts
           subsystems = subsystems.split(',')
           subsystems.each do |subsystem|
@@ -240,6 +241,7 @@ module NewRelic
       # for details on why we do it this way.
       def self.proc_try_read(path)
         return nil unless File.exist?(path)
+
         content = String.new('')
         File.open(path) do |f|
           loop do
@@ -281,6 +283,7 @@ module NewRelic
 
       def self.boot_id
         return nil unless linux?
+
         if bid = proc_try_read('/proc/sys/kernel/random/boot_id')
           bid.chomp!
 

data/lib/new_relic/agent/threading/agent_thread.rb

@@ -60,6 +60,7 @@ module NewRelic
             ::NewRelic::Agent.logger.debug("Failed to backtrace #{thread.inspect}: #{e.class.name}: #{e.to_s}")
           end
           return nil unless bt
+
           bt.reject! { |t| t.include?('/newrelic_rpm-') } unless profile_agent_code
           bt
         end