newrelic_rpm 3.7.1.188 → 3.7.2.190.beta

data.tar.gz.sig

@@ -1,2 +1,3 @@
-���ڪb��f��w+�;Q�ڇ0g��Q�*	�0T�hA(����9��Oh�r��
-)~��U�6�.g�V]�F�<�@!���{�1�Ug��k1�����͆c����[�5v�gU�H�:�L��WM��6������
+c��eF6,���|���%�4�M�r7�cH���/
+
+9~�5�X(����J�_VN�36B.�L�n�D�vԨw��{������)�ѧ~���e�)���B��

data/CHANGELOG

@@ -17,7 +17,7 @@
   successfully report data after an app forked or daemonized. Gems or scripts
   with daemonizing modes had to wait for agent support or find workarounds.
 
-  With 3.7.1 setting `restart_thread_in_child: true` in your newrelic.yml
+  With 3.7.1 setting `restart_thread_in_children: true` in your newrelic.yml
   automatically restarts the agent in child processes without requiring custom
   code. For now the feature is opt-in, but future releases may default it on.
 

data/Guardfile

@@ -1,7 +1,7 @@
-guard :test, :test_paths => ['test/new_relic'], :all_after_pass => false do
+guard :minitest, :test_folders => ['test/new_relic'], :all_after_pass => false do
   watch(%r{^lib/(.+)\.rb$})     { |m| "test/#{m[1]}_test.rb" }
   watch(%r{^test/.+_test\.rb$})
   watch(%r{^test/rum/.*})       { "test/new_relic/rack/browser_monitoring_test.rb" }
-  watch('test/test_helper.rb')  { "test" }
-  watch('test/agent_helper.rb') { "test" }
+  watch('test/test_helper.rb')  { "test/new_relic" }
+  watch('test/agent_helper.rb') { "test/new_relic" }
 end

data/README.md

@@ -34,7 +34,7 @@ can be found on [our docs site](http://docs.newrelic.com/docs/ruby/supported-fra
 
 Any Rack based framework should work but may not be tested.  Install
 the Ruby Agent as a gem and add the Developer Mode middleware if
-desired.  Report any problems to support@newrelic.com.
+desired.  Report any problems by visiting support.newrelic.com.
 
 You can also monitor non-web applications. Refer to the "Other
 Environments" section under "Getting Started".

data/Rakefile

@@ -1,10 +1,8 @@
 require 'rubygems'
 require 'rake/testtask'
-require "#{File.dirname(__FILE__)}/lib/new_relic/version.rb"
 require "#{File.dirname(__FILE__)}/lib/tasks/all.rb"
 
 task :default => :test
-
 task :test => ['test:newrelic']
 
 namespace :test do

data/init.rb

@@ -7,13 +7,10 @@
 require 'new_relic/control'
 
 # If you are having problems seeing data, be sure and check the
-# newrelic_agent.log files in the log diretory of your application
+# newrelic_agent.log files in the log directory of your application
 #
 # If you can't find any log files and you don't see anything in your
-# application log files, try uncommenting the two lines at the
-# bottom of this file to verify the plugin is being loaded,
-# then send the output to support@newrelic.com if you are unable to
-# resolve the issue.
+# application log files please visit support.newrelic.com.
 
 # Initializer for the NewRelic Ruby Agent
 

data/lib/new_relic/agent.rb

@@ -139,6 +139,9 @@ module NewRelic
     # An unrecoverable client-side error that prevents the agent from continuing
     class UnrecoverableAgentException < ServerConnectionException; end
 
+    # An error while serializing data for the collector
+    class SerializationError < StandardError; end
+
     class BackgroundLoadingError < StandardError; end
 
     # placeholder name used when we cannot determine a transaction's name

data/lib/new_relic/agent/agent.rb

@@ -951,6 +951,8 @@ module NewRelic
             @service.send(endpoint, items)
           rescue ForceRestartException, ForceDisconnectException
             raise
+          rescue SerializationError => e
+            NewRelic::Agent.logger.warn("Failed to serialize data for #{endpoint}, discarding. Error: ", e)
           rescue UnrecoverableServerException => e
             NewRelic::Agent.logger.warn("#{endpoint} data was rejected by remote service, discarding. Error: ", e)
           rescue => e

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

@@ -606,6 +606,12 @@ module NewRelic
           :type => String,
           :description => "Obfuscation level for sql queries reported in transaction trace segments (e.g. 'obfuscated', 'raw', 'none')."
         },
+        :'transaction_tracer.capture_attributes' => {
+          :default => true,
+          :public => true,
+          :type => Boolean,
+          :description => 'Enable or disable collection of custom attributes on transaction traces.'
+        },
         :'transaction_tracer.limit_segments' => {
           :default => 4000,
           :public => true,
@@ -684,6 +690,12 @@ module NewRelic
           :type => Boolean,
           :description => 'Enable or disable collection of source code for errors that support it.'
         },
+        :'error_collector.capture_attributes' => {
+          :default => true,
+          :public => true,
+          :type => Boolean,
+          :description => 'Enable or disable collection of custom attributes on errors.'
+        },
         :'error_collector.ignore_errors' => {
           :default => 'ActionController::RoutingError,Sinatra::NotFound',
           :public => true,
@@ -757,6 +769,18 @@ module NewRelic
           :type => Boolean,
           :description => 'Enable or disable HTTPS instrumentation by JavaScript agent on HTTP pages.'
         },
+        :'browser_monitoring.capture_attributes' => {
+          :default => false,
+          :public => false,
+          :type => Boolean,
+          :description => 'Include custom attributes in real user monitoring script in outgoing responses.'
+        },
+        :'capture_attributes.page_view_events' => {
+          :default => false,
+          :public => false,
+          :type => Boolean,
+          :description => 'Deprecated setting that is still in use by a few clients. Correct setting is browser_monitoring.capture_attributes.'
+        },
         :js_agent_loader => {
           :default => '',
           :public => false,
@@ -854,23 +878,11 @@ module NewRelic
           :type => Fixnum,
           :description => 'Maximum number of request events recorded by the analytics event sampling in a single harvest.'
         },
-        :'capture_attributes.traces' => {
-          :default => true,
-          :public => false,
-          :type => Boolean,
-          :description => 'Include custom parameters in transaction traces and traced errors'
-        },
-        :'capture_attributes.transaction_events' => {
+        :'analytics_events.capture_attributes' => {
           :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.'
+          :description => 'Include custom attributes in analytics event data.'
         },
         :restart_thread_in_children => {
           :default => false,
@@ -878,6 +890,12 @@ module NewRelic
           :type => Boolean,
           :description => 'Controls whether to check on running a transaction whether to respawn the harvest thread.'
         },
+        :normalize_json_string_encodings => {
+          :default => true,
+          :public => false,
+          :type => Boolean,
+          :description => 'Controls whether to normalize string encodings prior to serializing data for the collector to JSON.'
+        }
       }.freeze
 
     end

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

@@ -62,6 +62,7 @@ module NewRelic
           nr_env_var_keys = collect_new_relic_environment_variable_keys
 
           nr_env_var_keys.each do |key|
+            next if key.upcase == 'NEW_RELIC_LOG'
             set_value_from_environment_variable(key)
           end
         end

data/lib/new_relic/agent/cross_app_monitor.rb

@@ -88,7 +88,7 @@ module NewRelic
       def save_referring_transaction_info(request_headers)
         txn_header = from_headers( request_headers, NEWRELIC_TXN_HEADER_KEYS ) or return
         txn_header = obfuscator.deobfuscate( txn_header )
-        txn_info = NewRelic.json_load( txn_header )
+        txn_info = NewRelic::JSONWrapper.load( txn_header )
         NewRelic::Agent.logger.debug "Referring txn_info: %p" % [ txn_info ]
 
         TransactionState.get.referring_transaction_info = txn_info
@@ -147,7 +147,7 @@ module NewRelic
           content_length,
           transaction_guid()
         ]
-        payload = obfuscator.obfuscate(NewRelic.json_dump(payload))
+        payload = obfuscator.obfuscate(NewRelic::JSONWrapper.dump(payload))
       end
 
       def set_transaction_custom_parameters

data/lib/new_relic/agent/cross_app_tracing.rb

@@ -154,7 +154,7 @@ module NewRelic
         cross_app_id = NewRelic::Agent.config[:cross_process_id] or
           raise NewRelic::Agent::CrossAppTracing::Error, "no cross app ID configured"
         txn_guid = NewRelic::Agent::TransactionState.get.request_guid
-        txn_data = NewRelic.json_dump([ txn_guid, false ])
+        txn_data = NewRelic::JSONWrapper.dump([ txn_guid, false ])
 
         request[ NR_ID_HEADER ]  = obfuscator.obfuscate( cross_app_id )
         request[ NR_TXN_HEADER ] = obfuscator.obfuscate( txn_data )
@@ -273,7 +273,7 @@ module NewRelic
         decoded_appdata.set_encoding( ::Encoding::UTF_8 ) if
           decoded_appdata.respond_to?( :set_encoding )
 
-        return NewRelic.json_load( decoded_appdata )
+        return NewRelic::JSONWrapper.load( decoded_appdata )
       end
 
 

data/lib/new_relic/agent/error_collector.rb

@@ -163,7 +163,7 @@ module NewRelic
         # If anything else is left over, we treat it like a custom param
         def custom_params_from_opts(options)
           # If anything else is left over, treat it like a custom param:
-          if Agent.config[:'capture_attributes.traces']
+          if Agent.config[:'error_collector.capture_attributes']
             fetch_from_options(options, :custom_params, {}).merge(options)
           else
             {}

data/lib/new_relic/agent/http_clients/typhoeus_wrappers.rb

@@ -38,7 +38,10 @@ module NewRelic
       class TyphoeusHTTPRequest
         def initialize(request)
           @request = request
-          @uri = URI.parse(request.url)
+          @uri = case request.url
+            when ::URI then request.url
+            else ::URI.parse(request.url.to_s)
+            end
         end
 
         def type

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

@@ -23,8 +23,8 @@ module NewRelic
         end
 
         def start(name, id, payload)
-          payload[:request] = TransactionState.get.request
-          event = ControllerEvent.new(name, Time.now, nil, id, payload)
+          request = TransactionState.get.request
+          event = ControllerEvent.new(name, Time.now, nil, id, payload, request)
           push_event(event)
 
           if NewRelic::Agent.is_execution_traced? && !event.ignored?
@@ -96,7 +96,7 @@ module NewRelic
 
         def start_transaction(event)
           txn = Transaction.start(:controller,
-                                  :request => event.payload[:request],
+                                  :request => event.request,
                                   :filtered_params => filter(event.payload[:params]))
           txn.apdex_start = (event.queue_start || event.time)
           txn.name = event.metric_name
@@ -120,16 +120,18 @@ module NewRelic
 
       class ControllerEvent < Event
         attr_accessor :parent, :scope
-        attr_reader :queue_start
+        attr_reader :queue_start, :request
 
-        def initialize(name, start, ending, transaction_id, payload)
-          super
+        def initialize(name, start, ending, transaction_id, payload, request)
+          # We have a different initialize parameter list, so be explicit
+          super(name, start, ending, transaction_id, payload)
 
+          @request = request
           @controller_class = payload[:controller].split('::') \
             .inject(Object){|m,o| m.const_get(o)}
 
-          if payload[:request] && payload[:request].respond_to?(:env)
-            @queue_start = QueueTime.parse_frontend_timestamp(payload[:request].env, self.time)
+          if request && request.respond_to?(:env)
+            @queue_start = QueueTime.parse_frontend_timestamp(request.env, self.time)
           end
         end
 

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

@@ -25,19 +25,24 @@ module NewRelic
           event = pop_event(id)
 
           if NewRelic::Agent.is_execution_traced? && event.recordable?
-            record_metrics(event)
-            NewRelic::Agent.instance.stats_engine \
+            scope = NewRelic::Agent.instance.stats_engine \
               .pop_scope(event.scope, event.metric_name, event.end)
+            record_metrics(event, scope)
           end
         rescue => e
           log_notification_error(e, name, 'finish')
         end
 
-        def record_metrics(event)
+        def record_metrics(event, scope)
+          exclusive = event.duration - scope.children_time
+          metric_specs = [
+            NewRelic::MetricSpec.new(event.metric_name),
+            NewRelic::MetricSpec.new(event.metric_name, StatsEngine::MetricStats::SCOPE_PLACEHOLDER)
+          ]
           NewRelic::Agent.instance.stats_engine \
-            .record_metrics(event.metric_name,
-                            event.duration,
-                            :scoped => true)
+            .record_metrics_internal(metric_specs,
+                                     event.duration,
+                                     exclusive)
         end
 
         class RenderEvent < Event

data/lib/new_relic/agent/javascript_instrumentor.rb

@@ -71,6 +71,9 @@ module NewRelic
         else
           true
         end
+      rescue => e
+        ::NewRelic::Agent.logger.debug "Failure during insert_js", e
+        false
       end
 
       def missing_config?(key)
@@ -81,6 +84,9 @@ module NewRelic
       def browser_timing_header
         return "" unless insert_js?
         browser_timing_config + browser_timing_loader
+      rescue => e
+        ::NewRelic::Agent.logger.debug "Failure during RUM browser_timing_header construction", e
+        ""
       end
 
       # NOTE: Internal prototyping often overrides this, so leave name stable!
@@ -92,7 +98,7 @@ module NewRelic
       def browser_timing_config
         NewRelic::Agent::Transaction.freeze_name
         data = data_for_js_agent
-        json = NewRelic.json_dump(data)
+        json = NewRelic::JSONWrapper.dump(data)
         html_safe_if_needed("\n<script type=\"text/javascript\">window.NREUM||(NREUM={});NREUM.info=#{json}</script>")
       end
 
@@ -106,7 +112,7 @@ module NewRelic
       TT_GUID_KEY          = "ttGuid".freeze
       AGENT_TOKEN_KEY      = "agentToken".freeze
       AGENT_KEY            = "agent".freeze
-      EXTRA_KEY            = "extra".freeze
+      USER_ATTRIBUTES_KEY  = "userAttributes".freeze
       SSL_FOR_HTTP_KEY     = "sslForHttp".freeze
 
       # NOTE: Internal prototyping may override this, so leave name stable!
@@ -124,10 +130,11 @@ module NewRelic
           APPLICATION_TIME_KEY => timings.app_time_in_millis,
           TT_GUID_KEY          => state.request_guid_to_include,
           AGENT_TOKEN_KEY      => state.request_token,
-          AGENT_KEY            => NewRelic::Agent.config[:js_agent_file],
-          EXTRA_KEY            => obfuscator.obfuscate(formatted_extra_parameter_for_js_agent)
+          AGENT_KEY            => NewRelic::Agent.config[:js_agent_file]
         }
+
         add_ssl_for_http(data)
+        add_user_attributes(data)
 
         data
       end
@@ -139,43 +146,27 @@ module NewRelic
         end
       end
 
-      # NOTE: Internal prototyping may override this, so leave name stable!
-      def data_for_js_agent_extra_parameter
-        return {} unless include_custom_parameters_in_extra?
-        current_transaction.custom_parameters.dup
-      end
-
-      def include_custom_parameters_in_extra?
-        current_transaction &&
-          NewRelic::Agent.config[:'analytics_events.enabled'] &&
-          NewRelic::Agent.config[:'capture_attributes.page_view_events']
-      end
+      def add_user_attributes(data)
+        return unless include_custom_parameters?
 
-      def formatted_extra_parameter_for_js_agent
-        format_extra_data(data_for_js_agent_extra_parameter)
+        params = event_params(current_transaction.custom_parameters)
+        json = NewRelic::JSONWrapper.dump(params)
+        data[USER_ATTRIBUTES_KEY] = obfuscator.obfuscate(json)
       end
 
-      # Format the props using semicolon separated pairs separated by '=':
-      #   product=pro;user=bill@microsoft.com
-      def format_extra_data(extra_props)
-        event_params(extra_props).
-          map {|k,v| format_pair(k, v)}.
-          join(';')
+      # Still support deprecated capture_attributes.page_view_events for
+      # clients that use it. Could potentially be removed if we don't have
+      # anymore users with it set according to zeitgeist.
+      def include_custom_parameters?
+        has_custom_parameters? &&
+          (NewRelic::Agent.config[:'browser_monitoring.capture_attributes'] ||
+           NewRelic::Agent.config[:'capture_attributes.page_view_events'])
       end
 
-      def format_pair(key, value)
-        key = escape_special_characters(key)
-        value = format_value(value)
-        "#{key}=#{value}"
-      end
-
-      def escape_special_characters(string)
-        string.to_s.tr("\";=", "':-" )
-      end
-
-      def format_value(v)
-        v = "##{v}" if v.is_a?(Numeric)
-        escape_special_characters(v)
+      def has_custom_parameters?
+        current_transaction &&
+          current_transaction.custom_parameters &&
+          !current_transaction.custom_parameters.empty?
       end
 
       def html_safe_if_needed(string)

data/lib/new_relic/agent/method_tracer.rb

@@ -403,8 +403,26 @@ module NewRelic
           # returns an eval-able string that contains the tracing code
           # for a fully traced metric including scoping
           def method_with_push_scope(method_name, metric_name_code, options)
-            klass = (self === Module) ? "self" : "self.class"
-
+            # At this point, we expect 'self' to point to a Class or Module that
+            # has included the NewRelic::Agent::MethodTracer module, which means
+            # it should have an instance method defined called
+            # 'trace_execution_scoped'.
+            #
+            # If this is not the case, assume that
+            # we're relying on the fact that MethodTracer is included into the
+            # Module class by init_plugin, and try to call
+            # trace_execution_scoped as a class rather than instance method.
+            #
+            # The inclusion of MethodTracer into Module will be going away in
+            # the future, so if we detect people relying on that behavior, warn
+            # and record a supportability metric.
+            if self.method_defined?(:trace_execution_scoped)
+              klass = 'self'
+            else
+              NewRelic::Agent.logger.warn("Called add_method_tracer from #{self} without including the NewRelic::Agent::MethodTracer module. This is deprecated and will stop working in the future. Please see http://docs.newrelic.com/docs/ruby/ruby-custom-metric-collection for examples of correct add_method_tracer usage.")
+              NewRelic::Agent.increment_metric("Supportability/usage/improper_add_method_tracer")
+              klass = 'self.class'
+            end
             "def #{_traced_method_name(method_name, metric_name_code)}(*args, &block)
               #{options[:code_header]}
               result = #{klass}.trace_execution_scoped(\"#{metric_name_code}\",