newrelic_rpm 9.0.0 → 9.2.2

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

@@ -2,7 +2,6 @@
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
 
-require 'new_relic/agent/range_extensions'
 require 'new_relic/agent/guid_generator'
 
 module NewRelic
@@ -56,7 +55,7 @@ module NewRelic
           @start_time ||= Process.clock_gettime(Process::CLOCK_REALTIME)
           return unless transaction
 
-          parent.child_start(self) if parent
+          parent&.child_start(self)
         end
 
         def finish
@@ -105,38 +104,6 @@ module NewRelic
           @start_time.to_f..@end_time.to_f
         end
 
-        def timings_overlap?(timing1, timing2)
-          (timing1.first >= timing2.first && timing1.first <= timing2.last) ||
-            (timing2.first >= timing1.first && timing2.first <= timing1.last)
-        end
-
-        def merge_timings(timing1, timing2)
-          [([timing1.first, timing2.first].min),
-            ([timing1.last, timing2.last].max)]
-        end
-
-        # @children_timings is an array of array, with each inner array
-        # holding exactly 2 values, a child segment's start time and finish
-        # time (in that order). When it's time to record, these timings are
-        # converted into an array of range objects (using the same start and
-        # end values as the original array). Any two range objects that
-        # intersect and merged into a larger range. This checking for a
-        # intersections and merging of ranges is expensive, so the operation
-        # is only done at recording time.
-        def children_time_ranges
-          @children_time_ranges ||= begin
-            overlapped = @children_timings.each_with_object([]) do |timing, timings|
-              i = timings.index { |t| timings_overlap?(t, timing) }
-              if i
-                timings[i] = merge_timings(timing, timings[i])
-              else
-                timings << timing
-              end
-            end
-            overlapped.map { |t| Range.new(t.first, t.last) }
-          end
-        end
-
         def children_time_ranges?
           !@children_timings.empty?
         end
@@ -228,7 +195,7 @@ module NewRelic
 
           if finished?
             transaction.async = true
-            parent.descendant_complete(self, segment) if parent
+            parent&.descendant_complete(self, segment)
           end
         end
 
@@ -262,19 +229,19 @@ module NewRelic
 
         def force_finish
           finish
-          NewRelic::Agent.logger.warn("Segment: #{name} was unfinished at " \
-            "the end of transaction. Timing information for this segment's" \
-            "parent #{parent.name} in #{transaction.best_name} may be inaccurate.")
+          NewRelic::Agent.logger.send(transaction.async? ? :debug : :warn, "Segment: #{name} was unfinished at " \
+            "the end of transaction. Timing information for this segment's " \
+            "parent #{parent&.name} in #{transaction.best_name} may be inaccurate.")
         end
 
         def run_complete_callbacks
           segment_complete
-          parent.child_complete(self) if parent
+          parent&.child_complete(self)
           transaction.segment_complete(self)
         end
 
         def record_metrics
-          raise NotImplementedError, "Subclasses must implement record_metrics"
+          raise NotImplementedError, 'Subclasses must implement record_metrics'
         end
 
         # callback for subclasses to override
@@ -299,12 +266,6 @@ module NewRelic
         end
 
         def record_exclusive_duration
-          overlapping_duration = if children_time_ranges?
-            RangeExtensions.compute_overlap(time_range, children_time_ranges)
-          else
-            0.0
-          end
-
           @exclusive_duration = duration - children_time - overlapping_duration
           transaction.total_time += @exclusive_duration
           params[:exclusive_duration_millis] = @exclusive_duration * 1000 if transaction.async?
@@ -314,6 +275,51 @@ module NewRelic
           transaction.metrics
         end
 
+        def ranges_intersect?(r1, r2)
+          r1.begin > r2.begin ? r2.cover?(r1.begin) : r1.cover?(r2.begin)
+        end
+
+        def range_overlap(range)
+          return 0.0 unless ranges_intersect?(range, time_range)
+
+          [range.end, time_range.end].min - [range.begin, time_range.begin].max
+        end
+
+        # Child segments operating concurrently with this segment may have
+        # start and end times that overlap with this segment's own times. The
+        # amount of overlap needs to be removed from the `children_time` total
+        # when calculating an `@exclusive_duration` value to be added to the
+        # transaction's total time.
+        #
+        # If there aren't any child segments, return 0.0. Otherwise, take the
+        # `@children_timings` array of arrays (each array holds a child
+        # segment's start time and end time), sort it by the first elements
+        # (start times), and use the start and finish times to create Range
+        # objects. Combine all of the child segment ranges that overlap with
+        # one another into new bigger ranges. Then take those bigger ranges
+        # and calculate how much overlap there is between them and this
+        # segment's own time range. Keep a running sum of all of the overlap
+        # amounts and then return it.
+        def overlapping_duration
+          sum = 0.0
+          return sum unless children_time_ranges?
+
+          @children_timings.sort_by!(&:first)
+          range = Range.new(*@children_timings.first)
+          (1..(@children_timings.size - 1)).each do |i|
+            possible = Range.new(*@children_timings[i])
+
+            if ranges_intersect?(range, possible)
+              range = range.begin..possible.end
+            else
+              sum += range_overlap(range)
+              range = possible
+            end
+          end
+
+          sum += range_overlap(range)
+        end
+
         def transaction_state
           @transaction_state ||= if @transaction
             transaction.state

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

@@ -24,7 +24,7 @@ module NewRelic
           @nosql_statement = nil
           @record_sql = true
           set_instance_info(host, port_path_or_id)
-          @database_name = database_name ? database_name.to_s : nil
+          @database_name = database_name&.to_s
           super(Datastores::MetricHelper.scoped_metric_for(product, operation, collection),
                 nil,
                 start_time)

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

@@ -35,7 +35,7 @@ module NewRelic
         end
 
         def caller_transport_type
-          @caller_transport_type ||= "Unknown"
+          @caller_transport_type ||= 'Unknown'
         end
 
         def accept_transport_type_from_api(value)
@@ -68,8 +68,9 @@ module NewRelic
           )
         end
 
-        def log_request_headers(headers, direction = "OUTGOING")
-          NewRelic::Agent.logger.debug("#{direction} REQUEST HEADERS: #{headers}")
+        def log_request_headers(headers, direction = 'OUTGOING')
+          printed_headers = headers.is_a?(NewRelic::Agent::HTTPClients::AbstractRequest) ? headers.headers : headers
+          NewRelic::Agent.logger.debug("#{direction} REQUEST HEADERS: #{printed_headers}")
         end
 
         def insert_headers(headers)
@@ -82,12 +83,12 @@ module NewRelic
         end
 
         def consume_message_headers(headers, tracer_state, transport_type)
-          log_request_headers(headers, "INCOMING")
+          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)
+          NewRelic::Agent.logger.error('Error in consume_message_headers', e)
         end
 
         def assign_intrinsics
@@ -135,7 +136,7 @@ module NewRelic
             transaction.synthetics_payload = incoming_payload
           end
         rescue => e
-          NewRelic::Agent.logger.error("Error in consume_message_synthetics_header", e)
+          NewRelic::Agent.logger.error('Error in consume_message_synthetics_header', e)
         end
 
         def consume_message_distributed_tracing_headers(headers, transport_type)

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

@@ -13,7 +13,7 @@ module NewRelic
         attr_accessor :distributed_trace_payload
         attr_writer :distributed_trace_payload_created
 
-        SUPPORTABILITY_DISTRIBUTED_TRACE = "Supportability/DistributedTrace"
+        SUPPORTABILITY_DISTRIBUTED_TRACE = 'Supportability/DistributedTrace'
         CREATE_PREFIX = "#{SUPPORTABILITY_DISTRIBUTED_TRACE}/CreatePayload"
         ACCEPT_PREFIX = "#{SUPPORTABILITY_DISTRIBUTED_TRACE}/AcceptPayload"
         IGNORE_PREFIX = "#{ACCEPT_PREFIX}/Ignored"
@@ -30,10 +30,10 @@ module NewRelic
         IGNORE_ACCEPT_MAJOR_VERSION_METRIC = "#{IGNORE_PREFIX}/MajorVersion"
         IGNORE_ACCEPT_UNTRUSTED_ACCOUNT_METRIC = "#{IGNORE_PREFIX}/UntrustedAccount"
 
-        LBRACE = "{"
+        LBRACE = '{'
         NULL_PAYLOAD = 'null'
 
-        NEWRELIC_TRACE_KEY = "HTTP_NEWRELIC"
+        NEWRELIC_TRACE_KEY = 'HTTP_NEWRELIC'
 
         def accept_distributed_tracing_incoming_request(request)
           return unless Agent.config[:'distributed_tracing.enabled']
@@ -55,7 +55,7 @@ module NewRelic
           payload
         rescue => e
           NewRelic::Agent.increment_metric(CREATE_EXCEPTION_METRIC)
-          NewRelic::Agent.logger.warn("Failed to create distributed trace payload", e)
+          NewRelic::Agent.logger.warn('Failed to create distributed trace payload', e)
           nil
         end
 
@@ -75,7 +75,7 @@ module NewRelic
           true
         rescue => e
           NewRelic::Agent.increment_metric(ACCEPT_EXCEPTION_METRIC)
-          NewRelic::Agent.logger.warn("Failed to accept distributed trace payload", e)
+          NewRelic::Agent.logger.warn('Failed to accept distributed trace payload', e)
           false
         end
 
@@ -114,19 +114,18 @@ module NewRelic
           decoded
         rescue => e
           NewRelic::Agent.increment_metric(ACCEPT_PARSE_EXCEPTION_METRIC)
-          NewRelic::Agent.logger.warn("Error parsing distributed trace payload", e)
+          NewRelic::Agent.logger.warn('Error parsing distributed trace payload', e)
           nil
         end
 
         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?
+          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

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

@@ -16,10 +16,10 @@ module NewRelic
         NR_SYNTHETICS_HEADER = 'X-NewRelic-Synthetics'
         APP_DATA_KEY = 'NewRelicAppData'
 
-        EXTERNAL_ALL = "External/all"
-        EXTERNAL_ALL_WEB = "External/allWeb"
-        EXTERNAL_ALL_OTHER = "External/allOther"
-        MISSING_STATUS_CODE = "MissingHTTPStatusCode"
+        EXTERNAL_ALL = 'External/all'
+        EXTERNAL_ALL_WEB = 'External/allWeb'
+        EXTERNAL_ALL_OTHER = 'External/allOther'
+        MISSING_STATUS_CODE = 'MissingHTTPStatusCode'
 
         attr_reader :library, :uri, :procedure, :http_status_code
         attr_writer :record_agent_attributes
@@ -62,14 +62,14 @@ module NewRelic
         # @api public
         def add_request_headers(request)
           process_host_header(request)
-          synthetics_header = transaction && transaction.raw_synthetics_header
+          synthetics_header = transaction&.raw_synthetics_header
           insert_synthetics_header(request, synthetics_header) if synthetics_header
 
           return unless record_metrics?
 
           transaction.distributed_tracer.insert_headers(request)
         rescue => e
-          NewRelic::Agent.logger.error("Error in add_request_headers", e)
+          NewRelic::Agent.logger.error('Error in add_request_headers', e)
         end
 
         # This method extracts app data from an external response if present. If
@@ -92,10 +92,10 @@ module NewRelic
             @app_data = data
             update_segment_name
           else
-            NewRelic::Agent.logger.debug("External segment response has invalid cross_app_id")
+            NewRelic::Agent.logger.debug('External segment response has invalid cross_app_id')
           end
         rescue => e
-          NewRelic::Agent.logger.error("Error in read_response_headers", e)
+          NewRelic::Agent.logger.error('Error in read_response_headers', e)
         end
 
         def cross_app_request? # :nodoc:
@@ -154,7 +154,7 @@ module NewRelic
 
           end
         rescue => e
-          NewRelic::Agent.logger.error("error during get_request_metadata", e)
+          NewRelic::Agent.logger.error('error during get_request_metadata', e)
         end
 
         # Process obfuscated +String+ sent from a called application that is also running a New Relic agent and
@@ -176,13 +176,13 @@ module NewRelic
               @app_data = app_data
               update_segment_name
             else
-              NewRelic::Agent.logger.error("error processing response metadata: invalid/non-trusted ID")
+              NewRelic::Agent.logger.error('error processing response metadata: invalid/non-trusted ID')
             end
           end
 
           nil
         rescue => e
-          NewRelic::Agent.logger.error("error during process_response_metadata", e)
+          NewRelic::Agent.logger.error('error during process_response_metadata', e)
         end
 
         def record_metrics

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

@@ -91,7 +91,7 @@ module NewRelic
             transaction.distributed_tracer.log_request_headers(headers)
           end
         rescue => e
-          NewRelic::Agent.logger.error("Error during message header processing", e)
+          NewRelic::Agent.logger.error('Error during message header processing', e)
         end
       end
     end

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

@@ -11,7 +11,7 @@ module NewRelic
         attr_reader :request_path, :referer, :accept, :content_length, :content_type,
           :host, :port, :user_agent, :request_method
 
-        HTTP_ACCEPT_HEADER_KEY = "HTTP_ACCEPT".freeze
+        HTTP_ACCEPT_HEADER_KEY = 'HTTP_ACCEPT'.freeze
 
         def initialize(request)
           @request_path = path_from_request(request)
@@ -85,7 +85,7 @@ module NewRelic
         # rails construct the PATH_INFO enviroment variable improperly and we're generally
         # being defensive.
 
-        ROOT_PATH = "/".freeze
+        ROOT_PATH = '/'.freeze
 
         def path_from_request(request)
           path = attribute_from_request(request, :path) || ''

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

@@ -32,7 +32,7 @@ module NewRelic
           if segment = NewRelic::Agent::Tracer.current_segment
             segment.merge_untrusted_agent_attributes(attributes, prefix, default_destinations)
           else
-            NewRelic::Agent.logger.debug("Attempted to merge untrusted attributes without segment")
+            NewRelic::Agent.logger.debug('Attempted to merge untrusted attributes without segment')
           end
         end
 

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

@@ -13,7 +13,7 @@ module NewRelic
         end
 
         def allow_sample?(sample)
-          sample.synthetics_resource_id != nil
+          !sample.synthetics_resource_id.nil?
         end
 
         def truncate_samples

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

@@ -14,7 +14,7 @@ module NewRelic
         attr_accessor :transaction_name, :guid, :attributes,
           :node_count, :finished, :threshold, :profile
 
-        ROOT = "ROOT".freeze
+        ROOT = 'ROOT'.freeze
 
         def initialize(start_time)
           @start_time = start_time

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

@@ -20,7 +20,7 @@ module NewRelic
           end
         end
 
-        SUPPORTABILITY_PREFIX = "Supportability/TraceContext"
+        SUPPORTABILITY_PREFIX = 'Supportability/TraceContext'
         CREATE_PREFIX = "#{SUPPORTABILITY_PREFIX}/Create"
         ACCEPT_PREFIX = "#{SUPPORTABILITY_PREFIX}/Accept"
         TRACESTATE_PREFIX = "#{SUPPORTABILITY_PREFIX}/TraceState"
@@ -73,7 +73,7 @@ module NewRelic
           true
         rescue Exception => e
           NewRelic::Agent.increment_metric(CREATE_EXCEPTION_METRIC)
-          NewRelic::Agent.logger.warn("Failed to create trace context payload", e)
+          NewRelic::Agent.logger.warn('Failed to create trace context payload', e)
           false
         end
 
@@ -95,7 +95,7 @@ module NewRelic
 
         def create_trace_state_payload
           unless Agent.config[:'distributed_tracing.enabled']
-            NewRelic::Agent.logger.warn("Not configured to create WC3 trace context payload")
+            NewRelic::Agent.logger.warn('Not configured to create WC3 trace context payload')
             return
           end
 
@@ -144,7 +144,7 @@ module NewRelic
           true
         rescue => e
           NewRelic::Agent.increment_metric(ACCEPT_EXCEPTION_METRIC)
-          NewRelic::Agent.logger.warn("Failed to accept trace context payload", e)
+          NewRelic::Agent.logger.warn('Failed to accept trace context payload', e)
           false
         end
 

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

@@ -58,7 +58,7 @@ module NewRelic
         end
 
         def to_s_compact
-          str = String.new('')
+          str = +''
           str << metric_name
           if children.any?
             str << "{#{children.map { |cs| cs.to_s_compact }.join(',')}}"
@@ -67,9 +67,9 @@ module NewRelic
         end
 
         def to_debug_str(depth)
-          tab = String.new('  ') * depth
+          tab = (+'  ') * depth
           s = tab.clone
-          s << ">> #{'%3i ms' % (@entry_timestamp * 1000)} [#{self.class.name.split("::").last}] #{metric_name} \n"
+          s << ">> #{'%3i ms' % (@entry_timestamp * 1000)} [#{self.class.name.split('::').last}] #{metric_name} \n"
           unless params.empty?
             params.each do |k, v|
               s << "#{tab}    -#{'%-16s' % k}: #{v.to_s[0..80]}\n"
@@ -136,10 +136,8 @@ module NewRelic
         def each_node(&block)
           yield(self)
 
-          if @children
-            @children.each do |node|
-              node.each_node(&block)
-            end
+          @children&.each do |node|
+            node.each_node(&block)
           end
         end
 
@@ -149,11 +147,14 @@ module NewRelic
           summary = yield(self)
           summary.current_nest_count += 1 if summary
 
+          # no then branch coverage
+          # rubocop:disable Style/SafeNavigation
           if @children
             @children.each do |node|
               node.each_node_with_nest_tracking(&block)
             end
           end
+          # rubocop:enable Style/SafeNavigation
 
           summary.current_nest_count -= 1 if summary
         end

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

@@ -29,6 +29,12 @@ module NewRelic
           else
             segment.record_on_finish = true
             ::NewRelic::Agent.logger.debug("Segment limit of #{segment_limit} reached, ceasing collection.")
+
+            if finished?
+              ::NewRelic::Agent.logger.debug("Transaction #{best_name} has finished but segments still being created, resetting state.")
+              NewRelic::Agent::Tracer.state.reset
+              NewRelic::Agent.record_metric('Supportability/Transaction/SegmentLimitReachedAfterFinished/ResetState', 1)
+            end
           end
           segment.transaction_assigned
         end
@@ -52,8 +58,8 @@ module NewRelic
           segments.each { |s| s.finalize }
         end
 
-        WEB_TRANSACTION_TOTAL_TIME = "WebTransactionTotalTime".freeze
-        OTHER_TRANSACTION_TOTAL_TIME = "OtherTransactionTotalTime".freeze
+        WEB_TRANSACTION_TOTAL_TIME = 'WebTransactionTotalTime'.freeze
+        OTHER_TRANSACTION_TOTAL_TIME = 'OtherTransactionTotalTime'.freeze
 
         def record_total_time_metrics
           total_time_metric = if recording_web_transaction?

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

@@ -63,7 +63,7 @@ module NewRelic
         #
         # This value will be forcibly capped by the max_capacity
         def capacity
-          raise NotImplementedError.new("TransactionSampleBuffer subclasses must provide a capacity override")
+          raise NotImplementedError.new('TransactionSampleBuffer subclasses must provide a capacity override')
         end
 
         # Apply hard upper limit to the capacity to prevent users from