newrelic_rpm 8.15.0 → 9.6.0

data/lib/new_relic/agent/stats.rb

@@ -118,7 +118,7 @@ module NewRelic
       def inspect_full
         variables = instance_variables.map do |ivar|
           "#{ivar.to_s}=#{instance_variable_get(ivar).inspect}"
-        end.join(" ")
+        end.join(' ')
         "#<NewRelic::Agent::Stats #{variables}>"
       end
 

data/lib/new_relic/agent/synthetics_event_aggregator.rb

@@ -37,7 +37,7 @@ module NewRelic
         NewRelic::Agent.logger.debug("Synthetics transaction event limit (#{metadata[:capacity]}) reached. Further synthetics events this harvest period dropped.")
 
         engine = NewRelic::Agent.instance.stats_engine
-        engine.tl_record_supportability_metric_count("SyntheticsEventAggregator/synthetics_events_dropped", num_dropped)
+        engine.tl_record_supportability_metric_count('SyntheticsEventAggregator/synthetics_events_dropped', num_dropped)
       end
     end
   end

data/lib/new_relic/agent/system_info.rb

@@ -13,6 +13,8 @@ require 'socket'
 module NewRelic
   module Agent
     module SystemInfo
+      DOCKER_CGROUPS_V2_PATTERN = %r{.*/docker/containers/([0-9a-f]{64})/.*}.freeze
+
       def self.ruby_os_identifier
         RbConfig::CONFIG['target_os']
       end
@@ -128,7 +130,7 @@ module NewRelic
 
         num_physical_packages = cores.keys.map(&:first).uniq.size
         num_physical_cores = cores.size
-        num_logical_processors = cores.values.reduce(0, :+)
+        num_logical_processors = cores.values.sum
 
         if num_physical_cores == 0
           num_logical_processors = total_processors
@@ -172,15 +174,39 @@ module NewRelic
         proc_try_read('/proc/version')
       end
 
+      # When operating within a Docker container, attempt to obtain the
+      # container id.
+      #
+      # First look for `/proc/self/mountinfo` to exist on disk to signify
+      # cgroups v2. If that file exists, read it and expect it to contain one
+      # or more "/docker/containers/<container_id>/" lines from which the
+      # container id can be gleaned.
+      #
+      # Next look for `/proc/self/cgroup` to exist on disk to signify cgroup v1.
+      # If that file exists, read it and parse the "cpu" group info in the hope
+      # of finding a 64 character container id value.
+      #
+      # For non-cgroups based containers, use a `nil` value for the container
+      # id without generating any warnings or errors.
       def self.docker_container_id
         return unless ruby_os_identifier.include?('linux')
 
+        cgroupsv2_based_id = docker_container_id_for_cgroupsv2
+        return cgroupsv2_based_id if cgroupsv2_based_id
+
         cgroup_info = proc_try_read('/proc/self/cgroup')
         return unless cgroup_info
 
         parse_docker_container_id(cgroup_info)
       end
 
+      def self.docker_container_id_for_cgroupsv2
+        mountinfo = proc_try_read('/proc/self/mountinfo')
+        return unless mountinfo
+
+        Regexp.last_match(1) if mountinfo =~ DOCKER_CGROUPS_V2_PATTERN
+      end
+
       def self.parse_docker_container_id(cgroup_info)
         cpu_cgroup = parse_cgroup_ids(cgroup_info)['cpu']
         return unless cpu_cgroup
@@ -202,7 +228,7 @@ module NewRelic
           return
         when /docker/
           ::NewRelic::Agent.logger.debug("Cgroup indicates docker but container_id unrecognized: '#{cpu_cgroup}'")
-          ::NewRelic::Agent.increment_metric("Supportability/utilization/docker/error")
+          ::NewRelic::Agent.increment_metric('Supportability/utilization/docker/error')
           return
         else
           ::NewRelic::Agent.logger.debug("Ignoring unrecognized cgroup ID format: '#{cpu_cgroup}'")
@@ -211,7 +237,7 @@ module NewRelic
 
         if container_id && container_id.size != 64
           ::NewRelic::Agent.logger.debug("Found docker container_id with invalid length: #{container_id}")
-          ::NewRelic::Agent.increment_metric("Supportability/utilization/docker/error")
+          ::NewRelic::Agent.increment_metric('Supportability/utilization/docker/error')
           nil
         else
           container_id
@@ -242,7 +268,7 @@ module NewRelic
       def self.proc_try_read(path)
         return nil unless File.exist?(path)
 
-        content = String.new('')
+        content = +''
         File.open(path) do |f|
           loop do
             begin
@@ -289,8 +315,8 @@ module NewRelic
 
           if bid.ascii_only?
             if bid.empty?
-              ::NewRelic::Agent.logger.debug("boot_id not found in /proc/sys/kernel/random/boot_id")
-              ::NewRelic::Agent.increment_metric("Supportability/utilization/boot_id/error")
+              ::NewRelic::Agent.logger.debug('boot_id not found in /proc/sys/kernel/random/boot_id')
+              ::NewRelic::Agent.increment_metric('Supportability/utilization/boot_id/error')
               nil
 
             elsif bid.bytesize == 36
@@ -298,19 +324,19 @@ module NewRelic
 
             else
               ::NewRelic::Agent.logger.debug("Found boot_id with invalid length: #{bid}")
-              ::NewRelic::Agent.increment_metric("Supportability/utilization/boot_id/error")
+              ::NewRelic::Agent.increment_metric('Supportability/utilization/boot_id/error')
               bid[0, 128]
 
             end
           else
             ::NewRelic::Agent.logger.debug("Found boot_id with non-ASCII characters: #{bid}")
-            ::NewRelic::Agent.increment_metric("Supportability/utilization/boot_id/error")
+            ::NewRelic::Agent.increment_metric('Supportability/utilization/boot_id/error')
             nil
 
           end
         else
-          ::NewRelic::Agent.logger.debug("boot_id not found in /proc/sys/kernel/random/boot_id")
-          ::NewRelic::Agent.increment_metric("Supportability/utilization/boot_id/error")
+          ::NewRelic::Agent.logger.debug('boot_id not found in /proc/sys/kernel/random/boot_id')
+          ::NewRelic::Agent.increment_metric('Supportability/utilization/boot_id/error')
           nil
 
         end

data/lib/new_relic/agent/threading/agent_thread.rb

@@ -45,7 +45,7 @@ module NewRelic
 
             if txn && !txn.recording_web_transaction?
               :background
-            elsif txn && txn.recording_web_transaction?
+            elsif txn&.recording_web_transaction?
               :request
             else
               :other

data/lib/new_relic/agent/threading/backtrace_node.rb

@@ -70,7 +70,7 @@ module NewRelic
         end
 
         def dump_string
-          result = String.new("#<BacktraceRoot:#{object_id}>")
+          result = +"#<BacktraceRoot:#{object_id}>"
           child_results = @children.map { |c| c.dump_string(2) }.join("\n")
           result << "\n" unless child_results.empty?
           result << child_results
@@ -116,8 +116,8 @@ module NewRelic
         def dump_string(indent = 0)
           @file, @method, @line_no = parse_backtrace_frame(@raw_line)
           indentation = ' ' * indent
-          result = String.new("#{indentation}#<BacktraceNode:#{object_id} ) + \
-                              [#{@runnable_count}] #{@file}:#{@line_no} in #{@method}>")
+          result = +"#{indentation}#<BacktraceNode:#{object_id} ) + \
+                              [#{@runnable_count}] #{@file}:#{@line_no} in #{@method}>"
           child_results = @children.map { |c| c.dump_string(indent + 2) }.join("\n")
           result << "\n" unless child_results.empty?
           result << child_results

data/lib/new_relic/agent/threading/backtrace_service.rb

@@ -6,7 +6,7 @@ module NewRelic
   module Agent
     module Threading
       class BacktraceService
-        ALL_TRANSACTIONS = "**ALL**".freeze
+        ALL_TRANSACTIONS = '**ALL**'.freeze
 
         def self.is_supported?
           !is_resque?
@@ -41,9 +41,7 @@ module NewRelic
             @overhead_percent_threshold = new_value
           end
 
-          if event_listener
-            event_listener.subscribe(:transaction_finished, &method(:on_transaction_finished))
-          end
+          event_listener&.subscribe(:transaction_finished, &method(:on_transaction_finished))
         end
 
         # Public interface
@@ -221,9 +219,7 @@ module NewRelic
 
         # This method is expected to be called with @lock held.
         def aggregate_global_backtrace(backtrace, bucket, thread)
-          if @profiles[ALL_TRANSACTIONS]
-            @profiles[ALL_TRANSACTIONS].aggregate(backtrace, bucket, thread)
-          end
+          @profiles[ALL_TRANSACTIONS]&.aggregate(backtrace, bucket, thread)
         end
 
         # This method is expected to be called with @lock held.

data/lib/new_relic/agent/threading/thread_profile.rb

@@ -72,7 +72,7 @@ module NewRelic
           all_nodes = @traces.values.map { |n| n.flattened }.flatten
 
           NewRelic::Agent.instance.stats_engine
-            .tl_record_supportability_metric_count("ThreadProfiler/NodeCount", all_nodes.size)
+            .tl_record_supportability_metric_count('ThreadProfiler/NodeCount', all_nodes.size)
 
           all_nodes.sort! do |a, b|
             # we primarily prefer higher runnable_count
@@ -103,10 +103,10 @@ module NewRelic
           convert_N_trace_nodes_to_arrays(THREAD_PROFILER_NODES)
 
           {
-            "OTHER" => @traces[:other].as_array,
-            "REQUEST" => @traces[:request].as_array,
-            "AGENT" => @traces[:agent].as_array,
-            "BACKGROUND" => @traces[:background].as_array
+            'OTHER' => @traces[:other].as_array,
+            'REQUEST' => @traces[:request].as_array,
+            'AGENT' => @traces[:agent].as_array,
+            'BACKGROUND' => @traces[:background].as_array
           }
         end
 

data/lib/new_relic/agent/timestamp_sampled_buffer.rb

@@ -7,7 +7,7 @@ require 'new_relic/agent/heap'
 module NewRelic
   module Agent
     class TimestampSampledBuffer < PrioritySampledBuffer
-      TIMESTAMP_KEY = "timestamp".freeze
+      TIMESTAMP_KEY = 'timestamp'.freeze
 
       private
 

data/lib/new_relic/agent/tracer.rb

@@ -66,9 +66,10 @@ module NewRelic
         #
         # @api public
         def transaction_sampled?
-          if txn = current_transaction
-            txn.sampled?
-          end
+          txn = current_transaction
+          return false unless txn
+
+          txn.sampled?
         end
         alias_method :sampled?, :transaction_sampled?
 
@@ -107,7 +108,7 @@ module NewRelic
             current_transaction.notice_error(exception)
             raise
           ensure
-            finishable.finish if finishable
+            finishable&.finish
           end
         end
 
@@ -246,8 +247,8 @@ module NewRelic
           log_error('start_segment', exception)
         end
 
-        UNKNOWN = "Unknown".freeze
-        OTHER = "other".freeze
+        UNKNOWN = 'Unknown'.freeze
+        OTHER = 'other'.freeze
 
         # Creates and starts a datastore segment used to time
         # datastore operations.
@@ -355,9 +356,8 @@ module NewRelic
 
           yield
         rescue => exception
-          if segment && segment.is_a?(Transaction::AbstractSegment)
-            segment.notice_error(exception)
-          end
+          # needs else branch coverage
+          segment.notice_error(exception) if segment&.is_a?(Transaction::AbstractSegment)
           raise
         end
 
@@ -410,12 +410,22 @@ module NewRelic
 
         alias_method :tl_clear, :clear_state
 
-        def thread_block_with_current_transaction(*args, segment_name:, parent: nil, &block)
-          current_txn = ::Thread.current[:newrelic_tracer_state].current_transaction if ::Thread.current[:newrelic_tracer_state] && ::Thread.current[:newrelic_tracer_state].is_execution_traced?
-          proc do
+        def current_segment_key
+          ::Fiber.current.object_id
+        end
+
+        def thread_tracing_enabled?
+          NewRelic::Agent.config[:'instrumentation.thread.tracing']
+        end
+
+        def thread_block_with_current_transaction(segment_name:, parent: nil, &block)
+          parent ||= current_segment
+          current_txn = ::Thread.current[:newrelic_tracer_state]&.current_transaction if ::Thread.current[:newrelic_tracer_state]&.is_execution_traced?
+          proc do |*args|
             begin
-              if current_txn
+              if current_txn && !current_txn.finished?
                 NewRelic::Agent::Tracer.state.current_transaction = current_txn
+                current_txn.async = true
                 segment_name += "/Thread#{::Thread.current.object_id}/Fiber#{::Fiber.current.object_id}" if NewRelic::Agent.config[:'thread_ids_enabled']
                 segment = NewRelic::Agent::Tracer.start_segment(name: segment_name, parent: parent)
               end
@@ -478,7 +488,8 @@ module NewRelic
         end
 
         def pop_traced
-          @untraced.pop if @untraced
+          # needs else branch coverage
+          @untraced.pop if @untraced # rubocop:disable Style/SafeNavigation
         end
 
         def is_execution_traced?
@@ -498,7 +509,5 @@ module NewRelic
         attr_accessor :sql_sampler_transaction_data
       end
     end
-
-    TransactionState = Tracer
   end
 end

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
@@ -20,14 +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, :starting_thread_id
+        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
 
+        CALLBACK = :@callback
+        SEGMENT = 'segment'
+
         def initialize(name = nil, start_time = nil)
           @name = name
-          @starting_thread_id = ::Thread.current.object_id
+          @starting_segment_key = NewRelic::Agent::Tracer.current_segment_key
           @transaction_name = nil
           @transaction = nil
           @guid = NewRelic::Agent::GuidGenerator.generate_guid
@@ -50,13 +52,14 @@ module NewRelic
           @code_function = nil
           @code_lineno = nil
           @code_namespace = nil
+          invoke_callback
         end
 
         def start
           @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 +108,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 +199,7 @@ module NewRelic
 
           if finished?
             transaction.async = true
-            parent.descendant_complete(self, segment) if parent
+            parent&.descendant_complete(self, segment)
           end
         end
 
@@ -262,19 +233,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 +270,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 +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
@@ -321,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

@@ -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)