newrelic_rpm 9.17.0 → 9.21.0

data/lib/new_relic/agent/tracer.rb

@@ -247,7 +247,7 @@ module NewRelic
           log_error('start_segment', exception)
         end
 
-        UNKNOWN = 'Unknown'.freeze
+        UNKNOWN = NewRelic::UNKNOWN
         OTHER = 'other'.freeze
 
         # Creates and starts a datastore segment used to time

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

@@ -19,7 +19,7 @@ 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_segment_key
+        attr_reader :start_time, :end_time, :duration, :exclusive_duration, :guid, :starting_segment_key, :thread_id
         attr_accessor :name, :parent, :children_time, :transaction, :transaction_name, :llm_event
         attr_writer :record_metrics, :record_scoped_metric, :record_on_finish
         attr_reader :noticed_error
@@ -30,6 +30,7 @@ module NewRelic
         def initialize(name = nil, start_time = nil)
           @name = name
           @starting_segment_key = NewRelic::Agent::Tracer.current_segment_key
+          @thread_id = Thread.current.object_id
           @transaction_name = nil
           @transaction = nil
           @guid = NewRelic::Agent::GuidGenerator.generate_guid

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

@@ -11,7 +11,7 @@ module NewRelic
   module Agent
     class Transaction
       class DatastoreSegment < Segment
-        UNKNOWN = 'unknown'.freeze
+        UNKNOWN = NewRelic::UNKNOWN_LOWER
 
         attr_reader :product, :operation, :collection, :sql_statement, :nosql_statement, :host, :port_path_or_id
         attr_accessor :database_name, :record_sql

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 ||= NewRelic::UNKNOWN
         end
 
         def accept_transport_type_from_api(value)
@@ -127,7 +127,7 @@ module NewRelic
         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
+              incoming_payload = ::JSON.parse(deobfuscate(synthetics_header)) and
               SyntheticsMonitor.is_valid_payload?(incoming_payload) and
               SyntheticsMonitor.is_supported_version?(incoming_payload) and
               SyntheticsMonitor.is_trusted?(incoming_payload)
@@ -167,7 +167,7 @@ module NewRelic
           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))
+          txn_info = ::JSON.parse(deobfuscate(txn_header))
           payload = CrossAppPayload.new(decoded_id, transaction, txn_info)
 
           @cross_app_payload = payload

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

@@ -18,7 +18,7 @@ module NewRelic
         STREAM = 'Stream'.freeze
         TEMP = 'Temp'.freeze
         TOPIC = 'Topic'.freeze
-        UNKNOWN = 'Unknown'.freeze
+        UNKNOWN = NewRelic::UNKNOWN
 
         DESTINATION_TYPES = [
           :exchange,

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

@@ -43,12 +43,7 @@ module NewRelic
           end
 
           if request_path
-            destinations = if allow_other_headers?
-              default_destinations
-            else
-              AttributeFilter::DST_TRANSACTION_TRACER | AttributeFilter::DST_ERROR_COLLECTOR
-            end
-            txn.add_agent_attribute(:'request.uri', request_path, destinations)
+            txn.add_agent_attribute(:'request.uri', request_path, default_destinations)
           end
 
           if accept

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

@@ -136,10 +136,8 @@ module NewRelic
 
           transaction.distributed_tracer.parent_transaction_id = payload.transaction_id
 
-          unless payload.sampled.nil?
-            transaction.sampled = payload.sampled
-            transaction.priority = payload.priority if payload.priority
-          end
+          determine_sampling_decision(payload, header_data.trace_parent['trace_flags'])
+
           NewRelic::Agent.increment_metric(ACCEPT_SUCCESS_METRIC)
           true
         rescue => e
@@ -148,6 +146,37 @@ module NewRelic
           false
         end
 
+        def determine_sampling_decision(payload, trace_flags)
+          if trace_flags == '01'
+            set_priority_and_sampled(NewRelic::Agent.config[:'distributed_tracing.sampler.remote_parent_sampled'], payload)
+          elsif trace_flags == '00'
+            set_priority_and_sampled(NewRelic::Agent.config[:'distributed_tracing.sampler.remote_parent_not_sampled'], payload)
+          else
+            use_nr_tracestate_sampled(payload)
+          end
+        rescue
+          use_nr_tracestate_sampled(payload)
+        end
+
+        def use_nr_tracestate_sampled(payload)
+          unless payload.sampled.nil?
+            transaction.sampled = payload.sampled
+            transaction.priority = payload.priority if payload.priority
+          end
+        end
+
+        def set_priority_and_sampled(config, payload)
+          if config == 'always_on'
+            transaction.sampled = true
+            transaction.priority = 2.0
+          elsif config == 'always_off'
+            transaction.sampled = false
+            transaction.priority = 0
+          else # default
+            use_nr_tracestate_sampled(payload)
+          end
+        end
+
         def ignore_trace_context?
           if trace_context_header_data
             NewRelic::Agent.increment_metric(IGNORE_MULTIPLE_ACCEPT_METRIC)

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

@@ -25,7 +25,7 @@ module NewRelic
           segment.parent = parent || thread_starting_span || current_segment
           set_current_segment(segment)
           if @segments.length < segment_limit
-            @segments << segment
+            @segment_lock.synchronize { @segments << segment }
           else
             segment.record_on_finish = true
             ::NewRelic::Agent.logger.debug("Segment limit of #{segment_limit} reached, ceasing collection.")
@@ -51,7 +51,7 @@ module NewRelic
 
         def segment_complete(segment)
           # if parent was in another thread, remove the current_segment entry for this thread
-          if segment.parent && segment.parent.starting_segment_key != NewRelic::Agent::Tracer.current_segment_key
+          if segment.parent&.starting_segment_key != NewRelic::Agent::Tracer.current_segment_key
             remove_current_segment_by_thread_id(NewRelic::Agent::Tracer.current_segment_key)
           else
             set_current_segment(segment.parent)
@@ -65,7 +65,7 @@ module NewRelic
         private
 
         def finalize_segments
-          segments.each { |s| s.finalize }
+          @segment_lock.synchronize { segments.each { |s| s&.finalize } }
         end
 
         WEB_TRANSACTION_TOTAL_TIME = 'WebTransactionTotalTime'.freeze

data/lib/new_relic/agent/transaction.rb

@@ -215,6 +215,7 @@ module NewRelic
         @nesting_max_depth = 0
         @current_segment_by_thread = {}
         @current_segment_lock = Mutex.new
+        @segment_lock = Mutex.new
         @segments = []
 
         self.default_name = options[:transaction_name]
@@ -437,7 +438,7 @@ module NewRelic
       end
 
       def initial_segment
-        segments.first
+        segments&.first
       end
 
       def finished?

data/lib/new_relic/agent/transaction_time_aggregator.rb

@@ -150,7 +150,7 @@ module NewRelic
           # rubocop:disable Style/SafeNavigation
           transaction_name = transaction_name = Tracer.current_transaction &&
             Tracer.current_transaction.best_name ||
-            'unknown'
+            NewRelic::UNKNOWN_LOWER
           # rubocop:enable Style/SafeNavigation
           NewRelic::Agent.logger.warn("Unable to calculate elapsed transaction time for #{transaction_name}")
         end

data/lib/new_relic/agent/utilization/ecs.rb

@@ -0,0 +1,22 @@
+# 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/utilization/vendor'
+
+module NewRelic
+  module Agent
+    module Utilization
+      class ECS < Vendor
+        vendor_name 'ecs'
+        endpoint ENV['ECS_CONTAINER_METADATA_URI'] || ''
+        headers 'Metadata' => 'true'
+        keys %w[DockerId]
+
+        def transform_key(key)
+          'ecs' + key
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/utilization/ecs_v4.rb

@@ -0,0 +1,22 @@
+# 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/utilization/vendor'
+
+module NewRelic
+  module Agent
+    module Utilization
+      class ECSV4 < Vendor
+        vendor_name 'ecs_v4'
+        endpoint ENV['ECS_CONTAINER_METADATA_URI_V4'] || ''
+        headers 'Metadata' => 'true'
+        keys %w[DockerId]
+
+        def transform_key(key)
+          'ecs' + key
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/utilization_data.rb

@@ -6,6 +6,8 @@ require 'new_relic/agent/utilization/aws'
 require 'new_relic/agent/utilization/gcp'
 require 'new_relic/agent/utilization/azure'
 require 'new_relic/agent/utilization/pcf'
+require 'new_relic/agent/utilization/ecs'
+require 'new_relic/agent/utilization/ecs_v4'
 
 module NewRelic
   module Agent
@@ -84,18 +86,51 @@ module NewRelic
         result
       end
 
+      def append_ecs_info(collector_hash)
+        return unless Agent.config[:'utilization.detect_aws']
+
+        Thread.new do
+          # try v4 first, and only try unversioned endpoint if v4 fails
+          ecs = Utilization::ECSV4.new
+          if ecs.detect
+            collector_hash[:vendors] ||= {}
+            collector_hash[:vendors][:ecs] = ecs.metadata
+          else
+            ecs = Utilization::ECS.new
+            if ecs.detect
+              collector_hash[:vendors] ||= {}
+              collector_hash[:vendors][:ecs] = ecs.metadata
+            end
+          end
+        end
+      end
+
       def append_vendor_info(collector_hash)
+        threads = []
+        complete = false
+
+        # ecs needs be checked even if AWS check succeeds
+        ecs_thread = append_ecs_info(collector_hash)
+
         VENDORS.each_pair do |klass, config_option|
           next unless Agent.config[config_option]
 
-          vendor = klass.new
+          threads << Thread.new do
+            vendor = klass.new
 
-          if vendor.detect
-            collector_hash[:vendors] ||= {}
-            collector_hash[:vendors][vendor.vendor_name.to_sym] = vendor.metadata
-            break
+            if vendor.detect
+              collector_hash[:vendors] ||= {}
+              collector_hash[:vendors][vendor.vendor_name.to_sym] = vendor.metadata
+
+              complete = true
+            end
           end
         end
+
+        while complete == false && threads.any?(&:alive?)
+          sleep 0.01
+        end
+        ecs_thread&.join
       end
 
       def append_docker_info(collector_hash)

data/lib/new_relic/agent/vm/c_ruby_vm.rb

@@ -61,7 +61,7 @@ module NewRelic
         end
 
         def gather_constant_cache_invalidations
-          RubyVM.stat[RUBY_VERSION >= '3.2.0' ? :constant_cache_invalidations : :global_constant_state]
+          RubyVM.stat[NewRelic::Helper.version_satisfied?(RUBY_VERSION, '>=', '3.2.0') ? :constant_cache_invalidations : :global_constant_state]
         end
 
         def gather_constant_cache_misses
@@ -86,9 +86,9 @@ module NewRelic
           when :gc_total_time
             NewRelic::LanguageSupport.gc_profiler_enabled?
           when :method_cache_invalidations
-            RUBY_VERSION < '3.0.0'
+            NewRelic::Helper.version_satisfied?(RUBY_VERSION, '<', '3.0.0')
           when :constant_cache_misses
-            RUBY_VERSION >= '3.2.0'
+            NewRelic::Helper.version_satisfied?(RUBY_VERSION, '>=', '3.2.0')
           else
             false
           end

data/lib/new_relic/agent.rb

@@ -293,6 +293,7 @@ module NewRelic
     #
     # This method is safe to use from any thread.
     #
+    # @!scope class
     # @api public
     def record_metric(metric_name, value) # THREAD_LOCAL_ACCESS
       record_api_supportability_metric(:record_metric)
@@ -333,6 +334,7 @@ module NewRelic
     #
     # This method is safe to use from any thread.
     #
+    # @!scope class
     # @api public
     #
     def increment_metric(metric_name, amount = 1) # THREAD_LOCAL_ACCESS
@@ -360,6 +362,7 @@ module NewRelic
     #
     # Return the new block or the existing filter Proc if no block is passed.
     #
+    # @!scope class
     # @api public
     #
     def ignore_error_filter(&block)
@@ -398,6 +401,7 @@ module NewRelic
     # them if you are calling <code>notice_error</code> outside a
     # transaction.
     #
+    # @!scope class
     # @api public
     #
     def notice_error(exception, options = {})
@@ -435,6 +439,7 @@ module NewRelic
     # :'error.expected' => Whether (true) or not (false) the error was expected
     # :options => The options hash passed to `NewRelic::Agent.notice_error`
     #
+    # @!scope class
     # @api public
     #
     def set_error_group_callback(callback_proc)
@@ -474,6 +479,7 @@ module NewRelic
     #                           may be strings, symbols, numeric values or
     #                           booleans.
     #
+    # @!scope class
     # @api public
     #
     def record_custom_event(event_type, event_attrs)
@@ -506,6 +512,7 @@ module NewRelic
     # @param [optional, Hash] Set of key-value pairs to store any other
     #   desired data to submit with the feedback event.
     #
+    # @!scope class
     # @api public
     #
     def record_llm_feedback_event(trace_id:,
@@ -559,6 +566,7 @@ module NewRelic
     # :model => [String] The name of the LLM model
     # :content => [String] The message content or prompt
     #
+    # @!scope class
     # @api public
     #
     def set_llm_token_count_callback(callback_proc)
@@ -591,6 +599,7 @@ module NewRelic
     # file logger.  The setting for the newrelic.yml section to use
     # (ie, RAILS_ENV) can be overridden with an :env argument.
     #
+    # @!scope class
     # @api public
     #
     def manual_start(options = {})
@@ -623,6 +632,7 @@ module NewRelic
     #   connection, this tells me to only try it once so this method returns
     #   quickly if there is some kind of latency with the server.
     #
+    # @!scope class
     # @api public
     #
     def after_fork(options = {})
@@ -636,6 +646,7 @@ module NewRelic
     #
     # @param options [Hash] Unused options Hash, for back compatibility only
     #
+    # @!scope class
     # @api public
     #
     def shutdown(options = {})
@@ -646,6 +657,7 @@ module NewRelic
     # Clear out any data the agent has buffered but has not yet transmitted
     # to the collector.
     #
+    # @!scope class
     # @api public
     def drop_buffered_data
       # the following line needs else branch coverage
@@ -660,6 +672,7 @@ module NewRelic
     # register instrumentation than just loading the files directly,
     # although that probably also works.
     #
+    # @!scope class
     # @api public
     #
     def add_instrumentation(file_pattern)
@@ -669,6 +682,7 @@ module NewRelic
 
     # Require agent testing helper methods
     #
+    # @!scope class
     # @api public
     def require_test_helper
       record_api_supportability_metric(:require_test_helper)
@@ -689,6 +703,7 @@ module NewRelic
     #       my_obfuscator(sql)
     #    end
     #
+    # @!scope class
     # @api public
     #
     def set_sql_obfuscator(type = :replace, &block)
@@ -704,6 +719,7 @@ module NewRelic
     # traced errors, transaction traces, Insights events, slow SQL traces,
     # or RUM injection will happen for this transaction.
     #
+    # @!scope class
     # @api public
     #
     def ignore_transaction
@@ -714,6 +730,7 @@ module NewRelic
     # This method disables the recording of Apdex metrics in the current
     # transaction.
     #
+    # @!scope class
     # @api public
     #
     def ignore_apdex
@@ -724,6 +741,7 @@ module NewRelic
     # This method disables browser monitoring javascript injection in the
     # current transaction.
     #
+    # @!scope class
     # @api public
     #
     def ignore_enduser
@@ -736,6 +754,7 @@ module NewRelic
     # track of the first entry point and turn on tracing again after
     # leaving that block.  This uses the thread local Tracer::State.
     #
+    # @!scope class
     # @api public
     #
     def disable_all_tracing
@@ -760,6 +779,7 @@ module NewRelic
     #     ...
     #   end
     #
+    # @!scope class
     # @api public
     #
     def disable_sql_recording
@@ -798,6 +818,7 @@ module NewRelic
     #                           may be strings, symbols, numeric values or
     #                           booleans.
     #
+    # @!scope class
     # @api public
     #
     def add_custom_attributes(params) # THREAD_LOCAL_ACCESS
@@ -838,6 +859,7 @@ module NewRelic
     #                           booleans.
     #
     # @see https://docs.newrelic.com/docs/using-new-relic/welcome-new-relic/get-started/glossary#span
+    # @!scope class
     # @api public
     def add_custom_span_attributes(params)
       record_api_supportability_metric(:add_custom_span_attributes)
@@ -879,6 +901,7 @@ module NewRelic
     #
     #                         Attribute pairs with empty or nil contents
     #                         will be dropped.
+    # @!scope class
     # @api public
     def add_custom_log_attributes(params)
       record_api_supportability_metric(:add_custom_log_attributes)
@@ -894,6 +917,7 @@ module NewRelic
     #
     # @param [String] user_id    The user id to add to the current transaction attributes
     #
+    # @!scope class
     # @api public
     def set_user_id(user_id)
       record_api_supportability_metric(:set_user_id)
@@ -937,6 +961,7 @@ module NewRelic
     #
     # The default category is the same as the running transaction.
     #
+    # @!scope class
     # @api public
     #
     def set_transaction_name(name, options = {})
@@ -947,6 +972,7 @@ module NewRelic
     # Get the name of the current running transaction.  This is useful if you
     # want to modify the default name.
     #
+    # @!scope class
     # @api public
     #
     def get_transaction_name # THREAD_LOCAL_ACCESS
@@ -1018,6 +1044,7 @@ module NewRelic
     # * entity.guid - The guid of the current entity.
     # * hostname    - The fully qualified hostname.
     #
+    # @!scope class
     # @api public
     def linking_metadata
       metadata = Hash.new
@@ -1044,6 +1071,7 @@ module NewRelic
     #
     # @param [String] nonce The nonce to use in the javascript tag for browser instrumentation
     #
+    # @!scope class
     # @api public
     #
     def browser_timing_header(nonce = nil)

data/lib/new_relic/constants.rb

@@ -16,6 +16,7 @@ module NewRelic
   HTTP = 'HTTP'
   HTTPS = 'HTTPS'
   UNKNOWN = 'Unknown'
+  UNKNOWN_LOWER = 'unknown'
 
   FORMAT_NON_RACK = 0
   FORMAT_RACK = 1

data/lib/new_relic/control/instance_methods.rb

@@ -74,6 +74,7 @@ module NewRelic
         NewRelic::Agent.agent = NewRelic::Agent::Agent.instance
         init_instrumentation
         init_security_agent
+        report_agent_version_metric
       end
 
       def determine_env(options)
@@ -171,6 +172,10 @@ module NewRelic
       def stdout
         STDOUT
       end
+
+      def report_agent_version_metric
+        NewRelic::Agent.record_metric_once("Supportability/AgentVersion/newrelic_rpm/#{NewRelic::VERSION::STRING}")
+      end
     end
     include InstanceMethods
   end

data/lib/new_relic/control/instrumentation.rb

@@ -68,7 +68,7 @@ module NewRelic
     end
 
     def rails_32_deprecation
-      return unless defined?(Rails::VERSION) && Gem::Version.new(Rails::VERSION::STRING) <= Gem::Version.new('3.2')
+      return unless defined?(Rails::VERSION) && NewRelic::Helper.version_satisfied?(Rails::VERSION::STRING, '<=', '3.2')
 
       deprecation_msg = 'The Ruby agent is dropping support for Rails 3.2 ' \
         'in a future major release. Please upgrade your Rails version to continue receiving support. ' \

data/lib/new_relic/dependency_detection.rb

@@ -179,7 +179,6 @@ module DependencyDetection
     # logs the resolved value during debug mode.
     def fetch_config_value(key)
       valid_value = valid_config_value(::NewRelic::Agent.config[key].to_s.to_sym)
-      ::NewRelic::Agent.logger.debug("Using #{valid_value} configuration value for #{self.name} to configure instrumentation")
       return valid_value
     end
 

data/lib/new_relic/helper.rb

@@ -83,6 +83,13 @@ module NewRelic
       end
     end
 
+    def version_satisfied?(left, operator, right)
+      left = Gem::Version.new(left) unless left.is_a?(Gem::Version)
+      right = Gem::Version.new(right) unless right.is_a?(Gem::Version)
+
+      left.public_send(operator, right)
+    end
+
     # Bundler version 2.5.12 deprecated all_specs and added installed_specs.
     # To support newer Bundler versions, try to use installed_specs first,
     # then fall back to all_specs.

data/lib/new_relic/version.rb

@@ -6,7 +6,7 @@
 module NewRelic
   module VERSION # :nodoc:
     MAJOR = 9
-    MINOR = 17
+    MINOR = 21
     TINY = 0
 
     STRING = "#{MAJOR}.#{MINOR}.#{TINY}"

data/lib/sequel/extensions/new_relic_instrumentation.rb

@@ -79,7 +79,7 @@ module Sequel
 
     THREAD_SAFE_CONNECTION_POOL_CLASSES = [
       (defined?(::Sequel::ThreadedConnectionPool) && ::Sequel::ThreadedConnectionPool),
-      (defined?(::Sequel::TimedQueueConnectionPool) && RUBY_VERSION >= '3.2' && ::Sequel::TimedQueueConnectionPool)
+      (defined?(::Sequel::TimedQueueConnectionPool) && NewRelic::Helper.version_satisfied?(RUBY_VERSION, '>=', '3.2') && ::Sequel::TimedQueueConnectionPool)
     ].compact.freeze
 
     def explainer_for(sql)

data/lib/tasks/helpers/newrelicyml.rb

@@ -141,6 +141,8 @@ module NewRelicYML
     description.gsub!(/<InlinePopover type="(.*)" \/>/, '\1')
     # remove hyperlinks
     description.gsub!(/\[([^\]]+)\]\([^\)]+\)/, '\1')
+    # delete lines with code fences including the language
+    description.gsub!(/```[a-zA-Z0-9_]*\n(.*?)```/m, '\1')
     # remove single pairs of backticks
     description.gsub!(/`([^`]+)`/, '\1')
     # removed href links
@@ -150,11 +152,13 @@ module NewRelicYML
   end
 
   def self.format_description(description)
+    # remove all tab characters
+    description.delete!("\t")
     # remove leading and trailing whitespace
     description.strip!
     # wrap text after 80 characters, assuming we're at one tabstop's (two
-    # spaces') level of indentation already
-    description.gsub!(/(.{1,78})(\s+|\Z)/, "\\1\n")
+    # spaces') level of indentation already, keep leading whitespace
+    description.gsub!(/(.{1,78})(\s|\Z)/, "\\1\n")
     # add hashtags to lines
     description = description.split("\n").map { |line| "  # #{line}" }.join("\n")