ghazel-newrelic_rpm 3.1.0.1 → 3.4.0.2

data/lib/new_relic/control/configuration.rb

@@ -1,5 +1,7 @@
 module NewRelic
   class Control
+    # used to contain methods to look up settings from the
+    # configuration located in newrelic.yml
     module Configuration
       def settings
         unless @settings
@@ -34,7 +36,7 @@ module NewRelic
       # Merge the given options into the config options.
       # They might be a nested hash
       def merge_options(options, hash=self)
-        options.each do |key, val |
+        options.each do |key, val|
           case
           when key == :config then next
           when val.is_a?(Hash)
@@ -47,6 +49,28 @@ module NewRelic
         end
       end
 
+      def merge_server_side_config(data)
+        remove_server_controlled_configs
+        config = Hash.new
+        data.each_pair do |key, value|
+          if key.include?('.')
+            key = key.split('.')
+            config[key.first] ||= Hash.new
+            config[key.first][key[1]] = value
+          else
+            config[key] = value
+          end
+        end
+        merge_options(config)
+      end
+
+      def remove_server_controlled_configs
+        settings.delete('transaction_tracer')
+        settings.delete('slow_sql')
+        settings.delete('error_collector')
+        settings.delete('capture_params')
+      end
+
       def [](key)
         fetch(key)
       end
@@ -61,15 +85,18 @@ module NewRelic
 
       def apdex_t
         # Always initialized with a default
-        fetch('apdex_t').to_f
+        @apdex_t_float ||= fetch('apdex_t').to_f
       end
 
       def license_key
-        fetch('license_key')
+        env_setting = ENV['NEW_RELIC_LICENSE_KEY'] || ENV['NEWRELIC_LICENSE_KEY']
+        fetch('license_key', env_setting)
       end
+      
       def capture_params
         fetch('capture_params')
       end
+      
       # True if we are sending data to the server, monitoring production
       def monitor_mode?
         fetch('monitor_mode', fetch('enabled'))
@@ -79,24 +106,31 @@ module NewRelic
       def developer_mode?
         fetch('developer_mode', fetch('developer'))
       end
-
+      
+      # whether we should install the
+      # NewRelic::Rack::BrowserMonitoring middleware automatically on
+      # Rails applications
       def browser_monitoring_auto_instrument?
         fetch('browser_monitoring', {}).fetch('auto_instrument', true)
       end
 
-      # True if the app runs in multi-threaded mode
       def multi_threaded?
         fetch('multi_threaded')
       end
 
       def disable_serialization?
-        fetch('disable_serialization', false)
+        fetch('disable_serialization', true)
+      end
+      def disable_serialization=(b)
+        self['disable_serialization'] = b
       end
       
       # True if we should view files in textmate
       def use_textmate?
         fetch('textmate')
       end
+      
+      # defaults to 2MiB
       def post_size_limit
         fetch('post_size_limit', 2 * 1024 * 1024)
       end
@@ -135,12 +169,19 @@ module NewRelic
       def validate_token
         self['validate_token'] || ENV['NR_VALIDATE_TOKEN']
       end
-
+      
       def use_ssl?
         @use_ssl = fetch('ssl', false) unless @use_ssl
         @use_ssl
       end
-
+      
+      def log_file_path
+        fetch('log_file_path', 'log/')
+      end
+      
+      # only verify certificates if you're very sure you want this
+      # level of security, it includes possibly app-crashing dns
+      # lookups every connection to the server
       def verify_certificate?
         unless @verify_certificate
           unless use_ssl?
@@ -151,6 +192,14 @@ module NewRelic
         end
         @verify_certificate
       end
+
+      def disable_backtrace_cleanup?
+        fetch('disable_backtrace_cleanup')
+      end
+
+      def has_slow_sql_config?
+        self['slow_sql'] && self['slow_sql'].has_key?('enabled')
+      end
     end
     include Configuration
   end

data/lib/new_relic/control/frameworks.rb

@@ -0,0 +1,10 @@
+module NewRelic
+  class Control
+    # Contains subclasses of NewRelic::Control that are used when
+    # starting the agent within an application. Framework-specific
+    # logic should be included here, as documented within the Control
+    # abstract parent class
+    module Frameworks
+    end
+  end
+end

data/lib/new_relic/control/frameworks/external.rb

@@ -1,11 +1,11 @@
-# This is the control used when starting up in the context of
-# The New Relic Infrastructure Agent.  We want to call this
-# out specifically because in this context we are not monitoring
-# the running process, but actually external things.
 require 'new_relic/control/frameworks/ruby'
 module NewRelic
   class Control
     module Frameworks
+      # This is the control used when starting up in the context of
+      # The New Relic Infrastructure Agent.  We want to call this
+      # out specifically because in this context we are not monitoring
+      # the running process, but actually external things.
       class External < NewRelic::Control::Frameworks::Ruby
         def init_config(options={})
           super

data/lib/new_relic/control/frameworks/merb.rb

@@ -1,6 +1,7 @@
 module NewRelic
   class Control
     module Frameworks
+      # Includes limited support for Merb
       class Merb < NewRelic::Control
 
         def env
@@ -12,7 +13,7 @@ module NewRelic
 
         def to_stdout(msg)
           Merb.logger.info("NewRelic ~ " + msg)
-        rescue Exception => e
+        rescue => e
           STDOUT.puts "NewRelic ~ " + msg
         end
 

data/lib/new_relic/control/frameworks/rails.rb

@@ -1,10 +1,10 @@
-# Control subclass instantiated when Rails is detected.  Contains
-# Rails specific configuration, instrumentation, environment values,
-# etc.
 require 'new_relic/control/frameworks/ruby'
 module NewRelic
   class Control
     module Frameworks
+      # Control subclass instantiated when Rails is detected.  Contains
+      # Rails specific configuration, instrumentation, environment values,
+      # etc.
       class Rails < NewRelic::Control::Frameworks::Ruby
 
         def env
@@ -17,11 +17,27 @@ module NewRelic
             super
           end
         end
+        def logger
+          ::RAILS_DEFAULT_LOGGER
+        end
 
         # In versions of Rails prior to 2.0, the rails config was only available to
-        # the init.rb, so it had to be passed on from there.
+        # the init.rb, so it had to be passed on from there.  This is a best effort to 
+        # find a config and use that.
         def init_config(options={})
-          rails_config=options[:config]
+          rails_config = options[:config]
+          if !rails_config && defined?(::Rails) && ::Rails.respond_to?(:configuration)
+            rails_config = ::Rails.configuration
+          end
+          # Install the dependency detection, 
+          if rails_config && ::Rails.configuration.respond_to?(:after_initialize)
+            rails_config.after_initialize do
+              # This will insure we load all the instrumentation as late as possible.  If the agent
+              # is not enabled, it will load a limited amount of instrumentation.  See 
+              # delayed_job_injection.rb
+              DependencyDetection.detect!
+            end
+          end          
           if !agent_enabled?
             # Might not be running if it does not think mongrel, thin, passenger, etc
             # is running, if it things it's a rake task, or if the agent_enabled is false.
@@ -36,12 +52,12 @@ module NewRelic
         def install_browser_monitoring(config)
           return if @browser_monitoring_installed
           @browser_monitoring_installed = true
-          return if config.nil? || !config.respond_to?(:middleware) || !browser_monitoring_auto_instrument?
+          return if config.nil? || !config.respond_to?(:middleware) || ! browser_monitoring_auto_instrument?
           begin
             require 'new_relic/rack/browser_monitoring'
             config.middleware.use NewRelic::Rack::BrowserMonitoring
             log!("Installed New Relic Browser Monitoring middleware", :info)
-          rescue Exception => e
+          rescue => e
             log!("Error installing New Relic Browser Monitoring middleware: #{e.inspect}", :error)
           end
         end
@@ -61,24 +77,29 @@ module NewRelic
                 log!("NewRelic Agent Developer Mode enabled.")
                 log!("To view performance information, go to http://localhost#{port}/newrelic")
               end
-            rescue Exception => e
+            rescue => e
               log!("Error installing New Relic Developer Mode: #{e.inspect}", :error)
             end
-          else
+          elsif rails_config
             log!("Developer mode not available for Rails versions prior to 2.2", :warn)
           end
         end
 
         def log!(msg, level=:info)
-          super unless should_log?
-          ::RAILS_DEFAULT_LOGGER.send(level, msg)
-        rescue Exception => e
+          if should_log?
+            logger = ::Rails.respond_to?(:logger) ? ::Rails.logger : ::RAILS_DEFAULT_LOGGER
+            logger.send(level, msg)
+          else
+            super
+          end
+        rescue => e
           super
         end
 
         def to_stdout(message)
-          ::RAILS_DEFAULT_LOGGER.info(message)
-        rescue Exception => e
+          logger = ::Rails.respond_to?(:logger) ? ::Rails.logger : ::RAILS_DEFAULT_LOGGER
+          logger.info(message)
+        rescue => e
           super
         end
 
@@ -137,14 +158,6 @@ module NewRelic
           }
         end
 
-        def _install_instrumentation
-          super
-          if defined?(Rails) && Rails.respond_to?(:configuration) && Rails.configuration.respond_to?(:after_initialize)
-            Rails.configuration.after_initialize do
-              DependencyDetection.detect!
-            end
-          end
-        end
       end
     end
   end

data/lib/new_relic/control/frameworks/rails3.rb

@@ -1,14 +1,16 @@
-# Control subclass instantiated when Rails is detected.  Contains
-# Rails specific configuration, instrumentation, environment values,
-# etc.
 require 'new_relic/control/frameworks/rails'
 module NewRelic
   class Control
     module Frameworks
+      # Control subclass instantiated when Rails is detected.  Contains
+      # Rails 3.0+  specific configuration, instrumentation, environment values,
+      # etc. Many methods are inherited from the
+      # NewRelic::Control::Frameworks::Rails class, where the two do
+      # not differ
       class Rails3 < NewRelic::Control::Frameworks::Rails
 
         def env
-          ::Rails.env.to_s
+          @env ||= ::Rails.env.to_s
         end
         
         # Rails can return an empty string from this method, causing
@@ -30,9 +32,12 @@ module NewRelic
 
 
         def log!(msg, level=:info)
-          super unless should_log?
-          logger.send(level, msg)
-        rescue Exception => e
+          if should_log?
+            logger.send(level, msg)
+          else
+            super
+          end
+        rescue => e
           super
         end
 

data/lib/new_relic/control/frameworks/ruby.rb

@@ -1,11 +1,11 @@
-# A control used when no framework is detected.
-# Looks for a newrelic.yml file in several locations
-# including ./, ./config, $HOME/.newrelic and $HOME/.
-# It loads the settings from the newrelic.yml section
-# based on the value of RUBY_ENV or RAILS_ENV.
 module NewRelic
   class Control
     module Frameworks
+      # A control used when no framework is detected - the default.
+      # Looks for a newrelic.yml file in several locations including
+      # ./, ./config, $HOME/.newrelic and $HOME/.  It loads the
+      # settings from the newrelic.yml section based on the value of
+      # RUBY_ENV or RAILS_ENV.
       class Ruby < NewRelic::Control
 
         def env

data/lib/new_relic/control/frameworks/sinatra.rb

@@ -3,16 +3,13 @@ require 'new_relic/control/frameworks/ruby'
 module NewRelic
   class Control
     module Frameworks
+      # Contains basic control logic for Sinatra
       class Sinatra < NewRelic::Control::Frameworks::Ruby
 
         def env
           @env ||= ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
         end
 
-        # This is the control used when starting up in the context of
-        # The New Relic Infrastructure Agent.  We want to call this
-        # out specifically because in this context we are not monitoring
-        # the running process, but actually external things.
         def init_config(options={})
           super
         end

data/lib/new_relic/control/instance_methods.rb

@@ -1,11 +1,22 @@
+require 'new_relic/language_support'
+
 module NewRelic
   class Control
+    include NewRelic::LanguageSupport::Control
+
+    # Contains methods that relate to the runtime usage of the control
+    # object. Note that these are subject to override in the
+    # NewRelic::Control::Framework classes that are actually instantiated
     module InstanceMethods
       # The env is the setting used to identify which section of the newrelic.yml
       # to load.  This defaults to a framework specific value, such as ENV['RAILS_ENV']
       # but can be overridden as long as you set it before calling #init_plugin
       attr_writer :env
 
+      # The local environment contains all the information we report
+      # to the server about what kind of application this is, what
+      # gems and plugins it uses, and many other kinds of
+      # machine-dependent information useful in debugging
       attr_reader :local_env
 
 
@@ -34,13 +45,15 @@ module NewRelic
       #
       def init_plugin(options={})
         options['app_name'] = ENV['NEWRELIC_APP_NAME'] if ENV['NEWRELIC_APP_NAME']
+        options['app_name'] ||= ENV['NEW_RELIC_APP_NAME'] if ENV['NEW_RELIC_APP_NAME']
 
         # Merge the stringified options into the config as overrides:
         logger_override = options.delete(:log)
         environment_name = options.delete(:env) and self.env = environment_name
         dispatcher = options.delete(:dispatcher) and @local_env.dispatcher = dispatcher
         dispatcher_instance_id = options.delete(:dispatcher_instance_id) and @local_env.dispatcher_instance_id = dispatcher_instance_id
-
+        
+        NewRelic::Agent::PipeChannelManager.listener.start if options.delete(:start_channel_listener)
 
         # Clear out the settings, if they've already been loaded.  It may be that
         # between calling init_plugin the first time and the second time, the env
@@ -90,13 +103,14 @@ module NewRelic
         # dispatcher running
         return true if @local_env.dispatcher != nil
       end
-
+      
+      # Asks the LocalEnvironment instance which framework should be loaded
       def app
         @local_env.framework
       end
       alias framework app
-
-      def to_s
+      
+      def to_s #:nodoc:
         "Control[#{self.app}]"
       end
 
@@ -105,7 +119,9 @@ module NewRelic
       # Append framework specific environment information for uploading to
       # the server for change detection.  Override in subclasses
       def append_environment_info; end
-
+      
+      # Asks bundler to tell us which gemspecs are loaded in the
+      # current process
       def bundler_gem_list
         if defined?(Bundler) && Bundler.instance_eval do @load end
           Bundler.load.specs.map do | spec |
@@ -116,11 +132,15 @@ module NewRelic
           []
         end
       end
-
+      
+      # path to the config file, defaults to the "#{root}/config/newrelic.yml"
       def config_file
         File.expand_path(File.join(root,"config","newrelic.yml"))
       end
-
+      
+      # initializes the control instance with a local environment and
+      # an optional config file override. Checks for the config file
+      # and loads it.
       def initialize local_env, config_file_override=nil
         @local_env = local_env
         @instrumentation_files = []
@@ -133,18 +153,24 @@ module NewRelic
           puts "Cannot find or read #{newrelic_file}"
           @yaml = {}
         else
-          @yaml = YAML.load(ERB.new(File.read(newrelic_file)).result(binding))
+          @yaml = load_newrelic_yml(newrelic_file, binding)
         end
       rescue ScriptError, StandardError => e
-        puts e
-        puts e.backtrace.join("\n")
-        raise "Error reading newrelic.yml file: #{e}"
+        new_err = e.class.new("Error reading newrelic.yml file: #{e}")
+        new_err.set_backtrace(e.backtrace)
+        raise new_err
       end
-
+      
+      def load_newrelic_yml(path, binding)
+        YAML.load(ERB.new(File.read(path)).result(binding))
+      end
+      
       def root
         '.'
       end
 
+      # Delegates to the class method newrelic_root, implemented by
+      # each subclass
       def newrelic_root
         self.class.newrelic_root
       end