newrelic_rpm 8.11.0 → 8.13.0

data/lib/new_relic/agent/configuration/dotted_hash.rb

@@ -36,6 +36,7 @@ module NewRelic
         def dot_flattened(nested_hash, names = [], result = {})
           nested_hash.each do |key, val|
             next if val.nil?
+
             if val.respond_to?(:has_key?)
               dot_flattened(val, names + [key], result)
             else

data/lib/new_relic/agent/configuration/environment_source.rb

@@ -34,6 +34,7 @@ module NewRelic
           set_dotted_alias(config_setting)
 
           return unless value[:aliases]
+
           value[:aliases].each do |config_alias|
             self.alias_map[config_alias] = config_setting
           end
@@ -50,8 +51,8 @@ module NewRelic
 
         def set_log_file
           if ENV['NEW_RELIC_LOG']
-            if ENV['NEW_RELIC_LOG'].casecmp('STDOUT').zero?
-              self[:log_file_path] = self[:log_file_name] = 'STDOUT'
+            if ENV['NEW_RELIC_LOG'].casecmp(NewRelic::STANDARD_OUT) == 0
+              self[:log_file_path] = self[:log_file_name] = NewRelic::STANDARD_OUT
             else
               self[:log_file_path] = File.dirname(ENV['NEW_RELIC_LOG'])
               self[:log_file_name] = File.basename(ENV['NEW_RELIC_LOG'])

data/lib/new_relic/agent/configuration/high_security_source.rb

@@ -18,6 +18,7 @@ module NewRelic
             :'transaction_tracer.record_sql' => record_sql_setting(local_settings, :'transaction_tracer.record_sql'),
             :'slow_sql.record_sql' => record_sql_setting(local_settings, :'slow_sql.record_sql'),
             :'mongo.obfuscate_queries' => true,
+            :'elasticsearch.obfuscate_queries' => true,
             :'transaction_tracer.record_redis_arguments' => false,
 
             :'custom_insights_events.enabled' => false,

data/lib/new_relic/agent/configuration/manager.rb

@@ -36,6 +36,7 @@ module NewRelic
 
         def add_config_for_testing(source, level = 0)
           raise 'Invalid config type for testing' unless [Hash, DottedHash].include?(source.class)
+
           invoke_callbacks(:add, source)
           @configs_for_testing << [source.freeze, level]
           reset_cache
@@ -110,6 +111,7 @@ module NewRelic
         def fetch(key)
           config_stack.each do |config|
             next unless config
+
             accessor = key.to_sym
 
             if config.has_key?(accessor)
@@ -160,6 +162,7 @@ module NewRelic
 
         def invoke_callbacks(direction, source)
           return unless source
+
           source.keys.each do |key|
             begin
               # we need to evaluate and apply transformations for the value to deal with procs as values

data/lib/new_relic/agent/configuration/security_policy_source.rb

@@ -79,6 +79,15 @@ module NewRelic
                 change_setting(policies, :'mongo.obfuscate_queries', true)
               }
             },
+            {
+              option: :'elasticsearch.capture_queries',
+              supported: true,
+              enabled_fn: method(:enabled?),
+              disabled_value: false,
+              permitted_fn: proc { |policies|
+                change_setting(policies, :'elasticsearch.obfuscate_queries', true)
+              }
+            },
             {
               option: :'transaction_tracer.record_redis_arguments',
               supported: true,
@@ -212,6 +221,7 @@ module NewRelic
           security_policies.inject({}) do |settings, (policy_name, policy_settings)|
             SECURITY_SETTINGS_MAP[policy_name].each do |policy|
               next unless policy[:supported]
+
               if policy_settings[ENABLED]
                 if policy[:enabled_fn].call(policy[:option])
                   if permitted_fn = policy[:permitted_fn]

data/lib/new_relic/agent/configuration/yaml_source.rb

@@ -156,6 +156,7 @@ module NewRelic
         def dot_flattened(nested_hash, names = [], result = {})
           nested_hash.each do |key, val|
             next if val.nil?
+
             if val.respond_to?(:has_key?) && !CONFIG_WITH_HASH_VALUE.include?(key)
               dot_flattened(val, names + [key], result)
             else

data/lib/new_relic/agent/connect/request_builder.rb

@@ -42,6 +42,7 @@ module NewRelic
         # clear out so downstream code doesn't have to check again.
         def sanitize_environment_report(environment_report)
           return NewRelic::EMPTY_ARRAY unless @service.valid_to_marshal?(environment_report)
+
           environment_report
         end
 

data/lib/new_relic/agent/database/obfuscation_helpers.rb

@@ -53,6 +53,7 @@ module NewRelic
 
         def obfuscate_single_quote_literals(sql)
           return sql unless sql =~ COMPONENTS_REGEX_MAP[:single_quotes]
+
           sql.gsub(COMPONENTS_REGEX_MAP[:single_quotes], PLACEHOLDER)
         end
 

data/lib/new_relic/agent/database.rb

@@ -32,6 +32,8 @@ module NewRelic
       # Take care not to the dup the query more than once as
       # correctly encoded may also dup the query.
       def capture_query(query)
+        return unless query
+
         id = query.object_id
         query = Helper.correctly_encoded(truncate_query(query))
         if query.object_id == id
@@ -42,6 +44,8 @@ module NewRelic
       end
 
       def truncate_query(query)
+        return unless query
+
         if query.length > (MAX_QUERY_LENGTH - 4)
           query[0..MAX_QUERY_LENGTH - 4] << ELLIPSIS
         else
@@ -114,6 +118,7 @@ module NewRelic
       # in a report period, selected for shipment to New Relic
       def explain_sql(statement)
         return nil unless statement.sql && statement.explainer && statement.config
+
         statement.sql = statement.sql.split(";\n")[0] # only explain the first
         return statement.explain || []
       end
@@ -223,6 +228,7 @@ module NewRelic
 
         def explain
           return unless explainable?
+
           handle_exception_in_explain do
             start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
             plan = @explainer.call(self)
@@ -238,6 +244,7 @@ module NewRelic
 
         def append_sql(new_sql)
           return if new_sql.empty?
+
           @sql = Database.truncate_query(@sql << NEWLINE << new_sql)
         end
 

data/lib/new_relic/agent/database_adapter.rb

@@ -13,6 +13,7 @@ module NewRelic
 
       def self.value
         return unless defined? ActiveRecord::Base
+
         new(::NewRelic::Control.instance.env, ActiveRecord::VERSION::STRING).value
       end
 
@@ -26,6 +27,7 @@ module NewRelic
       def value
         match = VERSIONS.keys.find { |key| version >= Gem::Version.new(key) }
         return unless match
+
         VERSIONS[match].call(env)
       end
     end

data/lib/new_relic/agent/datastores/mongo/event_formatter.rb

@@ -2,7 +2,7 @@
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
 
-require 'new_relic/agent/datastores/mongo/obfuscator'
+require_relative '../nosql_obfuscator'
 
 module NewRelic
   module Agent
@@ -26,6 +26,7 @@ module NewRelic
 
             command.each do |key, value|
               next if DENYLISTED_KEYS.include?(key)
+
               if OBFUSCATE_KEYS.include?(key)
                 obfuscated = obfuscate(value)
                 result[key] = obfuscated if obfuscated
@@ -38,7 +39,7 @@ module NewRelic
 
           def self.obfuscate(statement)
             if NewRelic::Agent.config[:'mongo.obfuscate_queries']
-              statement = Obfuscator.obfuscate_statement(statement)
+              statement = NewRelic::Agent::Datastores::NosqlObfuscator.obfuscate_statement(statement)
             end
             statement
           end

data/lib/new_relic/agent/datastores/mongo/metric_translator.rb

@@ -2,7 +2,7 @@
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
 
-require 'new_relic/agent/datastores/mongo/obfuscator'
+require 'new_relic/agent/datastores/nosql_obfuscator'
 require 'new_relic/agent/datastores/metric_helper'
 
 module NewRelic

data/lib/new_relic/agent/datastores/nosql_obfuscator.rb

@@ -0,0 +1,41 @@
+# 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
+  module Agent
+    module Datastores
+      module NosqlObfuscator
+        ALLOWLIST = [:operation].freeze
+
+        def self.obfuscate_statement(source, allowlist = ALLOWLIST)
+          if source.is_a?(Hash)
+            obfuscated = {}
+            source.each do |key, value|
+              if allowlist.include?(key)
+                obfuscated[key] = value
+              else
+                obfuscated[key] = obfuscate_value(value, allowlist)
+              end
+            end
+            obfuscated
+          else
+            obfuscate_value(source, allowlist)
+          end
+        end
+
+        QUESTION_MARK = '?'.freeze
+
+        def self.obfuscate_value(value, allowlist = ALLOWLIST)
+          if value.is_a?(Hash)
+            obfuscate_statement(value, allowlist)
+          elsif value.is_a?(Array)
+            value.map { |v| obfuscate_value(v, allowlist) }
+          else
+            QUESTION_MARK
+          end
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/distributed_tracing/cross_app_tracing.rb

@@ -64,6 +64,7 @@ module NewRelic
 
       def add_message_cat_headers(headers)
         return unless CrossAppTracing.cross_app_enabled?
+
         @is_cross_app_caller = true
         insert_message_headers(headers,
           transaction.guid,
@@ -112,9 +113,11 @@ module NewRelic
         end
 
         return unless transaction.include_guid?
+
         payload[:guid] = transaction.guid
 
         return unless is_cross_app?
+
         trip_id = cat_trip_id
         path_hash = cat_path_hash
         referring_path_hash = cat_referring_path_hash

data/lib/new_relic/agent/distributed_tracing/distributed_trace_attributes.rb

@@ -25,6 +25,7 @@ module NewRelic
       # inserts them into the specified destination.
       def copy_to_hash(transaction_payload, destination)
         return unless enabled?
+
         INTRINSIC_KEYS.each do |key|
           value = transaction_payload[key]
           destination[key] = value unless value.nil?
@@ -35,8 +36,10 @@ module NewRelic
       # inserts them as intrinsics in the specified transaction_attributes
       def copy_to_attributes(transaction_payload, destination)
         return unless enabled?
+
         INTRINSIC_KEYS.each do |key|
           next unless transaction_payload.key?(key)
+
           destination.add_intrinsic_attribute(key, transaction_payload[key])
         end
       end

data/lib/new_relic/agent/distributed_tracing/distributed_trace_metrics.rb

@@ -23,6 +23,7 @@ module NewRelic
 
       def record_metrics_for_transaction(transaction)
         return unless Agent.config[:'distributed_tracing.enabled']
+
         dt = transaction.distributed_tracer
         payload = dt.distributed_trace_payload || dt.trace_state_payload
 

data/lib/new_relic/agent/distributed_tracing/distributed_trace_payload.rb

@@ -58,6 +58,7 @@ module NewRelic
         def from_json(serialized_payload)
           raw_payload = JSON.parse(serialized_payload)
           return raw_payload if raw_payload.nil?
+
           payload_data = raw_payload[DATA_KEY]
 
           payload = new

data/lib/new_relic/agent/distributed_tracing/trace_context.rb

@@ -96,6 +96,7 @@ module NewRelic
           def extract_traceparent(format, carrier)
             header_name = trace_parent_header_for_format(format)
             return unless header = carrier[header_name]
+
             if matchdata = header.match(TRACE_PARENT_REGEX)
               TRACE_PARENT_REGEX.named_captures.inject({}) do |hash, (name, (index))|
                 hash[name] = matchdata[index]

data/lib/new_relic/agent/encoding_normalizer.rb

@@ -19,9 +19,11 @@ module NewRelic
           normalize_string(object.to_s)
         when Array
           return object if object.empty?
+
           object.map { |x| normalize_object(x) }
         when Hash
           return object if object.empty?
+
           hash = {}
           object.each_pair do |k, v|
             k = normalize_string(k) if k.is_a?(String)

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/http_rb_wrappers.rb

@@ -9,7 +9,7 @@ module NewRelic
     module HTTPClients
       class HTTPResponse < AbstractResponse
         def [](key)
-          _, value = @wrapped_response.headers.find { |k, _| key.casecmp(k).zero? }
+          _, value = @wrapped_response.headers.find { |k, _| key.casecmp(k) == 0 }
           value unless value.nil?
         end
 

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

@@ -10,7 +10,7 @@ module NewRelic
       class HTTPClientResponse < AbstractResponse
         def [](key)
           @wrapped_response.headers.each do |k, v|
-            if key.casecmp(k).zero?
+            if key.casecmp(k) == 0
               return v
             end
           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. ' \
 
@@ -46,7 +47,5 @@ DependencyDetection.defer do
       :deprecated_active_merchant_version,
       deprecation_msg
     )
-
-    ::NewRelic::Agent.record_metric("Supportability/Deprecated/ActiveMerchant", 1)
   end
 end

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
@@ -52,8 +53,6 @@ DependencyDetection.defer do
       :deprecated_acts_as_solr,
       deprecation_msg
     )
-
-    ::NewRelic::Agent.record_metric("Supportability/Deprecated/ActsAsSolr", 1)
   end
 
   executes do

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

@@ -21,8 +21,6 @@ DependencyDetection.defer do
       :deprecated_authlogic,
       deprecation_msg
     )
-
-    ::NewRelic::Agent.record_metric("Supportability/Deprecated/Authlogic", 1)
   end
 
   executes do

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/data_mapper.rb

@@ -26,7 +26,6 @@ DependencyDetection.defer do
       :deprecated_datamapper,
       deprecation_msg
     )
-    ::NewRelic::Agent.record_metric("Supportability/Deprecated/DataMapper", 1)
   end
 
   executes do

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. ' \
@@ -105,8 +106,6 @@ DependencyDetection.defer do
       :deprecated_delayed_job_version,
       deprecation_msg
     )
-
-    ::NewRelic::Agent.record_metric("Supportability/Deprecated/DelayedJob", 1)
   end
 
   def delayed_job_version

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