newrelic_rpm 4.5.0.337 → 4.6.0.338

data/lib/new_relic/agent/external.rb

@@ -0,0 +1,137 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+require 'new_relic/agent/transaction/tracing'
+require 'new_relic/agent/cross_app_tracing'
+
+module NewRelic
+  module Agent
+    module External
+      extend self
+
+      # This method creates and starts an external request segment using the
+      # given library, URI, and procedure. This is used to time external calls
+      # made over HTTP.
+      #
+      # @param [String] library a string of the class name of the library used to
+      # make the external call, for example, 'Net::HTTP'.
+      #
+      # @param [String, URI] uri indicates the URI to which the
+      # external request is being made. The URI should begin with the protocol,
+      # for example, 'https://github.com'.
+      #
+      # @param [String] procedure the HTTP method being used for the external
+      # request as a string, for example, 'GET'.
+      #
+      # @api public
+      def start_segment(library: nil, uri: nil, procedure: nil)
+        raise ArgumentError, 'Argument `library` is required' if library.nil?
+        raise ArgumentError, 'Argument `uri` is required' if uri.nil?
+        raise ArgumentError, 'Argument `procedure` is required' if procedure.nil?
+
+        ::NewRelic::Agent.record_api_supportability_metric(:start_segment)
+
+        ::NewRelic::Agent::Transaction.start_external_request_segment(library, uri, procedure)
+      end
+
+      NON_HTTP_CAT_ID_HEADER  = 'NewRelicID'.freeze
+      NON_HTTP_CAT_TXN_HEADER = 'NewRelicTransaction'.freeze
+      NON_HTTP_CAT_SYNTHETICS_HEADER = 'NewRelicSynthetics'.freeze
+
+      # Process obfuscated +String+ indentifying a calling application and transaction that is also running a
+      # New Relic agent and save information in current transaction for inclusion in a trace. The +String+ is
+      # generated by +get_request_metadata+ on the calling application.
+      #
+      # @param request_metadata [String] received obfuscated request metadata
+      #
+      # @api public
+      #
+      def process_request_metadata request_metadata
+        NewRelic::Agent.record_api_supportability_metric(:process_request_metadata)
+        return unless CrossAppTracing.cross_app_enabled?
+
+        state = NewRelic::Agent::TransactionState.tl_get
+        if transaction = state.current_transaction
+          rmd = ::JSON.parse obfuscator.deobfuscate(request_metadata)
+
+          # handle/check ID
+          #
+          if id = rmd[NON_HTTP_CAT_ID_HEADER] and CrossAppTracing.trusted_valid_cross_app_id?(id)
+            state.client_cross_app_id = id
+
+            # handle transaction info
+            #
+            if txn_info = rmd[NON_HTTP_CAT_TXN_HEADER]
+              state.referring_transaction_info = txn_info
+              CrossAppTracing.assign_intrinsic_transaction_attributes state
+            end
+
+            # handle synthetics
+            #
+            if synth = rmd[NON_HTTP_CAT_SYNTHETICS_HEADER]
+              transaction.synthetics_payload = synth
+              transaction.raw_synthetics_header = obfuscator.obfuscate ::JSON.dump(synth)
+            end
+
+          else
+            NewRelic::Agent.logger.error "error processing request metadata: invalid/non-trusted ID: '#{id}'"
+          end
+
+          nil
+        end
+      rescue => e
+        NewRelic::Agent.logger.error 'error during process_request_metadata', e
+      end
+
+      # Obtain an obfuscated +String+ suitable for delivery across public networks that carries transaction
+      # information from this application to a calling application which is also running a New Relic agent.
+      # This +String+ can be processed by +process_response_metadata+ on the calling application.
+      #
+      # @return [String] obfuscated response metadata to send
+      #
+      # @api public
+      #
+      def get_response_metadata
+        NewRelic::Agent.record_api_supportability_metric(:get_response_metadata)
+        return unless CrossAppTracing.cross_app_enabled?
+
+        state = NewRelic::Agent::TransactionState.tl_get
+        if transaction = state.current_transaction and state.client_cross_app_id
+
+          # must freeze the name since we're responding with it
+          #
+          transaction.freeze_name_and_execute_if_not_ignored do
+
+            # build response payload
+            #
+            rmd = {
+              NewRelicAppData: [
+                NewRelic::Agent.config[:cross_process_id],
+                state.timings.transaction_name,
+                state.timings.queue_time_in_seconds.to_f,
+                state.timings.app_time_in_seconds.to_f,
+                -1, # per non-HTTP CAT spec
+                state.request_guid
+              ]
+            }
+
+            # obfuscate the generated response metadata JSON
+            #
+            obfuscator.obfuscate ::JSON.dump(rmd)
+
+          end
+        end
+      rescue => e
+        NewRelic::Agent.logger.error "error during get_response_metadata", e
+      end
+
+      private
+
+      def obfuscator
+        CrossAppTracing.obfuscator
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+module NewRelic
+  module Agent
+    module HTTPClients
+
+      # This class provides a public interface for wrapping HTTP requests. This
+      # may be used to create wrappers that are compatible with New Relic's
+      # external request API.
+      #
+      # @api public
+      class AbstractRequest
+        ERROR_MESSAGE = 'Subclasses of NewRelic::Agent::HTTPClients::AbstractRequest must implement a '.freeze
+
+        def []
+          raise NotImplementedError, ERROR_MESSAGE + ':[] method'
+        end
+
+        def []=
+          raise NotImplementedError, ERROR_MESSAGE + ':[]= method'
+        end
+
+        def host_from_header
+          raise NotImplementedError, ERROR_MESSAGE + ':host_from_header method'
+        end
+      end
+    end
+  end
+end

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

@@ -2,6 +2,8 @@
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
 
+require 'new_relic/agent/http_clients/abstract_request'
+
 module NewRelic
   module Agent
     module HTTPClients
@@ -45,7 +47,7 @@ module NewRelic
       end
 
 
-      class CurbResponse
+      class CurbResponse < AbstractRequest
 
         def initialize(curlobj)
           @headers = {}

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

@@ -2,6 +2,8 @@
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
 
+require 'new_relic/agent/http_clients/abstract_request'
+
 module NewRelic
   module Agent
     module HTTPClients
@@ -26,7 +28,7 @@ module NewRelic
         end
       end
 
-      class ExconHTTPRequest
+      class ExconHTTPRequest < AbstractRequest
         attr_reader :method
 
         EXCON = "Excon".freeze

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

@@ -2,6 +2,8 @@
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
 
+require 'new_relic/agent/http_clients/abstract_request'
+
 module NewRelic
   module Agent
     module HTTPClients
@@ -22,7 +24,7 @@ module NewRelic
         end
       end
 
-      class HTTPRequest
+      class HTTPRequest < AbstractRequest
         HTTP_RB = 'http.rb'.freeze
         HOST    = 'host'.freeze
         COLON   = ':'.freeze

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

@@ -2,6 +2,8 @@
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
 
+require 'new_relic/agent/http_clients/abstract_request'
+
 module NewRelic
   module Agent
     module HTTPClients
@@ -26,7 +28,7 @@ module NewRelic
         end
       end
 
-      class HTTPClientRequest
+      class HTTPClientRequest < AbstractRequest
         attr_reader :request, :uri
 
         HTTP_CLIENT = "HTTPClient".freeze

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

@@ -2,10 +2,12 @@
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
 
+require 'new_relic/agent/http_clients/abstract_request'
+
 module NewRelic
   module Agent
     module HTTPClients
-      class NetHTTPRequest
+      class NetHTTPRequest < AbstractRequest
         def initialize(connection, request)
           @connection = connection
           @request = request

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

@@ -2,6 +2,8 @@
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
 
+require 'new_relic/agent/http_clients/abstract_request'
+
 module NewRelic
   module Agent
     module HTTPClients
@@ -35,7 +37,7 @@ module NewRelic
         end
       end
 
-      class TyphoeusHTTPRequest
+      class TyphoeusHTTPRequest < AbstractRequest
         def initialize(request)
           @request = request
           @uri = case request.url

data/lib/new_relic/agent/sql_sampler.rb

@@ -51,8 +51,8 @@ module NewRelic
 
         state.sql_sampler_transaction_data = TransactionSqlData.new
 
-        if state.transaction_sample_builder
-          guid = state.transaction_sample_builder.sample.guid
+        if state.current_transaction
+          guid = state.current_transaction.guid
         end
 
         if Agent.config[:'slow_sql.enabled'] && state.sql_sampler_transaction_data

data/lib/new_relic/agent/throughput_monitor.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+module NewRelic
+  module Agent
+    class ThroughputMonitor
+
+      def initialize target_samples = 10
+        @target = target_samples
+        @seen = 0
+        @seen_last = 0
+        @sampled_count = 0
+        @first_cycle = true
+        @lock = Mutex.new
+      end
+
+      # Called at the beginning of each transaction, increments seen and
+      # returns a boolean indicating if we should mark the transaction as
+      # sampled. This uses the adaptive sampling algorithm.
+      def sampled?
+        @lock.synchronize do
+          sampled = if @first_cycle
+            @sampled_count < 10
+          elsif @sampled_count < @target
+            rand(@seen_last) < @target
+          else
+            rand(@seen) < (@target ** (@target / @sampled_count) - @target ** 0.51)
+          end
+
+          @sampled_count += 1 if sampled
+          @seen += 1
+
+          sampled
+        end
+      end
+
+      def reset!
+        @lock.synchronize do
+          @first_cycle = false
+          @seen_last = @seen
+          @seen = 0
+          @sampled_count = 0
+        end
+      end
+
+      def stats
+        @lock.synchronize do
+          {
+            target: @target,
+            seen: @seen,
+            seen_last: @seen_last,
+            sampled_count: @sampled_count
+          }
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/transaction.rb

@@ -9,6 +9,7 @@ require 'new_relic/agent/method_tracer_helpers'
 require 'new_relic/agent/transaction/attributes'
 require 'new_relic/agent/transaction/request_attributes'
 require 'new_relic/agent/transaction/tracing'
+require 'new_relic/agent/transaction/distributed_tracing'
 require 'new_relic/agent/cross_app_tracing'
 
 module NewRelic
@@ -19,6 +20,7 @@ module NewRelic
     # @api public
     class Transaction
       include Tracing
+      include DistributedTracing
 
       # for nested transactions
       SUBTRANSACTION_PREFIX        = 'Nested/'.freeze
@@ -55,7 +57,8 @@ module NewRelic
                     :process_cpu_start,
                     :http_response_code,
                     :response_content_length,
-                    :response_content_type
+                    :response_content_type,
+                    :sampled
 
       attr_reader :guid,
                   :metrics,
@@ -66,7 +69,8 @@ module NewRelic
                   :attributes,
                   :payload,
                   :nesting_max_depth,
-                  :segments
+                  :segments,
+                  :end_time
 
       # Populated with the trace sample once this transaction is completed.
       attr_reader :transaction_trace
@@ -261,6 +265,7 @@ module NewRelic
 
         @category = category
         @start_time = Time.now
+        @end_time = nil
         @apdex_start = options[:apdex_start_time] || @start_time
         @jruby_cpu_start = jruby_cpu_time
         @process_cpu_start = process_cpu
@@ -277,6 +282,12 @@ module NewRelic
         @ignore_enduser = options.fetch(:ignore_enduser, false)
         @ignore_trace = false
 
+        if Agent.config[:'distributed_tracing.enabled']
+          @sampled = NewRelic::Agent.instance.throughput_monitor.sampled?
+        else
+          @sampled = nil
+        end
+
         @attributes = Attributes.new(NewRelic::Agent.instance.attribute_filter)
 
         merge_request_parameters(@filtered_params)
@@ -288,6 +299,10 @@ module NewRelic
         end
       end
 
+      def sampled?
+        @sampled
+      end
+
       def referer
         @request_attributes && @request_attributes.referer
       end
@@ -370,6 +385,16 @@ module NewRelic
           @default_name || NewRelic::Agent::UNKNOWN_METRIC
       end
 
+      # For common interface with Trace
+      alias_method :transaction_name, :best_name
+
+      attr_accessor :xray_session_id
+
+      def duration
+        (@end_time - @start_time).to_f
+      end
+      # End common interface
+
       def name_set?
         (@overridden_name || @default_name) ? true : false
       end
@@ -408,7 +433,6 @@ module NewRelic
       def start(state)
         return if !state.is_execution_traced?
 
-        transaction_sampler.on_start_transaction(state, start_time)
         sql_sampler.on_start_transaction(state, start_time, request_path)
         NewRelic::Agent.instance.events.notify(:start_transaction)
         NewRelic::Agent::BusyCalculator.dispatcher_start(start_time)
@@ -492,6 +516,8 @@ module NewRelic
 
       def stop(state, end_time, outermost_frame)
         return if !state.is_execution_traced?
+
+        @end_time = end_time
         freeze_name_and_execute_if_not_ignored
 
         if nesting_max_depth == 1
@@ -515,20 +541,21 @@ module NewRelic
       end
 
       def commit!(state, end_time, outermost_node_name)
+        generate_payload(state, start_time, end_time)
+
         assign_agent_attributes
         assign_intrinsics(state)
 
+        segments.each { |s| s.finalize }
+
         @transaction_trace = transaction_sampler.on_finishing_transaction(state, self, end_time)
         sql_sampler.on_finishing_transaction(state, @frozen_name)
 
-        segments.each { |s| s.record_metrics if s.record_metrics? }
         record_summary_metrics(outermost_node_name, end_time)
         record_apdex(state, end_time) unless ignore_apdex?
         record_queue_time
         record_client_application_metric state
 
-        generate_payload(state, start_time, end_time)
-
         record_exceptions
         record_transaction_event
         merge_metrics
@@ -563,6 +590,8 @@ module NewRelic
       end
 
       def assign_intrinsics(state)
+        attributes.add_intrinsic_attribute :'nr.sampled', sampled?
+
         if gc_time = calculate_gc_time
           attributes.add_intrinsic_attribute(:gc_time, gc_time)
         end
@@ -577,9 +606,11 @@ module NewRelic
           attributes.add_intrinsic_attribute(:synthetics_monitor_id, synthetics_monitor_id)
         end
 
-        if state.is_cross_app?
-          attributes.add_intrinsic_attribute(:trip_id, cat_trip_id(state))
-          attributes.add_intrinsic_attribute(:path_hash, cat_path_hash(state))
+        if distributed_trace_payload || order > 0
+          assign_distributed_tracing_intrinsics
+        elsif state.is_cross_app?
+          attributes.add_intrinsic_attribute(:trip_id, cat_trip_id)
+          attributes.add_intrinsic_attribute(:path_hash, cat_path_hash)
         end
       end
 
@@ -613,7 +644,11 @@ module NewRelic
           :attributes           => @attributes,
           :error                => false
         }
+
+        @payload[:'nr.sampled'] = sampled? if Agent.config[:'distributed_tracing.enabled']
+
         append_cat_info(state, duration, @payload)
+        append_distributed_tracing_info(@payload)
         append_apdex_perf_zone(duration, @payload)
         append_synthetics_to(state, @payload)
         append_referring_transaction_guid_to(state, @payload)
@@ -623,11 +658,11 @@ module NewRelic
         state.is_cross_app? || is_synthetics_request?
       end
 
-      def cat_trip_id(state)
+      def cat_trip_id
         NewRelic::Agent.instance.cross_app_monitor.client_referring_transaction_trip_id(state) || guid
       end
 
-      def cat_path_hash(state)
+      def cat_path_hash
         referring_path_hash = cat_referring_path_hash(state) || '0'
         seed = referring_path_hash.to_i(16)
         result = NewRelic::Agent.instance.cross_app_monitor.path_hash(best_name, seed)
@@ -702,8 +737,8 @@ module NewRelic
         payload[:guid] = guid
 
         return unless state.is_cross_app?
-        trip_id             = cat_trip_id(state)
-        path_hash           = cat_path_hash(state)
+        trip_id             = cat_trip_id
+        path_hash           = cat_path_hash
         referring_path_hash = cat_referring_path_hash(state)
 
         payload[:cat_trip_id]             = trip_id             if trip_id
@@ -847,6 +882,15 @@ module NewRelic
         Agent.config[key] && Agent.config[key][best_name]
       end
 
+      def threshold
+         source_class = Agent.config.source(:'transaction_tracer.transaction_threshold').class
+        if source_class == Configuration::DefaultSource
+          apdex_t * 4
+        else
+          Agent.config[:'transaction_tracer.transaction_threshold']
+        end
+      end
+
       def with_database_metric_name(model, method, product=nil)
         previous = self.instrumentation_state[:datastore_override]
         model_name = case model
@@ -925,8 +969,8 @@ module NewRelic
         state.is_cross_app_caller = true
         CrossAppTracing.insert_message_headers headers,
                                                guid,
-                                               cat_trip_id(state),
-                                               cat_path_hash(state),
+                                               cat_trip_id,
+                                               cat_path_hash,
                                                raw_synthetics_header
       end