newrelic_rpm 4.0.0.332 → 6.13.1

data/bin/nrdebug

@@ -2,7 +2,7 @@
 
 # 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 'tempfile'
 require 'rbconfig'

data/config.dot

@@ -1,7 +1,6 @@
 digraph AgentEnabled {
   node[color=green]
   "[agent_enabled]"
-  "[developer_mode]"
   "[monitor_mode]"
   "[slow_sql.explain_threshold]"
   "[slow_sql.stack_trace_threshold]"
@@ -19,9 +18,9 @@ digraph AgentEnabled {
   "[error_collector.capture_source]"
   "[error_collector.enabled]"
   "[error_collector.ignore_errors]"
+  "[error_collector.max_backtrace_frames]"
   "[browser_monitoring.auto_instrument]"
   "[license_key]"
-  "[ssl]"
   "[verify_certificate]"
   "[api_host]"
   "[api_port]"
@@ -43,7 +42,7 @@ digraph AgentEnabled {
   "[dispatcher]"
   "[force_send]"
   "[textmate]"
-  "[post_size_limit]"
+  "[max_payload_size_in_bytes]"
   "[sync_startup]"
   "[send_data_on_exit]"
   "[high_security]"
@@ -164,14 +163,12 @@ digraph AgentEnabled {
   "Control#server_from_host" -> "[host]"
   "Control#server_from_host" -> "[port]"
   "Control#server_from_host" -> "Control#convert_to_ip_address"
-  "Control#http_connection" -> "[ssl]"
   "Control#http_connection" -> "[verify_certificate]"
   "Control#http_connection" -> "Control#proxy_server"
   "Control#set_log_level!" -> "[log_level]"
   "Control#log_path" -> "[log_file_path]"
   "Control#log_path" -> "Control#log_to_stdout?"
   "Control#log_to_stdout?" -> "[log_file_path]"
-  "Control#convert_to_ip_address" -> "[ssl]"
   "Control#convert_to_ip_address" -> "[verify_certificate]"
   "Control#server" -> "Control#server_from_host"
   "Control#setup_log" -> "Control#set_log_level!"
@@ -201,7 +198,6 @@ digraph AgentEnabled {
   "Agent#validate_settings" -> "[validate_token]"
   "Agent#log_error" -> "Control#server"
   "Agent#monitoring?" -> "[monitor_mode]"
-  "Agent#check_trasaction_sampler_status" -> "[developer_mode]"
   "Agent#check_sql_sampler_status" -> "[slow_sql.enabled]"
   "Agent#check_sql_sampler_status" -> "[slow_sql.record_sql]"
   "Agent#check_sql_sampler_status" -> "[transaction_tracer.enabled]"
@@ -216,7 +212,6 @@ digraph AgentEnabled {
   "MethodTracer#remove_method_tracer" -> "[agent_enabled]"
 
   "Rails#init_config" -> "[agent_enabled]"
-  "Rails#init_config" -> "[developer_mode]"
 
   "ErrorCollector#initialize" -> "[error_collector.enabled]"
   "ErrorCollector#initialize" -> "[error_collector.capture_source]"
@@ -226,7 +221,7 @@ digraph AgentEnabled {
   "NewRelicService#initialize" -> "[timeout]"
   "NewRelicService#initialize" -> "[license_key]"
   "NewRelicService#initialize" -> "Control#server"
-  "NewRelicService#check_post_size" -> "[post_size_limit]"
+  "NewRelicService#check_post_size" -> "[max_payload_size_in_bytes]"
   "NewRelicService#connect" -> "Control#server_from_host"
   "NewRelicService#send_request" -> "Control#http_connection"
 
@@ -240,10 +235,6 @@ digraph AgentEnabled {
   "TransactionSampler#configure!" -> "[transaction_tracer.explain_threshold]"
   "TransactionSampler#configure!" -> "[transaction_tracer.explain_enabled]"
   "TransactionSampler#configure!" -> "[transaction_tracer.transaction_threshold]"
-  "TransactionSampler#configure!" -> "[developer_mode]"
-  "TransactionSampler#notice_push_scope" -> "[developer_mode]"
-  "TransactionSampler#capture_segment_trace" -> "[developer_mode]"
-  "TransactionSampler#store_segment_for_developer_mode" -> "[developer_mode]"
 
   "NoticedError#initialize" -> "[high_security]"
 

data/init.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.
 
 # This is the initialization for the New Relic Ruby Agent when used as
 # a plugin

data/install.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.
 
 if __FILE__ == $0 || $0 =~ /script\/plugin/ || File.basename($0) == 'rake'
   $LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), 'lib'))

data/lib/new_relic/agent.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 'forwardable'
 
@@ -26,16 +26,15 @@ module NewRelic
 
     require 'new_relic/version'
     require 'new_relic/local_environment'
-    require 'new_relic/metrics'
     require 'new_relic/metric_spec'
     require 'new_relic/metric_data'
-    require 'new_relic/collection_helper'
     require 'new_relic/noticed_error'
+    require 'new_relic/agent/noticible_error'
+    require 'new_relic/supportability_helper'
 
     require 'new_relic/agent/encoding_normalizer'
     require 'new_relic/agent/stats'
     require 'new_relic/agent/chained_call'
-    require 'new_relic/agent/cross_app_monitor'
     require 'new_relic/agent/agent'
     require 'new_relic/agent/method_tracer'
     require 'new_relic/agent/worker_loop'
@@ -45,14 +44,19 @@ module NewRelic
     require 'new_relic/agent/sql_sampler'
     require 'new_relic/agent/commands/thread_profiler_session'
     require 'new_relic/agent/error_collector'
-    require 'new_relic/agent/busy_calculator'
     require 'new_relic/agent/sampler'
     require 'new_relic/agent/database'
+    require 'new_relic/agent/datastores'
     require 'new_relic/agent/pipe_channel_manager'
     require 'new_relic/agent/configuration'
     require 'new_relic/agent/rules_engine'
     require 'new_relic/agent/http_clients/uri_util'
     require 'new_relic/agent/system_info'
+    require 'new_relic/agent/external'
+    require 'new_relic/agent/deprecator'
+    require 'new_relic/agent/logging'
+    require 'new_relic/agent/distributed_tracing'
+    require 'new_relic/agent/attribute_processing'
 
     require 'new_relic/agent/instrumentation/controller_instrumentation'
 
@@ -65,6 +69,8 @@ module NewRelic
     require 'thread'
     require 'resolv'
 
+    extend NewRelic::SupportabilityHelper
+
     # An exception that is thrown by the server if the agent license is invalid.
     class LicenseException < StandardError; end
 
@@ -72,7 +78,11 @@ module NewRelic
     class ForceDisconnectException < StandardError; end
 
     # An exception that forces an agent to restart.
-    class ForceRestartException < StandardError; end
+    class ForceRestartException < StandardError
+      def message
+        "#{super}, restarting."
+      end
+    end
 
     # Used to blow out of a periodic task without logging a an error, such as for routine
     # failures.
@@ -95,6 +105,8 @@ module NewRelic
 
     @agent = nil
     @logger = nil
+    @tracer_lock = Mutex.new
+    @tracer_queue = []
 
     # The singleton Agent instance.  Used internally.
     def agent #:nodoc:
@@ -106,6 +118,7 @@ module NewRelic
 
     def agent=(new_instance)#:nodoc:
       @agent = new_instance
+      add_deferred_method_tracers_now
     end
 
     alias instance agent #:nodoc:
@@ -120,17 +133,38 @@ module NewRelic
       @logger = log
     end
 
-    # This needs to come after the definition of the logger method above, since
-    # instantiating the config writes to the Logger.
+    # A third-party class may call add_method_tracer before the agent
+    # is initialized; these methods enable us to defer these calls
+    # until we have started up and can process them.
+    #
+    def add_or_defer_method_tracer(receiver, method_name, metric_name_code, options)
+      @tracer_lock.synchronize do
+        if @agent
+          receiver.send(:_add_method_tracer_now, method_name, metric_name_code, options)
+        else
+          @tracer_queue << [receiver, method_name, metric_name_code, options]
+        end
+      end
+    end
 
-    @config = NewRelic::Agent::Configuration::Manager.new
+    def add_deferred_method_tracers_now
+      @tracer_lock.synchronize do
+        @tracer_queue.each do |receiver, method_name, metric_name_code, options|
+          receiver.send(:_add_method_tracer_now, method_name, metric_name_code, options)
+        end
 
-    attr_reader :config
+        @tracer_queue = []
+      end
+    end
+
+    def config
+      @config ||= Configuration::Manager.new
+    end
 
     # For testing
     # Important that we don't change the instance or we orphan callbacks
     def reset_config
-      @config.reset_to_defaults
+      config.reset_to_defaults
     end
 
     # @!group Recording custom metrics
@@ -152,6 +186,8 @@ module NewRelic
     #
     # @api public
     def record_metric(metric_name, value) #THREAD_LOCAL_ACCESS
+      record_api_supportability_metric(:record_metric)
+
       return unless agent
 
       if value.is_a?(Hash)
@@ -176,11 +212,17 @@ module NewRelic
     # This method is safe to use from any thread.
     #
     # @api public
+
+    SUPPORTABILITY_INCREMENT_METRIC = 'Supportability/API/increment_metric'.freeze
+
     def increment_metric(metric_name, amount=1) #THREAD_LOCAL_ACCESS
       return unless agent
-
-      agent.stats_engine.tl_record_unscoped_metrics(metric_name) do |stats|
-        stats.increment_count(amount)
+      if amount == 1
+        metrics = [metric_name, SUPPORTABILITY_INCREMENT_METRIC]
+        agent.stats_engine.tl_record_unscoped_metrics(metrics) {|stats| stats.increment_count}
+      else
+        agent.stats_engine.tl_record_unscoped_metrics(metric_name) {|stats| stats.increment_count(amount)}
+        agent.stats_engine.tl_record_unscoped_metrics(SUPPORTABILITY_INCREMENT_METRIC) {|stats| stats.increment_count}
       end
     end
 
@@ -200,6 +242,8 @@ module NewRelic
     # @api public
     #
     def ignore_error_filter(&block)
+      record_api_supportability_metric(:ignore_error_filter)
+
       if block
         NewRelic::Agent::ErrorCollector.ignore_error_filter = block
       else
@@ -212,7 +256,7 @@ module NewRelic
     # @param [Exception] exception Error you wish to send
     # @param [Hash]      options Modify how New Relic processes the error
     # @option options [Hash]    :custom_params Custom parameters to attach to the trace
-    # @option options [Boolean] :trace_only Only record the error trace
+    # @option options [Boolean] :expected Only record the error trace
     #                           (do not affect error rate or Apdex status)
     # @option options [String]  :uri Request path, minus request params or query string
     #                           (usually not needed)
@@ -236,6 +280,14 @@ module NewRelic
     # @api public
     #
     def notice_error(exception, options={})
+      record_api_supportability_metric(:notice_error)
+
+      if options.has_key?(:trace_only)
+        NewRelic::Agent.logger.log_once(:warn, :trace_only_deprecated,
+          'Passing the :trace_only option to NewRelic::Agent.notice_error is deprecated. Please use :expected instead.')
+        options[:expected] = options.delete(:trace_only)
+      end
+
       Transaction.notice_error(exception, options)
       nil # don't return a noticed error datastructure. it can only hurt.
     end
@@ -269,9 +321,12 @@ module NewRelic
     # @api public
     #
     def record_custom_event(event_type, event_attrs)
+      record_api_supportability_metric(:record_custom_event)
+
       if agent && NewRelic::Agent.config[:'custom_insights_events.enabled']
         agent.custom_event_aggregator.record(event_type, event_attrs)
       end
+
       nil
     end
 
@@ -299,6 +354,7 @@ module NewRelic
     def manual_start(options={})
       raise "Options must be a hash" unless Hash === options
       NewRelic::Control.instance.init_plugin({ :agent_enabled => true, :sync_startup => true }.merge(options))
+      record_api_supportability_metric(:manual_start)
     end
 
     # Register this method as a callback for processes that fork
@@ -327,6 +383,7 @@ module NewRelic
     # @api public
     #
     def after_fork(options={})
+      record_api_supportability_metric(:after_fork)
       agent.after_fork(options) if agent
     end
 
@@ -338,6 +395,7 @@ module NewRelic
     # @api public
     #
     def shutdown(options={})
+      record_api_supportability_metric(:shutdown)
       agent.shutdown if agent
     end
 
@@ -347,6 +405,7 @@ module NewRelic
     # @api public
     def drop_buffered_data
       agent.drop_buffered_data if agent
+      record_api_supportability_metric(:drop_buffered_data)
     end
 
     # Add instrumentation files to the agent.  The argument should be
@@ -359,6 +418,7 @@ module NewRelic
     # @api public
     #
     def add_instrumentation(file_pattern)
+      record_api_supportability_metric(:add_instrumentation)
       NewRelic::Control.instance.add_instrumentation file_pattern
     end
 
@@ -366,6 +426,7 @@ module NewRelic
     #
     # @api public
     def require_test_helper
+      record_api_supportability_metric(:require_test_helper)
       require File.expand_path('../../../test/agent_helper', __FILE__)
     end
 
@@ -386,6 +447,7 @@ module NewRelic
     # @api public
     #
     def set_sql_obfuscator(type = :replace, &block)
+      record_api_supportability_metric(:set_sql_obfuscator)
       NewRelic::Agent::Database.set_sql_obfuscator(type, &block)
     end
 
@@ -400,6 +462,7 @@ module NewRelic
     # @api public
     #
     def ignore_transaction
+      record_api_supportability_metric(:ignore_transaction)
       txn = NewRelic::Agent::Transaction.tl_current
       txn.ignore! if txn
     end
@@ -410,6 +473,7 @@ module NewRelic
     # @api public
     #
     def ignore_apdex
+      record_api_supportability_metric(:ignore_apdex)
       txn = NewRelic::Agent::Transaction.tl_current
       txn.ignore_apdex! if txn
     end
@@ -420,6 +484,7 @@ module NewRelic
     # @api public
     #
     def ignore_enduser
+      record_api_supportability_metric(:ignore_enduser)
       txn = NewRelic::Agent::Transaction.tl_current
       txn.ignore_enduser! if txn
     end
@@ -427,11 +492,13 @@ module NewRelic
     # Yield to the block without collecting any metrics or traces in
     # any of the subsequent calls.  If executed recursively, will keep
     # track of the first entry point and turn on tracing again after
-    # leaving that block.  This uses the thread local TransactionState.
+    # leaving that block.  This uses the thread local Tracer::State.
     #
     # @api public
     #
     def disable_all_tracing
+      record_api_supportability_metric(:disable_all_tracing)
+
       return yield unless agent
 
       begin
@@ -448,14 +515,10 @@ module NewRelic
     # @api public
     #
     def disable_transaction_tracing
-      return yield unless agent
-
-      state = agent.set_record_tt(false)
-      begin
-        yield
-      ensure
-        agent.set_record_tt(state)
-      end
+      Deprecator.deprecate :disable_transaction_tracing,
+                           'disable_all_tracing or ignore_transaction'
+      record_api_supportability_metric(:disable_transaction_tracing)
+      yield
     end
 
     # This method sets the state of sql recording in the transaction
@@ -470,6 +533,8 @@ module NewRelic
     # @api public
     #
     def disable_sql_recording
+      record_api_supportability_metric(:disable_sql_recording)
+
       return yield unless agent
 
       state = agent.set_record_sql(false)
@@ -484,19 +549,13 @@ module NewRelic
 
     # Check to see if we are capturing metrics currently on this thread.
     def tl_is_execution_traced?
-      NewRelic::Agent::TransactionState.tl_get.is_execution_traced?
-    end
-
-    # helper method to check the thread local to determine whether the
-    # transaction in progress is traced or not
-    def tl_is_transaction_traced?
-      NewRelic::Agent::TransactionState.tl_get.is_transaction_traced?
+      NewRelic::Agent::Tracer.state.is_execution_traced?
     end
 
     # helper method to check the thread local to determine whether sql
     # is being recorded or not
     def tl_is_sql_recorded?
-      NewRelic::Agent::TransactionState.tl_get.is_sql_recorded?
+      NewRelic::Agent::Tracer.state.is_sql_recorded?
     end
 
     # @!group Adding custom attributes to traces
@@ -509,17 +568,57 @@ module NewRelic
     # these custom attributes will also be present in the script injected into
     # the response body, making them available on Insights PageView events.
     #
+    #
+    # @param [Hash] params      A Hash of attributes to be attached to the transaction event.
+    #                           Keys should be strings or symbols, and values
+    #                           may be strings, symbols, numeric values or
+    #                           booleans.
+    #
     # @api public
     #
     def add_custom_attributes(params) #THREAD_LOCAL_ACCESS
+      record_api_supportability_metric(:add_custom_attributes)
+
       if params.is_a? Hash
         txn = Transaction.tl_current
         txn.add_custom_attributes(params) if txn
+
+        segment = ::NewRelic::Agent::Tracer.current_segment
+        if segment
+          # Make sure not to override existing segment-level custom attributes
+          segment_custom_keys = segment.attributes.custom_attributes.keys.map(&:to_sym)
+          segment.add_custom_attributes(params.reject { |k, _v| segment_custom_keys.include?(k.to_sym) })
+        end
       else
         ::NewRelic::Agent.logger.warn("Bad argument passed to #add_custom_attributes. Expected Hash but got #{params.class}")
       end
     end
 
+    # Add custom attributes to the span event for the current span. Attributes will be visible on spans in the
+    # New Relic Distributed Tracing UI and on span events in New Relic Insights.
+    #
+    # Custom attributes will not be transmitted when +high_security+ setting is enabled or
+    # +custom_attributes+ setting is disabled.
+    #
+    # @param [Hash] params      A Hash of attributes to be attached to the span event.
+    #                           Keys should be strings or symbols, and values
+    #                           may be strings, symbols, numeric values or
+    #                           booleans.
+    #
+    # @see https://docs.newrelic.com/docs/using-new-relic/welcome-new-relic/get-started/glossary#span
+    # @api public
+    def add_custom_span_attributes params
+      record_api_supportability_metric :add_custom_span_attributes
+
+      if params.is_a? Hash
+        if segment = NewRelic::Agent::Tracer.current_segment
+          segment.add_custom_attributes params
+        end
+      else
+        ::NewRelic::Agent.logger.warn "Bad argument passed to #add_custom_span_attributes. Expected Hash but got #{params.class}"
+      end
+    end
+
     # @!endgroup
 
     # @!group Transaction naming
@@ -528,7 +627,9 @@ module NewRelic
     # apply a reasonable default based on framework routing, but in
     # cases where this is insufficient, this can be used to manually
     # control the name of the transaction.
-    # The category of transaction can be specified via the +:category+ option:
+    #
+    # The category of transaction can be specified via the +:category+ option.
+    # The following are the only valid categories:
     #
     # * <tt>:category => :controller</tt> indicates that this is a
     #   controller action and will appear with all the other actions.
@@ -548,6 +649,7 @@ module NewRelic
     # @api public
     #
     def set_transaction_name(name, options={})
+      record_api_supportability_metric(:set_transaction_name)
       Transaction.set_overriding_transaction_name(name, options[:category])
     end
 
@@ -557,6 +659,8 @@ module NewRelic
     # @api public
     #
     def get_transaction_name #THREAD_LOCAL_ACCESS
+      record_api_supportability_metric(:get_transaction_name)
+
       txn = Transaction.tl_current
       if txn
         namer = Instrumentation::ControllerInstrumentation::TransactionNamer
@@ -575,8 +679,8 @@ module NewRelic
     # @param [String] method the name of the finder method or other method to
     # identify the operation with.
     #
-    def with_database_metric_name(model, method = nil, product = nil, &block) #THREAD_LOCAL_ACCESS
-      if txn = Transaction.tl_current
+    def with_database_metric_name(model, method = nil, product = nil, &block)
+      if txn = Tracer.current_transaction
         txn.with_database_metric_name(model, method, product, &block)
       else
         yield
@@ -597,6 +701,54 @@ module NewRelic
       NewRelic::Agent.logger.debug "Ignoring exception during %p event notification" % [event_type]
     end
 
+    # @!group Trace and Entity metadata
+
+    TRACE_ID_KEY = 'trace.id'.freeze
+    SPAN_ID_KEY = 'span.id'.freeze
+    ENTITY_NAME_KEY = 'entity.name'.freeze
+    ENTITY_TYPE_KEY = 'entity.type'.freeze
+    ENTITY_GUID_KEY = 'entity.guid'.freeze
+    HOSTNAME_KEY = 'hostname'.freeze
+
+    ENTITY_TYPE = 'SERVICE'.freeze
+
+    # Returns a new hash containing trace and entity metadata that can be used
+    # to relate data to a trace or to an entity in APM.
+    #
+    # This hash includes:
+    # * trace.id    - The current trace id, if there is a current trace id. This
+    #   value may be omitted.
+    # * span.id     - The current span id, if there is a current span.  This
+    #   value may be omitted.
+    # * entity.name - The name of the current application. This is read from
+    #   the +app_name+ key in your config.  If there are multiple application
+    #   names, the first one is used.
+    # * entity.type - The entity type is hardcoded to the string +'SERVICE'+.
+    # * entity.guid - The guid of the current entity.
+    # * hostname    - The fully qualified hostname.
+    #
+    # @api public
+    def linking_metadata
+      metadata = Hash.new
+      metadata[ENTITY_NAME_KEY] = config[:app_name][0]
+      metadata[ENTITY_TYPE_KEY] = ENTITY_TYPE
+      metadata[HOSTNAME_KEY] = Hostname.get
+
+      if entity_guid = config[:entity_guid]
+        metadata[ENTITY_GUID_KEY] = entity_guid
+      end
+
+      if trace_id = Tracer.current_trace_id
+        metadata[TRACE_ID_KEY] = trace_id
+      end
+      if span_id = Tracer.current_span_id
+        metadata[SPAN_ID_KEY] = span_id
+      end
+      metadata
+    end
+
+    #@!endgroup
+
     # @!group Manual browser monitoring configuration
 
     # This method returns a string suitable for inclusion in a page - known as
@@ -614,6 +766,8 @@ module NewRelic
     # @api public
     #
     def browser_timing_header
+      record_api_supportability_metric(:browser_timing_header)
+
       return "" unless agent
       agent.javascript_instrumentor.browser_timing_header
     end