newrelic_rpm 4.8.0.341 → 6.13.1

data/lib/new_relic/agent/log_once.rb

@@ -1,6 +1,6 @@
 # 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.
 
 module NewRelic
   module Agent

data/lib/new_relic/agent/logging.rb

@@ -0,0 +1,139 @@
+# 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.
+
+require 'json'
+require 'new_relic/agent/hostname'
+
+module NewRelic
+  module Agent
+    module Logging
+
+      # This class can be used as the formatter for an existing logger.  It
+      # decorates log messages with trace and entity metadata, and formats each
+      # log messages as a JSON object.
+      #
+      # It can be added to a Rails application like this:
+      #
+      #   require 'newrelic_rpm'
+      #
+      #   Rails.application.configure do
+      #     config.log_formatter = ::NewRelic::Agent::Logging::DecoratingFormatter.new
+      #   end
+      #
+      # @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
+
+        def initialize
+          Agent.config.register_callback :app_name do
+            @app_name = nil
+          end
+        end
+
+        def call severity, time, progname, msg
+          message = '{'
+          if app_name
+            add_key_value message, ENTITY_NAME_KEY, app_name
+            message << COMMA
+          end
+          add_key_value message, ENTITY_TYPE_KEY, ENTITY_TYPE
+          message << COMMA
+          add_key_value message, HOSTNAME_KEY, Hostname.get
+
+          if entity_guid = Agent.config[:entity_guid]
+            message << COMMA
+            add_key_value message, ENTITY_GUID_KEY, entity_guid
+          end
+
+          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
+          message << QUOTE << MESSAGE_KEY << QUOTE << COLON << escape(msg)
+          message << COMMA
+          add_key_value message, LOG_LEVEL_KEY, severity
+          if progname
+            message << COMMA
+            add_key_value message, LOG_NAME_KEY, progname
+          end
+
+          message << COMMA
+          message << QUOTE << TIMESTAMP_KEY << QUOTE << COLON << (time.to_f * 1000).round.to_s
+          message << CLOSING_BRACE << NEWLINE
+        end
+
+        def app_name
+          @app_name ||= Agent.config[:app_name][0]
+        end
+
+        def add_key_value message, key, value
+          message << QUOTE << key << QUOTE << COLON << QUOTE << value << QUOTE
+        end
+
+        def escape message
+          if String === message
+            message.to_json
+          else
+            message.inspect.to_json
+          end
+        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
+      # messages formatted as JSON objects.  It extends the Logger class from
+      # the Ruby standard library, and accepts the same constructor parameters.
+      #
+      # It aliases the `:info` message to overwrite the `:write` method, so it
+      # can be used in Rack applications that expect the logger to be a file-like
+      # object.
+      #
+      # It can be added to an application like this:
+      #
+      #   require 'newrelic_rpm'
+      #
+      #   config.logger = NewRelic::Agent::Logging::DecoratingLogger.new "log/application.log"
+      #
+      # @api public
+      class DecoratingLogger < (defined?(::ActiveSupport) && defined?(::ActiveSupport::Logger) ? ::ActiveSupport::Logger : ::Logger)
+
+        alias :write :info
+
+        # 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"
+          def initialize(*args)
+            super(*args)
+            self.formatter = DecoratingFormatter.new
+          end
+        else
+          def initialize(*args, **kwargs)
+            super(*args, **kwargs)
+            self.formatter = DecoratingFormatter.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/memory_logger.rb

@@ -1,6 +1,6 @@
 # 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.
 
 # Base class for startup logging and testing in multiverse
 

data/lib/new_relic/agent/messaging.rb

@@ -1,6 +1,8 @@
 # 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/transaction'
 
 module NewRelic
@@ -13,12 +15,12 @@ module NewRelic
     module Messaging
       extend self
 
+      RABBITMQ_TRANSPORT_TYPE = "RabbitMQ"
+
       ATTR_DESTINATION = AttributeFilter::DST_TRANSACTION_EVENTS |
                          AttributeFilter::DST_TRANSACTION_TRACER |
                          AttributeFilter::DST_ERROR_COLLECTOR
 
-      EMPTY_STRING = ''.freeze
-
       # Start a MessageBroker segment configured to trace a messaging action.
       # Finishing this segment will handle timing and recording of the proper
       # metrics for New Relic's messaging features..
@@ -58,7 +60,7 @@ module NewRelic
                                        parameters: nil,
                                        start_time: nil)
 
-        Transaction.start_message_broker_segment(
+        Tracer.start_message_broker_segment(
           action: action,
           library: library,
           destination_type: destination_type,
@@ -123,16 +125,17 @@ module NewRelic
         raise ArgumentError, 'missing required argument: destination_type' if destination_type.nil?
         raise ArgumentError, 'missing required argument: destination_name' if destination_name.nil?
 
-        state = TransactionState.tl_get
+        state = Tracer.state
         return yield if state.current_transaction
         txn = nil
 
         begin
           txn_name = transaction_name library, destination_type, destination_name
-          txn = Transaction.start state, :message, transaction_name: txn_name
+
+          txn = Tracer.start_transaction name: txn_name, category: :message
 
           if headers
-            consume_message_headers headers, txn, state
+            txn.distributed_tracer.consume_message_headers headers, state, RABBITMQ_TRANSPORT_TYPE
             CrossAppTracing.reject_messaging_cat_headers(headers).each do |k, v|
               txn.add_agent_attribute :"message.headers.#{k}", v, AttributeFilter::DST_NONE unless v.nil?
             end
@@ -150,7 +153,7 @@ module NewRelic
         yield
       ensure
         begin
-          Transaction.stop(state) if txn
+          txn.finish if txn
         rescue => e
           NewRelic::Agent.logger.error "Error stopping Message Broker consume transaction", e
         end
@@ -159,7 +162,7 @@ module NewRelic
       # Start a MessageBroker segment configured to trace an AMQP publish.
       # Finishing this segment will handle timing and recording of the proper
       # metrics for New Relic's messaging features. This method is a convenience
-      # wrapper around NewRelic::Agent::Transaction.start_message_broker_segment.
+      # wrapper around NewRelic::Agent::Tracer.start_message_broker_segment.
       #
       # @param library [String] The name of the library being instrumented
       #
@@ -197,7 +200,7 @@ module NewRelic
 
         original_headers = headers.nil? ? nil : headers.dup
 
-        segment = Transaction.start_message_broker_segment(
+        segment = Tracer.start_message_broker_segment(
           action: :produce,
           library: library,
           destination_type: :exchange,
@@ -219,7 +222,7 @@ module NewRelic
       # Start a MessageBroker segment configured to trace an AMQP consume.
       # Finishing this segment will handle timing and recording of the proper
       # metrics for New Relic's messaging features. This method is a convenience
-      # wrapper around NewRelic::Agent::Transaction.start_message_broker_segment.
+      # wrapper around NewRelic::Agent::Tracer.start_message_broker_segment.
       #
       # @param library [String] The name of the library being instrumented
       #
@@ -258,7 +261,7 @@ module NewRelic
         raise ArgumentError, 'missing required argument: delivery_info' if delivery_info.nil?
         raise ArgumentError, 'missing required argument: message_properties' if message_properties.nil?
 
-        segment = Transaction.start_message_broker_segment(
+        segment = Tracer.start_message_broker_segment(
           action: :consume,
           library: library,
           destination_name: destination_name,
@@ -364,53 +367,6 @@ module NewRelic
         transaction_name
       end
 
-      def consume_message_headers headers, transaction, state
-        if CrossAppTracing.cross_app_enabled? && CrossAppTracing.message_has_crossapp_request_header?(headers)
-          decode_id headers[CrossAppTracing::NR_MESSAGE_BROKER_ID_HEADER], state
-          decode_txn_info headers[CrossAppTracing::NR_MESSAGE_BROKER_TXN_HEADER], state
-          CrossAppTracing.assign_intrinsic_transaction_attributes state
-        end
-
-        assign_synthetics_header headers[CrossAppTracing::NR_MESSAGE_BROKER_SYNTHETICS_HEADER], transaction
-      rescue => e
-        NewRelic::Agent.logger.error "Error in consume_message_headers", e
-      end
-
-      def decode_id encoded_id, transaction_state
-        decoded_id = if encoded_id.nil?
-                       EMPTY_STRING
-                     else
-                       CrossAppTracing.obfuscator.deobfuscate(encoded_id)
-                     end
-        if CrossAppTracing.trusted_valid_cross_app_id? decoded_id
-          transaction_state.client_cross_app_id = decoded_id
-        end
-      end
-
-      def decode_txn_info txn_header, transaction_state
-        begin
-          txn_info = ::JSON.load(CrossAppTracing.obfuscator.deobfuscate(txn_header))
-          transaction_state.referring_transaction_info = txn_info
-        rescue => e
-          NewRelic::Agent.logger.debug("Failure deserializing encoded header in #{self.class}, #{e.class}, #{e.message}")
-          nil
-        end
-      end
-
-      def assign_synthetics_header synthetics_header, transaction
-        if synthetics_header and
-           incoming_payload = ::JSON.load(CrossAppTracing.obfuscator.deobfuscate(synthetics_header)) and
-           SyntheticsMonitor.is_valid_payload?(incoming_payload) and
-           SyntheticsMonitor.is_supported_version?(incoming_payload) and
-           SyntheticsMonitor.is_trusted?(incoming_payload)
-
-          transaction.raw_synthetics_header = synthetics_header
-          transaction.synthetics_payload = incoming_payload
-        end
-      rescue => e
-        NewRelic::Agent.logger.error "Error in assign_synthetics_header", e
-      end
-
     end
   end
 end

data/lib/new_relic/agent/method_tracer.rb

@@ -1,6 +1,6 @@
 # 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.
 
 # This file may be independently required to set up method tracing prior to
 # the full agent loading. In those cases, we do need at least this require to
@@ -47,6 +47,7 @@ module NewRelic
     #
 
     module MethodTracer
+
       def self.included clazz
         clazz.extend ClassMethods
       end
@@ -67,7 +68,7 @@ module NewRelic
       #
       # @api public
       #
-      def trace_execution_scoped(metric_names, options={}) #THREAD_LOCAL_ACCESS
+      def trace_execution_scoped(metric_names, options=NewRelic::EMPTY_HASH) #THREAD_LOCAL_ACCESS
         NewRelic::Agent.record_api_supportability_metric :trace_execution_scoped
         NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped(metric_names, options) do
           # Using an implicit block avoids object allocation for a &block param
@@ -83,7 +84,7 @@ module NewRelic
       #
       # @api public
       #
-      def trace_execution_unscoped(metric_names, options={}) #THREAD_LOCAL_ACCESS
+      def trace_execution_unscoped(metric_names, options=NewRelic::EMPTY_HASH) #THREAD_LOCAL_ACCESS
         NewRelic::Agent.record_api_supportability_metric :trace_execution_unscoped
         return yield unless NewRelic::Agent.tl_is_execution_traced?
         t0 = Time.now
@@ -177,15 +178,25 @@ module NewRelic
             header
           end
 
+          # Positional and Keyword arguments are separated beginning with Ruby 2.7
+          def arguments_for_ruby_version
+            if RUBY_VERSION < "2.7.0"
+              "(*args, &block)"
+            else
+              "(*args, **kwargs, &block)"
+            end
+          end
+
           # returns an eval-able string that contains the traced
           # method code used if the agent is not creating a scope for
           # use in scoped metrics.
           def method_without_push_scope(method_name, metric_name_code, options)
-            "def #{_traced_method_name(method_name, metric_name_code)}(*args, &block)
+            arguments = arguments_for_ruby_version
+            "def #{_traced_method_name(method_name, metric_name_code)}#{arguments}
               #{assemble_code_header(method_name, metric_name_code, options)}
               t0 = Time.now
               begin
-                #{_untraced_method_name(method_name, metric_name_code)}(*args, &block)\n
+                #{_untraced_method_name(method_name, metric_name_code)}#{arguments}\n
               ensure
                 duration = (Time.now - t0).to_f
                 NewRelic::Agent.record_metric(\"#{metric_name_code}\", duration)
@@ -197,11 +208,12 @@ module NewRelic
           # returns an eval-able string that contains the tracing code
           # for a fully traced metric including scoping
           def method_with_push_scope(method_name, metric_name_code, options)
-            "def #{_traced_method_name(method_name, metric_name_code)}(*args, &block)
+            arguments = arguments_for_ruby_version
+            "def #{_traced_method_name(method_name, metric_name_code)}#{arguments}
               #{options[:code_header]}
               result = ::NewRelic::Agent::MethodTracerHelpers.trace_execution_scoped(\"#{metric_name_code}\",
                         :metric => #{options[:metric]}) do
-                #{_untraced_method_name(method_name, metric_name_code)}(*args, &block)
+                #{_untraced_method_name(method_name, metric_name_code)}#{arguments}
               end
               #{options[:code_footer]}
               result
@@ -291,7 +303,27 @@ module NewRelic
         #
         # @api public
         #
-        def add_method_tracer(method_name, metric_name_code=nil, options = {})
+        def add_method_tracer(method_name, metric_name_code = nil, options = {})
+          ::NewRelic::Agent.add_or_defer_method_tracer(self, method_name, metric_name_code, options)
+        end
+
+        # For tests only because tracers must be removed in reverse-order
+        # from when they were added, or else other tracers that were added to the same method
+        # may get removed as well.
+        def remove_method_tracer(method_name, metric_name_code) # :nodoc:
+          return unless Agent.config[:agent_enabled]
+          if method_defined? "#{_traced_method_name(method_name, metric_name_code)}"
+            alias_method method_name, "#{_untraced_method_name(method_name, metric_name_code)}"
+            undef_method "#{_traced_method_name(method_name, metric_name_code)}"
+            ::NewRelic::Agent.logger.debug("removed method tracer #{method_name} #{metric_name_code}\n")
+          else
+            raise "No tracer for '#{metric_name_code}' on method '#{method_name}'"
+          end
+        end
+
+        private
+
+        def _add_method_tracer_now(method_name, metric_name_code, options)
           NewRelic::Agent.record_api_supportability_metric(:add_method_tracer)
 
           return unless newrelic_method_exists?(method_name)
@@ -308,25 +340,10 @@ module NewRelic
           send visibility, method_name
           send visibility, _traced_method_name(method_name, metric_name_code)
           ::NewRelic::Agent.logger.debug("Traced method: class = #{derived_class_name},"+
-                    "method = #{method_name}, "+
-                    "metric = '#{metric_name_code}'")
+                                         "method = #{method_name}, "+
+                                         "metric = '#{metric_name_code}'")
         end
 
-        # For tests only because tracers must be removed in reverse-order
-        # from when they were added, or else other tracers that were added to the same method
-        # may get removed as well.
-        def remove_method_tracer(method_name, metric_name_code) # :nodoc:
-          return unless Agent.config[:agent_enabled]
-          if method_defined? "#{_traced_method_name(method_name, metric_name_code)}"
-            alias_method method_name, "#{_untraced_method_name(method_name, metric_name_code)}"
-            undef_method "#{_traced_method_name(method_name, metric_name_code)}"
-            ::NewRelic::Agent.logger.debug("removed method tracer #{method_name} #{metric_name_code}\n")
-          else
-            raise "No tracer for '#{metric_name_code}' on method '#{method_name}'"
-          end
-        end
-        private
-
         # given a method and a metric, this method returns the
         # untraced alias of the method name
         def _untraced_method_name(method_name, metric_name)

data/lib/new_relic/agent/method_tracer_helpers.rb

@@ -1,6 +1,6 @@
 # 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.
 
 module NewRelic
   module Agent
@@ -9,15 +9,15 @@ module NewRelic
 
       extend self
 
-      def trace_execution_scoped(metric_names, options={}) #THREAD_LOCAL_ACCESS
-        state = NewRelic::Agent::TransactionState.tl_get
+      def trace_execution_scoped(metric_names, options=NewRelic::EMPTY_HASH) #THREAD_LOCAL_ACCESS
+        state = NewRelic::Agent::Tracer.state
         return yield unless state.is_execution_traced?
 
         metric_names = Array(metric_names)
         first_name   = metric_names.shift
         return yield unless first_name
 
-        segment = NewRelic::Agent::Transaction.start_segment(
+        segment = NewRelic::Agent::Tracer.start_segment(
           name: first_name,
           unscoped_metrics: metric_names
         )
@@ -27,7 +27,7 @@ module NewRelic
         end
 
         begin
-          yield
+          Tracer.capture_segment_error(segment) { yield }
         ensure
           segment.finish if segment
         end