newrelic_rpm 3.1.0.beta1 → 3.1.0.beta2

data/CHANGELOG

@@ -1,5 +1,11 @@
-v3.1.0
-  * Experimental support for aggregating data from short-running processes using NewRelic::Agent.load_data and NewRelic::Agent.save_data
+v3.1.0 
+  * Experimental support for aggregating data from short-running
+    processes using NewRelic::Agent.load_data and
+    NewRelic::Agent.save_data
+
+v3.0.1 
+  * Updated Real User Monitoring to reduce javascript size and improve
+    compatibility, fix a few known bugs
 
 v3.0.0
   * Support for Real User Monitoring

data/README.rdoc

@@ -1,15 +1,13 @@
-= New Relic RPM
+= New Relic Ruby Agent
 
-
-
-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
-application as it runs in production. The New Relic Agent is
+New Relic is a performance management system, developed by
+New Relic, Inc (http://www.newrelic.com).  It provides you with deep
+information about the performance of your Rails or Ruby
+application as it runs in production. The New Relic Ruby Agent is
 dual-purposed as a either a Rails plugin or a Gem, hosted on
 github[http://github.com/newrelic/rpm/tree/master].
 
-The New Relic Agent runs in one of two modes:
+The New Relic Ruby Agent runs in one of two modes:
 
 ==== Production Mode
 
@@ -25,17 +23,16 @@ automatically in Rails applications.
 
 == Supported Environments
 
-* Ruby 1.8.6, 1.8.7, 1.9.1, or 1.9.2, including REE
-* JRuby 1.4 minimum
+* Ruby 1.8.7, 1.9.1, or 1.9.2, including REE
+* JRuby 1.4 or higher
 * Rails 2.0 or later for Production Mode
-* Rails 2.2 or later for Developer Mode
-* Merb 1.0 or later
+* Rails 2.3 or later for Developer Mode
 * Sinatra
 * Rack
 
 Any Rack based framework should work but may not be tested.  Install
-RPM as a gem and add the Developer Mode middleware if desired.  Report
-any problems to support@newrelic.com.
+the Ruby Agent as a gem and add the Developer Mode middleware if
+desired.  Report any problems to support@newrelic.com.
 
 You can also monitor non-web applications. Refer to the "Other
 Environments" section under "Getting Started".
@@ -48,7 +45,7 @@ install the gem as a plug-in--details below.
    gem install newrelic_rpm
 
 To monitor your applications in production, create an account at
-http://newrelic.com/get-RPM.html.  There you can
+http://newrelic.com/ .  There you can
 sign up for a free Lite account or one of our paid subscriptions.
 
 Once you receive the welcome e-mail with a license key and
@@ -86,7 +83,7 @@ to your init.rb file.
 
 === Sinatra Installation 
 
-To use RPM with a Sinatra app, add
+To use the Ruby Agent with a Sinatra app, add
     require 'newrelic_rpm'
 in your Sinatra app, below the Sinatra require directive.
 
@@ -99,7 +96,7 @@ the middleware stack.  See the +config.ru+ sample below.
 
 === Other Environments
 
-You can use RPM to monitor any Ruby application.  Add 
+You can use the Ruby Agent to monitor any Ruby application.  Add 
     require 'newrelic_rpm'
 to your startup sequence and then manually start the agent using
     NewRelic::Agent.manual_start
@@ -107,7 +104,7 @@ to your startup sequence and then manually start the agent using
 To instrument Rack based applications, refer to the docs in
 NewRelic::Agent::Instrumentation::Rack.
 
-Refer to the docs in NewRelic for details on how to monitor other web
+Refer to the docs in New Relic for details on how to monitor other web
 frameworks, background jobs, and daemons.
 
 Also, see if your environment is already supported by the
@@ -115,7 +112,7 @@ rpm_contrib[http://newrelic.github.com/rpm_contrib] gem.
 
 == Developer Mode
 
-When running the RPM Developer Mode, the RPM Agent will track the
+When running the Developer Mode, the Ruby Agent will track the
 performance of every HTTP request serviced by your application, and
 store in memory this information for the last 100 HTTP transactions.
 
@@ -132,9 +129,10 @@ all environments but +development+.
 
 ==== Developer Mode in Rails
 
-Developer Mode is available automatically in Rails Applications
-based on Rails 2.3 and later.  No additional configuration is
-required.
+Developer Mode is available automatically in Rails Applications based
+on Rails 2.3 and later.  No additional configuration is required. When
+your application starts and +developer_mode+ is enabled, the Ruby
+Agent injects a middleware into your Rails middleware stack.
 
 For earlier versions of Rails that support Rack, you can use
 a +config.ru+ as below.
@@ -148,15 +146,14 @@ middleware. This middleware passes all requests that do not start with
 
 Here's an example entry for Developer Mode in a +config.ru+ file:
 
-    require 'new_relic/rack_app'
+    require 'new_relic/rack/developer_mode'
     use NewRelic::Rack::DeveloperMode
 
-
 == Production Mode
 
 When your application runs in the production environment, the New
-Relic agent runs in production mode. It connects to the New Relic RPM
-service and sends deep performance data to the RPM service for your
+Relic agent runs in production mode. It connects to the New Relic
+service and sends deep performance data to the UI for your
 analysis. To view this data, log in to http://rpm.newrelic.com.
 
 NOTE: You must have a valid account and license key to view this data
@@ -165,10 +162,13 @@ online.  Refer to instructions in *Getting Started*, below.
 
 = Support
 
-Reach out to us--and to fellow RPM users--at
+Reach out to us--and to fellow users--at
 support.newrelic.com[http://support.newrelic.com/discussions/support].
 There you'll find documentation, FAQs, and forums where you can submit
-suggestions and discuss RPM with New Relic staff and other users.
+suggestions and discuss New Relic with staff and other users.
+
+Also available is community support on IRC: we generally use #newrelic
+on irc.freenode.net
 
 Find a bug?  E-mail support@newrelic.com, or post it to
 support.newrelic.com[http://support.newrelic.com/discussions/support].

data/bin/mongrel_rpm

@@ -11,7 +11,7 @@ OptionParser.new do |opts|
   opts.banner = "Usage: #{File.basename($0)} [options] [app_name]"
   opts.on("-p", "--port=port", Integer, "default: #{port}") { | port | }
   opts.on("--[no-]logging", "turn off request logging" ) { | l | options[:logging] = l }
-  opts.on("--license=rpm_license_key", "override license key" ) { | l | options[:license_key] = l }
+  opts.on("--license=license_key", "override license key" ) { | l | options[:license_key] = l }
   opts.on("--install", "install a newrelic.yml template" ) { | l | options[:install] = true }
   opts.separator ""
   opts.separator "app_name is the name of the application where the metrics will be stored"

data/lib/new_relic/agent.rb

@@ -1,15 +1,16 @@
 require 'new_relic/control'
-# = New Relic RPM Agent
+require 'new_relic/data_serialization'
+# = New Relic Ruby Agent
 #
-# New Relic RPM is a performance monitoring application for Ruby
-# applications running in production.  For more information on RPM
-# please visit http://www.newrelic.com.
+# New Relic is a performance monitoring application for applications
+# running in production.  For more information on New Relic please visit
+# http://www.newrelic.com.
 #
-# The New Relic Agent can be installed in Rails applications to gather
-# runtime performance metrics, traces, and errors for display in a
-# Developer Mode UI (mapped to /newrelic in your application server)
-# or for monitoring and analysis at http://rpm.newrelic.com with just
-# about any Ruby application.
+# The New Relic Ruby Agent can be installed in Rails applications to
+# gather runtime performance metrics, traces, and errors for display
+# in a Developer Mode middleware (mapped to /newrelic in your application
+# server) or for monitoring and analysis at http://rpm.newrelic.com
+# with just about any Ruby application.
 #
 # == Getting Started
 # For instructions on installation and setup, see
@@ -20,18 +21,18 @@ require 'new_relic/control'
 # To instrument Rack middlwares or Metal apps, refer to the docs in
 # NewRelic::Agent::Instrumentation::Rack.
 #
-# == Agent API
+# == Ruby Agent API
 #
-# For details on the Agent API, refer to NewRelic::Agent.
+# For details on the Ruby Agent API, refer to NewRelic::Agent.
 #
-# == Customizing RPM
+# == Customizing the Ruby Agent
 #
-# For detailed information on customizing the RPM Agent
+# For detailed information on customizing the Ruby Agent
 # please visit our {support and documentation site}[http://support.newrelic.com].
 #
 module NewRelic
-  # == Agent APIs
-  # This module contains the public API methods for the Agent.
+  # == Ruby Agent APIs
+  # This module contains the public API methods for the Ruby Agent.
   #
   # For adding custom instrumentation to method invocations, refer to
   # the docs in the class NewRelic::Agent::MethodTracer.
@@ -39,7 +40,7 @@ module NewRelic
   # For information on how to customize the controller
   # instrumentation, or to instrument something other than Rails so
   # that high level dispatcher actions or background tasks show up as
-  # first class operations in RPM, refer to
+  # first class operations in New Relic, refer to
   # NewRelic::Agent::Instrumentation::ControllerInstrumentation and
   # NewRelic::Agent::Instrumentation::ControllerInstrumentation::ClassMethods.
   #
@@ -155,10 +156,10 @@ module NewRelic
     # 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
+    # Agent will only connect to the service 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.
+    # will fire up and start reporting to the service.
     #
     # Options are passed in as overrides for values in the
     # newrelic.yml, such as app_name.  In addition, the option +log+
@@ -313,10 +314,10 @@ module NewRelic
       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
-    # different from the original exception) or nil to ignore this
-    # exception.
+    # Set a filter to be applied to errors that the Ruby Agent 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.
     #
@@ -326,7 +327,7 @@ module NewRelic
       agent.error_collector.ignore_error_filter(&block)
     end
 
-    # Record the given error in RPM.  It will be passed through the
+    # Record the given error.  It will be passed through the
     # #ignore_error_filter if there is one.
     #
     # * <tt>exception</tt> is the exception which will be recorded.  May also be

data/lib/new_relic/agent/agent.rb

@@ -4,6 +4,7 @@ require 'net/http'
 require 'logger'
 require 'zlib'
 require 'stringio'
+require 'new_relic/data_serialization'
 
 module NewRelic
   module Agent
@@ -73,6 +74,7 @@ module NewRelic
         end
 
         def unsent_timeslice_data
+          @unsent_timeslice_data ||= {}
           @unsent_timeslice_data.keys.length
         end
 
@@ -294,7 +296,7 @@ module NewRelic
           end
 
           def log_sql_transmission_warning?
-            log_if((@record_sql == :raw), :warn, "Agent is configured to send raw SQL to RPM service")
+            log_if((@record_sql == :raw), :warn, "Agent is configured to send raw SQL to the service")
           end
 
           def sampler_config
@@ -352,7 +354,7 @@ module NewRelic
           end
 
           def log_version_and_pid
-            log.info "New Relic RPM Agent #{NewRelic::VERSION::STRING} Initialized: pid = #{$$}"
+            log.info "New Relic Ruby Agent #{NewRelic::VERSION::STRING} Initialized: pid = #{$$}"
           end
 
           def log_if(boolean, level, message)
@@ -467,7 +469,7 @@ module NewRelic
             # when a disconnect is requested, stop the current thread, which
             # is the worker thread that gathers data and talks to the
             # server.
-            log.error "RPM forced this agent to disconnect (#{error.message})"
+            log.error "New Relic forced this agent to disconnect (#{error.message})"
             disconnect
           end
 
@@ -520,7 +522,7 @@ module NewRelic
         #
         # See #connect for a description of connection_options.
         def start_worker_thread(connection_options = {})
-          log.debug "Creating RPM worker thread."
+          log.debug "Creating Ruby Agent worker thread."
           @worker_thread = Thread.new do
             deferred_work!(connection_options)
           end # thread new
@@ -570,7 +572,7 @@ module NewRelic
           end
 
           def log_error(error)
-            log.error "Error establishing connection with New Relic RPM Service at #{control.server}: #{error.message}"
+            log.error "Error establishing connection with New Relic Service at #{control.server}: #{error.message}"
             log.debug error.backtrace.join("\n")
           end
 
@@ -621,7 +623,7 @@ module NewRelic
                       else
                         error_collector.enabled = false
                       end
-            log.debug "Errors will #{enabled ? '' : 'not '}be sent to the RPM service."
+            log.debug "Errors will #{enabled ? '' : 'not '}be sent to the New Relic service."
           end
 
           def enable_random_samples!(sample_rate)
@@ -642,7 +644,7 @@ module NewRelic
               enable_random_samples!(sample_rate) if @should_send_random_samples
               log.debug "Transaction tracing threshold is #{@slowest_transaction_threshold} seconds."
             else
-              log.debug "Transaction traces will not be sent to the RPM service."
+              log.debug "Transaction traces will not be sent to the New Relic service."
             end
           end
 
@@ -723,7 +725,7 @@ module NewRelic
         #   later (default true).
         # * <tt>force_reconnect => true</tt> if you want to establish a new connection
         #   to the server before running the worker loop.  This means you get a separate
-        #   agent run and RPM sees it as a separate instance (default is false).
+        #   agent run and New Relic sees it as a separate instance (default is false).
         def connect(options)
           # Don't proceed if we already connected (@connected=true) or if we tried
           # to connect and were rejected with prejudice because of a license issue
@@ -734,7 +736,7 @@ module NewRelic
           @connect_retry_period = should_keep_retrying?(options) ? 10 : 0
 
           sleep connect_retry_period
-          log.debug "Connecting Process to RPM: #$0"
+          log.debug "Connecting Process to New Relic: #$0"
           query_server_for_configuration
           @connected_pid = $$
           @connected = true
@@ -921,7 +923,7 @@ module NewRelic
               response = http.request(request)
             end
           rescue Timeout::Error
-            log.warn "Timed out trying to post data to RPM (timeout = #{@request_timeout} seconds)" unless @request_timeout < 30
+            log.warn "Timed out trying to post data to New Relic (timeout = #{@request_timeout} seconds)" unless @request_timeout < 30
             raise
           end
           if response.is_a? Net::HTTPServiceUnavailable
@@ -999,7 +1001,7 @@ module NewRelic
               log.debug "Serializing agent data to disk"
               NewRelic::Agent.save_data
               if @connected_pid == $$
-                log.debug "Sending RPM service agent run shutdown message"
+                log.debug "Sending New Relic service agent run shutdown message"
                 invoke_remote :shutdown, @agent_id, Time.now.to_f
               else
                 log.debug "This agent connected from parent process #{@connected_pid}--not sending shutdown"

data/lib/new_relic/agent/beacon_configuration.rb

@@ -2,19 +2,23 @@ module NewRelic
   module Agent
     class BeaconConfiguration
       attr_reader :browser_timing_header
+      attr_reader :browser_timing_static_footer
       attr_reader :application_id
       attr_reader :browser_monitoring_key
       attr_reader :beacon
       attr_reader :rum_enabled
       attr_reader :license_bytes
 
+      JS_HEADER = "<script>var NREUMQ=[];NREUMQ.push([\"mark\",\"firstbyte\",new Date().getTime()]);</script>"
+
       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)
+        @browser_timing_header = build_browser_timing_header
+        @browser_timing_static_footer = build_load_file_js(connect_data) 
       end
 
       def license_bytes
@@ -25,22 +29,22 @@ module NewRelic
         @license_bytes
       end
 
-      def load_file_js(connect_data)
+      def build_load_file_js(connect_data)
         return "" unless connect_data.fetch('rum.load_episodes_file', true)
 
         episodes_url = connect_data.fetch('episodes_url', '')
-        "(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);})()"
+        "(function(){var d=document;var e=d.createElement(\"script\");e.async=true;e.src=\"#{episodes_url}\";var s=d.getElementsByTagName(\"script\")[0];s.parentNode.insertBefore(e,s);})();"
       end
 
-      def basic_javascript(connect_data)
-        "<script>var NREUMQ=[];NREUMQ.push([\"mark\",\"firstbyte\",new Date().getTime()]);#{load_file_js(connect_data)}</script>"
+      def javascript_header
+        JS_HEADER.dup
       end
 
-      def build_browser_timing_header(connect_data)
+      def build_browser_timing_header
         return "" if !@rum_enabled
         return "" if @browser_monitoring_key.nil?
-
-        value = basic_javascript(connect_data)
+        
+        value = javascript_header
         if value.respond_to?(:html_safe)
           value.html_safe
         else

data/lib/new_relic/agent/browser_monitoring.rb

@@ -56,7 +56,7 @@ module NewRelic
 
       def footer_js_string(beacon, license_key, application_id)
         obfuscated_transaction_name = obfuscate(browser_monitoring_transaction_name)
-        html_safe_if_needed("<script type=\"text/javascript\" charset=\"utf-8\">NREUMQ.push([\"nrf2\",\"#{beacon}\",\"#{license_key}\",#{application_id},\"#{obfuscated_transaction_name}\",#{browser_monitoring_queue_time},#{browser_monitoring_app_time}])</script>")
+        html_safe_if_needed("<script>#{NewRelic::Agent.instance.beacon_configuration.browser_timing_static_footer}NREUMQ.push([\"nrf2\",\"#{beacon}\",\"#{license_key}\",#{application_id},\"#{obfuscated_transaction_name}\",#{browser_monitoring_queue_time},#{browser_monitoring_app_time},new Date().getTime()])</script>")
       end
 
       def html_safe_if_needed(string)
@@ -76,7 +76,7 @@ module NewRelic
           index+=1
         }
 
-        [obfuscated].pack("m0").chomp
+        [obfuscated].pack("m0").gsub("\n", '')
       end
     end
   end

data/lib/new_relic/agent/error_collector.rb

@@ -145,7 +145,7 @@ module NewRelic
 
       def over_queue_limit?(message)
         over_limit = (@errors.length >= MAX_ERROR_QUEUE_LENGTH)
-        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: #{message}") if over_limit
+        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 New Relic until the queued errors have been sent: #{message}") if over_limit
         over_limit
       end