newrelic_rpm 2.8.1 → 2.8.2

data/lib/new_relic/agent/agent.rb

@@ -6,10 +6,6 @@ require 'singleton'
 require 'zlib'
 require 'stringio'
 
-
-# This must be turned off before we ship
-VALIDATE_BACKGROUND_THREAD_LOADING = false
-
 # The NewRelic Agent collects performance data from ruby applications in realtime as the
 # application runs, and periodically sends that data to the NewRelic server.
 module NewRelic::Agent
@@ -24,6 +20,8 @@ module NewRelic::Agent
   # Reserved for future use
   class ServerError < StandardError; end
   
+  class BackgroundLoadingError < StandardError; end
+
   # add some convenience methods for easy access to the Agent singleton.
   # the following static methods all point to the same Agent instance:
   #
@@ -171,13 +169,15 @@ module NewRelic::Agent
     def start(environment, identifier, force=false)
       
       if @started
-        log! "Agent Started Already!"
+        config.log! "Agent Started Already!"
         return
       end
       @environment = environment
       @identifier = identifier && identifier.to_s
       if @identifier
         start_reporting(force)
+        config.log! "New Relic RPM Agent #{NewRelic::VERSION::STRING} Initialized: pid = #{$$}"
+        config.log! "Agent Log is found in #{NewRelic::Config.instance.log_file}"
         return true
       else
         return false
@@ -323,7 +323,7 @@ module NewRelic::Agent
           # note if the agent attempts to report more frequently than the specified
           # report data, then it will be ignored.
           
-          log! "Reporting performance data every #{@report_period} seconds"        
+          config.log! "Reporting performance data every #{@report_period} seconds"        
           @worker_loop.add_task(@report_period) do 
             harvest_and_send_timeslice_data
           end
@@ -358,22 +358,21 @@ module NewRelic::Agent
       
       @worker_loop = WorkerLoop.new(log)
       
-      if VALIDATE_BACKGROUND_THREAD_LOADING
+      if config['check_bg_loading']
         require 'new_relic/agent/patch_const_missing'
-        self.class.newrelic_enable_warning
+        log.warn "Agent background loading checking turned on"
+        ClassLoadingWatcher.enable_warning
       end
       
       @worker_thread = Thread.new do
         begin
-          if VALIDATE_BACKGROUND_THREAD_LOADING
-            self.class.newrelic_set_agent_thread(Thread.current)
-          end          
+          ClassLoadingWatcher.set_background_thread(Thread.current) if config['check_bg_loading']
           run_worker_loop
         rescue IgnoreSilentlyException
-          log! "Unable to establish connection with the server.  Run with log level set to debug for more information."
+          config.log! "Unable to establish connection with the server.  Run with log level set to debug for more information."
         rescue StandardError => e
-          log! e
-          log! e.backtrace.join("\n")
+          config.log! e
+          config.log! e.backtrace.join("\n")
         end
       end
       
@@ -381,7 +380,7 @@ module NewRelic::Agent
       # by stopping the foreground thread after the background thread is created. Turn on dependency loading logging
       # and make sure that no loading occurs.
       #
-      #      log! "FINISHED AGENT INIT"
+      #      config.log! "FINISHED AGENT INIT"
       #      while true
       #        sleep 1
       #      end
@@ -438,7 +437,7 @@ module NewRelic::Agent
       # make sure the license key exists and is likely to be really a license key
       # by checking it's string length (license keys are 40 character strings.)
       if @prod_mode_enabled && (!@license_key || @license_key.length != 40)
-        log! "No license key found.  Please edit your newrelic.yml file and insert your license key"
+        config.log! "No license key found.  Please edit your newrelic.yml file and insert your license key"
         return
       end
       
@@ -504,7 +503,7 @@ module NewRelic::Agent
             config.settings
         @report_period = invoke_remote :get_data_report_period, @agent_id
  
-        log! "Connected to NewRelic Service at #{config.server}"
+        config.log! "Connected to NewRelic Service at #{config.server}"
         log.debug "Agent ID = #{@agent_id}."
         
         # Ask the server for permission to send transaction samples.  determined by subscription license.
@@ -519,8 +518,8 @@ module NewRelic::Agent
         @connected = true
         
       rescue LicenseException => e
-        log! e.message, :error
-        log! "Visit NewRelic.com to obtain a valid license key, or to upgrade your account."
+        config.log! e.message, :error
+        config.log! "Visit NewRelic.com to obtain a valid license key, or to upgrade your account."
         @invalid_license = true
         return false
         
@@ -576,12 +575,12 @@ module NewRelic::Agent
       @harvest_thread ||= Thread.current
       
       if @harvest_thread != Thread.current
-        log! "ERROR - two harvest threads are running (current=#{Thread.current}, havest=#{@harvest_thread}"
+        config.log! "ERROR - two harvest threads are running (current=#{Thread.current}, havest=#{@harvest_thread}"
         @harvest_thread = Thread.current
       end
       
       # Fixme: remove this check
-      log! "Agent sending data too frequently - #{now - @last_harvest_time} seconds" if (now.to_f - @last_harvest_time.to_f) < 45
+      config.log! "Agent sending data too frequently - #{now - @last_harvest_time} seconds" if (now.to_f - @last_harvest_time.to_f) < 45
       
       @unsent_timeslice_data ||= {}
       @unsent_timeslice_data = @stats_engine.harvest_timeslice_data(@unsent_timeslice_data, @metric_ids)
@@ -697,9 +696,9 @@ module NewRelic::Agent
         raise IgnoreSilentlyException
       end 
     rescue ForceDisconnectException => e
-      log! "RPM forced this agent to disconnect", :error
-      log! e.message, :error
-      log! "Restart this process to resume RPM's agent communication with NewRelic.com"
+      config.log! "RPM forced this agent to disconnect", :error
+      config.log! e.message, :error
+      config.log! "Restart this process to resume RPM's agent communication with NewRelic.com"
       # when a disconnect is requested, stop the current thread, which is the worker thread that 
       # gathers data and talks to the server. 
       @connected = false
@@ -710,14 +709,6 @@ module NewRelic::Agent
       raise IgnoreSilentlyException
     end
     
-    # send the given message to STDERR as well as the agent log, so that it shows
-    # up in the console.  This should be used for important informational messages at boot
-    def log!(msg, level = :info)
-      # only log to stderr when we are running as a mongrel process, so it doesn't
-      # muck with daemons and the like.
-      config.log!(msg, level)
-    end
-    
     def graceful_disconnect
       if @connected && !(config.server.host == "localhost" && @identifier == '3000')
         begin

data/lib/new_relic/agent/collection_helper.rb

@@ -3,19 +3,19 @@ module NewRelic::Agent::CollectionHelper
   # strings
   def normalize_params(params)
     case params
-      when Symbol, FalseClass, TrueClass, nil:
+      when Symbol, FalseClass, TrueClass, nil
         params
       when Numeric
         truncate(params.to_s)
       when String
         truncate(params)
-      when Hash:
+      when Hash
         new_params = {}
         params.each do | key, value |
           new_params[truncate(normalize_params(key),32)] = normalize_params(value)
       end
         new_params
-      when Enumerable:
+      when Enumerable
       # We only want the first 20 values of any enumerable.  Invoking to_a.first(20) works but
       # the to_a call might be expensive, so we'll just build it manually, even though it's
       # more verbose.
@@ -78,4 +78,4 @@ module NewRelic::Agent::CollectionHelper
       truncate(flatten(string), len)     
     end
   end
-end
+end

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

@@ -73,7 +73,7 @@ module NewRelic::Agent::Instrumentation
       # Skip instrumentation based on the value of 'do_not_trace' and if 
       # we aren't calling directly with a block.
       should_skip = !block_given? && case ignore_actions
-        when nil: false
+        when nil; false
         when Hash
         only_actions = Array(ignore_actions[:only])
         except_actions = Array(ignore_actions[:except])

data/lib/new_relic/agent/patch_const_missing.rb

@@ -1,31 +1,105 @@
 # This class is for debugging purposes only.
-#
-class Module
-  @@newrelic_agent_thread = nil
-  def new_relic_const_missing(*args)
-    if Thread.current == @@newrelic_agent_thread
-      msg = "Agent background thread shouldn't be calling const_missing (#{args.inspect})   \n"
-      msg << caller[0..4].join("   \n")
-      NewRelic::Config.instance.log.warn msg 
-    end
-    original_const_missing(*args)
+# It inserts instrumentation into class loading to verify
+# that no classes are being loaded on the new relic thread,
+# which can cause problems in the class loader code.
+
+module ClassLoadingWatcher
+  
+  extend self
+  @@background_thread = nil
+  
+  def background_thread
+    @@background_thread
   end
   
-  def newrelic_enable_warning
+  def set_background_thread(thread)
+    @@background_thread = thread
+    
+    # these tests that check is working...
+    #    begin
+    #      bad = Bad
+    #    rescue
+    #    end
+    
+    #    require 'new_relic/agent/patch_const_missing'
+    #    load 'new_relic/agent/patch_const_missing.rb'
+  end
+  module SanityCheck 
+    def new_relic_check_for_badness(*args)
+      
+      if Thread.current == ClassLoadingWatcher.background_thread    
+        msg = "Agent background thread shouldn't be loading classes (#{args.inspect})\n"
+        
+        exception = NewRelic::Agent::BackgroundLoadingError.new(msg.clone)
+        exception.set_backtrace(caller)
+        
+        NewRelic::Agent.instance.error_collector.notice_error(nil, nil, [], exception)
+        msg << caller.join("\n")
+        
+        NewRelic::Config.instance.log.error msg
+      end
+    end
+  end
+  def enable_warning
+    Object.class_eval do
+      if !defined?(non_new_relic_require)
+        alias_method :non_new_relic_require, :require
+        alias_method :require, :new_relic_require
+      end
+      
+      if !defined?(non_new_relic_load)
+        alias_method :non_new_relic_load, :load
+        alias_method :load, :new_relic_load
+      end
+    end
     Module.class_eval do
-      if !defined?(original_const_missing)
-        alias_method :original_const_missing, :const_missing
+      if !defined?(non_new_relic_const_missing)
+        alias_method :non_new_relic_const_missing, :const_missing
         alias_method :const_missing, :new_relic_const_missing
       end
     end
   end
-  def newrelic_disable_warning
+  
+  def disable_warning
+    Object.class_eval do
+      if defined?(non_new_relic_require)
+        alias_method :require, :non_new_relic_require
+        undef non_new_relic_require
+      end
+      
+      if defined?(non_new_relic_load)
+        alias_method :load, :non_new_relic_load
+        undef non_new_relic_load
+      end
+    end
     Module.class_eval do
-      alias_method :const_missing, :original_const_missing if defined?(original_const_missing)
+      if defined?(non_new_relic_const_missing)
+        alias_method :const_missing, :non_new_relic_const_missing
+        undef non_new_relic_const_missing
+      end
     end
   end
+end
+
+class Object
+  include ClassLoadingWatcher::SanityCheck
+  
+  def new_relic_require(*args)
+    new_relic_check_for_badness("Object require", *args)    
+    non_new_relic_require(*args)
+  end
+  
+  def new_relic_load(*args)
+    new_relic_check_for_badness("Object load", *args)
+    non_new_relic_load(*args)
+  end
+end
+
+class Module
+  include ClassLoadingWatcher::SanityCheck
   
-  def newrelic_set_agent_thread(thread)
-    @@newrelic_agent_thread = thread
+  def new_relic_const_missing(*args)
+    new_relic_check_for_badness("Module #{self.name} const_missing", *args)
+    non_new_relic_const_missing(*args)
   end
 end

data/lib/new_relic/config.rb

@@ -11,6 +11,8 @@ require 'net/https'
 module NewRelic
   
   class Config
+
+    attr_accessor :log_file
     
     # Structs holding info for the remote server and proxy server 
     class Server < Struct.new :host, :port
@@ -137,8 +139,8 @@ module NewRelic
     end
     
     def setup_log(identifier)
-      log_file = "#{log_path}/#{log_file_name(identifier)}"
-      @log = Logger.new log_file
+      @log_file = "#{log_path}/#{log_file_name(identifier)}"
+      @log = Logger.new @log_file
       
       # change the format just for our logger
       
@@ -148,15 +150,13 @@ module NewRelic
       
       # set the log level as specified in the config file
       case fetch("log_level","info").downcase
-        when "debug": @log.level = Logger::DEBUG
-        when "info": @log.level = Logger::INFO
-        when "warn": @log.level = Logger::WARN
-        when "error": @log.level = Logger::ERROR
-        when "fatal": @log.level = Logger::FATAL
+        when "debug"; @log.level = Logger::DEBUG
+        when "info"; @log.level = Logger::INFO
+        when "warn"; @log.level = Logger::WARN
+        when "error"; @log.level = Logger::ERROR
+        when "fatal"; @log.level = Logger::FATAL
       else @log.level = Logger::INFO
       end
-      log! "New Relic RPM Agent #{NewRelic::VERSION::STRING} Initialized: pid = #{$$}"
-      log! "Agent Log is found in #{log_file}"
       @log
     end
     

data/lib/new_relic/transaction_sample.rb

@@ -329,7 +329,7 @@ module NewRelic
         next if k == :path
         s << "  #{k}: " <<
         case v
-          when Enumerable: v.map(&:to_s).sort.join("; ")
+          when Enumerable; v.map(&:to_s).sort.join("; ")
         else
           v
         end << "\n"

data/lib/new_relic/version.rb

@@ -3,7 +3,7 @@ module NewRelic
   module VERSION #:nodoc:
   MAJOR = 2
   MINOR = 8
-  TINY  = 1
+  TINY  = 2
   STRING = [MAJOR, MINOR, TINY].join('.')
   def self.changes
     puts "NewRelic RPM Plugin Version: #{NewRelic::VERSION::STRING}"
@@ -12,6 +12,10 @@ module NewRelic
 
   CHANGELOG = <<EOF
 
+2009-02-07 version 2.8.2
+  * fix Ruby 1.9 syntax compatibility errors
+  * update the class loading sanity check, will notify server of errors
+  * fix agent output on script and rake task execution
 2009-01-27 version 2.8.1
   * Convert the deployment information upload script to an executable
     and put in the bin directory.  When installed as a gem this command

data/lib/newrelic_rpm.rb

@@ -1,7 +1,7 @@
 # Initialization script for the gem.
 # Add 
-#    #require 'new_relic'
-# to your initialization sequence, as late as possible.
+#    config.gem 'newrelic_rpm'
+# to your initialization sequence.
 #
 require 'new_relic/config'
 

data/test/new_relic/agent/tc_agent.rb

@@ -59,19 +59,55 @@ class AgentTests < ActiveSupport::TestCase
   
   def test_classloading_patch
     require 'new_relic/agent/patch_const_missing'
-    NewRelic::Agent::Agent.newrelic_set_agent_thread(Thread.current)
-    # try loading some non-existent class
-    NewRelic::Config.instance.log.expects(:warn).at_least_once.with{|args| args =~ /calling const_missing.*:FooBar/}
-    NewRelic::Config.instance.log.expects(:warn).with{|args| args =~ /calling const_missing.*:FooBaz/}.never
-    NewRelic::Agent::Agent.newrelic_enable_warning
+    ClassLoadingWatcher.set_background_thread(Thread.current)
+    
+    NewRelic::Config.instance.log.expects(:error).at_least_once.with{|args| args =~ /Agent background thread.*:FooBar/}
+    NewRelic::Config.instance.log.expects(:error).with{|args| args =~ /Agent background thread.*:FooBaz/}.never
+    
+    ClassLoadingWatcher.enable_warning
     assert_raise NameError do
       FooBar::Bat
     end
-    NewRelic::Agent::Agent.newrelic_disable_warning
+    ClassLoadingWatcher.disable_warning
     assert_raise NameError do
       FooBaz::Bat
     end
   end
+
+  def test_require
+    require 'new_relic/agent/patch_const_missing'
+    ClassLoadingWatcher.set_background_thread(Thread.current)
+    
+    # try loading some non-existent class
+    NewRelic::Config.instance.log.expects(:error).at_least_once.with{|args| args =~ /Agent background thread.*net/}
+    NewRelic::Config.instance.log.expects(:error).with{|args| args =~ /Agent background thread.*net/}.never
+    
+    ClassLoadingWatcher.enable_warning
+    
+    require 'net/http'
+
+    ClassLoadingWatcher.disable_warning
+
+    require 'net/http'
+  end
+  
+  def test_load
+    require 'new_relic/agent/patch_const_missing'
+    ClassLoadingWatcher.set_background_thread(Thread.current)
+    
+    # try loading some non-existent class
+    NewRelic::Config.instance.log.expects(:error).at_least_once.with{|args| args =~ /Agent background thread.*/}
+    NewRelic::Config.instance.log.expects(:error).with{|args| args =~ /Agent background thread.*/}.never
+    
+    ClassLoadingWatcher.enable_warning
+    
+    load 'net/http.rb'
+
+    ClassLoadingWatcher.disable_warning
+
+    load 'net/http.rb'
+  end
+
   def test_info
     props = NewRelic::Config.instance.app_config_info
     list = props.assoc('Plugin List').last.sort

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: newrelic_rpm
 version: !ruby/object:Gem::Version 
-  version: 2.8.1
+  version: 2.8.2
 platform: ruby
 authors: 
 - Bill Kayser
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-29 00:00:00 -08:00
+date: 2009-02-05 00:00:00 -08:00
 default_executable: newrelic_cmd
 dependencies: []
 
@@ -175,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: newrelic
-rubygems_version: 1.3.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: New Relic Ruby Performance Monitoring Agent