newrelic_rpm 3.8.0.218 → 3.8.1.221

data/CHANGELOG

@@ -1,5 +1,37 @@
 # New Relic Ruby Agent Release Notes #
 
+## v3.8.1 ##
+
+  * Better handling for Rack applications implemented as middlewares
+
+  When using a Sinatra application as a middleware around another app (for
+  example, a Rails app), or manually instrumenting a Rack middleware wrapped
+  around another application, the agent would previously generate two separate
+  transaction names in the New Relic UI (one for the middleware, and one for
+  the inner application).
+
+  As of this release, the agent will instead unify these two parts into a single
+  transaction in the UI. The unified name will be the name assigned to the
+  inner-most traced transaction by default. Calls to
+  NewRelic::Agent.set_transaction_name will continue to override the default
+  names assigned by the agent's instrumentation code.
+
+  This change also makes it possible to run X-Ray sessions against transactions
+  of the 'inner' application in cases where one instrumented app is wrapped in
+  another that's implemented as a middleware.
+
+  * Support for mongo-1.10.0
+
+  The Ruby agent now instruments version 1.10.0 of the mongo gem (versions 1.8.x
+  and 1.9.x were already supported, and continue to be).
+
+  * Allow setting configuration file path via an option to manual_start
+
+  Previously, passing the :config_path option to NewRelic::Agent.manual_start
+  would not actually affect the location that the agent would use to look for
+  its configuration file. This has been fixed, and the log messages emitted when
+  a configuration file is not found should now be more helpful.
+
 ## v3.8.0 ##
 
   * Better support for forking and daemonizing dispatchers (e.g. Puma, Unicorn)

data/README.md

@@ -4,7 +4,7 @@ New Relic is a performance management system, developed by
 New Relic, Inc (http://www.newrelic.com).  It provides you with deep
 information about the performance of your Rails or Ruby
 application as it runs in production. The New Relic Ruby Agent is
-dual-purposed as a either a Rails plugin or a Gem, hosted on
+dual-purposed as a either a Gem or a Rails plugin, hosted on
 [github](http://github.com/newrelic/rpm/tree/master).
 
 The New Relic Ruby Agent runs in one of two modes:
@@ -51,11 +51,7 @@ and avoid breaking your code with future changes to the agent.
 
 ## Getting Started
 
-Install the Ruby Agent as a gem.
-
-    gem install newrelic_rpm
-
-Or add it to your project's Gemfile.
+Add the Ruby Agent to your project's Gemfile.
 
     gem 'newrelic_rpm'
 
@@ -182,7 +178,8 @@ You can find more detailed documentation [on our website](http://newrelic.com/do
 and specifically in the [Ruby category](http://newrelic.com/docs/ruby).
 
 If you can't find what you're looking for there, reach out to us on our [support
-site](http://support.newrelic.com/) and we'll be happy to help you.
+site](http://support.newrelic.com/) or our [community forum](http://forum.newrelic.com)
+and we'll be happy to help you.
 
 Also available is community support on IRC: we generally use #newrelic
 on irc.freenode.net

data/Rakefile

@@ -1,7 +1,10 @@
 require 'rubygems'
 require 'rake/testtask'
+require 'yard'
 require "#{File.dirname(__FILE__)}/lib/tasks/all.rb"
 
+YARD::Rake::YardocTask.new
+
 task :default => :test
 task :test => ['test:newrelic']
 

data/lib/new_relic/agent.rb

@@ -505,11 +505,7 @@ module NewRelic
     # @api public
     #
     def set_transaction_name(name, options={})
-      if Transaction.current
-        namer = Instrumentation::ControllerInstrumentation::TransactionNamer.new(self)
-        Transaction.current.type = options[:category] if options[:category]
-        Transaction.current.name = "#{namer.category_name(options[:category])}/#{name}"
-      end
+      Transaction.set_overriding_transaction_name(name, options)
     end
 
     # Get the name of the current running transaction.  This is useful if you
@@ -519,8 +515,8 @@ module NewRelic
     #
     def get_transaction_name
       if Transaction.current
-        namer = Instrumentation::ControllerInstrumentation::TransactionNamer.new(self)
-        Transaction.current.name.sub(Regexp.new("\\A#{Regexp.escape(namer.category_name)}/"), '')
+        namer = Instrumentation::ControllerInstrumentation::TransactionNamer
+        Transaction.current.best_name.sub(Regexp.new("\\A#{Regexp.escape(namer.category_name)}/"), '')
       end
     end
 

data/lib/new_relic/agent/agent.rb

@@ -255,16 +255,6 @@ module NewRelic
           end
         end
 
-        # Tells the statistics engine we are starting a new transaction
-        def start_transaction
-          @stats_engine.start_transaction
-        end
-
-        # Tells the statistics engine we are ending a transaction
-        def end_transaction
-          @stats_engine.end_transaction
-        end
-
         # Sets a thread local variable as to whether we should or
         # should not record sql in the current thread. Returns the
         # previous value, if there is one
@@ -419,8 +409,8 @@ module NewRelic
             if Agent.config[:license_key] && Agent.config[:license_key].length > 0
               true
             else
-              ::NewRelic::Agent.logger.warn("No license key found in newrelic.yml config. " +
-                "This often means your newrelic.yml is missing a section for the running environment '#{NewRelic::Control.instance.env}'")
+              ::NewRelic::Agent.logger.warn("No license key found. " +
+                "This often means your newrelic.yml file was not found, or it lacks a section for the running environment, '#{NewRelic::Control.instance.env}'.")
               false
             end
           end
@@ -922,7 +912,7 @@ module NewRelic
           log_error(e)
           if opts[:keep_retrying]
             note_connect_failure
-            ::NewRelic::Agent.logger.warn "Will re-attempt in #{connect_retry_period} seconds"
+            ::NewRelic::Agent.logger.info "Will re-attempt in #{connect_retry_period} seconds"
             sleep connect_retry_period
             retry
           else
@@ -1033,7 +1023,7 @@ module NewRelic
           rescue ForceRestartException, ForceDisconnectException
             raise
           rescue => e
-            NewRelic::Agent.logger.warn("Error during check_for_and_handle_agent_commands, will retry later: ", e)
+            NewRelic::Agent.logger.info("Error during check_for_and_handle_agent_commands, will retry later: ", e)
           end
         end
 

data/lib/new_relic/agent/agent_logger.rb

@@ -16,24 +16,24 @@ module NewRelic
         gather_startup_logs
       end
 
-      def fatal(*msgs)
-        format_and_send(:fatal, msgs)
+      def fatal(*msgs, &blk)
+        format_and_send(:fatal, msgs, &blk)
       end
 
-      def error(*msgs)
-        format_and_send(:error, msgs)
+      def error(*msgs, &blk)
+        format_and_send(:error, msgs, &blk)
       end
 
-      def warn(*msgs)
-        format_and_send(:warn, msgs)
+      def warn(*msgs, &blk)
+        format_and_send(:warn, msgs, &blk)
       end
 
-      def info(*msgs)
-        format_and_send(:info, msgs)
+      def info(*msgs, &blk)
+        format_and_send(:info, msgs, &blk)
       end
 
-      def debug(*msgs)
-        format_and_send(:debug, msgs)
+      def debug(*msgs, &blk)
+        format_and_send(:debug, msgs, &blk)
       end
 
       def log_once(level, key, *msgs)
@@ -74,7 +74,15 @@ module NewRelic
       end
 
       # Allows for passing exceptions in explicitly, which format with backtrace
-      def format_and_send(level, *msgs)
+      def format_and_send(level, *msgs, &block)
+        if block
+          if @log.send("#{level}?")
+            msgs = Array(block.call)
+          else
+            msgs = []
+          end
+        end
+
         msgs.flatten.each do |item|
           case item
           when Exception then log_exception(level, item, :debug)

data/lib/new_relic/agent/autostart.rb

@@ -13,7 +13,7 @@ module NewRelic
     # the console during interactive sessions.
     #
     # It should be possible to override Autostart logic with an explicit
-    # configuration, for example the NEWRELIC_ENABLE environment variable or
+    # configuration, for example the NEWRELIC_AGENT_ENABLED environment variable or
     # agent_enabled key in newrelic.yml
     module Autostart
       extend self

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

@@ -27,16 +27,23 @@ module NewRelic
           result
         end
 
-        def self.config_path
+        def self.config_search_paths
           Proc.new {
-            files = []
-            files << File.join("config","newrelic.yml")
-            files << File.join("newrelic.yml")
+            paths = [
+              File.join("config","newrelic.yml"),
+              File.join("newrelic.yml")
+            ]
             if ENV["HOME"]
-              files << File.join(ENV["HOME"], ".newrelic", "newrelic.yml")
-              files << File.join(ENV["HOME"], "newrelic.yml")
+              paths << File.join(ENV["HOME"], ".newrelic", "newrelic.yml")
+              paths << File.join(ENV["HOME"], "newrelic.yml")
             end
-            found_path = files.detect do |file|
+            paths
+          }
+        end
+
+        def self.config_path
+          Proc.new {
+            found_path = NewRelic::Agent.config[:config_search_paths].detect do |file|
               File.expand_path(file) if File.exists? file
             end
             found_path || ""
@@ -227,6 +234,12 @@ module NewRelic
           :type => String,
           :description => "Path to newrelic.yml. When omitted the agent will check (in order) 'config/newrelic.yml', 'newrelic.yml', $HOME/.newrelic/newrelic.yml' and $HOME/newrelic.yml."
         },
+        :config_search_paths => {
+          :default => DefaultSource.config_search_paths,
+          :public => false,
+          :type => Array,
+          :description => "An array of candidate locations for the agent's configuration file."
+        },
         :app_name => {
           :default => DefaultSource.app_name,
           :public => true,
@@ -525,7 +538,7 @@ module NewRelic
           :default => false,
           :public => true,
           :type => Boolean,
-          :description => 'Enable or disable agent middleware for sinatra. This middleware is responsible for instrumenting advanced feature support for sinatra (e.g. Cross-application tracing, Real User Monitoring, Error collection).'
+          :description => 'Enable or disable agent middleware for sinatra. This middleware is responsible for instrumenting advanced feature support for Sinatra; for example, cross application tracing, page load timing (sometimes referred to as real user monitoring or RUM), and error collection.'
         },
         :disable_view_instrumentation => {
           :default => false,
@@ -657,7 +670,7 @@ module NewRelic
           :default => false,
           :public => true,
           :type => Boolean,
-          :description => 'Enable or disable MongoDB instrumentation.'
+          :description => 'Controls whether instrumentation for the mongo gem will be installed by the agent.'
         },
         :'slow_sql.enabled' => {
           :default => DefaultSource.slow_sql_enabled,
@@ -723,7 +736,7 @@ module NewRelic
           :default => true,
           :public => true,
           :type => Boolean,
-          :description => 'Enable or disable real user monitoring.'
+          :description => 'Enable or disable page load timing (sometimes referred to as real user monitoring or RUM).'
         },
         :browser_key => {
           :default => '',
@@ -759,7 +772,7 @@ module NewRelic
           :default => DefaultSource.browser_monitoring_auto_instrument,
           :public => true,
           :type => Boolean,
-          :description => 'Enable or disable automatic insertion of the real user monitoring header and footer into outgoing responses.'
+          :description => 'Enable or disable automatic insertion of the JavaScript header into outgoing responses for page load timing (sometimes referred to as real user monitoring or RUM).'
         },
         :'browser_monitoring.loader' => {
           :default => DefaultSource.browser_monitoring_loader,
@@ -820,7 +833,7 @@ module NewRelic
           :default => true,
           :public => true,
           :type => Boolean,
-          :description => 'Enable or disable cross-application tracing.'
+          :description => 'Enable or disable cross application tracing.'
         },
         :cross_application_tracing => {
           :default => nil,

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

@@ -42,11 +42,14 @@ module NewRelic
         end
 
         def remove_config(source=nil)
-          if block_given?
-            @config_stack.delete_if {|c| yield c }
-          else
-            @config_stack.delete(source)
+          @config_stack.delete_if do |c|
+            if block_given?
+              yield c
+            else
+              c.class == source.class && c == source
+            end
           end
+
           reset_cache
           invoke_callbacks(:remove, source)
           log_config(:remove, source)
@@ -159,9 +162,13 @@ module NewRelic
         end
 
         def log_config(direction, source)
-          ::NewRelic::Agent.logger.debug(
-            "Updating config (#{direction}) from #{source.class}. Results:",
-            flattened.inspect)
+          # Just generating this log message (specifically calling
+          # flattened.inspect) is expensive enough that we don't want to do it
+          # unless we're actually going to be logging the message based on our
+          # current log level.
+          ::NewRelic::Agent.logger.debug do
+            "Updating config (#{direction}) from #{source.class}. Results: #{flattened.inspect}"
+          end
         end
 
         private

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

@@ -11,16 +11,13 @@ module NewRelic
         attr_accessor :file_path
 
         def initialize(path, env)
-          ::NewRelic::Agent.logger.info("Reading configuration from #{path}")
-
           config = {}
+
           begin
-            @file_path = File.expand_path(path)
-            if !File.exists?(@file_path)
-              ::NewRelic::Agent.logger.error("Unable to load configuration from #{path}")
-              return
-            end
+            @file_path = validate_config_file_path(path)
+            return unless @file_path
 
+            ::NewRelic::Agent.logger.info("Reading configuration from #{path}")
             file = File.read(@file_path)
 
             # Next two are for populating the newrelic.yml via erb binding, necessary
@@ -35,7 +32,7 @@ module NewRelic
 
             config = merge!(confighash[env] || {})
           rescue ScriptError, StandardError => e
-            ::NewRelic::Agent.logger.error("Unable to read configuration file #{path}: #{e}")
+            ::NewRelic::Agent.logger.error("Failed to read or parse configuration file at #{path}: #{e}")
           end
 
           if config['transaction_tracer'] &&
@@ -51,6 +48,40 @@ module NewRelic
 
         protected
 
+        def validate_config_file_path(path)
+          expanded_path = File.expand_path(path)
+
+          if path.empty? || !File.exists?(expanded_path)
+            warn_missing_config_file(expanded_path)
+            return
+          end
+
+          expanded_path
+        end
+
+        def warn_missing_config_file(path)
+          based_on        = 'unknown'
+          source          = ::NewRelic::Agent.config.source(:config_path)
+          candidate_paths = [path]
+
+          case source
+          when DefaultSource
+            based_on = 'defaults'
+            candidate_paths = NewRelic::Agent.config[:config_search_paths].map do |p|
+              File.expand_path(p)
+            end
+          when EnvironmentSource
+            based_on = 'environment variable'
+          when ManualSource
+            based_on = 'API call'
+          end
+
+          NewRelic::Agent.logger.warn(
+            "No configuration file found. Working directory = #{Dir.pwd}",
+            "Looked in these locations (based on #{based_on}): #{candidate_paths.join(", ")}"
+          )
+        end
+
         def with_yaml_engine
           return yield unless NewRelic::LanguageSupport.needs_syck?
 

data/lib/new_relic/agent/cross_app_monitor.rb

@@ -106,13 +106,15 @@ module NewRelic
 
       def insert_response_header(request_headers, response_headers)
         unless client_cross_app_id.nil?
-          unless NewRelic::Agent::TransactionState.get.transaction.nil?
-            NewRelic::Agent::Transaction.freeze_name
-            timings = NewRelic::Agent::TransactionState.get.timings
-            content_length = content_length_from_request(request_headers)
-
-            set_response_headers(response_headers, timings, content_length)
-            set_metrics(client_cross_app_id, timings)
+          txn = NewRelic::Agent::TransactionState.get.most_recent_transaction
+          unless txn.nil?
+            txn.freeze_name_and_execute_if_not_ignored do
+              timings = NewRelic::Agent::TransactionState.get.timings
+              content_length = content_length_from_request(request_headers)
+
+              set_response_headers(response_headers, timings, content_length)
+              set_metrics(client_cross_app_id, timings)
+            end
           end
           clear_client_cross_app_id
         end

data/lib/new_relic/agent/cross_app_tracing.rb

@@ -63,11 +63,11 @@ module NewRelic
       # This method MUST return a pair. The first item always returns the
       # starting time of the trace, even if an error occurs. The second item is
       # the transaction segment if it was sucessfully pushed.
-      def start_trace( request )
+      def start_trace(request)
         t0 = Time.now
 
-        inject_request_headers( request ) if cross_app_enabled?
-        segment = stats_engine.push_scope( :http_request, t0 )
+        inject_request_headers(request) if cross_app_enabled?
+        segment = NewRelic::Agent::TracedMethodStack.push_frame(:http_request, t0)
 
         return t0, segment
       rescue => err
@@ -109,9 +109,9 @@ module NewRelic
             end
           end
         ensure
-          # If we have a segment, always pop the scope stack to avoid an
-          # inconsistent state, which prevents tracing of whole transaction.
-          stats_engine.pop_scope( segment, scoped_metric, t1 ) if segment
+          # If we have a segment, always pop the traced method stack to avoid
+          # an inconsistent state, which prevents tracing of whole transaction.
+          NewRelic::Agent::TracedMethodStack.pop_frame( segment, scoped_metric, t1 ) if segment
         end
       rescue NewRelic::Agent::CrossAppTracing::Error => err
         NewRelic::Agent.logger.debug "while cross app tracing", err