newrelic_rpm 5.5.0.348 → 7.2.0

data/lib/new_relic/agent/transaction/abstract_segment.rb

@@ -1,9 +1,9 @@
 # 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.
 
 require 'new_relic/agent/range_extensions'
-require 'securerandom'
+require 'new_relic/agent/guid_generator'
 
 module NewRelic
   module Agent
@@ -21,13 +21,15 @@ module NewRelic
         # calculation in all other cases.
         #
         attr_reader :start_time, :end_time, :duration, :exclusive_duration, :guid
-        attr_accessor :name, :parent, :children_time, :transaction
+        attr_accessor :name, :parent, :children_time, :transaction, :transaction_name
         attr_writer :record_metrics, :record_scoped_metric, :record_on_finish
+        attr_reader :noticed_error
 
         def initialize name=nil, start_time=nil
           @name = name
+          @transaction_name = nil
           @transaction = nil
-          @guid = SecureRandom.hex(8)
+          @guid = NewRelic::Agent::GuidGenerator.generate_guid
           @parent = nil
           @params = nil
           @start_time = start_time if start_time
@@ -42,6 +44,7 @@ module NewRelic
           @record_metrics = true
           @record_scoped_metric = true
           @record_on_finish = false
+          @noticed_error = nil
         end
 
         def start
@@ -119,6 +122,30 @@ module NewRelic
         def transaction_assigned
         end
 
+        def set_noticed_error noticed_error
+          if @noticed_error
+            NewRelic::Agent.logger.debug \
+              "Segment: #{name} overwriting previously noticed " \
+              "error: #{@noticed_error.inspect} with: #{noticed_error.inspect}"
+          end
+          @noticed_error = noticed_error
+        end
+
+        def notice_error exception, options={}
+          if Agent.config[:high_security]
+            NewRelic::Agent.logger.debug \
+              "Segment: #{name} ignores notice_error for " \
+              "error: #{exception.inspect} because :high_security is enabled"
+          else
+            NewRelic::Agent.instance.error_collector.notice_segment_error self, exception, options
+          end
+        end
+
+        def noticed_error_attributes
+          return unless @noticed_error
+          @noticed_error.attributes_from_notice_error
+        end
+
         protected
 
         attr_writer :range_recorded
@@ -140,7 +167,7 @@ module NewRelic
 
           if finished?
             transaction.async = true
-            parent.descendant_complete self, segment
+            parent.descendant_complete(self, segment) if parent
           end
         end
 
@@ -228,7 +255,7 @@ module NewRelic
           @transaction_state ||= if @transaction
             transaction.state
           else
-            TransactionState.tl_get
+            Tracer.state
           end
         end
       end

data/lib/new_relic/agent/transaction/datastore_segment.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.
 
 require 'new_relic/agent/transaction/segment'
 require 'new_relic/agent/datastores/metric_helper'
@@ -109,13 +109,11 @@ module NewRelic
         end
 
         def add_instance_parameters
-          return unless NewRelic::Agent.config[:'datastore_tracer.instance_reporting.enabled']
           params[:host] = host if host
           params[:port_path_or_id] = port_path_or_id if port_path_or_id
         end
 
         def add_database_name_parameter
-          return unless NewRelic::Agent.config[:'datastore_tracer.database_name_reporting.enabled']
           params[:database_name] = database_name if database_name
         end
 

data/lib/new_relic/agent/transaction/distributed_tracer.rb

@@ -0,0 +1,177 @@
+# 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/transaction/trace_context'
+require 'new_relic/agent/transaction/distributed_tracing'
+require 'new_relic/agent/distributed_tracing/cross_app_tracing'
+
+module NewRelic
+  module Agent
+    class Transaction
+      class DistributedTracer
+        include NewRelic::Agent::CrossAppTracing
+        include DistributedTracing
+        include TraceContext
+
+        attr_reader :transaction
+        attr_accessor :parent_transaction_id
+
+        def parent_guid
+          if trace_context_header_data
+            trace_context_header_data.parent_id
+          elsif distributed_trace_payload
+            distributed_trace_payload.id
+          end
+        end
+
+        def accept_incoming_request request, transport_type=nil
+          accept_incoming_transport_type request, transport_type
+          if trace_parent_header_present? request
+            accept_trace_context_incoming_request request
+          else
+            accept_distributed_tracing_incoming_request request
+          end
+        end
+
+        def caller_transport_type
+          @caller_transport_type ||= "Unknown"
+        end
+
+        def accept_transport_type_from_api value
+          @caller_transport_type = DistributedTraceTransportType.from value
+        end
+
+        def accept_incoming_transport_type request, transport_type
+          if transport_type.to_s == NewRelic::EMPTY_STR
+            @caller_transport_type = DistributedTraceTransportType.for_rack_request request
+          else
+            @caller_transport_type = DistributedTraceTransportType.from transport_type
+          end
+        end
+
+        def initialize transaction
+          @transaction = transaction
+        end
+
+        def record_metrics
+          record_cross_app_metrics
+          DistributedTraceMetrics.record_metrics_for_transaction transaction
+        end
+
+        def append_payload payload
+          append_cat_info payload
+          DistributedTraceAttributes.copy_from_transaction \
+            transaction,
+            trace_state_payload || distributed_trace_payload,
+            payload
+        end
+
+        def log_request_headers headers, direction = "OUTGOING"
+          NewRelic::Agent.logger.debug "#{direction} REQUEST HEADERS: #{headers}"
+        end
+
+        def insert_headers headers
+          insert_trace_context_header headers
+          insert_distributed_trace_header headers
+          insert_cross_app_header headers
+          log_request_headers headers
+        end
+
+        def consume_message_headers headers, tracer_state, transport_type
+          log_request_headers headers, "INCOMING"
+          consume_message_distributed_tracing_headers headers, transport_type
+          consume_message_cross_app_tracing_headers headers, tracer_state
+          consume_message_synthetics_headers headers
+        rescue => e
+          NewRelic::Agent.logger.error "Error in consume_message_headers", e
+        end
+
+        def assign_intrinsics
+          if Agent.config[:'distributed_tracing.enabled']
+            DistributedTraceAttributes.copy_to_attributes transaction.payload, transaction.attributes
+          elsif is_cross_app?
+            assign_cross_app_intrinsics
+          end
+        end
+
+        def insert_distributed_trace_header headers
+          return unless Agent.config[:'distributed_tracing.enabled']
+          return if Agent.config[:'exclude_newrelic_header']
+          payload = create_distributed_trace_payload
+          headers[NewRelic::NEWRELIC_KEY] = payload.http_safe if payload
+        end
+
+        def insert_cat_headers headers
+          return unless CrossAppTracing.cross_app_enabled?
+          @is_cross_app_caller = true
+          insert_message_headers headers,
+            transaction.guid,
+            cat_trip_id,
+            cat_path_hash,
+            transaction.raw_synthetics_header
+        end
+
+        private
+
+        def consume_message_synthetics_headers headers
+          synthetics_header = headers[CrossAppTracing::NR_MESSAGE_BROKER_SYNTHETICS_HEADER]
+          if synthetics_header and
+             incoming_payload = ::JSON.load(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 consume_message_synthetics_header", e
+        end
+
+        def consume_message_distributed_tracing_headers headers, transport_type
+          return unless Agent.config[:'distributed_tracing.enabled']
+
+          accept_incoming_transport_type headers, transport_type
+
+          newrelic_trace_key = NewRelic::CANDIDATE_NEWRELIC_KEYS.detect do |key|
+            headers.has_key?(key)
+          end
+          return unless newrelic_trace_key && (payload = headers[newrelic_trace_key])
+
+          accept_distributed_trace_payload payload
+        end
+
+        def consume_message_cross_app_tracing_headers headers, tracer_state
+          return unless CrossAppTracing.cross_app_enabled?
+          return unless CrossAppTracing.message_has_crossapp_request_header?(headers)
+
+          accept_cross_app_payload headers, tracer_state
+          CrossAppTracing.assign_intrinsic_transaction_attributes tracer_state
+        end
+
+        def accept_cross_app_payload headers, tracer_state
+          encoded_id = headers[CrossAppTracing::NR_MESSAGE_BROKER_ID_HEADER]
+          decoded_id = encoded_id.nil? ? EMPTY_STRING : deobfuscate(encoded_id)
+
+          return unless CrossAppTracing.trusted_valid_cross_app_id?(decoded_id)
+          txn_header = headers[CrossAppTracing::NR_MESSAGE_BROKER_TXN_HEADER]
+          txn_info   = ::JSON.load(deobfuscate(txn_header))
+          payload    = CrossAppPayload.new(decoded_id, transaction, txn_info)
+
+          @cross_app_payload = payload
+        rescue => e
+          NewRelic::Agent.logger.debug("Failure deserializing encoded header in #{self.class}, #{e.class}, #{e.message}")
+          nil
+        end
+
+        def deobfuscate message
+          CrossAppTracing.obfuscator.deobfuscate message
+        end
+
+      end
+    end
+  end
+end
+

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

@@ -1,39 +1,68 @@
 # 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/distributed_trace_payload'
+require 'new_relic/agent/distributed_tracing/distributed_trace_payload'
+require 'new_relic/agent/distributed_tracing/distributed_trace_attributes'
+require 'new_relic/agent/distributed_tracing/distributed_trace_metrics'
 
 module NewRelic
   module Agent
     class Transaction
       module DistributedTracing
         attr_accessor :distributed_trace_payload
+        attr_writer :distributed_trace_payload_created
+
+        SUPPORTABILITY_DISTRIBUTED_TRACE       = "Supportability/DistributedTrace"
+        CREATE_PREFIX                          = "#{SUPPORTABILITY_DISTRIBUTED_TRACE}/CreatePayload"
+        ACCEPT_PREFIX                          = "#{SUPPORTABILITY_DISTRIBUTED_TRACE}/AcceptPayload"
+        IGNORE_PREFIX                          = "#{ACCEPT_PREFIX}/Ignored"
+
+        CREATE_SUCCESS_METRIC                  = "#{CREATE_PREFIX}/Success"
+        CREATE_EXCEPTION_METRIC                = "#{CREATE_PREFIX}/Exception"
+        ACCEPT_SUCCESS_METRIC                  = "#{ACCEPT_PREFIX}/Success"
+        ACCEPT_EXCEPTION_METRIC                = "#{ACCEPT_PREFIX}/Exception"
+        ACCEPT_PARSE_EXCEPTION_METRIC          = "#{ACCEPT_PREFIX}/ParseException"
+
+        IGNORE_ACCEPT_AFTER_CREATE_METRIC      = "#{IGNORE_PREFIX}/CreateBeforeAccept"
+        IGNORE_MULTIPLE_ACCEPT_METRIC          = "#{IGNORE_PREFIX}/Multiple"
+        IGNORE_ACCEPT_NULL_METRIC              = "#{IGNORE_PREFIX}/Null"
+        IGNORE_ACCEPT_MAJOR_VERSION_METRIC     = "#{IGNORE_PREFIX}/MajorVersion"
+        IGNORE_ACCEPT_UNTRUSTED_ACCOUNT_METRIC = "#{IGNORE_PREFIX}/UntrustedAccount"
+
+        LBRACE = "{"
+        NULL_PAYLOAD = 'null'
 
-        def distributed_trace?
-          !!distributed_trace_payload
+        NEWRELIC_TRACE_KEY = "HTTP_NEWRELIC"
+
+        def accept_distributed_tracing_incoming_request request
+          return unless Agent.config[:'distributed_tracing.enabled']
+          return unless payload = request[NEWRELIC_TRACE_KEY]
+
+          accept_distributed_trace_payload payload
         end
 
-        SUPPORTABILITY_CREATE_PAYLOAD_SUCCESS   = "Supportability/DistributedTrace/CreatePayload/Success".freeze
-        SUPPORTABILITY_CREATE_PAYLOAD_EXCEPTION = "Supportability/DistributedTrace/CreatePayload/Exception".freeze
+        def distributed_trace_payload_created?
+          @distributed_trace_payload_created ||= false
+        end
 
         def create_distributed_trace_payload
           return unless Agent.config[:'distributed_tracing.enabled']
-          self.distributed_trace_payload_created = true
-          payload = DistributedTracePayload.for_transaction self
-          NewRelic::Agent.increment_metric SUPPORTABILITY_CREATE_PAYLOAD_SUCCESS
+
+          @distributed_trace_payload_created = true
+          payload = DistributedTracePayload.for_transaction transaction
+          NewRelic::Agent.increment_metric CREATE_SUCCESS_METRIC
           payload
         rescue => e
-          NewRelic::Agent.increment_metric SUPPORTABILITY_CREATE_PAYLOAD_EXCEPTION
+          NewRelic::Agent.increment_metric CREATE_EXCEPTION_METRIC
           NewRelic::Agent.logger.warn "Failed to create distributed trace payload", e
           nil
         end
 
-        SUPPORTABILITY_ACCEPT_PAYLOAD_SUCCESS   = "Supportability/DistributedTrace/AcceptPayload/Success".freeze
-        SUPPORTABILITY_ACCEPT_PAYLOAD_EXCEPTION = "Supportability/DistributedTrace/AcceptPayload/Exception".freeze
-
         def accept_distributed_trace_payload payload
           return unless Agent.config[:'distributed_tracing.enabled']
+
           return false if check_payload_ignored(payload)
           return false unless check_payload_present(payload)
           return false unless payload = decode_payload(payload)
@@ -43,95 +72,37 @@ module NewRelic
 
           assign_payload_and_sampling_params(payload)
 
-          NewRelic::Agent.increment_metric SUPPORTABILITY_ACCEPT_PAYLOAD_SUCCESS
+          NewRelic::Agent.increment_metric ACCEPT_SUCCESS_METRIC
           true
         rescue => e
-          NewRelic::Agent.increment_metric SUPPORTABILITY_ACCEPT_PAYLOAD_EXCEPTION
+          NewRelic::Agent.increment_metric ACCEPT_EXCEPTION_METRIC
           NewRelic::Agent.logger.warn "Failed to accept distributed trace payload", e
           false
         end
 
-        def trace_id
-          if distributed_trace_payload
-            distributed_trace_payload.trace_id
-          else
-            guid
-          end
-        end
-
-        def parent_id
-          # The payload comes from our parent transaction, so its ID
-          # is our parent ID.
-          #
-          distributed_trace_payload && distributed_trace_payload.transaction_id
-        end
-
-        def distributed_trace_payload_created?
-          @distributed_trace_payload_created ||=  false
-        end
-
-        attr_writer :distributed_trace_payload_created
-
-        def append_distributed_trace_info transaction_payload
-          return unless Agent.config[:'distributed_tracing.enabled']
-          if distributed_trace_payload
-            distributed_trace_payload.assign_intrinsics self, transaction_payload
-          else
-            DistributedTracePayload.assign_initial_intrinsics self, transaction_payload
-          end
-        end
-
-        def assign_distributed_trace_intrinsics
-          return unless Agent.config[:'distributed_tracing.enabled']
-          DistributedTracePayload::INTRINSIC_KEYS.each do |key|
-            next unless @payload.key? key
-            attributes.add_intrinsic_attribute key, @payload[key]
-          end
-          nil
-        end
-
-        # This method returns transport_duration in seconds. Transport duration
-        # is stored in milliseconds on the payload, but it's needed in seconds
-        # for metrics and intrinsics.
-        def transport_duration
-          return unless distributed_trace_payload
-          duration = (start_time.to_f * 1000 - distributed_trace_payload.timestamp) / 1000
-          duration < 0 ? 0 : duration
-        end
-
         private
 
-        SUPPORTABILITY_CREATE_BEFORE_ACCEPT_PAYLOAD   = "Supportability/DistributedTrace/AcceptPayload/Ignored/CreateBeforeAccept".freeze
-        SUPPORTABILITY_MULTIPLE_ACCEPT_PAYLOAD        = "Supportability/DistributedTrace/AcceptPayload/Ignored/Multiple".freeze
-        SUPPORTABILITY_PAYLOAD_ACCEPT_IGNORED_NULL    = "Supportability/DistributedTrace/AcceptPayload/Ignored/Null".freeze
-        SUPPORTABILITY_PAYLOAD_ACCEPT_IGNORED_BROWSER = "Supportability/DistributedTrace/AcceptPayload/Ignored/BrowserAgentInjected".freeze
-
         def check_payload_ignored(payload)
           if distributed_trace_payload
-            NewRelic::Agent.increment_metric SUPPORTABILITY_MULTIPLE_ACCEPT_PAYLOAD
+            NewRelic::Agent.increment_metric IGNORE_MULTIPLE_ACCEPT_METRIC
             return true
           elsif distributed_trace_payload_created?
-            NewRelic::Agent.increment_metric SUPPORTABILITY_CREATE_BEFORE_ACCEPT_PAYLOAD
+            NewRelic::Agent.increment_metric IGNORE_ACCEPT_AFTER_CREATE_METRIC
             return true
           end
           false
         end
 
-        NULL_PAYLOAD = 'null'.freeze
-
         def check_payload_present(payload)
           # We might be passed a Ruby `nil` object _or_ the JSON "null"
           if payload.nil? || payload == NULL_PAYLOAD
-            NewRelic::Agent.increment_metric SUPPORTABILITY_PAYLOAD_ACCEPT_IGNORED_NULL
+            NewRelic::Agent.increment_metric IGNORE_ACCEPT_NULL_METRIC
             return nil
           end
 
           payload
         end
 
-        SUPPORTABILITY_PAYLOAD_ACCEPT_IGNORED_PARSE_EXCEPTION = "Supportability/DistributedTrace/AcceptPayload/ParseException".freeze
-        LBRACE = "{".freeze
-
         def decode_payload(payload)
           decoded = if payload.start_with? LBRACE
             DistributedTracePayload.from_json payload
@@ -143,7 +114,7 @@ module NewRelic
 
           decoded
         rescue => e
-          NewRelic::Agent.increment_metric SUPPORTABILITY_PAYLOAD_ACCEPT_IGNORED_PARSE_EXCEPTION
+          NewRelic::Agent.increment_metric ACCEPT_PARSE_EXCEPTION_METRIC
           NewRelic::Agent.logger.warn "Error parsing distributed trace payload", e
           nil
         end
@@ -156,105 +127,44 @@ module NewRelic
             !payload.parent_type.nil? &&
             (!payload.transaction_id.nil? || !payload.id.nil?) &&
             !payload.trace_id.nil? &&
-            !payload.timestamp.nil? &&
-            !payload.parent_account_id.nil?
+            !payload.timestamp.nil?
 
             true
           else
-            NewRelic::Agent.increment_metric SUPPORTABILITY_PAYLOAD_ACCEPT_IGNORED_PARSE_EXCEPTION
+            NewRelic::Agent.increment_metric ACCEPT_PARSE_EXCEPTION_METRIC
             false
           end
         end
 
-        SUPPORTABILITY_PAYLOAD_ACCEPT_IGNORED_MAJOR_VERSION = "Supportability/DistributedTrace/AcceptPayload/Ignored/MajorVersion".freeze
-
         def check_valid_version(payload)
           if DistributedTracePayload.major_version_matches?(payload)
             true
           else
-            NewRelic::Agent.increment_metric SUPPORTABILITY_PAYLOAD_ACCEPT_IGNORED_MAJOR_VERSION
+            NewRelic::Agent.increment_metric IGNORE_ACCEPT_MAJOR_VERSION_METRIC
             false
           end
         end
 
-        SUPPORTABILITY_PAYLOAD_ACCEPT_UNTRUSTED_ACCOUNT = "Supportability/DistributedTrace/AcceptPayload/Ignored/UntrustedAccount".freeze
-
         def check_trusted_account(payload)
           compare_key = payload.trusted_account_key || payload.parent_account_id
           unless compare_key == NewRelic::Agent.config[:trusted_account_key]
-            NewRelic::Agent.increment_metric SUPPORTABILITY_PAYLOAD_ACCEPT_UNTRUSTED_ACCOUNT
+            NewRelic::Agent.increment_metric IGNORE_ACCEPT_UNTRUSTED_ACCOUNT_METRIC
             return false
           end
           true
         end
 
         def assign_payload_and_sampling_params(payload)
-          self.distributed_trace_payload = payload
+          @distributed_trace_payload = payload
+          return if transaction.distributed_tracer.trace_context_header_data
+          transaction.trace_id = payload.trace_id
+          transaction.distributed_tracer.parent_transaction_id = payload.transaction_id
+          transaction.parent_span_id = payload.id
 
           unless payload.sampled.nil?
-            self.sampled = payload.sampled
-            self.priority = payload.priority if payload.priority
-          end
-        end
-
-        ALL_SUFFIX = "all".freeze
-        ALL_WEB_SUFFIX = "allWeb".freeze
-        ALL_OTHER_SUFFIX = "allOther".freeze
-
-        def transaction_type_suffix
-          if Transaction.recording_web_transaction?
-            ALL_WEB_SUFFIX
-          else
-            ALL_OTHER_SUFFIX
-          end
-        end
-
-        def record_distributed_tracing_metrics
-          return unless Agent.config[:'distributed_tracing.enabled']
-
-          record_caller_by_duration_metrics
-          record_transport_duration_metrics
-          record_errors_by_caller_metrics
-        end
-
-        DURATION_BY_CALLER_UNKOWN_PREFIX = "DurationByCaller/Unknown/Unknown/Unknown/Unknown".freeze
-
-        def record_caller_by_duration_metrics
-          prefix = if distributed_trace?
-            payload = distributed_trace_payload
-            "DurationByCaller/#{payload.parent_type}/#{payload.parent_account_id}/#{payload.parent_app_id}/#{payload.caller_transport_type}"
-          else
-            DURATION_BY_CALLER_UNKOWN_PREFIX
+            transaction.sampled = payload.sampled
+            transaction.priority = payload.priority if payload.priority
           end
-
-          metrics.record_unscoped "#{prefix}/#{ALL_SUFFIX}",              duration
-          metrics.record_unscoped "#{prefix}/#{transaction_type_suffix}", duration
-        end
-
-        def record_transport_duration_metrics
-          return unless distributed_trace?
-
-          payload = distributed_trace_payload
-          prefix = "TransportDuration/#{payload.parent_type}/#{payload.parent_account_id}/#{payload.parent_app_id}/#{payload.caller_transport_type}"
-
-          metrics.record_unscoped "#{prefix}/#{ALL_SUFFIX}",              transport_duration
-          metrics.record_unscoped "#{prefix}/#{transaction_type_suffix}", transport_duration
-        end
-
-        ERRORS_BY_CALLER_UNKOWN_PREFIX = "ErrorsByCaller/Unknown/Unknown/Unknown/Unknown".freeze
-
-        def record_errors_by_caller_metrics
-          return unless exceptions.size > 0
-
-          prefix = if distributed_trace?
-            payload = distributed_trace_payload
-            "ErrorsByCaller/#{payload.parent_type}/#{payload.parent_account_id}/#{payload.parent_app_id}/#{payload.caller_transport_type}"
-          else
-            ERRORS_BY_CALLER_UNKOWN_PREFIX
-          end
-
-          metrics.record_unscoped "#{prefix}/#{ALL_SUFFIX}",              1
-          metrics.record_unscoped "#{prefix}/#{transaction_type_suffix}", 1
         end
       end
     end