newrelic_rpm 2.11.0.beta → 2.11.0.beta2

data/lib/new_relic/agent.rb

@@ -31,8 +31,8 @@
 #
 # == Configuring the Agent
 # 
-# All agent configuration is done in the <tt>newrelic.yml</tt> file.  This
-# file is by default read from the +config+ directory of the
+# All agent configuration is done in the <tt>newrelic.yml</tt> file.
+# This file is by default read from the +config+ directory of the
 # application root and is subsequently searched for in the application
 # root directory, and then in a <tt>~/.newrelic</tt> directory
 #
@@ -171,16 +171,17 @@ module NewRelic
     # Call this to manually start the Agent in situations where the Agent does
     # not auto-start.
     # 
-    # When the app environment loads, so does the Agent. However, the Agent will
-    # only connect to RPM if a web front-end is found. If you want to selectively monitor
-    # ruby processes that don't use web plugins, then call this method in your
-    # code and the Agent will fire up and start reporting to RPM.
+    # When the app environment loads, so does the Agent. However, the
+    # Agent will only connect to RPM if a web front-end is found. If
+    # you want to selectively monitor ruby processes that don't use
+    # web plugins, then call this method in your code and the Agent
+    # will fire up and start reporting to RPM.
     #
-    # Options are passed in as overrides for values in the newrelic.yml, such
-    # as app_name.  In addition, the option +log+ will take a logger that
-    # will be used instead of the standard file logger.  The setting for
-    # the newrelic.yml section to use (ie, RAILS_ENV) can be overridden
-    # with an :env argument.
+    # Options are passed in as overrides for values in the
+    # newrelic.yml, such as app_name.  In addition, the option +log+
+    # will take a logger that will be used instead of the standard
+    # file logger.  The setting for the newrelic.yml section to use
+    # (ie, RAILS_ENV) can be overridden with an :env argument.
     #
     def manual_start(options={})
       raise unless Hash === options
@@ -188,32 +189,52 @@ module NewRelic
     end
     
     # Register this method as a callback for processes that fork
-    # jobs.  If the master/parent connects to the agent prior to forking
-    # the agent in the forked process will use that agent_run.  
-    # Otherwise the forked process will establish a new connection
-    # with the server.
-    def after_fork
-      agent.after_fork
+    # jobs.  
+    #
+    # Pass <tt>:force_reconnect => true</tt> to force the agent to
+    # reconnect to the server and start a worker loop for sending
+    # data.
+    #
+    # If the master/parent connects to the agent prior to forking the
+    # agent in the forked process will use that agent_run.  Otherwise
+    # the forked process will establish a new connection with the
+    # server.
+    # 
+    # Use this especially when you fork the process to run background
+    # jobs or other work.  If you are doing this with a web dispatcher
+    # that forks worker processes then you will need to force the
+    # agent to reconnect, which it won't do by default.  Passenger and
+    # Unicorn are already handled, nothing special needed for them.
+    def after_fork(options={})
+      agent.after_fork(options)
     end
+    
+    # Clear out any unsent metric data.
+    def reset_stats
+      agent.reset_stats
+    end
+
     # Shutdown the agent.  Call this before exiting.  Sends any queued data
     # and kills the background thread.
     def shutdown
       agent.shutdown
     end        
 
-    # Add instrumentation files to the agent.  The argument should be a glob
-    # matching ruby scripts which will be executed at the time instrumentation 
-    # is loaded.  Since instrumentation is not loaded when the agent is not
-    # running it's better to use this method to register instrumentation than
-    # just loading the files directly, although that probably also works. 
+    # Add instrumentation files to the agent.  The argument should be
+    # a glob matching ruby scripts which will be executed at the time
+    # instrumentation is loaded.  Since instrumentation is not loaded
+    # when the agent is not running it's better to use this method to
+    # register instrumentation than just loading the files directly,
+    # although that probably also works.
     def add_instrumentation file_pattern
       NewRelic::Control.instance.add_instrumentation file_pattern
     end
 
-    # This method sets the block sent to this method as a sql obfuscator. 
-    # The block will be called with a single String SQL statement to obfuscate.
-    # The method must return the obfuscated String SQL. 
-    # If chaining of obfuscators is required, use type = :before or :after
+    # This method sets the block sent to this method as a sql
+    # obfuscator.  The block will be called with a single String SQL
+    # statement to obfuscate.  The method must return the obfuscated
+    # String SQL.  If chaining of obfuscators is required, use type =
+    # :before or :after
     #
     # type = :before, :replace, :after
     #
@@ -257,9 +278,9 @@ module NewRelic
       end
     end
     
-    # Cancel the collection of the current transaction in progress, if any.
-    # Only affects the transaction started on this thread once it has started
-    # and before it has completed.
+    # Cancel the collection of the current transaction in progress, if
+    # any.  Only affects the transaction started on this thread once
+    # it has started and before it has completed.
     def abort_transaction!
       # The class may not be loaded if the agent is disabled
       if defined? NewRelic::Agent::Instrumentation::MetricFrame
@@ -267,10 +288,11 @@ module NewRelic
       end
     end
     
-    # Yield to the block without collecting any metrics or traces in any of the
-    # subsequent calls.  If executed recursively, will keep track of the first
-    # entry point and turn on tracing again after leaving that block.
-    # This uses the thread local +newrelic_untrace+
+    # Yield to the block without collecting any metrics or traces in
+    # any of the subsequent calls.  If executed recursively, will keep
+    # track of the first entry point and turn on tracing again after
+    # leaving that block.  This uses the thread local
+    # +newrelic_untrace+
     def disable_all_tracing
       agent.push_trace_execution_flag(false)
       yield
@@ -283,9 +305,10 @@ module NewRelic
       Thread.current[:newrelic_untraced].nil? || Thread.current[:newrelic_untraced].last != false      
     end
 
-    # Set a filter to be applied to errors that RPM will track.
-    # The block should evalute to the exception to track (which could be different from
-    # the original exception) or nil to ignore this exception.
+    # Set a filter to be applied to errors that RPM will track.  The
+    # block should evalute to the exception to track (which could be
+    # different from the original exception) or nil to ignore this
+    # exception.
     #
     # The block is yielded to with the exception to filter. 
     # 
@@ -295,8 +318,8 @@ module NewRelic
       agent.error_collector.ignore_error_filter(&block)
     end
     
-    # Record the given error in RPM.  It will be passed through the #ignore_error_filter
-    # if there is one.
+    # Record the given error in RPM.  It will be passed through the
+    # #ignore_error_filter if there is one.
     # 
     # * <tt>exception</tt> is the exception which will be recorded
     # Options:
@@ -322,13 +345,14 @@ module NewRelic
     # and is now deprecated.
     alias add_request_parameters add_custom_parameters #:nodoc:
     
-    # Yield to a block that is run with a database metric name context.  This means
-    # the Database instrumentation will use this for the metric name if it does not
-    # otherwise know about a model.  This is re-entrant.
+    # Yield to a block that is run with a database metric name
+    # context.  This means the Database instrumentation will use this
+    # for the metric name if it does not otherwise know about a model.
+    # This is re-entrant.
     #
     # * <tt>model</tt> is the DB model class
-    # * <tt>method</tt> is the name of the finder method or other method to identify the operation with.
-    #
+    # * <tt>method</tt> is the name of the finder method or other
+    #   method to identify the operation with.
     def with_database_metric_name(model, method, &block)
       if frame = NewRelic::Agent::Instrumentation::MetricFrame.current
         frame.with_database_metric_name(model, method, &block)

data/lib/new_relic/agent/agent.rb

@@ -19,6 +19,14 @@ module NewRelic
     # the NewRelic hosted site.
     
     PROTOCOL_VERSION = 8
+    # 14105: v8 (tag 2.10.3)
+    # (no v7)
+    # 10379: v6 (not tagged)
+    # 4078:  v5 (tag 2.5.4)
+    # 2292:  v4 (tag 2.3.6)
+    # 1754:  v3 (tag 2.3.0)
+    # 534:   v2 (shows up in 2.1.0, our first tag)
+    
     
     attr_reader :obfuscator
     attr_reader :stats_engine
@@ -38,15 +46,15 @@ module NewRelic
     end
     
     # This method should be called in a forked process after a fork.
-    # It assumes the parent process started the agent.  It clears any
-    # metrics carried over from the parent process, and restarts 
-    # the worker thread and sampler threads.
+    # It assumes the parent process initialized the agent, but does
+    # not assume the agent started.  
     #
-    # In addition, if the parent process had not connected to the server
-    # because it was a Passenger or Unicorn spawner, it will
-    # initiate the connection and create a new agent run.
+    # * It clears any metrics carried over from the parent process
+    # * Restarts the sampler thread if necessary
+    # * Initiates a new agent run and worker loop unless that was done
+    #   in the parent process and +:force_reconnect+ is not true
     #
-    def after_fork
+    def after_fork(options={})
       
       # @connected gets false after we fail to connect or have an error
       # connecting.  @connected has nil if we haven't finished trying to connect.
@@ -62,7 +70,7 @@ module NewRelic
 
       # Clear out stats that are left over from parent process
       reset_stats
-      start_worker_thread
+      start_worker_thread(options[:force_reconnect])
       @stats_engine.start_sampler_thread
     end
     
@@ -215,6 +223,17 @@ module NewRelic
       control.log! "New Relic RPM Agent #{NewRelic::VERSION::STRING} Initialized: pid = #$$"
       control.log! "Agent Log found in #{NewRelic::Control.instance.log_file}" if NewRelic::Control.instance.log_file
     end
+    
+    # Clear out the metric data, errors, and transaction traces.  Reset the histogram data.
+    def reset_stats
+      @stats_engine.reset_stats
+      @unsent_errors = []
+      @traces = nil
+      @unsent_timeslice_data = {}
+      @last_harvest_time = Time.now
+      @launch_time = Time.now
+      @histogram = NewRelic::Histogram.new(NewRelic::Control.instance.apdex_t / 10)
+    end
 
     private
     def collector
@@ -222,8 +241,7 @@ module NewRelic
     end
     
     # Try to launch the worker thread and connect to the server
-    def start_worker_thread
-      @worker_loop = WorkerLoop.new
+    def start_worker_thread(force_reconnect=false)
       log.debug "Creating RPM worker thread."
       @worker_thread = Thread.new do
         begin
@@ -231,23 +249,25 @@ module NewRelic
             # We try to connect.  If this returns false that means
             # the server rejected us for a licensing reason and we should 
             # just exit the thread.  If it returns nil
-            # that means it didn't try to connect because we're in the master
-            connect if not @connected
+            # that means it didn't try to connect because we're in the master.
+            connect if !@connected or force_reconnect
             if @connected
               # disable transaction sampling if disabled by the server and we're not in dev mode
               if !control.developer_mode? && !@should_send_samples
                 @transaction_sampler.disable
               end
-              control.log! "Reporting performance data every #{@report_period} seconds."
+              log.info "Reporting performance data every #{@report_period} seconds."
               log.debug "Running worker loop"
               # note if the agent attempts to report more frequently than allowed by the server
               # the server will start dropping data.
+              @worker_loop = WorkerLoop.new
               @worker_loop.run(@report_period) do
                 harvest_and_send_timeslice_data
                 harvest_and_send_slowest_sample if @should_send_samples
                 harvest_and_send_errors if error_collector.enabled
               end
-              @connected = true
+            else
+              log.debug "No connection.  Worker thread finished."
             end
           end
         rescue NewRelic::Agent::ForceRestartException => e
@@ -309,8 +329,6 @@ module NewRelic
     # connection is made, or the server rejects us.
     
     def connect(keep_retrying = true)
-      # Don't reconnect if we've already got a connection.
-      return if @connected
       
       # wait a few seconds for the web server to boot, necessary in development
       connect_retry_period = keep_retrying ? 10 : 0
@@ -403,15 +421,6 @@ module NewRelic
     def determine_home_directory
       control.root
     end
-    def reset_stats
-      @stats_engine.reset_stats
-      @unsent_errors = []
-      @traces = nil
-      @unsent_timeslice_data = {}
-      @last_harvest_time = Time.now
-      @launch_time = Time.now
-      @histogram = NewRelic::Histogram.new(NewRelic::Control.instance.apdex_t / 10)
-    end
     
     def harvest_and_send_timeslice_data
       

data/lib/new_relic/agent/error_collector.rb

@@ -36,7 +36,7 @@ module NewRelic
       if block
         @ignore_filter = block
       else
-        @ignore_error_filter
+        @ignore_filter
       end
     end
     

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

@@ -11,7 +11,7 @@ if defined?(PhusionPassenger)
       # We want to reset the stats from the stats engine in case any carried
       # over into the spawned process.  Don't clear them in case any were
       # cached.
-      NewRelic::Agent.after_fork
+      NewRelic::Agent.after_fork(:force_reconnect => true)
     else 
       # We're in conservative spawning mode. We don't need to do anything.
     end

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

@@ -3,7 +3,7 @@ if defined?(Unicorn::HttpServer)
     NewRelic::Agent.logger.debug "Installing Unicorn worker hook."
     old_worker_loop = instance_method(:worker_loop)
     define_method(:worker_loop) do | worker |
-      NewRelic::Agent.after_fork
+      NewRelic::Agent.after_fork(:force_reconnect => true)
       old_worker_loop.bind(self).call(worker)
     end
   end

data/lib/new_relic/local_environment.rb

@@ -79,7 +79,8 @@ module NewRelic
       append_environment_value 'Framework', @framework.to_s
       append_environment_value 'Dispatcher', @dispatcher.to_s if @dispatcher
       append_environment_value 'Dispatcher instance id', @dispatcher_instance_id if @dispatcher_instance_id
-      append_environment_value('Application root') { File.expand_path(NewRelic::Control.instance.root) }
+      # This just creates a lot of keys
+      # append_environment_value('Application root') { File.expand_path(NewRelic::Control.instance.root) }
       append_environment_value('Ruby version'){ RUBY_VERSION }
       append_environment_value('Ruby description'){ RUBY_DESCRIPTION } if defined? ::RUBY_DESCRIPTION
       append_environment_value('Ruby platform') { RUBY_PLATFORM }

data/lib/new_relic/version.rb

@@ -4,7 +4,7 @@ module NewRelic
     MAJOR = 2
     MINOR = 11
     TINY  = 0
-    BUILD = 'beta' # Set to nil for a release, 'beta1', 'alpha', etc for prerelease builds
+    BUILD = 'beta2'  # Set to nil for a release, 'beta1', 'alpha', etc for prerelease builds
     STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')
   end
   

data/newrelic_rpm.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{newrelic_rpm}
-  s.version = "2.11.0.beta"
+  s.version = "2.11.0.beta2"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bill Kayser"]
-  s.date = %q{2010-03-26}
+  s.date = %q{2010-03-29}
   s.description = %q{New Relic RPM is a Ruby performance management system, developed by
 New Relic, Inc (http://www.newrelic.com).  RPM provides you with deep
 information about the performance of your Ruby on Rails or Merb

metadata

@@ -6,8 +6,8 @@ version: !ruby/object:Gem::Version
   - 2
   - 11
   - 0
-  - beta
-  version: 2.11.0.beta
+  - beta2
+  version: 2.11.0.beta2
 platform: ruby
 authors: 
 - Bill Kayser
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-26 00:00:00 -07:00
+date: 2010-03-29 00:00:00 -07:00
 default_executable: 
 dependencies: []