newrelic_rpm 6.1.0.352 → 6.6.0.358

data/lib/new_relic/agent/commands/agent_command_router.rb

@@ -9,7 +9,6 @@
 # like the ThreadProfiler, so it's simpler to just keep it together here.
 
 require 'new_relic/agent/commands/agent_command'
-require 'new_relic/agent/commands/xray_session_collection'
 require 'new_relic/agent/threading/backtrace_service'
 
 module NewRelic
@@ -18,8 +17,7 @@ module NewRelic
       class AgentCommandRouter
         attr_reader :handlers
 
-        attr_accessor :thread_profiler_session, :backtrace_service,
-                      :xray_session_collection
+        attr_accessor :thread_profiler_session, :backtrace_service
 
         def initialize(event_listener=nil)
           @handlers    = Hash.new { |*| Proc.new { |cmd| self.unrecognized_agent_command(cmd) } }
@@ -27,11 +25,9 @@ module NewRelic
           @backtrace_service = Threading::BacktraceService.new(event_listener)
 
           @thread_profiler_session = ThreadProfilerSession.new(@backtrace_service)
-          @xray_session_collection = XraySessionCollection.new(@backtrace_service, event_listener)
 
           @handlers['start_profiler'] = Proc.new { |cmd| thread_profiler_session.handle_start_command(cmd) }
           @handlers['stop_profiler']  = Proc.new { |cmd| thread_profiler_session.handle_stop_command(cmd) }
-          @handlers['active_xray_sessions'] = Proc.new { |cmd| xray_session_collection.handle_active_xray_sessions(cmd) }
 
           if event_listener
             event_listener.subscribe(:before_shutdown, &method(:on_before_shutdown))
@@ -45,20 +41,10 @@ module NewRelic
         def check_for_and_handle_agent_commands
           commands = get_agent_commands
 
-          stop_xray_sessions unless active_xray_command?(commands)
-
           results = invoke_commands(commands)
           new_relic_service.agent_command_results(results) unless results.empty?
         end
 
-        def stop_xray_sessions
-          self.xray_session_collection.stop_all_sessions
-        end
-
-        def active_xray_command?(commands)
-          commands.any? {|command| command.name == 'active_xray_sessions'}
-        end
-
         def on_before_shutdown(*args)
           if self.thread_profiler_session.running?
             self.thread_profiler_session.stop(true)
@@ -67,7 +53,6 @@ module NewRelic
 
         def harvest!
           profiles = []
-          profiles += harvest_from_xray_session_collection
           profiles += harvest_from_thread_profiler_session
           log_profiles(profiles)
           profiles
@@ -76,14 +61,10 @@ module NewRelic
         # We don't currently support merging thread profiles that failed to send
         # back into the AgentCommandRouter, so we just no-op this method.
         # Same with reset! - we don't support asynchronous cancellation of a
-        # running thread profile or X-Ray session currently.
+        # running thread profile currently.
         def merge!(*args); end
         def reset!; end
 
-        def harvest_from_xray_session_collection
-          self.xray_session_collection.harvest_thread_profiles
-        end
-
         def harvest_from_thread_profiler_session
           if self.thread_profiler_session.ready_to_harvest?
             self.thread_profiler_session.stop(true)

data/lib/new_relic/agent/configuration/default_source.rb

@@ -91,12 +91,8 @@ module NewRelic
                 :rails
               when 3
                 :rails3
-              when 4
-                :rails4
-              when 5
-                :rails5
-              when 6
-                :rails6
+              when 4..6
+                :rails_notifications
               else
                 ::NewRelic::Agent.logger.error "Detected unsupported Rails version #{Rails::VERSION::STRING}"
               end
@@ -172,6 +168,16 @@ module NewRelic
           end
         end
 
+        def self.api_host
+          Proc.new do
+            if String(NewRelic::Agent.config[:license_key]).start_with? 'eu'
+              'rpm.eu.newrelic.com'
+            else
+              'rpm.newrelic.com'
+            end
+          end
+        end
+
         def self.convert_to_regexp_list(raw_value)
           value_list = convert_to_list(raw_value)
           value_list.map do |value|
@@ -472,7 +478,7 @@ module NewRelic
           :description => "URI for the New Relic data collection service."
         },
         :api_host => {
-          :default => 'rpm.newrelic.com',
+          :default => DefaultSource.api_host,
           :public => false,
           :type => String,
           :allowed_from_server => false,
@@ -553,12 +559,20 @@ module NewRelic
           :public => false,
           :type => Integer,
           :allowed_from_server => true,
-          :description => 'Number of seconds betwixt connections to the New Relic data collection service. Note that transaction events have a separate report period, specified by data_report_periods.analytic_event_data.'
+          :description => 'Number of seconds betwixt connections to the New Relic data collection service.'
+        },
+        :event_report_period => {
+          :default => 60,
+          :public => false,
+          :type => Integer,
+          :allowed_from_server => true,
+          :description => 'Number of seconds betwixt connections to the New Relic event collection services.'
         },
         :'data_report_periods.analytic_event_data' => {
           :default => 60,
           :public => false,
           :type => Integer,
+          :deprecated => true,
           :dynamic_name => true,
           :allowed_from_server => true,
           :description => 'Number of seconds between connections to the New Relic data collection service for sending transaction event data.'
@@ -1003,6 +1017,7 @@ module NewRelic
           :public => true,
           :type => Boolean,
           :allowed_from_server => true,
+          :dynamic_name => true,
           :description => 'If <code>true</code>, the agent collects <a href="https://docs.newrelic.com/docs/insights/new-relic-insights/decorating-events/error-event-default-attributes-insights">TransactionError events</a>.'
         },
         :'error_collector.max_event_samples_stored' => {
@@ -1157,35 +1172,7 @@ module NewRelic
           :allowed_from_server => true,
           :description => 'If <code>true</code>, enables use of the <a href="https://docs.newrelic.com/docs/apm/applications-menu/events/thread-profiler-tool">thread profiler</a>.'
         },
-        :'xray_session.enabled' => {
-          :default => true,
-          :public => true,
-          :type => Boolean,
-          :allowed_from_server => true,
-          :description => 'If <code>true</code>, enables <a href="https://docs.newrelic.com/docs/apm/transactions-menu/x-ray-sessions/x-ray-sessions">X-Ray sessions</a>.'
-        },
-        :'xray_session.allow_traces' => {
-          :default => true,
-          :public => false,
-          :type => Boolean,
-          :allowed_from_server => true,
-          :description => 'Enable or disable X-Ray sessions recording transaction traces.'
-        },
-        :'xray_session.allow_profiles' => {
-          :default => true,
-          :public => false,
-          :type => Boolean,
-          :allowed_from_server => true,
-          :description => 'Enable or disable X-Ray sessions taking thread profiles.'
-        },
-        :'xray_session.max_samples' => {
-          :default => 10,
-          :public => false,
-          :type => Integer,
-          :allowed_from_server => true,
-          :description => 'Maximum number of transaction traces to buffer for active X-Ray sessions'
-        },
-        :'xray_session.max_profile_overhead' => {
+        :'thread_profiler.max_profile_overhead' => {
           :default => 0.05,
           :public => false,
           :type => Float,
@@ -1235,6 +1222,13 @@ module NewRelic
           :allowed_from_server => false,
           :description => 'Controls whether to normalize string encodings prior to serializing data for the collector to JSON.'
         },
+        :backport_fast_active_record_connection_lookup => {
+          :default => false,
+          :public => true,
+          :type => Boolean,
+          :allowed_from_server => false,
+          :description => 'Backports the faster ActiveRecord connection lookup introduced in Rails 6, which improves agent performance when instrumenting ActiveRecord. Note that this setting may not be compatible with other gems that patch ActiveRecord.'
+        },
         :disable_vm_sampler => {
           :default      => false,
           :public       => true,
@@ -1273,7 +1267,12 @@ module NewRelic
           :type         => Boolean,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description  => 'If <code>true</code>, disables instrumentation for ActiveRecord 4.'
+          :deprecated   => true,
+          :description  => 'Deprecated.  ' \
+              'For agent versions 6.3 or higher, ' \
+              'use <a href="#disable_active_record_notifications"><code>' \
+                'disable_active_record_notifications' \
+              '</code></a> instead.'
         },
         :disable_active_record_5 => {
           :default      => false,
@@ -1281,7 +1280,20 @@ module NewRelic
           :type         => Boolean,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description  => 'If <code>true</code>, disables instrumentation for ActiveRecord 5.'
+          :deprecated   => true,
+          :description  => 'Deprecated.  ' \
+              'For agent versions 6.3 or higher, ' \
+              'use <a href="#disable_active_record_notifications"><code>' \
+                'disable_active_record_notifications' \
+              '</code></a> instead.'
+        },
+        :disable_active_record_notifications => {
+          :default      => false,
+          :public       => true,
+          :type         => Boolean,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description  => 'If <code>true</code>, disables instrumentation for ActiveRecord 4, 5, and 6.'
         },
         :disable_bunny => {
           :default      => false,
@@ -1793,14 +1805,14 @@ module NewRelic
         },
         :'span_events.enabled' => {
           :default => true,
-          :public => false,
+          :public => true,
           :type => Boolean,
           :allowed_from_server => true,
           :description => 'If <code>true</code>, enables span event sampling.'
         },
         :'span_events.max_samples_stored' => {
           :default => 1000,
-          :public => false,
+          :public => true,
           :type => Integer,
           :allowed_from_server => true,
           :description => 'Defines the maximum number of span events reported from a single harvest.'

data/lib/new_relic/agent/configuration/environment_source.rb

@@ -9,7 +9,8 @@ module NewRelic
         SUPPORTED_PREFIXES = /^new_relic_|^newrelic_/i
         SPECIAL_CASE_KEYS  = [
           'NEW_RELIC_ENV', # read by NewRelic::Control::Frameworks::Ruby
-          'NEW_RELIC_LOG'  # read by set_log_file
+          'NEW_RELIC_LOG',  # read by set_log_file
+          /^NEW_RELIC_METADATA_/ # read by NewRelic::Agent::Connect::RequestBuilder
         ]
 
         attr_accessor :alias_map, :type_map
@@ -66,7 +67,8 @@ module NewRelic
           nr_env_var_keys = collect_new_relic_environment_variable_keys
 
           nr_env_var_keys.each do |key|
-            next if SPECIAL_CASE_KEYS.include?(key.upcase)
+            next if SPECIAL_CASE_KEYS.any? { |pattern| pattern === key.upcase }
+
             set_value_from_environment_variable(key)
           end
         end

data/lib/new_relic/agent/configuration/event_harvest_config.rb

@@ -0,0 +1,39 @@
+# 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.
+
+module NewRelic
+  module Agent
+    module Configuration
+      module EventHarvestConfig
+
+        extend self
+
+        EVENT_HARVEST_CONFIG_KEY_MAPPING = {
+          :analytic_event_data => :'analytics_events.max_samples_stored',
+          :custom_event_data => :'custom_insights_events.max_samples_stored',
+          :error_event_data => :'error_collector.max_event_samples_stored'
+        }
+
+        def from_config(config)
+          {:harvest_limits => EVENT_HARVEST_CONFIG_KEY_MAPPING.inject({}) do
+            |connect_payload, (connect_payload_key, config_key)|
+              connect_payload[connect_payload_key] = config[config_key]
+              connect_payload
+            end
+          }
+        end
+
+        def to_config_hash(connect_reply)
+          config_hash = EVENT_HARVEST_CONFIG_KEY_MAPPING.inject({}) do 
+            |event_harvest_config, (connect_payload_key, config_key)|
+              event_harvest_config[config_key] = connect_reply['event_harvest_config']['harvest_limits'][connect_payload_key.to_s]
+              event_harvest_config
+            end
+          config_hash[:event_report_period] = connect_reply['event_harvest_config']['report_period_ms'] / 1000
+          config_hash
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/configuration/high_security_source.rb

@@ -13,6 +13,7 @@ module NewRelic
             :capture_params           => false,
             :'resque.capture_params'  => false,
             :'sidekiq.capture_params' => false,
+            :'attributes.include'     => [],
 
             :'transaction_tracer.record_sql' => record_sql_setting(local_settings, :'transaction_tracer.record_sql'),
             :'slow_sql.record_sql'           => record_sql_setting(local_settings, :'slow_sql.record_sql'),

data/lib/new_relic/agent/configuration/manager.rb

@@ -95,6 +95,7 @@ module NewRelic
           reset_cache
           log_config(:add, source)
 
+          notify_server_source_added if ServerSource === source
           notify_finished_configuring if !was_finished && finished_configuring?
         end
 
@@ -171,8 +172,19 @@ module NewRelic
           end
         end
 
+        # This event is intended to be fired every time the server source is
+        # applied.  This happens after the agent's initial connect, and again
+        # on every forced reconnect.
+        def notify_server_source_added
+          NewRelic::Agent.instance.events.notify(:server_source_configuration_added)
+        end
+
+        # This event is intended to be fired once during the entire lifespan of
+        # an agent run, after the server source has been applied for the first
+        # time.  This should indicate that all configuration has been applied,
+        # and the main functions of the agent are safe to start.
         def notify_finished_configuring
-          NewRelic::Agent.instance.events.notify(:finished_configuring)
+          NewRelic::Agent.instance.events.notify(:initial_configuration_complete)
         end
 
         def finished_configuring?

data/lib/new_relic/agent/configuration/server_source.rb

@@ -20,7 +20,6 @@ module NewRelic
           "browser_monitoring.loader_version",
           "cross_process_id",
           "data_report_period",
-          "data_report_periods.analytic_event_data",
           "encoding_key",
           "error_beacon",
           "js_agent_file",
@@ -39,6 +38,7 @@ module NewRelic
           merge_top_level_keys(merged_settings, connect_reply)
           merge_agent_config_hash(merged_settings, connect_reply)
           fix_transaction_threshold(merged_settings)
+          add_event_harvest_config(merged_settings, connect_reply)
           filter_keys(merged_settings)
 
           apply_feature_gates(merged_settings, connect_reply, existing_config)
@@ -74,6 +74,39 @@ module NewRelic
           end
         end
 
+        EVENT_HARVEST_CONFIG_SUPPORTABILITY_METRIC_NAMES = {
+          :'analytics_events.max_samples_stored' => 'Supportability/EventHarvest/AnalyticEventData/HarvestLimit',
+          :'custom_insights_events.max_samples_stored' => 'Supportability/EventHarvest/CustomEventData/HarvestLimit',
+          :'error_collector.max_event_samples_stored'=> 'Supportability/EventHarvest/ErrorEventData/HarvestLimit',
+          :event_report_period => 'Supportability/EventHarvest/ReportPeriod'
+        }
+
+        def add_event_harvest_config(merged_settings, connect_reply)
+          return unless event_harvest_config_is_valid connect_reply
+
+          event_harvest_config = EventHarvestConfig.to_config_hash(connect_reply)
+          EVENT_HARVEST_CONFIG_SUPPORTABILITY_METRIC_NAMES.each do |config_key, metric_name|
+            NewRelic::Agent.record_metric metric_name, event_harvest_config[config_key]
+          end
+
+          merged_settings.merge! event_harvest_config
+        end
+
+        def event_harvest_config_is_valid connect_reply
+          event_harvest_config = connect_reply['event_harvest_config']
+
+          if event_harvest_config.nil? \
+              || event_harvest_config['harvest_limits'].values.min < 0 \
+              || (event_harvest_config['report_period_ms'] / 1000) <= 0
+            NewRelic::Agent.logger.warn "Invalid event harvest config found " \
+                "in connect response; using default event report period."
+            NewRelic::Agent.record_metric('Supportability/Agent/Collector/MissingEventHarvestConfig', 1)
+            false
+          else
+            true
+          end
+        end
+
         def filter_keys(merged_settings)
           merged_settings.delete_if do |key, _|
             setting_spec = DEFAULTS[key.to_sym]

data/lib/new_relic/agent/connect/request_builder.rb

@@ -0,0 +1,69 @@
+# 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.
+
+require 'new_relic/environment_report'
+require 'new_relic/agent/configuration/event_harvest_config'
+
+module NewRelic
+  module Agent
+    module Connect
+
+      class RequestBuilder
+
+        def initialize(new_relic_service, config, event_harvest_config)
+          @service = new_relic_service
+          @config = config
+          @event_harvest_config = event_harvest_config
+        end
+
+
+        # Initializes the hash of settings that we send to the
+        # server. Returns a literal hash containing the options
+        def connect_payload
+          {
+            :pid           => $$,
+            :host          => local_host,
+            :display_host  => Agent.config[:'process_host.display_name'],
+            :app_name      => Agent.config.app_names,
+            :language      => 'ruby',
+            :labels        => Agent.config.parsed_labels,
+            :agent_version => NewRelic::VERSION::STRING,
+            :environment   => sanitize_environment_report(environment_report),
+            :metadata      => environment_metadata,
+            :settings      => Agent.config.to_collector_hash,
+            :high_security => Agent.config[:high_security],
+            :utilization   => UtilizationData.new.to_collector_hash,
+            :identifier    => "ruby:#{local_host}:#{Agent.config.app_names.sort.join(',')}",
+            :event_harvest_config => @event_harvest_config
+          }
+        end
+
+        # We've seen objects in the environment report (Rails.env in
+        # particular) that can't seralize to JSON. Cope with that here and
+        # clear out so downstream code doesn't have to check again.
+        def sanitize_environment_report(environment_report)
+          return [] unless @service.valid_to_marshal?(environment_report)
+          environment_report
+        end
+
+        # Checks whether we should send environment info, and if so,
+        # returns the snapshot from the local environment.
+        # Generating the EnvironmentReport has the potential to trigger
+        # require calls in Rails environments, so this method should only
+        # be called synchronously from on the main thread.
+        def environment_report
+          Agent.config[:send_environment_info] ? Array(EnvironmentReport.new) : []
+        end
+
+        def environment_metadata
+          ENV.select {|k, v| k =~ /^NEW_RELIC_METADATA_/}
+        end
+
+        def local_host
+          NewRelic::Agent::Hostname.get
+        end
+      end
+    end
+  end
+end