newrelic_rpm 6.15.0 → 9.7.1

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

@@ -1,17 +1,16 @@
-# 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/range_extensions'
 require 'new_relic/agent/guid_generator'
 
 module NewRelic
   module Agent
     class Transaction
       class AbstractSegment
-        # This class is the base class for all segments. It is reponsible for
+        # This class is the base class for all segments. It is responsible for
         # timing, naming, and defining lifecycle callbacks. One of the more
-        # complex responsibilites of this class is computing exclusive duration.
+        # complex responsibilities of this class is computing exclusive duration.
         # One of the reasons for this complexity is that exclusive time will be
         # computed using time ranges or by recording an aggregate value for
         # a segments children time. The reason for this is that computing
@@ -20,13 +19,17 @@ module NewRelic
         # after its parent. We will use the optimized exclusive duration
         # calculation in all other cases.
         #
-        attr_reader :start_time, :end_time, :duration, :exclusive_duration, :guid
+        attr_reader :start_time, :end_time, :duration, :exclusive_duration, :guid, :starting_segment_key
         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
+        CALLBACK = :@callback
+        SEGMENT = 'segment'
+
+        def initialize(name = nil, start_time = nil)
           @name = name
+          @starting_segment_key = NewRelic::Agent::Tracer.current_segment_key
           @transaction_name = nil
           @transaction = nil
           @guid = NewRelic::Agent::GuidGenerator.generate_guid
@@ -36,8 +39,8 @@ module NewRelic
           @end_time = nil
           @duration = 0.0
           @exclusive_duration = 0.0
+          @children_timings = []
           @children_time = 0.0
-          @children_time_ranges = nil
           @active_children = 0
           @range_recorded = false
           @concurrent_children = false
@@ -45,22 +48,30 @@ module NewRelic
           @record_scoped_metric = true
           @record_on_finish = false
           @noticed_error = nil
+          @code_filepath = nil
+          @code_function = nil
+          @code_lineno = nil
+          @code_namespace = nil
+          invoke_callback
         end
 
         def start
-          @start_time ||= Time.now
+          @start_time ||= Process.clock_gettime(Process::CLOCK_REALTIME)
           return unless transaction
-          parent.child_start self if parent
+
+          parent&.child_start(self)
         end
 
         def finish
-          @end_time = Time.now
-          @duration = end_time.to_f - start_time.to_f
+          @end_time = Process.clock_gettime(Process::CLOCK_REALTIME)
+          @duration = end_time - start_time
+
           return unless transaction
+
           run_complete_callbacks
           finalize if record_on_finish?
         rescue => e
-          NewRelic::Agent.logger.error "Exception finishing segment: #{name}", e
+          NewRelic::Agent.logger.error("Exception finishing segment: #{name}", e)
         end
 
         def finished?
@@ -94,21 +105,39 @@ module NewRelic
         end
 
         def time_range
-          @start_time.to_f .. @end_time.to_f
-        end
-
-        def children_time_ranges
-          @children_time_ranges ||= []
+          @start_time.to_f..@end_time.to_f
         end
 
         def children_time_ranges?
-          !!@children_time_ranges
+          !@children_timings.empty?
         end
 
         def concurrent_children?
           @concurrent_children
         end
 
+        def code_information=(info = {})
+          return unless info[:filepath]
+
+          @code_filepath = info[:filepath]
+          @code_function = info[:function]
+          @code_lineno = info[:lineno]
+          @code_namespace = info[:namespace]
+        end
+
+        def all_code_information_present?
+          @code_filepath && @code_function && @code_lineno && @code_namespace
+        end
+
+        def code_attributes
+          return ::NewRelic::EMPTY_HASH unless all_code_information_present?
+
+          @code_attributes ||= {'code.filepath' => @code_filepath,
+                                'code.function' => @code_function,
+                                'code.lineno' => @code_lineno,
+                                'code.namespace' => @code_namespace}
+        end
+
         INSPECT_IGNORE = [:@transaction, :@transaction_state].freeze
 
         def inspect
@@ -122,27 +151,30 @@ module NewRelic
         def transaction_assigned
         end
 
-        def set_noticed_error noticed_error
+        def set_noticed_error(noticed_error)
           if @noticed_error
-            NewRelic::Agent.logger.debug \
+            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={}
+        def notice_error(exception, options = {})
           if Agent.config[:high_security]
-            NewRelic::Agent.logger.debug \
+            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
+            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
 
@@ -154,20 +186,20 @@ module NewRelic
           @range_recorded
         end
 
-        def child_start segment
+        def child_start(segment)
           @active_children += 1
-          @concurrent_children = @concurrent_children || @active_children > 1
+          @concurrent_children ||= @active_children > 1
 
           transaction.async = true if @concurrent_children
         end
 
-        def child_complete segment
+        def child_complete(segment)
           @active_children -= 1
-          record_child_time segment
+          record_child_time(segment)
 
           if finished?
             transaction.async = true
-            parent.descendant_complete(self, segment) if parent
+            parent&.descendant_complete(self, segment)
           end
         end
 
@@ -177,71 +209,67 @@ module NewRelic
         # an ancestor whose end time is greater than or equal to the descendant's
         # we can stop the propagation. We pass along the direct child so we can
         # make any corrections needed for exclusive time calculation.
+        def descendant_complete(child, descendant)
+          add_child_timing(descendant)
 
-        def descendant_complete child, descendant
-          RangeExtensions.merge_or_append descendant.time_range,
-                                            children_time_ranges
           # If this child's time was previously added to this segment's
           # aggregate children time, we need to re-record it using a time range
           # for proper exclusive time calculation
           unless child.range_recorded?
             self.children_time -= child.duration
-            record_child_time_as_range child
+            record_child_time_as_range(child)
           end
 
           if parent && finished? && descendant.end_time >= end_time
-            parent.descendant_complete self, descendant
+            parent.descendant_complete(self, descendant)
           end
         end
 
         private
 
+        def add_child_timing(segment)
+          @children_timings << [segment.start_time, segment.end_time]
+        end
+
         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
-          transaction.segment_complete self
+          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
         def segment_complete
         end
 
-        def record_child_time child
+        def record_child_time(child)
           if concurrent_children? || finished? && end_time < child.end_time
-            record_child_time_as_range child
+            record_child_time_as_range(child)
           else
-            record_child_time_as_number child
+            record_child_time_as_number(child)
           end
         end
 
-        def record_child_time_as_range child
-          RangeExtensions.merge_or_append child.time_range,
-                                          children_time_ranges
+        def record_child_time_as_range(child)
+          add_child_timing(child)
           child.range_recorded = true
         end
 
-        def record_child_time_as_number child
+        def record_child_time_as_number(child)
           self.children_time += child.duration
         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?
@@ -251,6 +279,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
@@ -258,6 +331,57 @@ module NewRelic
             Tracer.state
           end
         end
+
+        # for segment callback usage info, see self.set_segment_callback
+        def invoke_callback
+          return unless self.class.instance_variable_defined?(CALLBACK)
+
+          NewRelic::Agent.logger.debug("Invoking callback for #{self.class.name}...")
+          self.class.instance_variable_get(CALLBACK).call
+        rescue Exception => e
+          NewRelic::Agent.logger.error("Error encountered while invoking callback for #{self.class.name}: " +
+                                       "#{e.class} - #{e.message}")
+        end
+
+        # Setting and invoking a segment callback
+        # =======================================
+        # Each individual segment class such as `ExternalRequestSegment` allows
+        # for exactly one instance of a `Proc` (meaning a proc or lambda) to be
+        # set as a callback. A callback can be set on a segment class by calling
+        # `.set_segment_callback` with a proc or lambda as the only argument.
+        # If set, the callback will be invoked with `#call` at segment class
+        # initialization time.
+        #
+        # Example usage:
+        #   callback = -> { puts 'Hello, World! }
+        #   ExternalRequestSegment.set_segment_callback(callback)
+        #   ExternalRequestSegment.new(library, uri, procedure)
+        #
+        # A callback set on a segment class will only be called when that
+        # specific segment class is initialized. Other segment classes will not
+        # be impacted.
+        #
+        # Great caution should be taken in the defining of the callback block
+        # to not have the block perform anything too time consuming or resource
+        # intensive in order to keep the New Relic Ruby agent operating
+        # normally.
+        #
+        # Given that callbacks are user defined, they must be set entirely at
+        # the user's own risk. It is recommended that each callback use
+        # conditional logic that only performs work for certain qualified
+        # segments. It is recommended that each callback be thoroughly tested
+        # in non-production environments before being introduced to production
+        # environments.
+        def self.set_segment_callback(callback_proc)
+          unless callback_proc.is_a?(Proc)
+            NewRelic::Agent.logger.error("#{self}.#{__method__}: expected an argument of type Proc, " \
+                                         "got #{callback_proc.class}")
+            return
+          end
+
+          NewRelic::Agent.record_api_supportability_metric(:set_segment_callback)
+          instance_variable_set(CALLBACK, callback_proc)
+        end
       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/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 require 'new_relic/agent/transaction/segment'
 require 'new_relic/agent/datastores/metric_helper'
@@ -11,33 +11,31 @@ module NewRelic
   module Agent
     class Transaction
       class DatastoreSegment < Segment
-
         UNKNOWN = 'unknown'.freeze
 
         attr_reader :product, :operation, :collection, :sql_statement, :nosql_statement, :host, :port_path_or_id
         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
+        def initialize(product, operation, collection = nil, host = nil, port_path_or_id = nil, database_name = nil, start_time = nil)
           @product = product
           @operation = operation
           @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),
+          set_instance_info(host, port_path_or_id)
+          @database_name = database_name&.to_s
+          super(Datastores::MetricHelper.scoped_metric_for(product, operation, collection),
                 nil,
-                start_time
+                start_time)
         end
 
-        def set_instance_info host = nil, port_path_or_id = nil
+        def set_instance_info(host = nil, port_path_or_id = nil)
           port_path_or_id = port_path_or_id.to_s if port_path_or_id
           host_present = host && !host.empty?
           ppi_present = port_path_or_id && !port_path_or_id.empty?
 
-          host = NewRelic::Agent::Hostname.get_external host if host_present
+          host = NewRelic::Agent::Hostname.get_external(host) if host_present
 
           case
           when host_present && ppi_present
@@ -57,15 +55,16 @@ module NewRelic
           end
         end
 
-        def notice_sql sql
-          _notice_sql sql
+        def notice_sql(sql)
+          _notice_sql(sql)
           nil
         end
 
         # @api private
-        def _notice_sql sql, config=nil, explainer=nil, binds=nil, name=nil
+        def _notice_sql(sql, config = nil, explainer = nil, binds = nil, name = nil)
           return unless record_sql?
-          @sql_statement = Database::Statement.new sql, config, explainer, binds, name, host, port_path_or_id, database_name
+
+          @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
@@ -85,8 +84,9 @@ module NewRelic
         #   please ensure all data passed to this method is safe to transmit to
         #   New Relic.
 
-        def notice_nosql_statement nosql_statement
+        def notice_nosql_statement(nosql_statement)
           return unless record_sql?
+
           @nosql_statement = Database.truncate_query(nosql_statement)
           nil
         end
@@ -120,8 +120,9 @@ module NewRelic
         NEWLINE = "\n".freeze
 
         def add_backtrace_parameter
-           return unless duration >= Agent.config[:'transaction_tracer.stack_trace_threshold']
-           params[:backtrace] = caller.join(NEWLINE)
+          return unless duration >= Agent.config[:'transaction_tracer.stack_trace_threshold']
+
+          params[:backtrace] = caller.join(NEWLINE)
         end
 
         def notice_sql_statement
@@ -138,8 +139,11 @@ module NewRelic
         end
 
         def record_span_event
+          # don't record a span event if the transaction is ignored
+          return if transaction.ignore?
+
           aggregator = ::NewRelic::Agent.agent.span_event_aggregator
-          priority   = transaction.priority
+          priority = transaction.priority
 
           aggregator.record(priority: priority) do
             SpanEventPrimitive.for_datastore_segment(self)