newrelic_rpm 2.14.1 → 3.0.0.beta1

data/CHANGELOG

@@ -1,3 +1,11 @@
+v3.0.0
+  * Support for Real User Monitoring
+  * Back end work on internals to improve reliability
+  * added a 'log_file_name' and 'log_file_path' configuration variable to allow
+    setting the path and name of the agent log file
+  * Improve reliability of statistics calculations
+  * Remove some previously deprecated methods
+
 v2.14.1
   * Avoid overriding methods named 'log' when including the MethodTracer module
   * Ensure that all load paths for 'new_relic/agent' go through 'new_relic/control' first

data/README.rdoc

@@ -1,5 +1,7 @@
 = New Relic RPM
 
+
+
 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

data/install.rb

@@ -1,9 +1,9 @@
 if __FILE__ == $0 || $0 =~ /script\/plugin/
   $LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
-  require 'new_relic/command'  
+  require 'new_relic/command'
   begin
     NewRelic::Command::Install.new(:quiet => true, :app_name => 'My Application').run
   rescue NewRelic::Command::CommandFailure => e
     $stderr.puts e.message
   end
-end
+end

data/lib/new_relic/agent.rb

@@ -71,9 +71,10 @@ module NewRelic
     require 'new_relic/noticed_error'
     require 'new_relic/histogram'
     require 'new_relic/timer_lib'
-    
+
     require 'new_relic/agent'
     require 'new_relic/agent/chained_call'
+    require 'new_relic/agent/browser_monitoring'
     require 'new_relic/agent/agent'
     require 'new_relic/agent/shim_agent'
     require 'new_relic/agent/method_tracer'
@@ -291,6 +292,14 @@ module NewRelic
     def is_execution_traced?
       Thread.current[:newrelic_untraced].nil? || Thread.current[:newrelic_untraced].last != false
     end
+    
+    def is_transaction_traced?
+      Thread::current[:record_tt] != false
+    end
+    
+    def is_sql_recorded?
+      Thread::current[:record_sql] != 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
@@ -379,5 +388,29 @@ module NewRelic
     def record_transaction(response_sec, options = {})
       agent.record_transaction(response_sec, options)
     end
+
+    # PRE-RELEASE
+    # Returns a Javascript string which should be injected into the very top of the response body
+    #
+    def browser_timing_header
+      agent.browser_timing_header
+    end
+
+    # PRE-RELEASE
+    # Returns a Javascript string which should be injected into the very bottom of the response body
+    #
+    def browser_timing_footer
+      agent.browser_timing_footer
+    end
+
+    # FOR BACKWARD COMPATIBILITY (REMOVE BEFORE GA)
+    def browser_instrumentation_header(options={})
+      agent.browser_timing_header
+    end
+
+    # FOR BACKWARD COMPATIBILITY (REMOVE BEFORE GA)
+    def browser_instrumentation_footer(options={})
+      agent.browser_timing_footer
+    end
   end
 end

data/lib/new_relic/agent/agent.rb

@@ -62,6 +62,7 @@ module NewRelic
         attr_reader :histogram
         attr_reader :metric_ids
         attr_reader :url_rules
+        attr_reader :beacon_configuration
 
         def record_transaction(duration_seconds, options={})
           is_error = options['is_error'] || options['error_message'] || options['exception']
@@ -198,7 +199,12 @@ module NewRelic
         # Push flag indicating whether we should be tracing in this
         # thread.
         def push_trace_execution_flag(should_trace=false)
-          (Thread.current[:newrelic_untraced] ||= []) << should_trace
+          value = Thread.current[:newrelic_untraced]
+          if (value.nil?)
+            Thread.current[:newrelic_untraced] = []
+          end
+
+          Thread.current[:newrelic_untraced] << should_trace
         end
 
         # Pop the current trace execution status.  Restore trace execution status
@@ -222,7 +228,7 @@ module NewRelic
         def log
           NewRelic::Agent.logger
         end
-        
+
         # Herein lies the corpse of the former 'start' method. May
         # it's unmatched flog score rest in pieces.
         module Start
@@ -236,13 +242,13 @@ module NewRelic
           def disabled?
             !control.agent_enabled?
           end
-          
+
           def log_dispatcher
             dispatcher_name = control.dispatcher.to_s
             return if log_if(dispatcher_name.empty?, :info, "No dispatcher detected.")
             log.info "Dispatcher: #{dispatcher_name}"
           end
-          
+
           def log_app_names
             log.info "Application: #{control.app_names.join(", ")}"
           end
@@ -252,7 +258,7 @@ module NewRelic
           end
 
           def apdex_f_threshold?
-            sampler_config.fetch('transaction_threshold', '') =~ /apdex_f/i            
+            sampler_config.fetch('transaction_threshold', '') =~ /apdex_f/i
           end
 
           def set_sql_recording!
@@ -269,7 +275,7 @@ module NewRelic
             else
               @record_sql = :obfuscated
             end
-            
+
             log_sql_transmission_warning?
           end
 
@@ -280,7 +286,7 @@ module NewRelic
           def sampler_config
             control.fetch('transaction_tracer', {})
           end
-          
+
           # this entire method should be done on the transaction
           # sampler object, rather than here. We should pass in the
           # sampler config.
@@ -290,7 +296,7 @@ module NewRelic
             @explain_threshold = sampler_config.fetch('explain_threshold', 0.5).to_f
             @explain_enabled = sampler_config.fetch('explain_enabled', true)
             set_sql_recording!
-            
+
             # default to 2.0, string 'apdex_f' will turn into your
             # apdex * 4
             @slowest_transaction_threshold = sampler_config.fetch('transaction_threshold', 2.0).to_f
@@ -302,23 +308,23 @@ module NewRelic
           end
 
           def using_rubinius?
-            RUBY_VERSION =~ /rubinius/i            
+            RUBY_VERSION =~ /rubinius/i
           end
-          
+
           def using_jruby?
-            defined?(JRuby) 
+            defined?(JRuby)
           end
-          
+
           def using_sinatra?
             defined?(Sinatra::Application)
           end
-          
+
           # we should not set an at_exit block if people are using
           # these as they don't do standard at_exit behavior per MRI/YARV
           def weird_ruby?
             using_rubinius? || using_jruby? || using_sinatra?
           end
-          
+
           def install_exit_handler
             if control.send_data_on_exit && !weird_ruby?
               # Our shutdown handler needs to run after other shutdown handlers
@@ -334,7 +340,7 @@ module NewRelic
           def log_version_and_pid
             log.info "New Relic RPM Agent #{NewRelic::VERSION::STRING} Initialized: pid = #{$$}"
           end
-          
+
           def log_if(boolean, level, message)
             self.log.send(level, message) if boolean
             boolean
@@ -344,7 +350,7 @@ module NewRelic
             self.log.send(level, message) unless boolean
             boolean
           end
-          
+
           def monitoring?
             log_unless(control.monitor_mode?, :warn, "Agent configured not to send data in this environment - edit newrelic.yml to change this")
           end
@@ -356,7 +362,7 @@ module NewRelic
           def has_correct_license_key?
             has_license_key? && correct_license_length
           end
-          
+
           def correct_license_length
             key = control.license_key
             log_unless((key.length == 40), :error, "Invalid license key: #{key}")
@@ -365,7 +371,7 @@ module NewRelic
           def using_forking_dispatcher?
             log_if([:passenger, :unicorn].include?(control.dispatcher), :info, "Connecting workers after forking.")
           end
-            
+
           def check_config_and_start_agent
             return unless monitoring? && has_correct_license_key?
             return if using_forking_dispatcher?
@@ -473,7 +479,7 @@ module NewRelic
           rescue Exception => e
             handle_other_error(e)
           end
-          
+
           def deferred_work!(connection_options)
             catch_errors do
               NewRelic::Agent.disable_all_tracing do
@@ -494,7 +500,7 @@ module NewRelic
           end
         end
         include StartWorkerThread
-        
+
         # Try to launch the worker thread and connect to the server.
         #
         # See #connect for a description of connection_options.
@@ -509,7 +515,7 @@ module NewRelic
         def control
           NewRelic::Control.instance
         end
-        
+
         module Connect
           attr_accessor :connect_retry_period
           attr_accessor :connect_attempts
@@ -558,7 +564,7 @@ module NewRelic
             log.info "Visit NewRelic.com to obtain a valid license key, or to upgrade your account."
             disconnect
           end
-          
+
           def log_seed_token
             if control.validate_seed
               log.debug "Connecting with validation seed/token: #{control.validate_seed}/#{control.validate_token}"
@@ -602,13 +608,14 @@ module NewRelic
                       end
             log.debug "Errors will #{enabled ? '' : 'not '}be sent to the RPM service."
           end
-          
+
           def enable_random_samples!(sample_rate)
+            sample_rate = 10 unless sample_rate.to_i > 0# a sane default for random sampling
             @transaction_sampler.random_sampling = true
             @transaction_sampler.sampling_rate = sample_rate
             log.info "Transaction sampling enabled, rate = #{@transaction_sampler.sampling_rate}"
           end
-          
+
 
           def configure_transaction_tracer!(server_enabled, sample_rate)
             # Ask the server for permission to send transaction samples.
@@ -633,13 +640,14 @@ module NewRelic
 
           def query_server_for_configuration
             set_collector_host!
-            
+
             finish_setup(connect_to_server)
           end
           def finish_setup(config_data)
             @agent_id = config_data['agent_run_id']
             @report_period = config_data['data_report_period']
             @url_rules = config_data['url_rules']
+            @beacon_configuration = BeaconConfiguration.new(config_data)
 
             log_connection!(config_data)
             configure_transaction_tracer!(config_data['collect_traces'], config_data['sample_rate'])
@@ -938,6 +946,7 @@ module NewRelic
 
       extend ClassMethods
       include InstanceMethods
+      include BrowserMonitoring
     end
   end
 end

data/lib/new_relic/agent/browser_monitoring.rb

@@ -0,0 +1,111 @@
+require 'base64'
+
+module NewRelic
+  module Agent
+    class BeaconConfiguration
+      attr_reader :browser_timing_header
+      attr_reader :application_id
+      attr_reader :browser_monitoring_key
+      attr_reader :beacon
+      attr_reader :rum_enabled
+      attr_reader :license_bytes
+
+      def initialize(connect_data)
+        @browser_monitoring_key = connect_data['browser_key']
+        @application_id = connect_data['application_id']
+        @beacon = connect_data['beacon']
+        @rum_enabled = connect_data['rum.enabled']
+        @rum_enabled = true if @rum_enabled.nil?
+        @browser_timing_header = build_browser_timing_header(connect_data)
+      end
+
+      def license_bytes
+        if @license_bytes.nil?
+          @license_bytes = []
+          NewRelic::Control.instance.license_key.each_byte {|byte| @license_bytes << byte}
+        else
+          @license_bytes
+        end
+      end
+
+      def build_browser_timing_header(connect_data)
+        return "" if !@rum_enabled
+        return "" if @browser_monitoring_key.nil?
+
+        episodes_url = connect_data['episodes_url']
+        load_episodes_file = connect_data['rum.load_episodes_file']
+        load_episodes_file = true if load_episodes_file.nil?
+
+        load_js = load_episodes_file ? "(function(){var d=document;var e=d.createElement(\"script\");e.type=\"text/javascript\";e.async=true;e.src=\"#{episodes_url}\";var s=d.getElementsByTagName(\"script\")[0];s.parentNode.insertBefore(e,s);})()" : ""
+
+        value = "<script>var NREUMQ=[];NREUMQ.push([\"mark\",\"firstbyte\",new Date().getTime()]);#{load_js}</script>"
+        if value.respond_to?(:html_safe)
+          value.html_safe
+        else
+          value
+        end
+      end
+    end
+
+    module BrowserMonitoring
+
+      def browser_timing_header
+        return "" if NewRelic::Agent.instance.beacon_configuration.nil?
+
+        return "" if !NewRelic::Agent.is_transaction_traced? || !NewRelic::Agent.is_execution_traced?
+          
+        NewRelic::Agent.instance.beacon_configuration.browser_timing_header
+      end
+
+      def browser_timing_footer
+        config = NewRelic::Agent.instance.beacon_configuration
+        return "" if config.nil? || !config.rum_enabled
+       
+        license_key = config.browser_monitoring_key
+        return "" if license_key.nil?
+
+        return "" if !NewRelic::Agent.is_transaction_traced? || !NewRelic::Agent.is_execution_traced?
+          
+        application_id = config.application_id
+        beacon = config.beacon
+
+        transaction_name = Thread.current[:newrelic_most_recent_transaction] || "<unknown>"
+        start_time = Thread.current[:newrelic_start_time]
+        queue_time = (Thread.current[:newrelic_queue_time].to_f * 1000.0).round
+
+        value = ''
+        if start_time
+
+          obf = obfuscate(transaction_name)
+          app_time = ((Time.now - start_time).to_f * 1000.0).round
+
+          queue_time = 0.0 if queue_time < 0
+          app_time = 0.0 if app_time < 0
+
+          value = <<-eos
+<script type="text/javascript" charset="utf-8">NREUMQ.push(["nrf2","#{beacon}","#{license_key}",#{application_id},"#{obf}",#{queue_time},#{app_time}])</script>
+eos
+        end
+        if value.respond_to?(:html_safe)
+          value.html_safe
+        else
+          value
+        end
+      end
+
+      private
+
+      def obfuscate(text)
+        obfuscated = ""
+        key_bytes = NewRelic::Agent.instance.beacon_configuration.license_bytes
+        index = 0
+        text.each_byte{|byte|
+          obfuscated.concat((byte ^ key_bytes[index % 13].to_i))
+          index+=1
+        }
+
+        [obfuscated].pack("m0").chomp
+      end
+    end
+  end
+end

data/lib/new_relic/agent/error_collector.rb

@@ -97,7 +97,7 @@ module NewRelic
       end
 
       def custom_params_from_opts(options)
-        # If anything else is left over, treat it like a custom param:        
+        # If anything else is left over, treat it like a custom param:
         fetch_from_options(options, :custom_params, {}).merge(options)
       end
 
@@ -109,14 +109,14 @@ module NewRelic
           nil
         end
       end
-      
+
       def normalized_request_and_custom_params(options)
         {
           :request_params => normalize_params(request_params_from_opts(options)),
           :custom_params  => normalize_params(custom_params_from_opts(options))
         }
       end
-      
+
       def error_params_from_options(options)
         uri_ref_and_root(options).merge(normalized_request_and_custom_params(options))
       end
@@ -148,7 +148,7 @@ module NewRelic
         log.warn("The error reporting queue has reached #{MAX_ERROR_QUEUE_LENGTH}. The error detail for this and subsequent errors will not be transmitted to RPM until the queued errors have been sent: #{exception}") if over_limit
         over_limit
       end
-      
+
 
       def add_to_error_queue(noticed_error, exception)
         @lock.synchronize do