newrelic_rpm 3.7.3.204 → 3.8.0.218

data/CHANGELOG

@@ -1,5 +1,78 @@
 # New Relic Ruby Agent Release Notes #
 
+## v3.8.0 ##
+
+  * Better support for forking and daemonizing dispatchers (e.g. Puma, Unicorn)
+
+  The agent should now work out-of-the box with no special configuration on
+  servers that fork or daemonize themselves (such as Unicorn or Puma in some
+  configurations). The agent's background thread will be automatically restarted
+  after the first transaction processed within each child process.
+
+  This change means it's no longer necessary to set the
+  'restart_thread_in_children setting' in your agent configuration file if you
+  were doing so previously.
+
+  * Rails 4.1 support
+
+  Rails 4.1 has shipped, and the Ruby agent is ready for it! We've been running
+  our test suites against the release candidates with no significant issues, so
+  we're happy to announce full compatibility with this new release of Rails.
+
+  * Ruby VM measurements
+
+  The Ruby agent now records more detailed information about the performance and
+  behavior of the Ruby VM, mainly focused around Ruby's garbage collector. This
+  information is exposed on the new 'Ruby VM' tab in the UI. For details about
+  what is recorded, see:
+
+  http://docs.newrelic.com/docs/ruby/ruby-vm-stats
+
+  * Separate in-transaction GC timings for web and background processes
+
+  Previously, an application with GC instrumentation enabled, and both web and
+  background processes reporting in to it would show an overly inflated GC band
+  on the application overview graph, because data from both web and non-web
+  transactions would be included. This has been fixed, and GC time during web
+  and non-web transactions is now tracked separately.
+
+  * More accurate GC measurements on multi-threaded web servers
+
+  The agent could previously have reported inaccurate GC times on multi-threaded
+  web servers such as Puma. It will now correctly report GC timings in
+  multi-threaded contexts.
+
+  * Improved ActiveMerchant instrumentation
+
+  The agent will now trace the store, unstore, and update methods on
+  ActiveMerchant gateways. In addition, a bug preventing ActiveMerchant
+  instrumentation from working on Ruby 1.9+ has been fixed.
+
+  Thanks to Troex Nevelin for the contribution!
+
+  * More robust Real User Monitoring script injection with charset meta tags
+
+  Previous versions of the agent with Real User Monitoring enabled could have
+  injected JavaScript code into the page above a charset meta tag. By the HTML5
+  spec, the charset tag must appear in the first 1024 bytes of the page, so the
+  Ruby agent will now attempt to inject RUM script after a charset tag, if one
+  is present.
+
+  * More robust connection sequence with New Relic servers
+
+  A rare bug that could cause the agent's initial connection handshake with
+  New Relic servers to silently fail has been fixed, and better logging has been
+  added to the related code path to ease diagnosis of any future issues.
+
+  * Prevent over-counting of queue time with nested transactions
+
+  When using add_transaction_tracer on methods called from within a Rails or
+  Sinatra action, it was previously possible to get inflated queue time
+  measurements, because queue time would be recorded for both the outer
+  transaction (the Rails or Sinatra action) and the inner transaction (the
+  method given to add_transaction_tracer). This has been fixed, so only the
+  outermost transaction will now record queue time.
+
 ## v3.7.3 ##
 
   * Obfuscation for PostgreSQL explain plans

data/README.md

@@ -21,7 +21,7 @@ automatically in Rails applications.
 
 ## Supported Environments
 
-* Ruby 1.8.7, REE, 1.9.x, 2.0.x
+* Ruby 1.8.7, REE, 1.9.x, 2.0.x, 2.1.x
 * JRuby 1.6 and 1.7
 * Rubinius 2.x (Experimental support only)
 * Rails 2.1 or later for Production Mode

data/Rakefile

@@ -23,11 +23,7 @@ namespace :test do
   task :multiverse, [:suite, :param1, :param2, :param3, :param4] => [] do |t, args|
     require File.expand_path(File.join(File.dirname(__FILE__), 'test', 'multiverse', 'lib', 'multiverse', 'environment'))
     opts = Multiverse::Runner.parse_args(args)
-    if opts.key?(:run_one)
-      Multiverse::Runner.run_one(args.suite, opts)
-    else
-      Multiverse::Runner.run(args.suite, opts)
-    end
+    Multiverse::Runner.run(args.suite, opts)
   end
 
   desc "Test the multiverse testing framework by executing tests in test/multiverse/test. Get meta with it."

data/lib/new_relic/agent.rb

@@ -113,6 +113,7 @@ module NewRelic
     require 'new_relic/agent/samplers/memory_sampler'
     require 'new_relic/agent/samplers/object_sampler'
     require 'new_relic/agent/samplers/delayed_job_sampler'
+    require 'new_relic/agent/samplers/vm_sampler'
     require 'set'
     require 'thread'
     require 'resolv'

data/lib/new_relic/agent/agent.rb

@@ -106,6 +106,8 @@ module NewRelic
         # collector on connect.  The former are applied during txns,
         # the latter during harvest.
         attr_reader :transaction_rules
+        # Responsbile for restarting the harvest thread
+        attr_reader :harvester
         attr_reader :harvest_lock
         # GC::Profiler.total_time is not monotonic so we wrap it.
         attr_reader :monotonic_gc_profiler
@@ -166,6 +168,8 @@ module NewRelic
         #   connection, this tells me to only try it once so this method returns
         #   quickly if there is some kind of latency with the server.
         def after_fork(options={})
+          # Mark started early because if we've explicitly called after_fork,
+          # we should be ready to run and shouldn't restarting if we can't.
           @harvester.mark_started
 
           Agent.config.apply_config(NewRelic::Agent::Configuration::ManualSource.new(options), 1)
@@ -173,9 +177,9 @@ module NewRelic
           if channel_id = options[:report_to_channel]
             @service = NewRelic::Agent::PipeService.new(channel_id)
             if connected?
-              @connected_pid = $$
+              @connected_pid = Process.pid
             else
-              ::NewRelic::Agent.logger.debug("Child process #{$$} not reporting to non-connected parent.")
+              ::NewRelic::Agent.logger.debug("Child process #{Process.pid} not reporting to non-connected parent (process #{Process.ppid}).")
               @service.shutdown(Time.now)
               disconnect
             end
@@ -188,13 +192,11 @@ module NewRelic
 
           ::NewRelic::Agent.logger.debug "Starting the worker thread in #{$$} after forking."
 
+          # Clear out locks and stats left over from parent process
           reset_objects_with_locks
-
-          # Clear out stats that are left over from parent process
           drop_buffered_data
 
-          generate_environment_report unless @service.is_a?(NewRelic::Agent::PipeService)
-          start_worker_thread(options)
+          setup_and_start_agent(options)
         end
 
         # True if we have initialized and completed 'start'
@@ -462,16 +464,35 @@ module NewRelic
               !NewRelic::Agent::PipeChannelManager.listener.started?
           end
 
+          def in_resque_child_process?
+            @service.is_a?(NewRelic::Agent::PipeService)
+          end
+
           # Sanity-check the agent configuration and start the agent,
           # setting up the worker thread and the exit handler to shut
           # down the agent
           def check_config_and_start_agent
             return unless monitoring? && has_correct_license_key?
             return if using_forking_dispatcher?
-            generate_environment_report
+            setup_and_start_agent
+          end
+
+          # This is the shared method between the main agent startup and the
+          # after_fork call restarting the thread in deferred dispatchers.
+          #
+          # Treatment of @started and env report is important to get right.
+          def setup_and_start_agent(options={})
+            @started = true
+            @harvester.mark_started
+
+            unless in_resque_child_process?
+              generate_environment_report
+              install_exit_handler
+              @harvest_samplers.load_samplers unless Agent.config[:disable_samplers]
+            end
+
             connect_in_foreground if Agent.config[:sync_startup]
-            start_worker_thread
-            install_exit_handler
+            start_worker_thread(options)
           end
         end
 
@@ -512,8 +533,6 @@ module NewRelic
         def start
           return unless agent_should_start?
 
-          @started = true
-          @local_host = determine_host
           log_startup
           check_config_and_start_agent
           log_version_and_pid
@@ -541,10 +560,6 @@ module NewRelic
           reset_harvest_locks
         end
 
-        def add_harvest_sampler(subclass)
-          @harvest_samplers.add_sampler(subclass)
-        end
-
         private
 
         # All of this module used to be contained in the
@@ -763,12 +778,22 @@ 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,
+              :host => local_host,
               :app_name => Agent.config.app_names,
               :language => 'ruby',
               :agent_version => NewRelic::VERSION::STRING,
@@ -811,7 +836,7 @@ module NewRelic
 
             ::NewRelic::Agent.logger.debug "Server provided config: #{config_data.inspect}"
             server_config = NewRelic::Agent::Configuration::ServerSource.new(config_data, Agent.config)
-            Agent.config.apply_config(server_config, 1)
+            Agent.config.replace_or_add_config(server_config, 1)
             log_connection!(config_data) if @service
 
             @transaction_rules = RulesEngine.from_specs(config_data['transaction_name_rules'])
@@ -912,6 +937,10 @@ module NewRelic
           Socket.gethostname
         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
@@ -934,7 +963,7 @@ module NewRelic
         #  #merge!(items)
         #    merge the given items back into the internal buffer of the
         #    container, so that they may be harvested again later.
-        #  
+        #
         def harvest_and_send_from_container(container, endpoint)
           items = harvest_from_container(container, endpoint)
           send_data_to_endpoint(endpoint, items, container) unless items.empty?

data/lib/new_relic/agent/agent_logger.rb

@@ -54,7 +54,7 @@ module NewRelic
       def log_exception(level, e, backtrace_level=level)
         @log.send(level, "%p: %s" % [ e.class, e.message ])
         @log.send(backtrace_level) do
-          backtrace = e.backtrace
+          backtrace = backtrace_from_exception(e)
           if backtrace
             "Debugging backtrace:\n" + backtrace.join("\n  ")
           else
@@ -63,6 +63,16 @@ module NewRelic
         end
       end
 
+      def backtrace_from_exception(e)
+        # We've seen that often the backtrace on a SystemStackError is bunk
+        # so massage the caller instead at a known depth.
+        #
+        # Tests keep us honest about minmum method depth our log calls add.
+        return caller.drop(5) if e.is_a?(SystemStackError)
+
+        e.backtrace
+      end
+
       # Allows for passing exceptions in explicitly, which format with backtrace
       def format_and_send(level, *msgs)
         msgs.flatten.each do |item|

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

@@ -902,7 +902,7 @@ module NewRelic
           :description => 'Include custom attributes in analytics event data.'
         },
         :restart_thread_in_children => {
-          :default => false,
+          :default => true,
           :public => false,
           :type => Boolean,
           :description => 'Controls whether to check on running a transaction whether to respawn the harvest thread.'
@@ -912,6 +912,90 @@ module NewRelic
           :public => false,
           :type => Boolean,
           :description => 'Controls whether to normalize string encodings prior to serializing data for the collector to JSON.'
+        },
+        :disable_vm_sampler => {
+          :default      => false,
+          :public       => true,
+          :type         => Boolean,
+          :dynamic_name => true,
+          :description  => 'Controls whether the Ruby VM sampler is enabled. This sampler periodically gathers performance measurements from the Ruby VM.'
+        },
+        :disable_memory_sampler => {
+          :default      => false,
+          :public       => true,
+          :type         => Boolean,
+          :dynamic_name => true,
+          :description  => 'Controls whether the memory sampler is enabled. This sampler periodically measures the memory usage of the host process.'
+        },
+        :disable_cpu_sampler => {
+          :default      => false,
+          :public       => true,
+          :type         => Boolean,
+          :dynamic_name => true,
+          :description  => 'Controls whether the CPU sampler is enabled. This sampler periodically samples the CPU usage of the host process.'
+        },
+        :disable_delayed_job_sampler => {
+          :default      => false,
+          :public       => true,
+          :type         => Boolean,
+          :dynamic_name => true,
+          :description  => 'Controls whether the Delayed Job sampler is enabled. This sampler periodically measures the depth of Delayed Job queues.'
+        },
+        :disable_active_record_4 => {
+          :default      => false,
+          :public       => true,
+          :type         => Boolean,
+          :dynamic_name => true,
+          :description  => 'Controls whether instrumentation for ActiveRecord 4 will be installed by the agent.'
+        },
+        :disable_curb => {
+          :default      => false,
+          :public       => true,
+          :type         => Boolean,
+          :dynamic_name => true,
+          :description  => 'Controls whether instrumentation for the curb gem will be installed by the agent.'
+        },
+        :disable_excon => {
+          :default      => false,
+          :public       => true,
+          :type         => Boolean,
+          :dynamic_name => true,
+          :description  => 'Controls whether instrumentation for the excon gem will be installed by the agent.'
+        },
+        :disable_httpclient => {
+          :default      => false,
+          :public       => true,
+          :type         => Boolean,
+          :dynamic_name => true,
+          :description  => 'Controls whether instrumentation for the httpclient gem will be installed by the agent.'
+        },
+        :disable_mongo => {
+          :default      => false,
+          :public       => true,
+          :type         => Boolean,
+          :dynamic_name => true,
+          :description  => 'Controls whether instrumentation for the mongo gem will be installed by the agent.'
+        },
+        :disable_rack => {
+          :default      => false,
+          :public       => true,
+          :type         => Boolean,
+          :dynamic_name => true,
+          :description  => "Controls whether the agent will hook into Rack::Builder's to_app method in order to look for gems to instrument during application startup."
+        },
+        :disable_rubyprof => {
+          :default      => false,
+          :public       => true,
+          :type         => Boolean,
+          :dynamic_name => true,
+          :description  => 'Controls whether the agent will make use of RubyProf in developer mode if it is present.'
+        },
+        :disable_typhoeus => {
+          :default      => false,
+          :public       => true,
+          :type         => Boolean,
+          :dynamic_name => true,
+          :description  => 'Controls whether instrumentation for the typhoeus gem will be installed by the agent.'
         }
       }.freeze
 

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

@@ -53,11 +53,15 @@ module NewRelic
         end
 
         def replace_or_add_config(source, level=0)
-          index = @config_stack.map{|s| s.class}.index(source.class)
+          index = config_stack_index_for(source.class)
           @config_stack.delete_at(index) if index
           apply_config(source, index || level)
         end
 
+        def config_stack_index_for(source_class)
+          @config_stack.map{|s| s.class}.index(source_class)
+        end
+
         def source(key)
           @config_stack.each do |config|
             if config.respond_to?(key.to_sym) || config.has_key?(key.to_sym)

data/lib/new_relic/agent/datastores/mongo.rb

@@ -6,16 +6,21 @@ module NewRelic
   module Agent
     module Datastores
       module Mongo
-
         def self.is_supported_version?
           # No version constant in < 2.0 versions of Mongo :(
           defined?(::Mongo) &&
             defined?(::Mongo::MongoClient) &&
-            !is_version2
+            !is_version2? &&
+            !is_version_1_10_or_later?
+        end
+
+        def self.is_version_1_10_or_later?
+          # Again, no VERSION constant in 1.x, so we have to rely on constant checks
+          defined?(::Mongo::CollectionOperationWriter)
         end
 
         # At present we explicitly don't support version 2.x of the driver yet
-        def self.is_version2
+        def self.is_version2?
           defined?(::Mongo::VERSION) &&
             NewRelic::VersionNumber.new(::Mongo::VERSION) > NewRelic::VersionNumber.new("2.0.0")
         end

data/lib/new_relic/agent/harvester.rb

@@ -5,11 +5,15 @@
 module NewRelic
   module Agent
     class Harvester
+
       attr_accessor :starting_pid
 
       # Inject target for after_fork call to avoid spawning thread in tests
       def initialize(events, after_forker=NewRelic::Agent)
-        @starting_pid = Process.pid
+        # We intentionally don't set our pid as started at this point.
+        # Startup routines must call mark_started when they consider us set!
+        @starting_pid = nil
+
         @after_forker = after_forker
         @lock = Mutex.new