newrelic_rpm 6.2.0.354 → 6.3.0.355

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61ee707dd3738565b01b05857ed9ae7de00a6ab3e9cc0522ba5d651819c24634
-  data.tar.gz: e8b630ad8f1c69a51dae797a046f90bd8d87683dcc4a2fb97f2960dcf6f90b4b
+  metadata.gz: 0fad72be0a10cec48b242b8759e92676245a18b92be032e21dd7f652fcc78da2
+  data.tar.gz: 159a8569cf9b0c5caa5a8f5e89811325f9a5a47ac68dfd942e332ec945b43325
 SHA512:
-  metadata.gz: 9ee286b42523ceca71287a9463a6e6a66e825f27956fd460c72aacb640780a20db0e5c688951f2d0a4bb648a4d8bd5dad98220d1f5a98e9abcc51843bd71aa1e
-  data.tar.gz: 1a5070f668fd0b4f802ee71fe3909c123d0b38a53a1491ec07a496177cf9f392015c95ae62284b086a4fd27952fa0e62a7d720813de09449f5b4b8b8c4331a5e
+  metadata.gz: a0a73fa55d266e1daa3ce89941f25ae9cb4b6b9f5a904bdfef4faf837450ff91e2b17ff83e1b870886eefc6bb9b5451ee6bb9f418c4bd2742f63c6e4bcef86ae
+  data.tar.gz: 7d15dd7ada137326cf86d53ddba404628fe606be1aab1284e39ae65ff4985bee6efc8c92c727a99a506ecac5b2b7f20dfffc7435cc59954732261b7d88681861

data/.travis.yml

@@ -75,6 +75,7 @@ env:
     - TYPE=UNIT ENVIRONMENT=rails42
     - TYPE=UNIT ENVIRONMENT=rails50
     - TYPE=UNIT ENVIRONMENT=rails51
+    - TYPE=UNIT ENVIRONMENT=rails60
     - TYPE=UNIT ENVIRONMENT=norails
     - TYPE=FUNCTIONAL GROUP=agent
     - TYPE=FUNCTIONAL GROUP=api
@@ -127,18 +128,32 @@ matrix:
       env: TYPE=UNIT ENVIRONMENT=rails40
     - rvm: 2.4.2
       env: TYPE=UNIT ENVIRONMENT=rails41
+    - rvm: 2.4.2
+      env: TYPE=UNIT ENVIRONMENT=rails60
+
+    # 2.3
+    - rvm: 2.3.5
+      env: TYPE=UNIT ENVIRONMENT=rails60
+
+    # 2.2
+    - rvm: 2.2.8
+      env: TYPE=UNIT ENVIRONMENT=rails60
 
     # 2.1
     - rvm: 2.1.10
       env: TYPE=UNIT ENVIRONMENT=rails50
     - rvm: 2.1.10
       env: TYPE=UNIT ENVIRONMENT=rails51
+    - rvm: 2.1.10
+      env: TYPE=UNIT ENVIRONMENT=rails60
 
     # 2.0
     - rvm: 2.0.0-p648
       env: TYPE=UNIT ENVIRONMENT=rails50
     - rvm: 2.0.0-p648
       env: TYPE=UNIT ENVIRONMENT=rails51
+    - rvm: 2.0.0-p648
+      env: TYPE=UNIT ENVIRONMENT=rails60
 
     # jruby 9.2.6.0 (Compatible with MRI 2.5)
     - rvm: jruby-9.2.6.0
@@ -151,3 +166,5 @@ matrix:
       env: TYPE=UNIT ENVIRONMENT=rails40
     - rvm: jruby-9.2.6.0
       env: TYPE=UNIT ENVIRONMENT=rails41
+    - rvm: jruby-9.2.6.0
+      env: TYPE=UNIT ENVIRONMENT=rails60

data/CHANGELOG.md

@@ -1,19 +1,48 @@
 # New Relic Ruby Agent Release Notes #
 
+## v6.3.0
+
+  * **Official Rails 6.0 support**
+
+    This version of the agent has been verified against the Rails 6.0.0 release.
+
+    As ActiveRecord 4, 5, and 6 use the same New Relic instrumentation, the
+    `disable_active_record_4` and `disable_active_record_5` settings in NewRelic.yml are being
+    deprecated in favor of the new `disable_active_record_notifications`.  This new
+    setting will affect the instrumentation of ActiveRecord 4, 5, and 6. The deprecated settings
+    will be removed in a future release.
+
+  * **Bugfix for `newrelic deployments` script**
+
+    For applications housed in the EU, the `newrelic deployments` script included with previous
+    versions of the agent would fail with the following message: `Deployment not recorded:
+    Application does not exist.` This is because the script would attempt to send the deployment
+    notification to the US region. The deployment script now sends deployments to the correct region.
+
+  * **Faster ActiveRecord connection resolution**
+
+    This version of the agent uses the faster ActiveRecord connection resolution that Rails 6.0 uses, even on previous versions of Rails.
+    Thanks to Callum Jones for the contribution!
+
+  * **Support non-ascii characters in hostnames**
+
+    Previous versions of the agent would frequently log warnings like: `log writing failed.  "\xE2" from ASCII-8BIT to UTF-8` if the hostname contained a non-ascii character.  This version of the agent will no longer log these warnings.
+    Thanks to Rafael Petry for the contribution!
+
 ## v6.2.0
 
   * Bugfix for superfluous `Empty JSON response` error messages
 
-    Version 6.1.0 of the agent frequently logged error messages about an empty 
-    JSON response, when no error had occurred.  These logs no longer appear. 
+    Version 6.1.0 of the agent frequently logged error messages about an empty
+    JSON response, when no error had occurred.  These logs no longer appear.
 
   * Bugfix for `Unable to calculate elapsed transaction time` warning messages
 
-    Ruby Agent versions 5.4 through 6.1, when running in jruby without 
-    ObjectSpace enabled, would occasionally log a warning indicating that the 
+    Ruby Agent versions 5.4 through 6.1, when running in jruby without
+    ObjectSpace enabled, would occasionally log a warning indicating that the
     agent was unable to calculate the elapsed transaction time.  When this log
-    statement appeared, the affected transactions would not be included in the 
-    data displayed on the capacity analysis page.  These transactions are now 
+    statement appeared, the affected transactions would not be included in the
+    data displayed on the capacity analysis page.  These transactions are now
     correctly recorded.
 
 ## v6.1.0

data/lib/new_relic/agent/agent.rb

@@ -30,6 +30,8 @@ require 'new_relic/agent/utilization_data'
 require 'new_relic/environment_report'
 require 'new_relic/agent/attribute_filter'
 require 'new_relic/agent/adaptive_sampler'
+require 'new_relic/agent/connect/request_builder'
+require 'new_relic/agent/connect/response_handler'
 
 module NewRelic
   module Agent
@@ -74,7 +76,6 @@ module NewRelic
 
         @connect_state      = :pending
         @connect_attempts   = 0
-        @environment_report = nil
         @waited_on_connect  = nil
         @connected_pid      = nil
 
@@ -136,7 +137,7 @@ module NewRelic
         # Transaction and metric renaming rules as provided by the
         # collector on connect.  The former are applied during txns,
         # the latter during harvest.
-        attr_reader :transaction_rules
+        attr_accessor :transaction_rules
         # Responsbile for restarting the harvest thread
         attr_reader :harvester
         # GC::Profiler.total_time is not monotonic so we wrap it.
@@ -155,6 +156,10 @@ module NewRelic
           @transaction_event_recorder.synthetics_event_aggregator
         end
 
+        def agent_id=(agent_id)
+          @service.agent_id = agent_id
+        end
+
         # This method should be called in a forked process after a fork.
         # It assumes the parent process initialized the agent, but does
         # not assume the agent started.
@@ -476,7 +481,6 @@ module NewRelic
             @harvester.mark_started
 
             unless in_resque_child_process?
-              generate_environment_report
               install_exit_handler
               @harvest_samplers.load_samplers unless Agent.config[:disable_samplers]
             end
@@ -571,24 +575,6 @@ module NewRelic
             EventLoop.new
           end
 
-          # Never allow any data type to be reported more frequently than once
-          # per second.
-          MIN_ALLOWED_REPORT_PERIOD = 1.0
-
-          def report_period_for(method)
-            config_key = "data_report_periods.#{method}".to_sym
-            period = Agent.config[config_key]
-            if !period
-              period = Agent.config[:data_report_period]
-              ::NewRelic::Agent.logger.warn("Could not find configured period for #{method}, falling back to data_report_period (#{period} s)")
-            end
-            if period < MIN_ALLOWED_REPORT_PERIOD
-              ::NewRelic::Agent.logger.warn("Configured #{config_key} was #{period}, but minimum allowed is #{MIN_ALLOWED_REPORT_PERIOD}, using #{MIN_ALLOWED_REPORT_PERIOD}.")
-              period = MIN_ALLOWED_REPORT_PERIOD
-            end
-            period
-          end
-
           LOG_ONCE_KEYS_RESET_PERIOD = 60.0
 
           def create_and_run_event_loop
@@ -603,7 +589,7 @@ module NewRelic
               ::NewRelic::Agent.logger.clear_already_logged
             end
             @event_loop.fire_every(Agent.config[:data_report_period],       :report_data)
-            @event_loop.fire_every(report_period_for(:analytic_event_data), :report_event_data)
+            @event_loop.fire_every(Agent.config[:event_report_period],      :report_event_data)
             @event_loop.fire_every(LOG_ONCE_KEYS_RESET_PERIOD,              :reset_log_once_keys)
 
             @event_loop.run
@@ -768,10 +754,6 @@ module NewRelic
             shutdown
           end
 
-          def generate_environment_report
-            @environment_report = environment_for_connect
-          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
@@ -781,93 +763,40 @@ module NewRelic
             Agent.config[:send_environment_info] ? Array(EnvironmentReport.new) : []
           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
-            if !@service.valid_to_marshal?(@environment_report)
-              @environment_report = []
-            end
-          end
-
-          # Initializes the hash of settings that we send to the
-          # server. Returns a literal hash containing the options
-          def connect_settings
-            sanitize_environment_report
-
-            {
-              :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   => @environment_report,
-              :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(',')}"
-            }
-          end
-
-          # Returns connect data passed back from the server
+          # Builds the payload to send to the connect service,
+          # connects, then configures the agent using the response from 
+          # the connect service
           def connect_to_server
-            @service.connect(connect_settings)
-          end
+            request_builder = ::NewRelic::Agent::Connect::RequestBuilder.new(@service, Agent.config)
+            connect_response = @service.connect request_builder.connect_payload
 
-          # apdex_f is always 4 times the apdex_t
-          def apdex_f
-            (4 * Agent.config[:apdex_t]).to_f
-          end
+            response_handler = ::NewRelic::Agent::Connect::ResponseHandler.new(self, Agent.config)
+            response_handler.configure_agent(connect_response)
 
-          # Sets the collector host and connects to the server, then
-          # invokes the final configuration with the returned data
-          def query_server_for_configuration
-            finish_setup(connect_to_server)
+            log_connection connect_response if connect_response
+            connect_response
           end
 
-          # Takes a hash of configuration data returned from the
-          # server and uses it to set local variables and to
-          # initialize various parts of the agent that are configured
-          # separately.
-          #
-          # Can accommodate most arbitrary data - anything extra is
-          # ignored unless we say to do something with it here.
-          def finish_setup(config_data)
-            return if config_data == nil
-
-            @service.agent_id = config_data['agent_run_id']
-
-            security_policies = config_data.delete('security_policies')
-
-            add_server_side_config(config_data)
-            add_security_policy_config(security_policies) if security_policies
-
-            log_connection!(config_data)
-            @transaction_rules = RulesEngine.create_transaction_rules(config_data)
-            @stats_engine.metric_rules = RulesEngine.create_metric_rules(config_data)
-
-            # If you're adding something else here to respond to the server-side config,
-            # use Agent.instance.events.subscribe(:finished_configuring) callback instead!
+          # Logs when we connect to the server, for debugging purposes
+          # - makes sure we know if an agent has not connected
+          def log_connection(config_data)
+            ::NewRelic::Agent.logger.debug "Connected to NewRelic Service at #{@service.collector.name}"
+            ::NewRelic::Agent.logger.debug "Agent Run       = #{@service.agent_id}."
+            ::NewRelic::Agent.logger.debug "Connection data = #{config_data.inspect}"
+            if config_data['messages'] && config_data['messages'].any?
+              log_collector_messages(config_data['messages'])
+            end
           end
 
-          def add_server_side_config(config_data)
-            if config_data['agent_config']
-              ::NewRelic::Agent.logger.debug "Using config from server"
+          def log_collector_messages(messages)
+            messages.each do |message|
+              ::NewRelic::Agent.logger.send(message['level'].downcase, message['message'])
             end
-
-            ::NewRelic::Agent.logger.debug "Server provided config: #{config_data.inspect}"
-            server_config = NewRelic::Agent::Configuration::ServerSource.new(config_data, Agent.config)
-            Agent.config.replace_or_add_config(server_config)
           end
 
-          def add_security_policy_config(security_policies)
-            ::NewRelic::Agent.logger.info 'Installing security policies'
-            security_policy_source = NewRelic::Agent::Configuration::SecurityPolicySource.new(security_policies)
-            Agent.config.replace_or_add_config(security_policy_source)
-            # drop data collected before applying security policies
-            drop_buffered_data
+          # apdex_f is always 4 times the apdex_t
+          def apdex_f
+            (4 * Agent.config[:apdex_t]).to_f
           end
 
           class WaitOnConnectTimeout < StandardError
@@ -899,22 +828,6 @@ module NewRelic
             end
           end
 
-          # Logs when we connect to the server, for debugging purposes
-          # - makes sure we know if an agent has not connected
-          def log_connection!(config_data)
-            ::NewRelic::Agent.logger.debug "Connected to NewRelic Service at #{@service.collector.name}"
-            ::NewRelic::Agent.logger.debug "Agent Run       = #{@service.agent_id}."
-            ::NewRelic::Agent.logger.debug "Connection data = #{config_data.inspect}"
-            if config_data['messages'] && config_data['messages'].any?
-              log_collector_messages(config_data['messages'])
-            end
-          end
-
-          def log_collector_messages(messages)
-            messages.each do |message|
-              ::NewRelic::Agent.logger.send(message['level'].downcase, message['message'])
-            end
-          end
         end
         include Connect
 
@@ -974,7 +887,7 @@ module NewRelic
           return unless should_connect?(opts[:force_reconnect])
 
           ::NewRelic::Agent.logger.debug "Connecting Process to New Relic: #$0"
-          query_server_for_configuration
+          connect_to_server
           @connected_pid = $$
           @connect_state = :connected
           signal_connected
@@ -998,15 +911,6 @@ module NewRelic
           raise
         end
 
-        # Who am I? Well, this method can tell you your hostname.
-        def determine_host
-          NewRelic::Agent::Hostname.get
-        end
-
-        def local_host
-          @local_host ||= determine_host
-        end
-
         # Delegates to the control class to determine the root
         # directory of this project
         def determine_home_directory
@@ -1107,7 +1011,10 @@ module NewRelic
           harvest_and_send_from_container(transaction_event_aggregator, :analytic_event_data)
           harvest_and_send_from_container(synthetics_event_aggregator,  :analytic_event_data)
           harvest_and_send_from_container(@custom_event_aggregator,     :custom_event_data)
-          harvest_and_send_from_container(span_event_aggregator,        :span_event_data)
+        end
+
+        def harvest_and_send_span_event_data
+          harvest_and_send_from_container(span_event_aggregator, :span_event_data)
         end
 
         def harvest_and_send_error_event_data
@@ -1167,6 +1074,7 @@ module NewRelic
             harvest_and_send_transaction_traces
             harvest_and_send_slowest_sql
             harvest_and_send_timeslice_data
+            harvest_and_send_span_event_data
 
             check_for_and_handle_agent_commands
             harvest_and_send_for_agent_commands

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.'
@@ -1235,6 +1249,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 => true,
+          :public => false,
+          :type => Boolean,
+          :allowed_from_server => false,
+          :description => 'Enables patching of "sql.active_record" AS Notification to include :connection in payload.'
+        },
         :disable_vm_sampler => {
           :default      => false,
           :public       => true,
@@ -1273,7 +1294,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 +1307,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,