newrelic_rpm 3.17.2.327 → 3.18.0.329

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0301a8db8b21f5556ab12b5bef28f55c490d7e3f
-  data.tar.gz: 0b886aad5a9cbb3300decb937c6ccae89c7e7095
+  metadata.gz: 3c1e2869b811ed3b76c7a71c8386d238e53fef6b
+  data.tar.gz: cdd29e0fce09cca5e0c72d07a2471b33ffe57282
 SHA512:
-  metadata.gz: f5dc6f085fc8884c1f7cc894f54eeec9e5594559313ec5824dac4f4e18cda781b0917169d95d185f905e444eb0ce48867a44077a2761e2c923f03d751b8f0159
-  data.tar.gz: 91d221b247e28eaa666c3c96bfe43ad6a29ff02224ae4af4afcb949e33251e9747f4e5f8341e96b82b269045902c000fefdb90fc528f22ae375386846bc69e69
+  metadata.gz: 1207f33db770af8824c989fea1658d55ac2a9e1630f2fea50044a498908257e6d51081aaecaae94f09a8238ceba070b7b3744026f390c98e377b688a2c59c3ea
+  data.tar.gz: 61ee001c5fc41aabfdb89b3ba741bfc9a37eb3b74bb8b16ef1e374f918dd3baba9ab1308e968c38c89b146a1720af347324e808031f968f365f16135cfc4b7c2

data/.travis.yml

@@ -10,8 +10,8 @@ sudo: required
 before_install:
   - ./test/script/before_install/revert_rubygems.sh
   - gem --version
-  - ./test/script/before_install/jruby_bundler.sh
   - ./test/script/before_install/gemstash_mirror.sh
+  - ./test/script/before_install/update_bundler.sh
   - bundle --version
 
 install: bundle install
@@ -33,9 +33,10 @@ notifications:
 
 rvm:
   # Run slowest builds first to try and optimize overall cycle time.
-  - jruby-1.7.23 # NOTE: see test/script/before_install/jruby_bundler.sh
+  - jruby-1.7.23
   - jruby-9.1.2.0
-  - 2.3.2
+  - 2.4.0
+  - 2.3.3
   - 2.2.6
   - 2.1.10
   - 2.0.0-p648
@@ -76,32 +77,53 @@ env:
     - TYPE=FUNCTIONAL GROUP=serialization
     - TYPE=FUNCTIONAL GROUP=sinatra
     - TYPE=FUNCTIONAL GROUP=rest
-    - TYPE=FUNCTIONAL GROUP=rake
+    - TYPE=FUNCTIONAL GROUP=background_2
     - TYPE=NULLVERSE
 
 matrix:
   allow_failures:
     - rvm: rbx-2.5.8
+    - rvm: ree
   fast_finish: true
   exclude:
     - rvm: rbx-2.5.8 # Currently hangs
       env: TYPE=FUNCTIONAL GROUP=agent
 
     # Unsupported Rails/Ruby combinations
+    # 2.4
+    - rvm: 2.4.0
+      env: TYPE=UNIT ENVIRONMENT=rails21
+    - rvm: 2.4.0
+      env: TYPE=UNIT ENVIRONMENT=rails22
+    - rvm: 2.4.0
+      env: TYPE=UNIT ENVIRONMENT=rails23
+    - rvm: 2.4.0
+      env: TYPE=UNIT ENVIRONMENT=rails30
+    - rvm: 2.4.0
+      env: TYPE=UNIT ENVIRONMENT=rails31
+    - rvm: 2.4.0
+      env: TYPE=UNIT ENVIRONMENT=rails32
+    - rvm: 2.4.0
+      env: TYPE=UNIT ENVIRONMENT=rails40
+    - rvm: 2.4.0
+      env: TYPE=UNIT ENVIRONMENT=rails41
+    - rvm: 2.4.0
+      env: TYPE=UNIT ENVIRONMENT=rails42
+
     # 2.3
-    - rvm: 2.3.1
+    - rvm: 2.3.3
       env: TYPE=UNIT ENVIRONMENT=rails21
-    - rvm: 2.3.1
+    - rvm: 2.3.3
       env: TYPE=UNIT ENVIRONMENT=rails22
-    - rvm: 2.3.1
+    - rvm: 2.3.3
       env: TYPE=UNIT ENVIRONMENT=rails23
 
     # 2.2
-    - rvm: 2.2.5
+    - rvm: 2.2.6
       env: TYPE=UNIT ENVIRONMENT=rails21
-    - rvm: 2.2.5
+    - rvm: 2.2.6
       env: TYPE=UNIT ENVIRONMENT=rails22
-    - rvm: 2.2.5
+    - rvm: 2.2.6
       env: TYPE=UNIT ENVIRONMENT=rails23
 
     # 2.1

data/CHANGELOG.md

@@ -1,10 +1,50 @@
 # New Relic Ruby Agent Release Notes #
 
-  ## v3.17.2
+## v3.18.0 ##
 
-  * Compatibility with Ruby 2.4.0-preview3
+  * Ruby 2.4.0 support
 
-  The Ruby agent has been updated to work on Ruby 2.4.0-preview3.
+  The agent is now tested against the official release of ruby 2.4.0,
+  excluding incompatible packages.
+
+  * Agent-based metrics will not be recorded outside of active transactions
+
+  The agent has historically recorded metrics outside of a transaction. In
+  practice, this usually occurs in applications that run background job
+  processors. The agent would record metrics for queries the
+  background job processor is making between transactions. This can lead
+  to display issues on the background overview page and the presence of
+  metrics generated by the background job processor can mask the application
+  generated metrics on the database page. The agent will no longer generate
+  metrics outside of a transaction. Custom metrics recorded using
+  `NewRelic::Agent.record_metric` will continue to be recorded regardless
+  of whether there is an active transaction.
+
+  * Include ControllerInstrumentation module with ActiveSupport.on_load
+
+  The agent will now use the `on_load :action_controller` hook to include
+  the ControllerInstrumentation module in to both the `Base` and `API`
+  classes of ActionController for Rails 5. This ensures that the proper
+  load order is retained, minimizing side-effects of having the agent in
+  an application.
+
+  * Ensure values for revisions on Capistrano deploy notices
+
+  Previously, running the task to look up the changelog could
+  generate an error, if there weren't previous and current revisions
+  defined. This has now been fixed. Thanks Winfield Peterson for the
+  contribution!
+
+  * External Segment Rewrites
+
+  The agent has made internal changes to how it represents segments for
+  external web requests.
+
+## v3.17.2 ##
+
+  * compatibility with ruby 2.4.0-preview3
+
+  the ruby agent has been updated to work on ruby 2.4.0-preview3.
 
   * Early Access Sinatra 2.0 instrumentation
 

data/Rakefile

@@ -22,27 +22,6 @@ namespace :test do
 
   agent_home = File.expand_path(File.dirname(__FILE__))
 
-  # Agent-specific setup to enforce getting our proper suites directory
-  task :multiverse_setup do
-    ENV["SUITES_DIRECTORY"] = File.expand_path(File.join(File.dirname(__FILE__), 'test', 'multiverse', 'suites'))
-  end
-
-  task :multiverse => :multiverse_setup
-
-  desc "Test the multiverse testing framework by executing tests in test/multiverse/test. Get meta with it."
-  task 'multiverse:self', [:suite, :mode] => [] do |t, args|
-    args.with_defaults(:suite => "", :mode => "")
-    puts ("Testing the multiverse testing framework...")
-    test_files = FileList['test/multiverse/test/*_test.rb']
-    ruby test_files.join(" ")
-  end
-
-  task 'multiverse:prime', [:suite] => [] do |t, args|
-    require File.expand_path(File.join(File.dirname(__FILE__), 'test', 'multiverse', 'lib', 'multiverse', 'environment'))
-    opts = Multiverse::Runner.parse_args(args)
-    Multiverse::Runner.prime(args.suite, opts)
-  end
-
   desc "Run agent performance tests"
   task :performance, [:suite, :name] => [] do |t, args|
     require File.expand_path(File.join(File.dirname(__FILE__), 'test', 'performance', 'lib', 'performance'))

data/lib/new_relic/agent/cross_app_tracing.rb

@@ -7,135 +7,22 @@ module NewRelic
   module Agent
     module CrossAppTracing
 
-      # Exception raised if there is a problem with cross app transactions.
-      class Error < RuntimeError; end
-
       # The cross app response header for "outgoing" calls
-      NR_APPDATA_HEADER = 'X-NewRelic-App-Data'
+      NR_APPDATA_HEADER = 'X-NewRelic-App-Data'.freeze
 
       # The cross app id header for "outgoing" calls
-      NR_ID_HEADER = 'X-NewRelic-ID'
+      NR_ID_HEADER = 'X-NewRelic-ID'.freeze
 
       # The cross app transaction header for "outgoing" calls
-      NR_TXN_HEADER = 'X-NewRelic-Transaction'
+      NR_TXN_HEADER = 'X-NewRelic-Transaction'.freeze
 
       # The cross app synthetics header
-      NR_SYNTHETICS_HEADER = 'X-NewRelic-Synthetics'
-
-      # The index of the transaction GUID in the appdata header of responses
-      APPDATA_TXN_GUID_INDEX = 5
-
+      NR_SYNTHETICS_HEADER = 'X-NewRelic-Synthetics'.freeze
 
       ###############
       module_function
       ###############
 
-      # Send the given +request+, adding metrics appropriate to the
-      # response when it comes back.
-      #
-      # See the documentation for +start_trace+ for an explanation of what
-      # +request+ should look like.
-      #
-      def tl_trace_http_request(request)
-        state = NewRelic::Agent::TransactionState.tl_get
-        return yield unless state.is_execution_traced?
-
-        # It's important to set t0 outside the ensured block, otherwise there's
-        # a race condition if we raise after begin but before t0's set.
-        t0 = Time.now
-        begin
-          node = start_trace(state, t0, request)
-          response = yield
-        ensure
-          finish_trace(state, t0, node, request, response)
-        end
-
-        return response
-      end
-
-      # Set up the necessary state for cross-application tracing before the
-      # given +request+ goes out.
-      #
-      # The +request+ object passed in must respond to the following methods:
-      #
-      # * type - Return a String describing the underlying library being used
-      #          to make the request (e.g. 'Net::HTTP' or 'Typhoeus')
-      # * host - Return a String with the hostname or IP of the host being
-      #          communicated with.
-      # * method  - Return a String with the HTTP method name for this request
-      # * [](key) - Lookup an HTTP request header by name
-      # * []=(key, val) - Set an HTTP request header by name
-      # * uri  - Full URI of the request
-      #
-      # This method returns the transaction node if it was sucessfully pushed.
-      def start_trace(state, t0, request)
-        inject_request_headers(state, request) if cross_app_enabled?
-        stack = state.traced_method_stack
-        node = stack.push_frame(state, :http_request, t0)
-
-        return node
-      rescue => err
-        NewRelic::Agent.logger.error "Uncaught exception while tracing HTTP request", err
-        return nil
-      rescue Exception => e
-        NewRelic::Agent.logger.debug "Unexpected exception raised while tracing HTTP request", e
-
-        raise e
-      end
-
-
-      # Finish tracing the HTTP +request+ that started at +t0+ with the information in
-      # +response+ and the given +http+ connection.
-      #
-      # The +request+ must conform to the same interface described in the documentation
-      # for +start_trace+.
-      #
-      # The +response+ must respond to the following methods:
-      #
-      # * [](key) - Reads response headers.
-      # * to_hash - Converts response headers to a Hash
-      #
-      def finish_trace(state, t0, node, request, response)
-        unless t0
-          NewRelic::Agent.logger.error("HTTP request trace finished without start time. This is probably an agent bug.")
-          return
-        end
-
-        t1 = Time.now
-        duration = t1.to_f - t0.to_f
-
-        begin
-          if request
-            # Figure out which metrics we need to report based on the request and response
-            # The last (most-specific) one is scoped.
-            metrics = metrics_for(request, response)
-            scoped_metric = metrics.pop
-
-            stats_engine.record_scoped_and_unscoped_metrics(
-              state, scoped_metric, metrics, duration)
-
-            # If we don't have node, something failed during start_trace so
-            # the current node isn't the HTTP call it should have been.
-            if node
-              node.name = scoped_metric
-              add_transaction_trace_parameters(request, response)
-            end
-          end
-        ensure
-          # If we have a node, always pop the traced method stack to avoid
-          # an inconsistent state, which prevents tracing of whole transaction.
-          if node
-            stack = state.traced_method_stack
-            stack.pop_frame(state, node, scoped_metric, t1)
-          end
-        end
-      rescue NewRelic::Agent::CrossAppTracing::Error => err
-        NewRelic::Agent.logger.debug "while cross app tracing", err
-      rescue => err
-        NewRelic::Agent.logger.error "Uncaught exception while finishing an HTTP request trace", err
-      end
-
-      # Return +true+ if cross app tracing is enabled in the config.
       def cross_app_enabled?
         valid_cross_process_id? &&
           valid_encoding_key? &&
@@ -143,138 +30,51 @@ module NewRelic
       end
 
       def valid_cross_process_id?
-        NewRelic::Agent.config[:cross_process_id] && NewRelic::Agent.config[:cross_process_id].length > 0
+        if NewRelic::Agent.config[:cross_process_id] && NewRelic::Agent.config[:cross_process_id].length > 0
+          true
+        else
+          NewRelic::Agent.logger.debug "No cross_process_id configured"
+          false
+        end
       end
 
       def valid_encoding_key?
-        NewRelic::Agent.config[:encoding_key] && NewRelic::Agent.config[:encoding_key].length > 0
+        if NewRelic::Agent.config[:encoding_key] && NewRelic::Agent.config[:encoding_key].length > 0
+          true
+        else
+          NewRelic::Agent.logger.debug "No encoding_key set"
+          false
+        end
       end
 
       def cross_application_tracer_enabled?
         NewRelic::Agent.config[:"cross_application_tracer.enabled"] || NewRelic::Agent.config[:cross_application_tracing]
       end
 
-      # Fetcher for the cross app encoding key. Raises a
-      # NewRelic::Agent::CrossAppTracing::Error if the key isn't configured.
-      def cross_app_encoding_key
-        NewRelic::Agent.config[:encoding_key] or
-          raise NewRelic::Agent::CrossAppTracing::Error, "No encoding_key set."
-      end
-
       def obfuscator
-        @obfuscator ||= NewRelic::Agent::Obfuscator.new(cross_app_encoding_key)
+        @obfuscator ||= NewRelic::Agent::Obfuscator.new(NewRelic::Agent.config[:encoding_key])
       end
 
-      # Inject the X-Process header into the outgoing +request+.
-      def inject_request_headers(state, request)
-        cross_app_id = NewRelic::Agent.config[:cross_process_id] or
-          raise NewRelic::Agent::CrossAppTracing::Error, "no cross app ID configured"
-
-        state.is_cross_app_caller = true
-        txn_guid = state.request_guid
-        txn = state.current_transaction
-        if txn
-          trip_id   = txn.cat_trip_id(state)
-          path_hash = txn.cat_path_hash(state)
-
-          if txn.raw_synthetics_header
-            request[NR_SYNTHETICS_HEADER] = txn.raw_synthetics_header
-          end
-        end
+      def insert_request_headers(request, txn_guid, trip_id, path_hash, synthetics_header)
+        cross_app_id = NewRelic::Agent.config[:cross_process_id]
         txn_data  = NewRelic::JSONWrapper.dump([txn_guid, false, trip_id, path_hash])
 
         request[NR_ID_HEADER]  = obfuscator.obfuscate(cross_app_id)
         request[NR_TXN_HEADER] = obfuscator.obfuscate(txn_data)
-
-      rescue NewRelic::Agent::CrossAppTracing::Error => err
-        NewRelic::Agent.logger.debug "Not injecting x-process header", err
-      end
-
-      def add_transaction_trace_parameters(request, response)
-        filtered_uri = ::NewRelic::Agent::HTTPClients::URIUtil.filter_uri(request.uri)
-        transaction_sampler.add_node_parameters(:uri => filtered_uri)
-        if response && response_is_crossapp?(response)
-          add_cat_transaction_trace_parameters(response)
-        end
-      end
-
-
-      # Extract any custom parameters from +response+ if it's cross-application and
-      # add them to the current TT node.
-      def add_cat_transaction_trace_parameters( response )
-        appdata = extract_appdata( response )
-        transaction_sampler.add_node_parameters( \
-          :transaction_guid => appdata[APPDATA_TXN_GUID_INDEX] )
-      end
-
-
-      # Return the set of metric names that correspond to
-      # the given +request+ and +response+.
-      # +response+ may be nil in the case that the request produced an error
-      # without ever receiving an HTTP response.
-      def metrics_for( request, response )
-        metrics = common_metrics( request )
-
-        if response && response_is_crossapp?( response )
-          begin
-            metrics.concat metrics_for_crossapp_response( request, response )
-          rescue => err
-            # Fall back to regular metrics if there's a problem with x-process metrics
-            NewRelic::Agent.logger.debug "%p while fetching x-process metrics: %s" %
-              [ err.class, err.message ]
-            metrics.concat metrics_for_regular_request( request )
-          end
-        else
-          metrics.concat metrics_for_regular_request( request )
+        if synthetics_header
+          request[NR_SYNTHETICS_HEADER] = synthetics_header
         end
-
-        return metrics
       end
 
-
-      # Return an Array of metrics used for every response.
-      def common_metrics( request )
-        metrics = [ "External/all" ]
-        metrics << "External/#{request.host}/all"
-
-        if NewRelic::Agent::Transaction.recording_web_transaction?
-          metrics << "External/allWeb"
+      def response_has_crossapp_header?(response)
+        if !!response[NR_APPDATA_HEADER]
+          true
         else
-          metrics << "External/allOther"
-        end
-
-        return metrics
-      end
-
-
-      # Returns +true+ if Cross Application Tracing is enabled, and the given +response+
-      # has the appropriate headers.
-      def response_is_crossapp?( response )
-        return false unless cross_app_enabled?
-        unless response[NR_APPDATA_HEADER]
-          return false
+          NewRelic::Agent.logger.debug "No #{NR_APPDATA_HEADER} header"
+          false
         end
-
-        return true
       end
 
-
-      # Return the set of metric objects appropriate for the given cross app
-      # +response+.
-      def metrics_for_crossapp_response( request, response )
-        xp_id, txn_name, _q_time, _r_time, _req_len, _ = extract_appdata( response )
-
-        check_crossapp_id( xp_id )
-        check_transaction_name( txn_name )
-
-        metrics = []
-        metrics << "ExternalApp/#{request.host}/#{xp_id}/all"
-        metrics << "ExternalTransaction/#{request.host}/#{xp_id}/#{txn_name}"
-
-        return metrics
-      end
-
-
       # Extract x-process application data from the specified +response+ and return
       # it as an array of the form:
       #
@@ -286,54 +86,19 @@ module NewRelic
       #    <request content length in bytes>,
       #    <transaction GUID>
       #  ]
-      def extract_appdata( response )
-        appdata = response[NR_APPDATA_HEADER] or
-          raise NewRelic::Agent::CrossAppTracing::Error,
-            "Can't derive metrics for response: no #{NR_APPDATA_HEADER} header!"
-
-        decoded_appdata = obfuscator.deobfuscate( appdata )
-        decoded_appdata.set_encoding( ::Encoding::UTF_8 ) if
-          decoded_appdata.respond_to?( :set_encoding )
-
-        return NewRelic::JSONWrapper.load( decoded_appdata )
-      end
+      def extract_appdata(response)
+        appdata = response[NR_APPDATA_HEADER]
 
+        decoded_appdata = obfuscator.deobfuscate(appdata)
+        decoded_appdata.set_encoding(::Encoding::UTF_8) if
+          decoded_appdata.respond_to?(:set_encoding)
 
-      # Return the set of metric objects appropriate for the given (non-cross app)
-      # +request+.
-      def metrics_for_regular_request( request )
-        metrics = []
-        metrics << "External/#{request.host}/#{request.type}/#{request.method}"
-
-        return metrics
-      end
-
-
-      # Fetch a reference to the stats engine.
-      def stats_engine
-        NewRelic::Agent.instance.stats_engine
-      end
-
-      def transaction_sampler
-        NewRelic::Agent.instance.transaction_sampler
+        NewRelic::JSONWrapper.load(decoded_appdata)
       end
 
-      # Check the given +id+ to ensure it conforms to the format of a cross-application
-      # ID. Raises an NewRelic::Agent::CrossAppTracing::Error if it doesn't.
-      def check_crossapp_id( id )
-        id =~ /\A\d+#\d+\z/ or
-          raise NewRelic::Agent::CrossAppTracing::Error,
-            "malformed cross application ID %p" % [ id ]
+      def valid_cross_app_id?(xp_id)
+        !!(xp_id =~ /\A\d+#\d+\z/)
       end
-
-
-      # Check the given +name+ to ensure it conforms to the format of a valid transaction
-      # name.
-      def check_transaction_name( name )
-        # No-op -- apparently absolutely anything is a valid transaction name?
-        # This is here for when that inevitably comes back to haunt us.
-      end
-
     end
   end
 end