newrelic_rpm 4.8.0.341 → 6.13.1

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

@@ -1,8 +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 'new_relic/agent/guid_generator'
 
 module NewRelic
   module Agent
@@ -16,16 +17,19 @@ module NewRelic
         # a segments children time. The reason for this is that computing
         # exclusive duration using time ranges is expensive and it's only
         # necessary if a segment's children run concurrently, or a segment ends
-        # after it's parent. We will use the optimized exclusive duration
+        # after its parent. We will use the optimized exclusive duration
         # calculation in all other cases.
         #
-        attr_reader :start_time, :end_time, :duration, :exclusive_duration
-        attr_accessor :name, :parent, :children_time, :transaction
+        attr_reader :start_time, :end_time, :duration, :exclusive_duration, :guid
+        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 = NewRelic::Agent::GuidGenerator.generate_guid
           @parent = nil
           @params = nil
           @start_time = start_time if start_time
@@ -40,6 +44,7 @@ module NewRelic
           @record_metrics = true
           @record_scoped_metric = true
           @record_on_finish = false
+          @noticed_error = nil
         end
 
         def start
@@ -113,6 +118,34 @@ module NewRelic
           sprintf('#<%s:0x%x %s>', self.class.name, object_id, ivars.join(', '))
         end
 
+        # callback for subclasses to override
+        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
@@ -222,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'
@@ -15,7 +15,7 @@ module NewRelic
         UNKNOWN = 'unknown'.freeze
 
         attr_reader :product, :operation, :collection, :sql_statement, :nosql_statement, :host, :port_path_or_id
-        attr_accessor :database_name
+        attr_accessor :database_name, :record_sql
 
 
         def initialize product, operation, collection = nil, host = nil, port_path_or_id = nil, database_name = nil, start_time = nil
@@ -24,6 +24,7 @@ module NewRelic
           @collection = collection
           @sql_statement = nil
           @nosql_statement = nil
+          @record_sql = true
           set_instance_info host, port_path_or_id
           @database_name = database_name ? database_name.to_s : nil
           super Datastores::MetricHelper.scoped_metric_for(product, operation, collection),
@@ -67,6 +68,23 @@ module NewRelic
           @sql_statement = Database::Statement.new sql, config, explainer, binds, name, host, port_path_or_id, database_name
         end
 
+        # Method for simplifying attaching non-SQL data statements to a
+        # transaction. For instance, Mongo or CQL queries, Memcached or Redis
+        # keys would all be appropriate data to attach as statements.
+        #
+        # Data passed to this method is NOT obfuscated by New Relic, so please
+        # ensure that user information is obfuscated if the agent setting
+        # `transaction_tracer.record_sql` is set to `obfuscated`
+        #
+        # @param [String] nosql_statement text of the statement to capture.
+        #
+        # @note THERE ARE SECURITY CONCERNS WHEN CAPTURING STATEMENTS!
+        #   This method will properly ignore statements when the user has turned
+        #   off capturing queries, but it is not able to obfuscate arbitrary data!
+        #   To prevent exposing user information embedded in captured queries,
+        #   please ensure all data passed to this method is safe to transmit to
+        #   New Relic.
+
         def notice_nosql_statement nosql_statement
           return unless record_sql?
           @nosql_statement = Database.truncate_query(nosql_statement)
@@ -91,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
 
@@ -118,7 +134,16 @@ module NewRelic
         end
 
         def record_sql?
-          transaction_state.is_sql_recorded?
+          transaction_state.is_sql_recorded? && @record_sql
+        end
+
+        def record_span_event
+          aggregator = ::NewRelic::Agent.agent.span_event_aggregator
+          priority   = transaction.priority
+
+          aggregator.record(priority: priority) do
+            SpanEventPrimitive.for_datastore_segment(self)
+          end
         end
       end
     end

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

@@ -0,0 +1,171 @@
+# 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 insert_headers request
+          insert_trace_context_header request
+          insert_distributed_trace_header request
+          insert_cross_app_header request
+        end
+
+        def consume_message_headers headers, tracer_state, transport_type
+          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 request
+          return unless Agent.config[:'distributed_tracing.enabled']
+          return if Agent.config[:'exclude_newrelic_header']
+          payload = create_distributed_trace_payload
+          request[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,121 +1,173 @@
 # 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
 
-        def distributed_trace?
-          !!distributed_trace_payload
-        end
+        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"
 
-        def create_distributed_trace_payload url = nil
+        LBRACE = "{"
+        NULL_PAYLOAD = 'null'
+
+        NEWRELIC_TRACE_KEY = "HTTP_NEWRELIC"
+
+        def accept_distributed_tracing_incoming_request request
           return unless Agent.config[:'distributed_tracing.enabled']
-          self.order += 1
-          DistributedTracePayload.for_transaction self, url
+          return unless payload = request[NEWRELIC_TRACE_KEY]
+
+          accept_distributed_trace_payload payload
         end
 
-        LBRACE = "{".freeze
+        def distributed_trace_payload_created?
+          @distributed_trace_payload_created ||= false
+        end
 
-        def accept_distributed_trace_payload transport_type, payload
+        def create_distributed_trace_payload
           return unless Agent.config[:'distributed_tracing.enabled']
-          if distributed_trace_payload
-            NewRelic::Agent.increment_metric "Supportability/DistributedTracing/AcceptFailure/PayloadAlreadyAccepted"
-            return false
-          elsif self.order > 0
-            NewRelic::Agent.increment_metric "Supportability/DistributedTracing/AcceptFailure/CreateDistributedTracePayload-before-AcceptDistributedTracePayload"
-            return false
-          elsif name_frozen?
-            NewRelic::Agent.increment_metric "Supportability/DistributedTracing/AcceptFailure/BrowserAgentInjected"
-            return false
-          end
 
-          payload = if payload.start_with? LBRACE
-            DistributedTracePayload.from_json payload
-          else
-            DistributedTracePayload.from_http_safe payload
-          end
+          @distributed_trace_payload_created = true
+          payload = DistributedTracePayload.for_transaction transaction
+          NewRelic::Agent.increment_metric CREATE_SUCCESS_METRIC
+          payload
+        rescue => e
+          NewRelic::Agent.increment_metric CREATE_EXCEPTION_METRIC
+          NewRelic::Agent.logger.warn "Failed to create distributed trace payload", e
+          nil
+        end
+
+        def accept_distributed_trace_payload payload
+          return unless Agent.config[:'distributed_tracing.enabled']
 
-          payload.caller_transport_type = transport_type
-          self.distributed_trace_payload = payload
+          return false if check_payload_ignored(payload)
+          return false unless check_payload_present(payload)
+          return false unless payload = decode_payload(payload)
+          return false unless check_required_fields_present(payload)
+          return false unless check_valid_version(payload)
+          return false unless check_trusted_account(payload)
 
-          self.sampled = payload.sampled unless payload.sampled.nil?
+          assign_payload_and_sampling_params(payload)
 
+          NewRelic::Agent.increment_metric ACCEPT_SUCCESS_METRIC
           true
         rescue => e
-          NewRelic::Agent.increment_metric "Supportability/DistributedTracing/AcceptFailure/Unknown"
+          NewRelic::Agent.increment_metric ACCEPT_EXCEPTION_METRIC
           NewRelic::Agent.logger.warn "Failed to accept distributed trace payload", e
           false
         end
 
-        def distributed_tracing_trip_id
+        private
+
+        def check_payload_ignored(payload)
           if distributed_trace_payload
-            distributed_trace_payload.trip_id
-          else
-            guid
+            NewRelic::Agent.increment_metric IGNORE_MULTIPLE_ACCEPT_METRIC
+            return true
+          elsif distributed_trace_payload_created?
+            NewRelic::Agent.increment_metric IGNORE_ACCEPT_AFTER_CREATE_METRIC
+            return true
           end
+          false
         end
 
-        def parent_ids
-          if distributed_trace_payload &&
-               distributed_trace_payload.parent_ids &&
-               distributed_trace_payload.parent_ids.last != guid
-            inbound_ids = distributed_trace_payload.parent_ids.dup
-            inbound_ids.push guid
-            if inbound_ids.size > 3
-              inbound_ids.shift
-            end
-            inbound_ids
-          else
-            [guid]
+        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 IGNORE_ACCEPT_NULL_METRIC
+            return nil
           end
+
+          payload
         end
 
-        def depth
-          if distributed_trace_payload
-            distributed_trace_payload.depth
+        def decode_payload(payload)
+          decoded = if payload.start_with? LBRACE
+            DistributedTracePayload.from_json payload
           else
-            1
+            DistributedTracePayload.from_http_safe payload
           end
-        end
 
-        def order
-          @order ||= 0
+          return nil unless check_payload_present(decoded)
+
+          decoded
+        rescue => e
+          NewRelic::Agent.increment_metric ACCEPT_PARSE_EXCEPTION_METRIC
+          NewRelic::Agent.logger.warn "Error parsing distributed trace payload", e
+          nil
         end
 
-        attr_writer :order
+        def check_required_fields_present(payload)
+          if \
+            !payload.version.nil? &&
+            !payload.parent_account_id.nil? &&
+            !payload.parent_app_id.nil? &&
+            !payload.parent_type.nil? &&
+            (!payload.transaction_id.nil? || !payload.id.nil?) &&
+            !payload.trace_id.nil? &&
+            !payload.timestamp.nil?
+
+            true
+          else
+            NewRelic::Agent.increment_metric ACCEPT_PARSE_EXCEPTION_METRIC
+            false
+          end
+        end
 
-        def append_distributed_tracing_info payload
-          return unless Agent.config[:'distributed_tracing.enabled']
-          if distributed_trace_payload
-            distributed_trace_payload.assign_intrinsics self, payload
-          elsif order > 0
-            DistributedTracePayload.assign_initial_intrinsics self, payload
+        def check_valid_version(payload)
+          if DistributedTracePayload.major_version_matches?(payload)
+            true
+          else
+            NewRelic::Agent.increment_metric IGNORE_ACCEPT_MAJOR_VERSION_METRIC
+            false
           end
         end
 
-        def assign_distributed_tracing_intrinsics
-          return unless Agent.config[:'distributed_tracing.enabled']
-          DistributedTracePayload::INTRINSIC_KEYS.each do |key|
-            next unless value = @payload[key]
-            attributes.add_intrinsic_attribute key, value
+        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 IGNORE_ACCEPT_UNTRUSTED_ACCOUNT_METRIC
+            return false
           end
-          nil
+          true
         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
-          (start_time.to_f * 1000 - distributed_trace_payload.timestamp) / 1000
+        def assign_payload_and_sampling_params(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?
+            transaction.sampled = payload.sampled
+            transaction.priority = payload.priority if payload.priority
+          end
         end
       end
     end
   end
 end
+