newrelic_rpm 3.14.0.305 → 3.14.1.311

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50bd75d704008669a67edbf82f40967d3465fb59
-  data.tar.gz: 82b7cf098d58c681ea061926fa1568429687cb62
+  metadata.gz: 912e19ec1b6cf6be2d2350e8cb666ac20bb05eb8
+  data.tar.gz: 4e355681d0aa06679be8c4d6ff1dba58be0790c3
 SHA512:
-  metadata.gz: 6160292363ad82115f434f5e6a6e6182ffd2f871aced553cf8465920ead0325a8146f3f5d00a318411b45ce882eafef5ea765bc68379cbb7ae3ab2c13190606e
-  data.tar.gz: 9398fc0ec397fb3ce9b58dfab6b6b0588248907bd6531fba226edbd919708aeeea5a0fe54c815cd65f8a3caf267bf60c1559445b1e339e8c10adcda76f16dc66
+  metadata.gz: 790329aea53676882b79e216d726467a683ada7baad5e41a7a6e5a5dabcaba04e74007747a10f38f8be5020716708af0c7b0202c5c6cd41b4f834c269717c7ed
+  data.tar.gz: 1ce543e65d1868ce3f8f349f5d906bf37474ae4a94d3f265a324903a460af8975b11492acae472b2f7b66efe5513beb896efc74610a4525e448ce3786c4d3631

data/CHANGELOG

@@ -1,5 +1,45 @@
 # New Relic Ruby Agent Release Notes #
 
+## v3.14.1 ##
+
+  * Add support for setting a display name on hosts
+
+  You can now configure a display name for your hosts using process_host.display_name,
+  to more easily distinguish dynamically assigned hosts. For more info, see
+  https://docs.newrelic.com/docs/apm/new-relic-apm/maintenance/add-rename-remove-hosts#display_name
+
+  * Fixes automatic middleware instrumentation for Puma 2.12.x
+
+  Starting with version 2.12.x the Puma project inlines versions of Rack::Builder
+  and Rack::URLMap under the Puma namespace. This had the unfortunate side effect of
+  breaking automatic Rack middleware instrumentation. We now instrument Puma::Rack::Builder
+  and Puma::Rack::URLMap and once again have automatic Rack middleware instrumentation for
+  applications running on Puma.
+
+  * Do not use a DelayedJob's display_name for naming the transaction
+
+  A DelayedJob's name may be superceded by a display_name, which can
+  lead to a metric grouping issue if the display_name contains unique
+  identifiers. We no longer use job name methods that may lead to an
+  arbitrary display_name. Instead, we use the appropriate class and/or
+  method names, depending what makes sense for the job and how it's called.
+
+  * Improvements to Mongo 2.1.x instrumentation
+
+  Fixes issue where getMore operations in batched queries could create metric grouping issues.
+  Previously when multiple Mongo queries executed in the same scope only a single query was recorded
+  as part of a transaction trace. Now transaction trace nodes will be created for every query
+  executed during a transaction.
+
+  * Bugfix for NewRelic::Agent.notice_error
+
+  Fixes issue introduced in v3.14.0 where calling NewRelic::Agent.notice_error outside of an active
+  transaction results in a NoMethodError.
+
+  * Bugfix for Resque TransactionError events
+
+  Fixes error preventing Transaction Error events generated in Resque tasks from being sent to New Relic.
+
 ## v3.14.0 ##
 
   * pruby marshaller removed
@@ -16,9 +56,21 @@
 
   * Additional attributes collected
 
-  The agent now collects the following information in web transactions (not
-  yet shown in the New Relic UI): Accept, Host, User-Agent, Content-Length HTTP
-  request headers, HTTP request method, and Content-Type HTTP response header.
+  The agent now collects the following information in web transactions:
+  Accept, Host, User-Agent, Content-Length HTTP request headers, HTTP request
+  method, and Content-Type HTTP response header.
+
+  * TransactionErrors reported for Advanced Analytics for APM Errors
+
+  With this release, the agent reports TransactionError events. These new events
+  power the beta feature Advanced Analytics for APM Errors. The error events are
+  also available today through New Relic Insights.
+
+  Advanced Analytics for APM Errors lets you see all of your errors, with
+  granular detail. Filter and group by any attribute to analyze them. Take
+  action to resolve issues through collaboration.
+
+  For more information, see https://docs.newrelic.com/docs/apm/applications-menu/events/view-apm-errors-error-traces
 
 ## v3.13.2 ##
 

data/lib/new_relic/agent/agent.rb

@@ -816,6 +816,7 @@ module NewRelic
             settings = {
               :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,

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

@@ -1246,7 +1246,7 @@ module NewRelic
           :type         => Boolean,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description  => 'Defines whether the agent will hook into Rack::Builder\'s <code>to_app</code> method to find gems to instrument during application startup.'
+          :description  => 'If true, prevents the agent from hooking into Rack::Builder\'s <code>to_app</code> method to find gems to instrument during application startup.'
         },
         :disable_rack_urlmap => {
           :default      => false,
@@ -1254,7 +1254,23 @@ module NewRelic
           :type         => Boolean,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description  => 'Defines whether the agent will hook into Rack::URLMap to install middleware tracing.'
+          :description  => 'If true, prevents the agent from hooking into Rack::URLMap to install middleware tracing.'
+        },
+        :disable_puma_rack => {
+          :default      => value_of(:disable_rack),
+          :public       => true,
+          :type         => Boolean,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description  => 'If true, prevents the agent from hooking into Puma::Rack::Builder\'s <code>to_app</code> method to find gems to instrument during application startup.'
+        },
+        :disable_puma_rack_urlmap => {
+          :default      => value_of(:disable_rack_urlmap),
+          :public       => true,
+          :type         => Boolean,
+          :dynamic_name => true,
+          :allowed_from_server => false,
+          :description  => 'If true, prevents the agent from hooking into Puma::Rack::URLMap to install middleware tracing.'
         },
         :disable_rubyprof => {
           :default      => false,
@@ -1301,6 +1317,13 @@ module NewRelic
           :transform    => DefaultSource.method(:convert_to_list),
           :description  => 'List of prefixes for heroku dyno names (such as "scheduler") to report as hostname without trailing dot and process ID.'
         },
+        :'process_host.display_name' => {
+          :default      => Proc.new{ NewRelic::Agent::Hostname.get },
+          :public       => true,
+          :type         => String,
+          :allowed_from_server => false,
+          :description  => 'Custom host name used for display purposes only.'
+        },
         :labels => {
           :default      => '',
           :public       => true,

data/lib/new_relic/agent/error_collector.rb

@@ -199,7 +199,8 @@ module NewRelic
         increment_error_count!(state, exception, options)
         noticed_error = create_noticed_error(exception, options)
         error_trace_aggregator.add_to_error_queue(noticed_error)
-        error_event_aggregator.append_event(noticed_error, state.current_transaction.payload)
+        payload = state.current_transaction ? state.current_transaction.payload : nil
+        error_event_aggregator.append_event(noticed_error, payload)
         exception
       rescue => e
         ::NewRelic::Agent.logger.warn("Failure when capturing error '#{exception}':", e)

data/lib/new_relic/agent/error_event_aggregator.rb

@@ -21,7 +21,7 @@ module NewRelic
         Agent.config[:'error_collector.capture_events']
       end
 
-      def append_event noticed_error, transaction_payload
+      def append_event noticed_error, transaction_payload = nil
         return unless enabled?
 
         @lock.synchronize do
@@ -96,15 +96,18 @@ module NewRelic
           :type => EVENT_TYPE,
           :'error.class' => noticed_error.exception_class_name,
           :'error.message' => noticed_error.message,
-          :timestamp => noticed_error.timestamp.to_f,
-          :transactionName => transaction_payload[:name],
-          :duration => transaction_payload[:duration]
+          :timestamp => noticed_error.timestamp.to_f
         }
+
         attrs[:port] = noticed_error.request_port if noticed_error.request_port
 
-        append_synthetics transaction_payload, attrs
-        append_cat transaction_payload, attrs
-        PayloadMetricMapping.append_mapped_metrics transaction_payload[:metrics], attrs
+        if transaction_payload
+          attrs[:transactionName] = transaction_payload[:name]
+          attrs[:duration] = transaction_payload[:duration]
+          append_synthetics transaction_payload, attrs
+          append_cat transaction_payload, attrs
+          PayloadMetricMapping.append_mapped_metrics transaction_payload[:metrics], attrs
+        end
 
         attrs
       end

data/lib/new_relic/agent/hostname.rb

@@ -7,7 +7,7 @@ module NewRelic
     module Hostname
       def self.get
         dyno_name = ENV['DYNO']
-        if dyno_name && ::NewRelic::Agent.config[:'heroku.use_dyno_names']
+        @hostname ||= if dyno_name && ::NewRelic::Agent.config[:'heroku.use_dyno_names']
           matching_prefix = heroku_dyno_name_prefix(dyno_name)
           dyno_name = "#{matching_prefix}.*" if matching_prefix
           dyno_name

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

@@ -4,6 +4,74 @@
 
 require 'new_relic/agent/instrumentation/controller_instrumentation'
 
+module NewRelic
+  module Agent
+    module Instrumentation
+      module DelayedJob
+        module Naming
+          module_function
+
+          CLASS_METHOD_DELIMITER     = '.'.freeze
+          INSTANCE_METHOD_DELIMITER  = '#'.freeze
+          LEGACY_DJ_FORMAT_DELIMITER = ';'.freeze
+          LEGACY_DJ_FORMAT_PREFIX    = 'LOAD'.freeze
+          LEGACY_DJ_DEFAULT_CLASS    = '(unknown class)'.freeze
+
+          def name_from_payload(payload_object)
+            if payload_object.is_a? ::Delayed::PerformableMethod
+              # payload_object contains a reference to an object
+              # that received an asynchronous method call via .delay or .handle_asynchronously
+              "#{object_name(payload_object)}#{delimiter(payload_object)}#{method_name(payload_object)}"
+            else
+              # payload_object is a user-defined job enqueued via Delayed::Job.enqueue
+              payload_object.class.name
+            end
+          end
+
+          # Older versions of Delayed Job use a semicolon-delimited string to stash the class name.
+          # The format of this string is "LOAD;<class name>;<ORM ID>"
+          def legacy_performable_method?(payload_object)
+            payload_object.object.is_a?(String) && payload_object.object.start_with?(LEGACY_DJ_FORMAT_PREFIX)
+          end
+
+          # If parsing for the class name fails, return a sensible default
+          def class_name_from_legacy_performable_method(payload_object)
+            payload_object.object.split(LEGACY_DJ_FORMAT_DELIMITER)[1] || LEGACY_DJ_DEFAULT_CLASS
+          end
+
+          def object_name(payload_object)
+            if payload_object.object.is_a?(Class)
+              payload_object.object.to_s
+            elsif legacy_performable_method?(payload_object)
+              class_name_from_legacy_performable_method(payload_object)
+            else
+              payload_object.object.class.name
+            end
+          end
+
+          def delimiter(payload_object)
+            if payload_object.object.is_a?(Class)
+              CLASS_METHOD_DELIMITER
+            else
+              INSTANCE_METHOD_DELIMITER
+            end
+          end
+
+          # DelayedJob's interface for the async method's name varies across the gem's versions
+          def method_name(payload_object)
+            if payload_object.respond_to?(:method_name)
+              payload_object.method_name
+            else
+              # early versions of Delayed Job override Object#method with the method name
+              payload_object.method
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
 DependencyDetection.defer do
   @name = :delayed_job
 
@@ -41,13 +109,23 @@ DependencyDetection.defer do
       alias initialize_without_new_relic initialize
       alias initialize initialize_with_new_relic
 
+      NR_TRANSACTION_CATEGORY = 'OtherTransaction/DelayedJob'.freeze
+
       def install_newrelic_job_tracer
         Delayed::Job.class_eval do
           include NewRelic::Agent::Instrumentation::ControllerInstrumentation
-          if self.instance_methods.include?('name') || self.instance_methods.include?(:name)
-            add_transaction_tracer "invoke_job", :category => 'OtherTransaction/DelayedJob', :path => '#{self.name}'
-          else
-            add_transaction_tracer "invoke_job", :category => 'OtherTransaction/DelayedJob'
+
+          alias_method :invoke_job_without_new_relic, :invoke_job
+
+          def invoke_job(*args, &block)
+            options = {
+              :category => NR_TRANSACTION_CATEGORY,
+              :path => ::NewRelic::Agent::Instrumentation::DelayedJob::Naming.name_from_payload(payload_object)
+            }
+
+            perform_action_with_newrelic_trace(options) do
+              invoke_job_without_new_relic(*args, &block)
+            end
           end
         end
       end

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

@@ -39,10 +39,11 @@ module NewRelic
         end
 
         def merge_first_middleware_options(opts, env)
-          opts.merge(
-            :request          => ::Rack::Request.new(env),
-            :apdex_start_time => QueueTime.parse_frontend_timestamp(env)
-          )
+          opts[:apdex_start_time] = QueueTime.parse_frontend_timestamp(env)
+          # this case is for the rare occasion that an app is using Puma::Rack
+          # without having ::Rack as a dependency
+          opts[:request] = ::Rack::Request.new(env) if defined? ::Rack
+          opts
         end
 
         def note_transaction_started(env)

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

@@ -9,6 +9,8 @@ module NewRelic
       class MongodbCommandSubscriber
 
         MONGODB = 'MongoDB'.freeze
+        GET_MORE = "getMore".freeze
+        COLLECTION = "collection".freeze
 
         def started(event)
           begin
@@ -31,9 +33,7 @@ module NewRelic
               base, other_metrics, event.duration
             )
 
-            NewRelic::Agent.instance.transaction_sampler.notice_nosql_statement(
-              generate_statement(started_event), event.duration
-            )
+            notice_nosql_statement(state, started_event, base, event.duration)
           rescue Exception => e
             log_notification_error('completed', e)
           end
@@ -45,7 +45,11 @@ module NewRelic
         private
 
         def collection(event)
-          event.command.values.first
+          if event.command_name == GET_MORE
+            event.command[COLLECTION]
+          else
+            event.command.values.first
+          end
         end
 
         def metrics(event)
@@ -68,6 +72,22 @@ module NewRelic
             event.command
           )
         end
+
+        def notice_nosql_statement(state, event, metric, duration)
+          end_time = Time.now.to_f
+
+          stack  = state.traced_method_stack
+
+          # enter transaction trace node
+          frame = stack.push_frame(state, :mongo_db, end_time - duration)
+
+          NewRelic::Agent.instance.transaction_sampler.notice_nosql_statement(
+              generate_statement(event), duration
+            )
+
+          # exit transaction trace node
+          stack.pop_frame(state, frame, metric, end_time)
+        end
       end
     end
   end

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

@@ -54,14 +54,28 @@ module NewRelic
       end
 
       module RackHelpers
+        def self.version_supported?
+          rack_version_supported? || puma_rack_version_supported?
+        end
+
         def self.rack_version_supported?
+          return false unless defined? ::Rack
+
           version = ::NewRelic::VersionNumber.new(::Rack.release)
           min_version = ::NewRelic::VersionNumber.new('1.1.0')
           version >= min_version
         end
 
+        def self.puma_rack_version_supported?
+          return false unless defined? ::Puma::Const::PUMA_VERSION
+
+          version = ::NewRelic::VersionNumber.new(::Puma::Const::PUMA_VERSION)
+          min_version = ::NewRelic::VersionNumber.new('2.12.0')
+          version >= min_version
+        end
+
         def self.middleware_instrumentation_enabled?
-          rack_version_supported? && !::NewRelic::Agent.config[:disable_middleware_instrumentation]
+          version_supported? && !::NewRelic::Agent.config[:disable_middleware_instrumentation]
         end
 
         def self.check_for_late_instrumentation(app)
@@ -74,6 +88,42 @@ module NewRelic
             end
           end
         end
+
+        def self.instrument_builder builder_class
+          ::NewRelic::Agent.logger.info "Installing deferred #{builder_class} instrumentation"
+
+          builder_class.class_eval do
+            class << self
+              attr_accessor :_nr_deferred_detection_ran
+            end
+            self._nr_deferred_detection_ran = false
+
+            include ::NewRelic::Agent::Instrumentation::RackBuilder
+
+            alias_method :to_app_without_newrelic, :to_app
+            alias_method :to_app, :to_app_with_newrelic_deferred_dependency_detection
+
+            if ::NewRelic::Agent::Instrumentation::RackHelpers.middleware_instrumentation_enabled?
+              ::NewRelic::Agent.logger.info "Installing #{builder_class} middleware instrumentation"
+              alias_method :run_without_newrelic, :run
+              alias_method :run, :run_with_newrelic
+
+              alias_method :use_without_newrelic, :use
+              alias_method :use, :use_with_newrelic
+            end
+          end
+
+          def self.instrument_url_map url_map_class
+            url_map_class.class_eval do
+              alias_method :initialize_without_newrelic, :initialize
+
+              def initialize(map = {})
+                traced_map = ::NewRelic::Agent::Instrumentation::RackURLMap.generate_traced_map(map)
+                initialize_without_newrelic(traced_map)
+              end
+            end
+          end
+        end
       end
 
       module RackBuilder
@@ -102,10 +152,10 @@ module NewRelic
         # DependencyDetection.detect!, since all libraries are likely loaded at
         # this point.
         def to_app_with_newrelic_deferred_dependency_detection
-          unless ::Rack::Builder._nr_deferred_detection_ran
+          unless self.class._nr_deferred_detection_ran
             NewRelic::Agent.logger.info "Doing deferred dependency-detection before Rack startup"
             DependencyDetection.detect!
-            ::Rack::Builder._nr_deferred_detection_ran = true
+            self.class._nr_deferred_detection_ran = true
           end
 
           result = to_app_without_newrelic
@@ -135,29 +185,20 @@ DependencyDetection.defer do
   end
 
   executes do
-    ::NewRelic::Agent.logger.info 'Installing deferred Rack instrumentation'
-
-    class ::Rack::Builder
-      class << self
-        attr_accessor :_nr_deferred_detection_ran
-      end
-      self._nr_deferred_detection_ran = false
-
-      include ::NewRelic::Agent::Instrumentation::RackBuilder
+    ::NewRelic::Agent::Instrumentation::RackHelpers.instrument_builder ::Rack::Builder
+  end
+end
 
-      alias_method :to_app_without_newrelic, :to_app
-      alias_method :to_app, :to_app_with_newrelic_deferred_dependency_detection
 
-      if ::NewRelic::Agent::Instrumentation::RackHelpers.middleware_instrumentation_enabled?
-        ::NewRelic::Agent.logger.info 'Installing Rack::Builder middleware instrumentation'
-        alias_method :run_without_newrelic, :run
-        alias_method :run, :run_with_newrelic
+DependencyDetection.defer do
+  named :puma_rack
 
-        alias_method :use_without_newrelic, :use
-        alias_method :use, :use_with_newrelic
-      end
-    end
+  depends_on do
+    defined?(::Puma::Rack::Builder) && !NewRelic::Agent.config[:disable_puma_rack]
+  end
 
+  executes do
+    ::NewRelic::Agent::Instrumentation::RackHelpers.instrument_builder ::Puma::Rack::Builder
   end
 end
 
@@ -174,13 +215,23 @@ DependencyDetection.defer do
   end
 
   executes do
-    class ::Rack::URLMap
-      alias_method :initialize_without_newrelic, :initialize
+    ::NewRelic::Agent::Instrumentation::RackHelpers.instrument_url_map ::Rack::URLMap
+  end
+end
 
-      def initialize(map = {})
-        traced_map = ::NewRelic::Agent::Instrumentation::RackURLMap.generate_traced_map(map)
-        initialize_without_newrelic(traced_map)
-      end
-    end
+DependencyDetection.defer do
+  named :puma_rack_urlmap
+
+  depends_on do
+    defined? Puma::Rack::URLMap
+  end
+
+  depends_on do
+    ::NewRelic::Agent::Instrumentation::RackHelpers.middleware_instrumentation_enabled? &&
+      !::NewRelic::Agent.config[:disable_puma_rack]
+  end
+
+  executes do
+    ::NewRelic::Agent::Instrumentation::RackHelpers.instrument_url_map ::Puma::Rack::URLMap
   end
 end