newrelic_rpm 3.6.9.171 → 3.7.0.174.beta

data/CHANGELOG

@@ -1,5 +1,14 @@
 # New Relic Ruby Agent Release Notes #
 
+## v3.7.0 ##
+
+  * RUM injection updates
+
+  The Ruby agent's code for both automatically and manually injecting the Real
+  User Monitoring scripts has been updated.  This should not require
+  application changes, but does result in a different script being injected
+  than previous versions of the agent.
+
 ## v3.6.9 ##
 
   * Experimental Rubinius 2.x support

data/lib/new_relic/agent.rb

@@ -451,29 +451,27 @@ module NewRelic
       nil # don't return a noticed error datastructure. it can only hurt.
     end
 
-    # Add parameters to the current transaction trace (and traced error if any)
-    # on the call stack.
+    # Add parameters to any Transaction Trace, Error or Analytics Events that
+    # are recorded during the current transaction.
+    #
+    # If configured to allow it, these custom parameters will also be present
+    # in the RUM script injected into the page.
     #
     # @api public
     #
     def add_custom_parameters(params)
-      Transaction.add_custom_parameters(params)
+      if params.is_a? Hash
+        Transaction.add_custom_parameters(params)
+      else
+        ::NewRelic::Agent.logger.warn("Bad argument passed to #add_custom_parameters. Expected Hash but got #{params.class}")
+      end
     end
 
-    # Set attributes about the user making this request. These attributes will be automatically
-    # appended to any Transaction Trace or Error that is collected. These attributes
-    # will also be collected for RUM requests.
-    #
-    # Attributes (hash)
-    # * <tt>:user</tt> => user name or ID
-    # * <tt>:account</tt> => account name or ID
-    # * <tt>:product</tt> => product name or level
-    #
-    # @api public
-    #
-    def set_user_attributes(attributes)
-      Transaction.set_user_attributes(attributes)
-    end
+    # @deprecated
+    alias add_request_parameters add_custom_parameters
+
+    # @deprecated
+    alias set_user_attributes add_custom_parameters
 
     # Set the name of the current running transaction.  The agent will
     # apply a reasonable default based on framework routing, but in
@@ -518,10 +516,6 @@ module NewRelic
       end
     end
 
-    # The #add_request_parameters method is aliased to #add_custom_parameters
-    # 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.

data/lib/new_relic/agent/beacon_configuration.rb

@@ -9,41 +9,10 @@ module NewRelic
     # need to look it up or reconfigure it every request
     class BeaconConfiguration
 
-      # the statically generated header - generated when the beacon
-      # configuration is created - does not vary per page
-      attr_reader :browser_timing_header
-
-      # the static portion of the RUM footer - this part does not vary
-      # by which request is in progress
-      attr_reader :browser_timing_static_footer
-
-      # RUM footer command used for 'finish' - based on whether JSONP is
-      # being used. 'nrfj' for JSONP, otherwise 'nrf2'
-      attr_reader :finish_command
-
-      # A static javascript header that is identical for every account
-      # and application
-      JS_HEADER = "<script type=\"text/javascript\">var NREUMQ=NREUMQ||[];NREUMQ.push([\"mark\",\"firstbyte\",new Date().getTime()]);</script>"
-
       # Creates a new browser configuration data. Argument is a hash
       # of configuration values from the server
       def initialize
-        if Agent.config[:js_errors_beta] && Agent.config[:js_agent_loader]
-          ::NewRelic::Agent.logger.debug("Beta JS errors functionality enabled")
-          ::NewRelic::Agent.logger.debug("JS agent loader version: #{Agent.config[:js_agent_loader_version]}")
-        else
-          @browser_timing_header = build_browser_timing_header
-          ::NewRelic::Agent.logger.debug("Browser timing header: #{@browser_timing_header.inspect}")
-          @browser_timing_static_footer = build_load_file_js
-          ::NewRelic::Agent.logger.debug("Browser timing static footer: #{@browser_timing_static_footer.inspect}")
-        end
-
-        if Agent.config[:'rum.jsonp']
-          ::NewRelic::Agent.logger.debug("Real User Monitoring is using JSONP protocol")
-          @finish_command = 'nrfj'
-        else
-          @finish_command = 'nrf2'
-        end
+        ::NewRelic::Agent.logger.debug("JS agent loader version: #{Agent.config[:'browser_monitoring.loader_version']}")
 
         if !Agent.config[:'rum.enabled']
           ::NewRelic::Agent.logger.debug("Real User Monitoring is disabled for this agent. Edit your configuration to change this.")
@@ -63,55 +32,6 @@ module NewRelic
         end
         @license_bytes
       end
-
-      # returns a snippet of text that does not change
-      # per-transaction. Is empty when rum is disabled, or we are not
-      # including the episodes file dynamically (i.e. the user
-      # includes it themselves)
-      def build_load_file_js
-        js = <<-EOS
-if (!NREUMQ.f) { NREUMQ.f=function() {
-NREUMQ.push(["load",new Date().getTime()]);
-EOS
-
-        if Agent.config[:'rum.load_episodes_file'] &&
-          Agent.config[:'rum.load_episodes_file'] != ''
-          js << <<-EOS
-var e=document.createElement("script");
-e.type="text/javascript";
-e.src=(("http:"===document.location.protocol)?"http:":"https:") + "//" +
-  "#{Agent.config[:episodes_file]}";
-document.body.appendChild(e);
-EOS
-        end
-
-        js << <<-EOS
-if(NREUMQ.a)NREUMQ.a();
-};
-NREUMQ.a=window.onload;window.onload=NREUMQ.f;
-};
-EOS
-        js
-      end
-
-      # returns a copy of the static javascript header, in case people
-      # are munging strings somewhere down the line
-      def javascript_header
-        JS_HEADER.dup
-      end
-
-      # Returns the header string, properly html-safed if needed
-      def build_browser_timing_header
-        return "" if !enabled?
-        return "" if Agent.config[:browser_key].nil?
-
-        value = javascript_header
-        if value.respond_to?(:html_safe)
-          value.html_safe
-        else
-          value
-        end
-      end
     end
   end
 end

data/lib/new_relic/agent/browser_monitoring.rb

@@ -13,16 +13,15 @@ module NewRelic
     #
     # @api public
     module BrowserMonitoring
+      include NewRelic::Coerce
+
       class DummyTransaction
 
+        attr_reader :custom_parameters
         attr_accessor :start_time
 
         def initialize
-          @attributes = {}
-        end
-
-        def user_attributes
-          @attributes
+          @custom_parameters = {}
         end
 
         def queue_time
@@ -142,10 +141,6 @@ module NewRelic
         end
       end
 
-      def transaction_attribute(key)
-        current_transaction.user_attributes[key] || ""
-      end
-
       def tt_guid
         state = NewRelic::Agent::TransactionState.get
         return state.request_guid if include_guid?(state)
@@ -161,54 +156,92 @@ module NewRelic
         return NewRelic::Agent::TransactionState.get.request_token
       end
 
-      def use_beta_js_agent?
-        return Agent.config[:js_errors_beta] && !Agent.config[:js_agent_loader].to_s.empty?
+      def js_agent_loader
+        Agent.config[:js_agent_loader].to_s
+      end
+
+      def has_loader?
+        !js_agent_loader.empty?
       end
 
-      # NOTE: This method may be overridden for internal prototyping, so should
-      # remain stable.
+      # NOTE: Internal prototyping often overrides this, so leave name stable!
       def header_js_string
-        if (use_beta_js_agent?)
-          html_safe_if_needed("\n<script type=\"text/javascript\">#{Agent.config[:js_agent_loader]}</script>")
-        else
-          NewRelic::Agent.instance.beacon_configuration.browser_timing_header
-        end
+        return "" unless has_loader?
+        html_safe_if_needed("\n<script type=\"text/javascript\">#{js_agent_loader}</script>")
       end
 
-      # NOTE: This method may be overridden for internal prototyping, so should
-      # remain stable.
+      # NOTE: Internal prototyping often overrides this, so leave name stable!
       def footer_js_string(config)
-        if (use_beta_js_agent?)
-          js_data = {
-            'txnParam' => config.finish_command,
-            'beacon' => NewRelic::Agent.config[:beacon],
-            'errorBeacon' => NewRelic::Agent.config[:error_beacon],
-            'licenseKey' => NewRelic::Agent.config[:browser_key],
-            'applicationID' => NewRelic::Agent.config[:application_id],
-            'transactionName' => obfuscate(config, browser_monitoring_transaction_name),
-            'queueTime' => current_timings.queue_time_in_millis,
-            'applicationTime' => current_timings.app_time_in_millis,
-            'ttGuid' => tt_guid,
-            'agentToken' => tt_token,
-            'user' => obfuscate(config, transaction_attribute(:user)),
-            'account' => obfuscate(config, transaction_attribute(:account)),
-            'product' => obfuscate(config, transaction_attribute(:product)),
-            'agent' => NewRelic::Agent.config[:js_agent_file]
-          }
-
-          html_safe_if_needed("\n<script type=\"text/javascript\">window.NREUM||(NREUM={});NREUM.info=#{NewRelic.json_dump(js_data)}</script>")
-        else
-          obfuscated_transaction_name = obfuscate(config, browser_monitoring_transaction_name)
+        data = js_data(config)
+        html_safe_if_needed("\n<script type=\"text/javascript\">window.NREUM||(NREUM={});NREUM.info=#{NewRelic.json_dump(data)}</script>")
+      end
+
+      BEACON_KEY           = "beacon".freeze
+      ERROR_BEACON_KEY     = "errorBeacon".freeze
+      LICENSE_KEY_KEY      = "licenseKey".freeze
+      APPLICATIONID_KEY    = "applicationID".freeze
+      TRANSACTION_NAME_KEY = "transactionName".freeze
+      QUEUE_TIME_KEY       = "queueTime".freeze
+      APPLICATION_TIME_KEY = "applicationTime".freeze
+      TT_GUID_KEY          = "ttGuid".freeze
+      AGENT_TOKEN_KEY      = "agentToken".freeze
+      AGENT_KEY            = "agent".freeze
+      EXTRA_KEY            = "extra".freeze
 
-          user = obfuscate(config, transaction_attribute(:user))
-          account = obfuscate(config, transaction_attribute(:account))
-          product = obfuscate(config, transaction_attribute(:product))
+      # NOTE: Internal prototyping may override this, so leave name stable!
+      def js_data(config)
+        {
+          BEACON_KEY           => NewRelic::Agent.config[:beacon],
+          ERROR_BEACON_KEY     => NewRelic::Agent.config[:error_beacon],
+          LICENSE_KEY_KEY      => NewRelic::Agent.config[:browser_key],
+          APPLICATIONID_KEY    => NewRelic::Agent.config[:application_id],
+          TRANSACTION_NAME_KEY => obfuscate(config, browser_monitoring_transaction_name),
+          QUEUE_TIME_KEY       => current_timings.queue_time_in_millis,
+          APPLICATION_TIME_KEY => current_timings.app_time_in_millis,
+          TT_GUID_KEY          => tt_guid,
+          AGENT_TOKEN_KEY      => tt_token,
+          AGENT_KEY            => NewRelic::Agent.config[:js_agent_file],
+          EXTRA_KEY            => obfuscate(config, format_extra_data(extra_data))
+        }
+      end
+
+      ANALYTICS_ENABLED = :'analytics_events.enabled'
+      ANALYTICS_TXN_ENABLED = :'analytics_events.transactions.enabled'
+      ANALYTICS_TXN_IN_PAGE = :'capture_attributes.page_view_events'
+
+      # NOTE: Internal prototyping may override this, so leave name stable!
+      def extra_data
+        return {} unless include_custom_parameters_in_extra?
+        current_transaction.custom_parameters.dup
+      end
+
+      def include_custom_parameters_in_extra?
+        NewRelic::Agent.config[ANALYTICS_ENABLED] &&
+          NewRelic::Agent.config[ANALYTICS_TXN_ENABLED] &&
+          NewRelic::Agent.config[ANALYTICS_TXN_IN_PAGE]
+      end
+
+      # Format the props using semicolon separated pairs separated by '=':
+      #   product=pro;user=bill@microsoft.com
+      def format_extra_data(extra_props)
+        extra_props = event_params(extra_props)
+        extra_props.map do |k, v|
+          key = escape_special_characters(k)
+          value = format_value(v)
+          "#{key}=#{value}"
+        end.join(';')
+      end
 
-          # This is slightly varied from other agents' RUM footer to ensure that
-          # NREUMQ is defined. Our experimental header placement has some holes
-          # where it could end up in a comment and not define NREUMQ as the footer
-          # assumes. We protect against that here.
-          html_safe_if_needed(%'<script type="text/javascript">if (typeof NREUMQ !== "undefined") { #{config.browser_timing_static_footer}NREUMQ.push(["#{config.finish_command}","#{Agent.config[:beacon]}","#{Agent.config[:browser_key]}","#{Agent.config[:application_id]}","#{obfuscated_transaction_name}",#{current_timings.queue_time_in_millis},#{current_timings.app_time_in_millis},new Date().getTime(),"#{tt_guid}","#{tt_token}","#{user}","#{account}","#{product}"]);}</script>')
+      def escape_special_characters(string)
+        string.to_s.tr("\";=", "':-" )
+      end
+
+      def format_value(v)
+        # flag numeric values with `#' prefix
+        if v.is_a? Numeric
+          value = "##{v}"
+        else
+          value = escape_special_characters(v)
         end
       end
 

data/lib/new_relic/agent/configuration/default_source.rb

@@ -98,6 +98,13 @@ module NewRelic
           Proc.new { self[:'rum.enabled'] }
         end
 
+        # This check supports the js_errors_beta key we've asked clients to
+        # set. Once JS errors are GA, browser_monitoring.loader can stop
+        # being dynamic.
+        def self.browser_monitoring_loader
+          Proc.new { self[:js_errors_beta] ? "full" : "rum"}
+        end
+
         def self.slow_sql_record_sql
           Proc.new { self[:'transaction_tracer.record_sql'] }
         end
@@ -640,12 +647,6 @@ module NewRelic
           :type => Boolean,
           :description => 'Enable or disable real user monitoring.'
         },
-        :'rum.jsonp' => {
-          :default => true,
-          :public => false,
-          :type => Boolean,
-          :description => 'Enable or disable jsonp as the default means of communicating with the beacon.'
-        },
         :'rum.load_episodes_file' => {
           :default => true,
           :public => false,
@@ -658,19 +659,25 @@ module NewRelic
           :type => Boolean,
           :description => 'Enable or disable automatic insertion of the real user monitoring header and footer into outgoing responses.'
         },
-        :'js_agent_loader_version' => {
-          :default => '',
-          :public => false,
+        :'browser_monitoring.loader' => {
+          :default => DefaultSource.browser_monitoring_loader,
+          :public => private,
           :type => String,
-          :description => 'Version of the JavaScript agent loader retrieved by the collector. This is only informational, setting the value does nothing.'
+          :description => 'Type of JavaScript agent loader to use for browser monitoring instrumentation'
+        },
+        :'browser_monitoring.debug' => {
+          :default => false,
+          :public => false,
+          :type => Boolean,
+          :description => 'Enable or disable debugging version of JavaScript agent loader for browser monitoring instrumentation.'
         },
-        :'js_agent_loader' => {
+        :js_agent_loader => {
           :default => '',
           :public => false,
           :type => String,
           :description => 'JavaScript agent loader content.'
         },
-        :'js_errors_beta' => {
+        :js_errors_beta => {
           :default => false,
           :public => false,
           :type => Boolean,
@@ -748,6 +755,18 @@ module NewRelic
           :type => Fixnum,
           :description => 'Maximum number of request events recorded by the analytics event sampling in a single harvest.'
         },
+        :'capture_attributes.transaction_events' => {
+          :default => true,
+          :public => true,
+          :type => Boolean,
+          :description => 'Include TT custom params in analytics event data.'
+        },
+        :'capture_attributes.page_view_events' => {
+          :default => false,
+          :public => false,
+          :type => Boolean,
+          :description => 'Include TT custom params in real user monitoring script in outgoing responses.'
+        },
       }.freeze
 
     end

data/lib/new_relic/agent/request_sampler.rb

@@ -13,9 +13,10 @@ class NewRelic::Agent::RequestSampler
           MonitorMixin
 
   # The namespace and keys of config values
-  MAX_SAMPLES_KEY  = :'analytics_events.max_samples_stored'
-  ENABLED_KEY      = :'analytics_events.enabled'
-  ENABLED_TXN_KEY  = :'analytics_events.transactions.enabled'
+  MAX_SAMPLES_KEY            = :'analytics_events.max_samples_stored'
+  ENABLED_KEY                = :'analytics_events.enabled'
+  ENABLED_TXN_KEY            = :'analytics_events.transactions.enabled'
+  INCLUDE_CUSTOM_PARAMS_KEY  = :'capture_attributes.transaction_events'
 
   # The type field of the sample
   SAMPLE_TYPE              = 'Transaction'
@@ -124,13 +125,19 @@ class NewRelic::Agent::RequestSampler
   def on_transaction_finished(payload)
     return unless @enabled
     return unless NewRelic::Agent::Transaction.transaction_type_is_web?(payload[:type])
-    sample = {
-      TIMESTAMP_KEY => float(payload[:start_timestamp]),
-      NAME_KEY      => string(payload[:name]),
-      DURATION_KEY  => float(payload[:duration]),
-      TYPE_KEY      => SAMPLE_TYPE
-    }.merge((payload[:overview_metrics] || {}))
-
+    # The order in which these are merged is important.  We want to ensure that
+    # custom parameters can't override required fields (e.g. type)
+    sample = {}
+    if ::NewRelic::Agent.config[INCLUDE_CUSTOM_PARAMS_KEY]
+      sample.merge!(event_params(payload[:custom_params] || {}))
+    end
+    sample.merge!(payload[:overview_metrics] || {})
+    sample.merge!({
+        TIMESTAMP_KEY     => float(payload[:start_timestamp]),
+        NAME_KEY          => string(payload[:name]),
+        DURATION_KEY      => float(payload[:duration]),
+        TYPE_KEY          => SAMPLE_TYPE,
+      })
     is_full = self.synchronize { @samples.append(sample) }
     notify_full if is_full && !@notified_full
   end