newrelic_rpm 6.5.0.357 → 6.6.0.358

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbc5cbd5b82f24318783bd0178088b454edea1138a4e53ec5f2a046a69a402f9
-  data.tar.gz: e1b6f23c1f0d019849d8cf690ed3330a858730480bfc18950ce2fb94ec95ff01
+  metadata.gz: 6d39324de06656b928892edc72296e459eb2737929e20f054514c2ddc980bfb0
+  data.tar.gz: 3752b1d5dbcd79b38a808460c68141926ae627f0c50ec8cc6ded103285719844
 SHA512:
-  metadata.gz: 7a9709ff031838e7b6faa3fc256dc9fe6a6d8ea0f5124f6d5380465ab4b8d190fa60705b61e8ca5b3b258951b0b2de002b5c0cf4f681b69a54b72dd397dee160
-  data.tar.gz: 40b244372a8ca4f3e6cd8d1886c67fe0af51ad159f5a11cd4bfaf72dccde081959752591135c363b5025bd3ade78c6bf4e69ed7e954917a9f22f85f2142d7bd0
+  metadata.gz: 6f277cc9660dde4ef818de176ad156202ad1993594416882e678b31786386f547b200a96444be1a84bfa53e8385700f07b837d3c500a1e8529d2e4c5d9bbf3ab
+  data.tar.gz: 258bd06b3feaf43c29e8007a6d97003d2d7879b719fc818ba1a374a2167f336f1b4b4352b31d938af24afb0c917751649e62eddaaab41a7955ef55e10f56e84d

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # New Relic Ruby Agent Release Notes #
 
+## v6.6.0
+
+  * **Bugfix for ActionCable Instrumentation**
+
+    Previous versions of the agent sometimes caused application crashes with some versions
+    of ActionCable.  The application would exit quickly after startup with the error:
+    `uninitialized constant ActionCable::Engine`.
+
+    Version 6.6.0 of the agent no longer crashes in this way.
+
+
+  * **Handling of disabling Error Collection**
+
+    When the agent first starts, it begins collecting Error Events and Traces before
+    fetching configuration from New Relic.  In previous versions of the agent, those
+    events or traces would be sent to New Relic, even if _Error Collection_ is disabled in
+    the application's server-side configuration.
+
+    Version 6.6.0 of the agent drops all collected Error Events and Traces if the
+    configuration from the server disables _Error Collection_.
+
 ## v6.5.0
 
 * **Change to default setting for ActiveRecord connection resolution**

data/lib/new_relic/agent/agent.rb

@@ -59,7 +59,7 @@ module NewRelic
         @cross_app_monitor         = NewRelic::Agent::CrossAppMonitor.new(@events)
         @distributed_trace_monitor = NewRelic::Agent::DistributedTraceMonitor.new(@events)
         @synthetics_monitor        = NewRelic::Agent::SyntheticsMonitor.new(@events)
-        @error_collector           = NewRelic::Agent::ErrorCollector.new
+        @error_collector           = NewRelic::Agent::ErrorCollector.new @events
         @transaction_rules         = NewRelic::Agent::RulesEngine.new
         @harvest_samplers          = NewRelic::Agent::SamplerCollection.new(@events)
         @monotonic_gc_profiler     = NewRelic::Agent::VM::MonotonicGCProfiler.new
@@ -70,9 +70,9 @@ module NewRelic
         @harvester       = NewRelic::Agent::Harvester.new(@events)
         @after_fork_lock = Mutex.new
 
-        @transaction_event_recorder = NewRelic::Agent::TransactionEventRecorder.new
-        @custom_event_aggregator    = NewRelic::Agent::CustomEventAggregator.new
-        @span_event_aggregator      = NewRelic::Agent::SpanEventAggregator.new
+        @transaction_event_recorder = NewRelic::Agent::TransactionEventRecorder.new @events
+        @custom_event_aggregator    = NewRelic::Agent::CustomEventAggregator.new @events
+        @span_event_aggregator      = NewRelic::Agent::SpanEventAggregator.new @events
 
         @connect_state      = :pending
         @connect_attempts   = 0
@@ -88,7 +88,7 @@ module NewRelic
       def setup_attribute_filter
         refresh_attribute_filter
 
-        @events.subscribe(:finished_configuring) do
+        @events.subscribe(:initial_configuration_complete) do
           refresh_attribute_filter
         end
       end
@@ -531,7 +531,7 @@ module NewRelic
           check_config_and_start_agent
           log_version_and_pid
 
-          events.subscribe(:finished_configuring) do
+          events.subscribe(:initial_configuration_complete) do
             log_ignore_url_regexes
           end
         end

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

@@ -1017,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' => {
@@ -1223,10 +1224,10 @@ module NewRelic
         },
         :backport_fast_active_record_connection_lookup => {
           :default => false,
-          :public => false,
+          :public => true,
           :type => Boolean,
           :allowed_from_server => false,
-          :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.'
+          :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,
@@ -1804,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/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/connect/response_handler.rb

@@ -35,7 +35,7 @@ module NewRelic
           @agent.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!
+          # use Agent.instance.events.subscribe(:initial_configuration_complete) callback instead!
         end
 
         def add_server_side_config(config_data)

data/lib/new_relic/agent/error_collector.rb

@@ -18,9 +18,9 @@ module NewRelic
       attr_reader :error_trace_aggregator, :error_event_aggregator
 
       # Returns a new error collector
-      def initialize
+      def initialize events
         @error_trace_aggregator = ErrorTraceAggregator.new(MAX_ERROR_QUEUE_LENGTH)
-        @error_event_aggregator = ErrorEventAggregator.new
+        @error_event_aggregator = ErrorEventAggregator.new events
 
         # lookup of exception class names to ignore.  Hash for fast access
         @ignore = {}

data/lib/new_relic/agent/error_event_aggregator.rb

@@ -13,7 +13,8 @@ module NewRelic
 
       named :ErrorEventAggregator
       capacity_key :'error_collector.max_event_samples_stored'
-      enabled_key :'error_collector.capture_events'
+      enabled_keys :'error_collector.enabled',
+                   :'error_collector.capture_events'
       buffer_class PrioritySampledBuffer
 
       def record noticed_error, transaction_payload = nil

data/lib/new_relic/agent/error_trace_aggregator.rb

@@ -91,6 +91,7 @@ module NewRelic
 
       def register_config_callbacks
         Agent.config.register_callback(:'error_collector.enabled') do |enabled|
+          reset! if enabled == false
           ::NewRelic::Agent.logger.debug "Error traces will #{enabled ? '' : 'not '}be sent to the New Relic service."
         end
       end

data/lib/new_relic/agent/event_aggregator.rb

@@ -8,20 +8,6 @@ module NewRelic
   module Agent
     class EventAggregator
       class << self
-        # This architecture requires that every aggregator
-        # implementation provide its own `named`, `capacity_key`, and
-        # `enabled_...` settings.  In particular, we do not allow
-        # subclasses to share these values from an intermediate
-        # superclass.
-
-        def inherited(subclass)
-          # Prevent uninitialized variable warnings; we have to do
-          # this as soon as the subclass is defined, before its
-          # implementor calls enabled_key() or enabled_fn().
-          subclass.instance_variable_set(:@enabled_key, nil)
-          subclass.instance_variable_set(:@enabled_fn,  nil)
-        end
-
         def named named = nil
           named ? @named = named.to_s.freeze : @named
         end
@@ -30,10 +16,25 @@ module NewRelic
           key ? @capacity_key = key : @capacity_key
         end
 
-        def enabled_key key = nil
-          key ? @enabled_key = key : @enabled_key
+        # An aggregator can specify one or more keys to check to see if it is
+        # enabled. Multiple keys will be &&'d and the enabled status of the
+        # aggregator will be reset when agent configuration changes.
+
+        def enabled_keys *keys
+          if keys.empty?
+            @enabled_keys ||= []
+          else
+            @enabled_keys = Array(keys)
+            @enabled_fn = ->(){ @enabled_keys.all? { |k| Agent.config[k] } }
+          end
         end
 
+        alias_method :enabled_key, :enabled_keys
+
+        # This can be used instead of `enabled_key(s)` for more fine grained
+        # control over whether an aggregator should be enabled. The enabled fn
+        # will be reevaluated after configuration changes
+
         def enabled_fn fn = nil
           fn ? @enabled_fn = fn : @enabled_fn
         end
@@ -47,13 +48,13 @@ module NewRelic
         end
       end
 
-      def initialize
+      def initialize events
         @lock = Mutex.new
         @buffer = self.class.buffer_class.new NewRelic::Agent.config[self.class.capacity_key]
-        @enabled = false
+        @enabled = self.class.enabled_fn ? self.class.enabled_fn.call : false
         @notified_full = false
         register_capacity_callback
-        register_enabled_callback
+        register_enabled_callback events
         after_initialize
       end
 
@@ -66,7 +67,6 @@ module NewRelic
       end
 
       def enabled?
-        return self.class.enabled_fn.call if self.class.enabled_fn
         @enabled
       end
 
@@ -126,18 +126,12 @@ module NewRelic
         end
       end
 
-      def register_enabled_callback
-        unless self.class.enabled_key || self.class.enabled_fn
-          ::NewRelic::Agent.logger.warn "#{self.class.named} needs an enabled_key or an enabled_fn."
-        end
-
-        return if self.class.enabled_fn
-
-        NewRelic::Agent.config.register_callback(self.class.enabled_key) do |enabled|
-          # intentionally unsynchronized for liveness
-          @enabled = enabled
-          ::NewRelic::Agent.logger.debug "#{self.class.named} will #{enabled ? '' : 'not '}be sent to the New Relic service."
-        end
+      def register_enabled_callback events
+        events.subscribe(:server_source_configuration_added) {
+          @enabled = self.class.enabled_fn.call
+          reset! if @enabled == false
+          ::NewRelic::Agent.logger.debug "#{self.class.named} will #{@enabled ? '' : 'not '}be sent to the New Relic service."
+        }
       end
 
       def notify_if_full

data/lib/new_relic/agent/inbound_request_monitor.rb

@@ -20,8 +20,8 @@ module NewRelic
       attr_reader :obfuscator
 
       def initialize(events)
-        events.subscribe(:finished_configuring) do
-          # This requires :encoding_key, so must wait until :finished_configuring
+        events.subscribe(:initial_configuration_complete) do
+          # This requires :encoding_key, so must wait until :initial_configuration_complete
           setup_obfuscator
           on_finished_configuring(events)
         end

data/lib/new_relic/agent/instrumentation/rails_notifications/action_cable.rb

@@ -28,9 +28,8 @@ DependencyDetection.defer do
       NewRelic::Agent::Instrumentation::ActionCableSubscriber.new)
 
     ActiveSupport.on_load(:action_cable) do
-      ::NewRelic::Agent::PrependSupportability.record_metrics_for(
-        ::ActionCable::Engine,
-        ::ActionCable::RemoteConnections)
+      ::NewRelic::Agent::PrependSupportability.record_metrics_for(::ActionCable::Engine) if defined?(::ActionCable::Engine)
+      ::NewRelic::Agent::PrependSupportability.record_metrics_for(::ActionCable::RemoteConnections) if defined?(::ActionCable::RemoteConnections)
     end
   end
 end

data/lib/new_relic/agent/javascript_instrumentor.rb

@@ -14,7 +14,7 @@ module NewRelic
       RUM_KEY_LENGTH = 13
 
       def initialize(event_listener)
-        event_listener.subscribe(:finished_configuring, &method(:log_configuration))
+        event_listener.subscribe(:initial_configuration_complete, &method(:log_configuration))
       end
 
       def log_configuration

data/lib/new_relic/agent/span_event_aggregator.rb

@@ -12,11 +12,8 @@ module NewRelic
     class SpanEventAggregator < EventAggregator
       named :SpanEventAggregator
       capacity_key :'span_events.max_samples_stored'
-
-      enabled_fn -> {
-        NewRelic::Agent.config[:'span_events.enabled'] &&
-        NewRelic::Agent.config[:'distributed_tracing.enabled']
-      }
+      enabled_keys :'span_events.enabled',
+                   :'distributed_tracing.enabled'
 
       def record priority: nil, event:nil, &blk
         unless(event || priority && blk)

data/lib/new_relic/agent/transaction_event_recorder.rb

@@ -14,9 +14,9 @@ module NewRelic
       attr_reader :transaction_event_aggregator
       attr_reader :synthetics_event_aggregator
 
-      def initialize
-        @transaction_event_aggregator = NewRelic::Agent::TransactionEventAggregator.new
-        @synthetics_event_aggregator = NewRelic::Agent::SyntheticsEventAggregator.new
+      def initialize events
+        @transaction_event_aggregator = NewRelic::Agent::TransactionEventAggregator.new events
+        @synthetics_event_aggregator = NewRelic::Agent::SyntheticsEventAggregator.new events
       end
 
       def record payload

data/lib/new_relic/version.rb

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

data/test/agent_helper.rb

@@ -452,6 +452,13 @@ def with_config(config_hash, at_start=true)
   end
 end
 
+def with_server_source config_hash, at_start=true
+  with_config config_hash, at_start do
+    NewRelic::Agent.config.notify_server_source_added
+    yield
+  end
+end
+
 def with_config_low_priority(config_hash)
   with_config(config_hash, false) do
     yield

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newrelic_rpm
 version: !ruby/object:Gem::Version
-  version: 6.5.0.357
+  version: 6.6.0.358
 platform: ruby
 authors:
 - Matthew Wear
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-21 00:00:00.000000000 Z
+date: 2019-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake