newrelic_rpm 6.4.0.356 → 6.5.0.357

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b076c28227c61e989c31bb41023266f4319602621a913cc403e224d7e5c5822
-  data.tar.gz: '06062208e9ca3921d1d3353ea91dcc84423747496f6744b617053e98d8488a83'
+  metadata.gz: bbc5cbd5b82f24318783bd0178088b454edea1138a4e53ec5f2a046a69a402f9
+  data.tar.gz: e1b6f23c1f0d019849d8cf690ed3330a858730480bfc18950ce2fb94ec95ff01
 SHA512:
-  metadata.gz: f5ab26028a95f4bb69d6ae882733b0796f0e547cae5a0c276413b0c8daf701eed0697a67b4ad87e64c43e9d1359af37dc9a187f41d59cb2e24caa8b6bbd25afe
-  data.tar.gz: d67d418c31585f72e05173c10c858a649ca5f6615dfc80cdfaa25fee451055cf20430aac5602c4553468c7ff5018675b734902674a83a44be27f4e54c077df6c
+  metadata.gz: 7a9709ff031838e7b6faa3fc256dc9fe6a6d8ea0f5124f6d5380465ab4b8d190fa60705b61e8ca5b3b258951b0b2de002b5c0cf4f681b69a54b72dd397dee160
+  data.tar.gz: 40b244372a8ca4f3e6cd8d1886c67fe0af51ad159f5a11cd4bfaf72dccde081959752591135c363b5025bd3ade78c6bf4e69ed7e954917a9f22f85f2142d7bd0

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # New Relic Ruby Agent Release Notes #
 
+## v6.5.0
+
+* **Change to default setting for ActiveRecord connection resolution**
+
+  Due to incompatibilities between the faster ActiveRecord connection resolution
+  released in v6.3.0 of the agent and other gems which patch ActiveRecord,
+  `backport_fast_active_record_connection_lookup` will now be set to `false` by default.
+  Because it results in a significant performance improvement, we recommend customers
+  whose environments include ActiveRecord change this setting to `true`
+  _unless_ they are using other gems which measure ActiveRecord performance, which may
+  lose functionality when combined with this setting. If unsure whether to enable
+  `backport_fast_active_record_connection_lookup`, we recommend enabling it in a
+  development environment to make sure other gems which patch ActiveRecord are still
+  working as expected.
+
+* **Bugfix for ActiveStorage instrumentation error**
+
+  Version 6.4.0 of the agent introduced a bug that interfered with ActiveStorage
+  callbacks, resulting in the agent being unable to instrument ActiveStorage operations.
+  ActiveStorage segments are now correctly recorded.
+
+* **Bugfix for ActiveRecord 4.1 and 4.2 exception logging**
+
+  Version 6.3.0 of the agent introduced a bug that prevented ActiveRecord versions 4.1
+  and 4.2 from logging exceptions that occurred within a database transaction.  This
+  version of the agent restores the exception logging functionality from previous agent
+  versions.
+  Thanks to Oleksiy Kovyrin for the contribution!
+
 ## v6.4.0
 
 * **Custom Metadata Collection**

data/lib/new_relic/agent/agent.rb

@@ -763,11 +763,20 @@ module NewRelic
             Agent.config[:send_environment_info] ? Array(EnvironmentReport.new) : []
           end
 
+          # Constructs and memoizes an event_harvest_config hash to be used in 
+          # the payload sent during connect (and reconnect)
+          def event_harvest_config
+            @event_harvest_config ||= Configuration::EventHarvestConfig.from_config(Agent.config)
+          end
+
           # 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
-            request_builder = ::NewRelic::Agent::Connect::RequestBuilder.new(@service, Agent.config)
+            request_builder = ::NewRelic::Agent::Connect::RequestBuilder.new \
+              @service,
+              Agent.config,
+              event_harvest_config
             connect_response = @service.connect request_builder.connect_payload
 
             response_handler = ::NewRelic::Agent::Connect::ResponseHandler.new(self, Agent.config)

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

@@ -1222,11 +1222,11 @@ module NewRelic
           :description => 'Controls whether to normalize string encodings prior to serializing data for the collector to JSON.'
         },
         :backport_fast_active_record_connection_lookup => {
-          :default => true,
+          :default => false,
           :public => false,
           :type => Boolean,
           :allowed_from_server => false,
-          :description => 'Enables patching of "sql.active_record" AS Notification to include :connection in payload.'
+          :description => 'Enables patching of "sql.active_record" AS Notification to include :connection in payload. Note that this setting may not be compatible with other gems that patch ActiveRecord.'
         },
         :disable_vm_sampler => {
           :default      => false,

data/lib/new_relic/agent/configuration/{event_data.rb → event_harvest_config.rb}

@@ -5,32 +5,32 @@
 module NewRelic
   module Agent
     module Configuration
-      module EventData
+      module EventHarvestConfig
 
         extend self
 
-        EVENT_DATA_CONFIG_KEY_MAPPING = {
+        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_DATA_CONFIG_KEY_MAPPING.inject({}) do
-            |event_data, (event_data_key, config_key)|
-              event_data[event_data_key] = config[config_key]
-              event_data
+          {: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_DATA_CONFIG_KEY_MAPPING.inject({}) do 
-            |event_data, (event_data_key, config_key)|
-              event_data[config_key] = connect_reply['event_data']['harvest_limits'][event_data_key.to_s]
-              event_data
+          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_data']['report_period_ms'] / 1000
+          config_hash[:event_report_period] = connect_reply['event_harvest_config']['report_period_ms'] / 1000
           config_hash
         end
       end

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

@@ -38,7 +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_data(merged_settings, connect_reply)
+          add_event_harvest_config(merged_settings, connect_reply)
           filter_keys(merged_settings)
 
           apply_feature_gates(merged_settings, connect_reply, existing_config)
@@ -74,14 +74,37 @@ module NewRelic
           end
         end
 
-        def add_event_data(merged_settings, connect_reply)
-            if connect_reply['event_data']
-              merged_settings.merge! EventData.to_config_hash(connect_reply)
-            else
-              NewRelic::Agent.logger.warn "No event data configuration found " \
-                  "in connect response; using default event report period."
-              NewRelic::Agent.record_metric('Supportability/Agent/Collector/MissingEventData', 1)
-            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)

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

@@ -3,7 +3,7 @@
 # See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
 
 require 'new_relic/environment_report'
-require 'new_relic/agent/configuration/event_data'
+require 'new_relic/agent/configuration/event_harvest_config'
 
 module NewRelic
   module Agent
@@ -11,9 +11,10 @@ module NewRelic
 
       class RequestBuilder
 
-        def initialize(new_relic_service, config)
+        def initialize(new_relic_service, config, event_harvest_config)
           @service = new_relic_service
           @config = config
+          @event_harvest_config = event_harvest_config
         end
 
 
@@ -34,7 +35,7 @@ module NewRelic
             :high_security => Agent.config[:high_security],
             :utilization   => UtilizationData.new.to_collector_hash,
             :identifier    => "ruby:#{local_host}:#{Agent.config.app_names.sort.join(',')}",
-            :event_data    => Configuration::EventData.from_config(Agent.config)
+            :event_harvest_config => @event_harvest_config
           }
         end
 

data/lib/new_relic/agent/instrumentation/active_record_notifications.rb

@@ -13,18 +13,13 @@ module NewRelic
   module Agent
     module Instrumentation
       module ActiveRecordNotifications
-        module BaseExtensions41
-          def self.included(base)
-            base.class_eval do
-              alias_method :log_without_performance_improvement, :log
-              alias_method :log, :log_with_performance_improvement
-            end
-          end
+        SQL_ACTIVE_RECORD = 'sql.active_record'.freeze
 
+        module BaseExtensions4x
           # https://github.com/rails/rails/blob/4-1-stable/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb#L371
-          def log_with_performance_improvement(sql, name = "SQL", binds = [], statement_name = nil)
+          def log(sql, name = "SQL", binds = [], statement_name = nil)
             @instrumenter.instrument(
-              "sql.active_record",
+              SQL_ACTIVE_RECORD,
               :sql            => sql,
               :name           => name,
               :connection_id  => object_id,
@@ -32,22 +27,20 @@ module NewRelic
               :statement_name => statement_name,
               :binds          => binds) { yield }
           rescue => e
-            raise translate_exception(e, sql)
+            # The translate_exception_class method got introduced in 4.1
+            if ::ActiveRecord::VERSION::MINOR == 0
+              raise translate_exception(e, sql)
+            else
+              raise translate_exception_class(e, sql)
+            end
           end
         end
 
         module BaseExtensions50
-          def self.included(base)
-            base.class_eval do
-              alias_method :log_without_performance_improvement, :log
-              alias_method :log, :log_with_performance_improvement
-            end
-          end
-
           # https://github.com/rails/rails/blob/5-0-stable/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb#L582
-          def log_with_performance_improvement(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil)
+          def log(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil)
             @instrumenter.instrument(
-              "sql.active_record",
+              SQL_ACTIVE_RECORD,
               sql:               sql,
               name:              name,
               binds:             binds,
@@ -61,17 +54,10 @@ module NewRelic
         end
 
         module BaseExtensions51
-          def self.included(base)
-            base.class_eval do
-              alias_method :log_without_performance_improvement, :log
-              alias_method :log, :log_with_performance_improvement
-            end
-          end
-
           # https://github.com/rails/rails/blob/5-1-stable/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb#L603
-          def log_with_performance_improvement(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil) # :doc:
+          def log(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil) # :doc:
             @instrumenter.instrument(
-              "sql.active_record",
+              SQL_ACTIVE_RECORD,
               sql:               sql,
               name:              name,
               binds:             binds,
@@ -154,19 +140,19 @@ DependencyDetection.defer do
 
   executes do
     if NewRelic::Agent.config[:backport_fast_active_record_connection_lookup]
-
-      activerecord_extension = if ::ActiveRecord::VERSION::MAJOR.to_i == 4
-        ::NewRelic::Agent::Instrumentation::ActiveRecordNotifications::BaseExtensions41
-      elsif ::ActiveRecord::VERSION::MAJOR.to_i == 5
-        if ::ActiveRecord::VERSION::MINOR.to_i == 0
-          ::NewRelic::Agent::Instrumentation::ActiveRecordNotifications::BaseExtensions50
-        elsif ::ActiveRecord::VERSION::MINOR.to_i >= 1
-          ::NewRelic::Agent::Instrumentation::ActiveRecordNotifications::BaseExtensions51
-        end
+      major_version = ::ActiveRecord::VERSION::MAJOR.to_i
+      minor_version = ::ActiveRecord::VERSION::MINOR.to_i
+
+      activerecord_extension = if major_version == 4
+        ::NewRelic::Agent::Instrumentation::ActiveRecordNotifications::BaseExtensions4x
+      elsif major_version == 5 && minor_version == 0
+        ::NewRelic::Agent::Instrumentation::ActiveRecordNotifications::BaseExtensions50
+      elsif major_version == 5 && minor_version == 1
+        ::NewRelic::Agent::Instrumentation::ActiveRecordNotifications::BaseExtensions51
       end
 
       unless activerecord_extension.nil?
-        ::ActiveRecord::ConnectionAdapters::AbstractAdapter.send(:include, activerecord_extension)
+        ::ActiveRecord::ConnectionAdapters::AbstractAdapter.send(:prepend, activerecord_extension)
       end
     end
   end

data/lib/new_relic/agent/instrumentation/active_storage_subscriber.rb

@@ -25,11 +25,11 @@ module NewRelic
           segment = Tracer.start_segment name: metric_name(name, payload)
           segment.params[:key] = payload[:key]
           segment.params[:exist] = payload[:exist] if payload.key? :exist
-          event_stack[id].push segment
+          push_segment id, segment
         end
 
         def finish_segment id
-          segment = event_stack[id].pop
+          segment = pop_segment id
           segment.finish if segment
         end
 

data/lib/new_relic/agent/priority_sampled_buffer.rb

@@ -22,6 +22,8 @@ module NewRelic
       def append(priority: nil, event: nil, &blk)
         increment_seen
 
+        return if @capacity == 0
+
         if @seen == @capacity
           @items = Heap.new(@items) { |x| priority_for(x) }
         end

data/lib/new_relic/version.rb

@@ -11,7 +11,7 @@ module NewRelic
     end
 
     MAJOR = 6
-    MINOR = 4
+    MINOR = 5
     TINY  = 0
 
     begin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newrelic_rpm
 version: !ruby/object:Gem::Version
-  version: 6.4.0.356
+  version: 6.5.0.357
 platform: ruby
 authors:
 - Matthew Wear
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-21 00:00:00.000000000 Z
+date: 2019-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -182,7 +182,7 @@ files:
 - lib/new_relic/agent/configuration/default_source.rb
 - lib/new_relic/agent/configuration/dotted_hash.rb
 - lib/new_relic/agent/configuration/environment_source.rb
-- lib/new_relic/agent/configuration/event_data.rb
+- lib/new_relic/agent/configuration/event_harvest_config.rb
 - lib/new_relic/agent/configuration/high_security_source.rb
 - lib/new_relic/agent/configuration/manager.rb
 - lib/new_relic/agent/configuration/manual_source.rb