newrelic_rpm 8.15.0 → 9.6.0

data/lib/new_relic/agent/log_event_attributes.rb

@@ -0,0 +1,115 @@
+# 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
+    class LogEventAttributes
+      MAX_ATTRIBUTE_COUNT = 240 # limit is 255, assume we send 15
+      ATTRIBUTE_KEY_CHARACTER_LIMIT = 255
+      ATTRIBUTE_VALUE_CHARACTER_LIMIT = 4094
+
+      def add_custom_attributes(attributes)
+        return if defined?(@custom_attribute_limit_reached) && @custom_attribute_limit_reached
+
+        attributes.each do |key, value|
+          next if absent?(key) || absent?(value)
+
+          add_custom_attribute(key, value)
+        end
+      end
+
+      def custom_attributes
+        @custom_attributes ||= {}
+      end
+
+      private
+
+      class TruncationError < StandardError
+        attr_reader :attribute, :limit
+
+        def initialize(attribute, limit, msg = "Can't truncate")
+          @attribute = attribute
+          @limit = limit
+          super(msg)
+        end
+      end
+
+      class InvalidTypeError < StandardError
+        attr_reader :attribute
+
+        def initialize(attribute, msg = 'Invalid attribute type')
+          @attribute = attribute
+          super(msg)
+        end
+      end
+
+      def absent?(value)
+        value.nil? || (value.respond_to?(:empty?) && value.empty?)
+      end
+
+      def add_custom_attribute(key, value)
+        if custom_attributes.size >= MAX_ATTRIBUTE_COUNT
+          NewRelic::Agent.logger.warn(
+            'Too many custom log attributes defined. ' \
+            "Only taking the first #{MAX_ATTRIBUTE_COUNT}."
+          )
+          @custom_attribute_limit_reached = true
+          return
+        end
+
+        @custom_attributes.merge!(truncate_attributes(key_to_string(key), value))
+      end
+
+      def key_to_string(key)
+        key.is_a?(String) ? key : key.to_s
+      end
+
+      def truncate_attribute(attribute, limit)
+        case attribute
+        when Integer
+          if attribute.digits.length > limit
+            raise TruncationError.new(attribute, limit)
+          end
+        when Float
+          if attribute.to_s.length > limit
+            raise TruncationError.new(attribute, limit)
+          end
+        when String, Symbol
+          if attribute.length > limit
+            attribute = attribute.slice(0..(limit - 1))
+          end
+        when TrueClass, FalseClass
+          attribute
+        else
+          raise InvalidTypeError.new(attribute)
+        end
+
+        attribute
+      end
+
+      def truncate_attributes(key, value)
+        key = truncate_attribute(key, ATTRIBUTE_KEY_CHARACTER_LIMIT)
+        value = truncate_attribute(value, ATTRIBUTE_VALUE_CHARACTER_LIMIT)
+
+        {key => value}
+      rescue TruncationError => e
+        NewRelic::Agent.logger.warn(
+          "Dropping custom log attribute #{key} => #{value} \n" \
+          "Length exceeds character limit of #{e.limit}. " \
+          "Can't truncate: #{e.attribute}"
+        )
+
+        {}
+      rescue InvalidTypeError => e
+        NewRelic::Agent.logger.warn(
+          "Dropping custom log attribute #{key} => #{value} \n" \
+          "Invalid type of #{e.attribute.class} given. " \
+          "Can't send #{e.attribute}."
+        )
+
+        {}
+      end
+    end
+  end
+end

data/lib/new_relic/agent/logging.rb

@@ -22,16 +22,21 @@ module NewRelic
       #
       # @api public
       class DecoratingFormatter < ::Logger::Formatter
-        TIMESTAMP_KEY = 'timestamp'.freeze
-        MESSAGE_KEY = 'message'.freeze
-        LOG_LEVEL_KEY = 'log.level'.freeze
-        LOG_NAME_KEY = 'logger.name'.freeze
-        NEWLINE = "\n".freeze
-
-        QUOTE = '"'.freeze
-        COLON = ':'.freeze
-        COMMA = ','.freeze
-        CLOSING_BRACE = '}'.freeze
+        MESSAGE_ELEMENT = 'message'
+        LOG_LEVEL_ELEMENT = 'log_level'
+        PROG_NAME_ELEMENT = 'prog_name'
+        ELEMENTS = ['app_name', 'entity_type', 'hostname', 'entity_guid', 'trace_id', 'span_id', MESSAGE_ELEMENT,
+          LOG_LEVEL_ELEMENT, PROG_NAME_ELEMENT].freeze
+        TIMESTAMP_KEY = 'timestamp'
+        MESSAGE_KEY = 'message'
+        LOG_LEVEL_KEY = 'log.level'
+        LOG_NAME_KEY = 'logger.name'
+        NEWLINE = "\n"
+
+        QUOTE = '"'
+        COLON = ':'
+        COMMA = ','
+        CLOSING_BRACE = '}'
         REPLACEMENT_CHAR = '�'
 
         def initialize
@@ -41,41 +46,80 @@ module NewRelic
         end
 
         def call(severity, time, progname, msg)
-          message = String.new('{')
-          if app_name
-            add_key_value(message, ENTITY_NAME_KEY, app_name)
-            message << COMMA
+          message = +'{'
+          ELEMENTS.each do |element|
+            args = case element
+                   when MESSAGE_ELEMENT then [message, msg]
+                   when LOG_LEVEL_ELEMENT then [message, severity]
+                   when PROG_NAME_ELEMENT then [message, progname]
+                   else [message]
+            end
+
+            send("add_#{element}", *args)
           end
+          message << COMMA
+          message << QUOTE << TIMESTAMP_KEY << QUOTE << COLON << (time.to_f * 1000).round.to_s
+          message << CLOSING_BRACE << NEWLINE
+        end
+
+        def clear_tags!
+          # No-op; just avoiding issues with act-fluent-logger-rails
+        end
+
+        private
+
+        def add_app_name(message)
+          return unless app_name
+
+          add_key_value(message, ENTITY_NAME_KEY, app_name)
+          message << COMMA
+        end
+
+        def add_entity_type(message)
           add_key_value(message, ENTITY_TYPE_KEY, ENTITY_TYPE)
           message << COMMA
+        end
+
+        def add_hostname(message)
           add_key_value(message, HOSTNAME_KEY, Hostname.get)
+        end
 
-          if entity_guid = Agent.config[:entity_guid]
-            message << COMMA
-            add_key_value(message, ENTITY_GUID_KEY, entity_guid)
-          end
+        def add_entity_guid(message)
+          return unless entity_guid = Agent.config[:entity_guid]
 
-          if trace_id = Tracer.trace_id
-            message << COMMA
-            add_key_value(message, TRACE_ID_KEY, trace_id)
-          end
-          if span_id = Tracer.span_id
-            message << COMMA
-            add_key_value(message, SPAN_ID_KEY, span_id)
-          end
+          message << COMMA
+          add_key_value(message, ENTITY_GUID_KEY, entity_guid)
+        end
+
+        def add_trace_id(message)
+          return unless trace_id = Tracer.trace_id
 
+          message << COMMA
+          add_key_value(message, TRACE_ID_KEY, trace_id)
+        end
+
+        def add_span_id(message)
+          return unless span_id = Tracer.span_id
+
+          message << COMMA
+          add_key_value(message, SPAN_ID_KEY, span_id)
+        end
+
+        def add_message(message, msg)
           message << COMMA
           message << QUOTE << MESSAGE_KEY << QUOTE << COLON << escape(msg)
           message << COMMA
+        end
+
+        def add_log_level(message, severity)
           add_key_value(message, LOG_LEVEL_KEY, severity)
-          if progname
-            message << COMMA
-            add_key_value(message, LOG_NAME_KEY, progname)
-          end
+        end
+
+        def add_prog_name(message, progname)
+          return unless progname
 
           message << COMMA
-          message << QUOTE << TIMESTAMP_KEY << QUOTE << COLON << (time.to_f * 1000).round.to_s
-          message << CLOSING_BRACE << NEWLINE
+          add_key_value(message, LOG_NAME_KEY, progname)
         end
 
         def app_name
@@ -98,10 +142,6 @@ module NewRelic
           end
           message.to_json
         end
-
-        def clear_tags!
-          # No-op; just avoiding issues with act-fluent-logger-rails
-        end
       end
 
       # This logger decorates logs with trace and entity metadata, and emits log
@@ -125,7 +165,7 @@ module NewRelic
         # Positional and Keyword arguments are separated beginning with Ruby 2.7
         # Signature of ::Logger constructor changes in Ruby 2.4 to have both positional and keyword args
         # We pivot on Ruby 2.7 for widest supportability with least amount of hassle.
-        if RUBY_VERSION < "2.7.0"
+        if RUBY_VERSION < '2.7.0'
           def initialize(*args)
             super(*args)
             self.formatter = DecoratingFormatter.new

data/lib/new_relic/agent/messaging.rb

@@ -14,7 +14,7 @@ module NewRelic
     module Messaging
       extend self
 
-      RABBITMQ_TRANSPORT_TYPE = "RabbitMQ"
+      RABBITMQ_TRANSPORT_TYPE = 'RabbitMQ'
 
       ATTR_DESTINATION = AttributeFilter::DST_TRANSACTION_EVENTS |
         AttributeFilter::DST_TRANSACTION_TRACER |
@@ -142,15 +142,16 @@ module NewRelic
           txn.add_agent_attribute(:'message.queueName', queue_name, ATTR_DESTINATION) if queue_name
           txn.add_agent_attribute(:'message.replyTo', reply_to, AttributeFilter::DST_NONE) if reply_to
         rescue => e
-          NewRelic::Agent.logger.error("Error starting Message Broker consume transaction", e)
+          NewRelic::Agent.logger.error('Error starting Message Broker consume transaction', e)
         end
 
         yield
       ensure
         begin
-          txn.finish if txn
+          # the following line needs else branch coverage
+          txn.finish if txn # rubocop:disable Style/SafeNavigation
         rescue => e
-          NewRelic::Agent.logger.error("Error stopping Message Broker consume transaction", e)
+          NewRelic::Agent.logger.error('Error stopping Message Broker consume transaction', e)
         end
       end
 
@@ -190,7 +191,8 @@ module NewRelic
 
         raise ArgumentError, 'missing required argument: headers' if headers.nil? && CrossAppTracing.cross_app_enabled?
 
-        original_headers = headers.nil? ? nil : headers.dup
+        # The following line needs else branch coverage
+        original_headers = headers.nil? ? nil : headers.dup # rubocop:disable Style/SafeNavigation
 
         segment = Tracer.start_message_broker_segment(
           action: :produce,
@@ -327,9 +329,9 @@ module NewRelic
 
       def transaction_name(library, destination_type, destination_name)
         transaction_name = Transaction::MESSAGE_PREFIX + library
-        transaction_name << Transaction::MessageBrokerSegment::SLASH
+        transaction_name << NewRelic::SLASH
         transaction_name << Transaction::MessageBrokerSegment::TYPES[destination_type]
-        transaction_name << Transaction::MessageBrokerSegment::SLASH
+        transaction_name << NewRelic::SLASH
 
         case destination_type
         when :queue

data/lib/new_relic/agent/method_tracer.rb

@@ -103,7 +103,7 @@ module NewRelic
         module AddMethodTracer
           ALLOWED_KEYS = [:metric, :push_scope, :code_header, :code_information, :code_footer].freeze
 
-          DEFAULT_SETTINGS = {:push_scope => true, :metric => true, :code_header => "", :code_footer => ""}.freeze
+          DEFAULT_SETTINGS = {:push_scope => true, :metric => true, :code_header => '', :code_footer => ''}.freeze
 
           # Checks the provided options to make sure that they make
           # sense. Raises an error if the options are incorrect to
@@ -134,7 +134,7 @@ module NewRelic
           #  Foo._nr_default_metric_name_code('bar') #=> "Custom/#{Foo.name}/bar"
           def _nr_default_metric_name(method_name)
             class_name = _nr_derived_class_name
-            -> (*) { "Custom/#{class_name}/#{method_name}" }
+            ->(*) { "Custom/#{class_name}/#{method_name}" }
           end
 
           # Checks to see if the method we are attempting to trace
@@ -170,14 +170,14 @@ module NewRelic
 
           def _nr_derived_class_name
             return self.name if self.name && !self.name.empty?
-            return "AnonymousModule" if self.to_s.start_with?("#<Module:")
+            return 'AnonymousModule' if self.to_s.start_with?('#<Module:')
 
             # trying to get the "MyClass" portion of "#<Class:MyClass>"
             name = self.to_s[/^#<Class:(.+)>$/, 1]
-            if name.start_with?("0x")
-              "AnonymousClass"
-            elsif name.start_with?("#<Class:")
-              "AnonymousClass/Class"
+            if name.start_with?('0x')
+              'AnonymousClass'
+            elsif name.start_with?('#<Class:')
+              'AnonymousClass/Class'
             else
               "#{name}/Class"
             end

data/lib/new_relic/agent/method_tracer_helpers.rb

@@ -11,7 +11,7 @@ module NewRelic
       #   function: the name of the Ruby method
       #   namespace: the Ruby class' namespace as a string, ex: 'MyModule::MyClass'
       SOURCE_CODE_INFORMATION_PARAMETERS = %i[filepath lineno function namespace].freeze
-      SOURCE_CODE_INFORMATION_FAILURE_METRIC = "Supportability/CodeLevelMetrics/Ruby/Failure".freeze
+      SOURCE_CODE_INFORMATION_FAILURE_METRIC = 'Supportability/CodeLevelMetrics/Ruby/Failure'.freeze
       MAX_ALLOWED_METRIC_DURATION = 1_000_000_000 # roughly 31 years
 
       extend self
@@ -46,13 +46,15 @@ module NewRelic
         cache_key = "#{object.object_id}#{method_name}".freeze
         return @code_information[cache_key] if @code_information.key?(cache_key)
 
-        namespace, location, is_class_method = namespace_and_location(object, method_name.to_sym)
+        info = namespace_and_location(object, method_name.to_sym)
+        return ::NewRelic::EMPTY_HASH if info.empty?
 
+        namespace, location, is_class_method = info
         @code_information[cache_key] = {filepath: location.first,
                                         lineno: location.last,
                                         function: "#{'self.' if is_class_method}#{method_name}",
                                         namespace: namespace}.freeze
-      rescue => e
+      rescue StandardError => e
         ::NewRelic::Agent.logger.warn("Unable to determine source code info for '#{object}', " \
                                         "method '#{method_name}' - #{e.class}: #{e.message}")
         ::NewRelic::Agent.increment_metric(SOURCE_CODE_INFORMATION_FAILURE_METRIC, 1)
@@ -66,10 +68,10 @@ module NewRelic
       end
 
       # The string representation of a singleton class looks like
-      # '#<Class:MyModule::MyClass>'. Return the 'MyModule::MyClass' part of
-      # that string
+      # '#<Class:MyModule::MyClass>', or '#<Class:MyModule::MyClass(id: integer, attribute: string)>'
+      # Return the 'MyModule::MyClass' part of that string
       def klass_name(object)
-        name = Regexp.last_match(1) if object.to_s =~ /^#<Class:(.*)>$/
+        name = Regexp.last_match(1) if object.to_s =~ /^#<Class:([\w:]+).*>$/
         return name if name
 
         raise "Unable to glean a class name from string '#{object}'"
@@ -101,6 +103,9 @@ module NewRelic
         klass = object.singleton_class? ? klassify_singleton(object) : object
         name = klass.name || '(Anonymous)'
         is_class_method = false
+
+        return controller_info(klass, name, is_class_method) if controller_without_method?(klass, method_name)
+
         method = if (klass.instance_methods + klass.private_instance_methods).include?(method_name)
           klass.instance_method(method_name)
         else
@@ -109,6 +114,22 @@ module NewRelic
         end
         [name, method.source_location, is_class_method]
       end
+
+      # Rails controllers can be a special case because by default, controllers in Rails
+      # automatically render views with names that correspond to valid routes. This means
+      # that a controller method may not have a corresponding method in the controller class.
+      def controller_without_method?(klass, method_name)
+        defined?(Rails) &&
+          defined?(ApplicationController) &&
+          klass < ApplicationController &&
+          !klass.method_defined?(method_name)
+      end
+
+      def controller_info(klass, name, is_class_method)
+        path = Rails.root.join("app/controllers/#{klass.name.underscore}.rb")
+
+        File.exist?(path) ? [name, [path.to_s, 1], is_class_method] : []
+      end
     end
   end
 end

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

@@ -12,7 +12,6 @@ module NewRelic
   module Agent
     module DistributedTracing
       class CrossAppMonitor < InboundRequestMonitor
-        NEWRELIC_ID_HEADER = 'X-NewRelic-ID'.freeze
         NEWRELIC_TXN_HEADER = 'X-NewRelic-Transaction'.freeze
         NEWRELIC_APPDATA_HEADER = 'X-NewRelic-App-Data'.freeze
 
@@ -24,7 +23,7 @@ module NewRelic
           if CrossAppTracing.cross_app_enabled?
             Deprecator.deprecate('cross_application_tracer')
             ::NewRelic::Agent.logger.warn(
-              "[DEPRECATED] Cross application tracing is enabled. Distributed tracing is replacing cross application tracing as the default means of tracing between services. To continue using cross application tracing, enable it with `cross_application_tracer.enabled: true` and `distributed_tracing.enabled: false`"
+              '[DEPRECATED] Cross application tracing is enabled. Distributed tracing is replacing cross application tracing as the default means of tracing between services. To continue using cross application tracing, enable it with `cross_application_tracer.enabled: true` and `distributed_tracing.enabled: false`'
             )
           end
 
@@ -35,7 +34,7 @@ module NewRelic
           rotated = ((seed << 1) | (seed >> 31)) & 0xffffffff
           app_name = NewRelic::Agent.config[:app_name].first
           identifier = "#{app_name};#{txn_name}"
-          sprintf("%08x", rotated ^ hash_transaction_name(identifier))
+          sprintf('%08x', rotated ^ hash_transaction_name(identifier))
         end
 
         private
@@ -45,7 +44,7 @@ module NewRelic
         #   :after_call will write our response headers/metrics and clean up the thread
         def register_event_listeners(events)
           NewRelic::Agent.logger
-            .debug("Wiring up Cross Application Tracing to events after finished configuring")
+            .debug('Wiring up Cross Application Tracing to events after finished configuring')
 
           events.subscribe(:before_call) do |env| # THREAD_LOCAL_ACCESS
             if id = decoded_id(env) and should_process_request?(id)
@@ -110,7 +109,7 @@ module NewRelic
         end
 
         def hash_transaction_name(identifier)
-          Digest::MD5.digest(identifier).unpack("@12N").first & 0xffffffff
+          Digest::MD5.digest(identifier).unpack('@12N').first & 0xffffffff
         end
       end
     end

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

@@ -14,7 +14,7 @@ module NewRelic
 
         def on_before_call(request)
           unless NewRelic::Agent.config[:'distributed_tracing.enabled']
-            NewRelic::Agent.logger.warn("Not configured to accept distributed trace headers")
+            NewRelic::Agent.logger.warn('Not configured to accept distributed trace headers')
             return
           end
 

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

@@ -5,7 +5,8 @@
 module NewRelic
   module Agent
     class SyntheticsMonitor < InboundRequestMonitor
-      SYNTHETICS_HEADER_KEY = 'HTTP_X_NEWRELIC_SYNTHETICS'.freeze
+      SYNTHETICS_HEADER_KEY = 'HTTP_X_NEWRELIC_SYNTHETICS'
+      SYNTHETICS_INFO_HEADER_KEY = 'HTTP_X_NEWRELIC_SYNTHETICS_INFO'
 
       SUPPORTED_VERSION = 1
       EXPECTED_PAYLOAD_LENGTH = 5
@@ -16,6 +17,7 @@ module NewRelic
 
       def on_before_call(request) # THREAD_LOCAL_ACCESS
         encoded_header = request[SYNTHETICS_HEADER_KEY]
+        info_header = request[SYNTHETICS_INFO_HEADER_KEY]
         return unless encoded_header
 
         incoming_payload = deserialize_header(encoded_header, SYNTHETICS_HEADER_KEY)
@@ -27,7 +29,16 @@ module NewRelic
 
         txn = Tracer.current_transaction
         txn.raw_synthetics_header = encoded_header
+        txn.raw_synthetics_info_header = info_header
         txn.synthetics_payload = incoming_payload
+        txn.synthetics_info_payload = load_json(info_header, SYNTHETICS_INFO_HEADER_KEY)
+      end
+
+      def load_json(header, key)
+        ::JSON.load(header)
+      rescue => err
+        NewRelic::Agent.logger.debug("Failure loading json header '#{key}' in #{self.class}, #{err.class}, #{err.message}")
+        nil
       end
 
       class << self

data/lib/new_relic/agent/new_relic_service/encoders.rb

@@ -25,7 +25,7 @@ module NewRelic
           end
 
           module Gzip
-            BINARY = "BINARY".freeze
+            BINARY = 'BINARY'.freeze
 
             def self.encode(data, opts = nil)
               output = StringIO.new

data/lib/new_relic/agent/new_relic_service/json_marshaller.rb

@@ -14,7 +14,7 @@ module NewRelic
           warn_for_yajl
         end
 
-        OK_YAJL_VERSION = Gem::Version.new("1.2.1")
+        OK_YAJL_VERSION = Gem::Version.new('1.2.1')
 
         def warn_for_yajl
           if defined?(::Yajl)
@@ -24,7 +24,7 @@ module NewRelic
             end
           end
         rescue => err
-          ::NewRelic::Agent.logger.warn("Failed trying to watch for problematic yajl-ruby version.", err)
+          ::NewRelic::Agent.logger.warn('Failed trying to watch for problematic yajl-ruby version.', err)
         end
 
         def dump(ruby, opts = {})

data/lib/new_relic/agent/new_relic_service/security_policy_settings.rb

@@ -14,7 +14,6 @@ module NewRelic
           custom_parameters
           custom_instrumentation_editor
           message_parameters
-          job_arguments
         ].map(&:freeze)
 
         def self.preliminary_settings(security_policies)