newrelic_rpm 6.6.0.358 → 6.11.0.365

data/lib/new_relic/agent/transaction.rb

@@ -1,17 +1,18 @@
 # 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.
+# frozen_string_literal: true
 
 require 'new_relic/agent/instrumentation/queue_time'
 require 'new_relic/agent/transaction_metrics'
 require 'new_relic/agent/method_tracer_helpers'
-require 'new_relic/agent/transaction/attributes'
+require 'new_relic/agent/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'
+require 'new_relic/agent/transaction/distributed_tracer'
 require 'new_relic/agent/transaction_time_aggregator'
 require 'new_relic/agent/deprecator'
+require 'new_relic/agent/guid_generator'
 
 module NewRelic
   module Agent
@@ -21,26 +22,38 @@ module NewRelic
     # @api public
     class Transaction
       include Tracing
-      include DistributedTracing
-      include CrossAppTracing
 
       # for nested transactions
-      SUBTRANSACTION_PREFIX        = 'Nested/'.freeze
-      CONTROLLER_PREFIX            = 'Controller/'.freeze
-      MIDDLEWARE_PREFIX            = 'Middleware/Rack/'.freeze
-      TASK_PREFIX                  = 'OtherTransaction/Background/'.freeze
-      RAKE_PREFIX                  = 'OtherTransaction/Rake/'.freeze
-      MESSAGE_PREFIX               = 'OtherTransaction/Message/'.freeze
-      RACK_PREFIX                  = 'Controller/Rack/'.freeze
-      SINATRA_PREFIX               = 'Controller/Sinatra/'.freeze
-      GRAPE_PREFIX                 = 'Controller/Grape/'.freeze
-      ACTION_CABLE_PREFIX          = 'Controller/ActionCable/'.freeze
-      OTHER_TRANSACTION_PREFIX     = 'OtherTransaction/'.freeze
+      NESTED_TRANSACTION_PREFIX    = "Nested/"
+      CONTROLLER_PREFIX            = "Controller/"
+      MIDDLEWARE_PREFIX            = "Middleware/Rack/"
+      OTHER_TRANSACTION_PREFIX     = "OtherTransaction/"
+      TASK_PREFIX                  = "#{OTHER_TRANSACTION_PREFIX}Background/"
+      RAKE_PREFIX                  = "#{OTHER_TRANSACTION_PREFIX}Rake/"
+      MESSAGE_PREFIX               = "#{OTHER_TRANSACTION_PREFIX}Message/"
+      RACK_PREFIX                  = "#{CONTROLLER_PREFIX}Rack/"
+      SINATRA_PREFIX               = "#{CONTROLLER_PREFIX}Sinatra/"
+      GRAPE_PREFIX                 = "#{CONTROLLER_PREFIX}Grape/"
+      ACTION_CABLE_PREFIX          = "#{CONTROLLER_PREFIX}ActionCable/"
 
       WEB_TRANSACTION_CATEGORIES   = [:web, :controller, :uri, :rack, :sinatra, :grape, :middleware, :action_cable].freeze
       TRANSACTION_NAMING_SOURCES   = [:child, :api].freeze
 
-      MIDDLEWARE_SUMMARY_METRICS   = ['Middleware/all'.freeze].freeze
+      MIDDLEWARE_SUMMARY_METRICS   = ["Middleware/all"].freeze
+      WEB_SUMMARY_METRIC           = "HttpDispatcher"
+      OTHER_SUMMARY_METRIC         = "#{OTHER_TRANSACTION_PREFIX}all"
+      QUEUE_TIME_METRIC            = "WebFrontend/QueueTime"
+
+      APDEX_S                       = "S"
+      APDEX_T                       = "T"
+      APDEX_F                       = "F"
+      APDEX_ALL_METRIC              = "ApdexAll"
+      APDEX_METRIC                  = "Apdex"
+      APDEX_OTHER_METRIC            = "ApdexOther"
+      APDEX_TXN_METRIC_PREFIX       = "Apdex/"
+      APDEX_OTHER_TXN_METRIC_PREFIX = "ApdexOther/Transaction/"
+
+      JRUBY_CPU_TIME_ERROR = "Error calculating JRuby CPU Time"
 
       # reference to the transaction state managing this transaction
       attr_accessor :state
@@ -59,7 +72,8 @@ module NewRelic
                     :process_cpu_start,
                     :http_response_code,
                     :response_content_length,
-                    :response_content_type
+                    :response_content_type,
+                    :parent_span_id
 
       attr_reader :guid,
                   :metrics,
@@ -137,23 +151,22 @@ module NewRelic
 
       def self.nested_transaction_name(name)
         if name.start_with?(CONTROLLER_PREFIX) || name.start_with?(OTHER_TRANSACTION_PREFIX)
-          "#{SUBTRANSACTION_PREFIX}#{name}"
+          "#{NESTED_TRANSACTION_PREFIX}#{name}"
         else
           name
         end
       end
 
-      # Indicate that you don't want to keep the currently saved transaction
-      # information
-      def self.abort_transaction! #THREAD_LOCAL_ACCESS
-        txn = Tracer.current_transaction
-        txn.abort_transaction! if txn
+      # discards the currently saved transaction information
+      def self.abort_transaction!
+        if txn = Tracer.current_transaction
+          txn.abort_transaction!
+        end
       end
 
       # See NewRelic::Agent.notice_error for options and commentary
-      def self.notice_error(e, options={}) #THREAD_LOCAL_ACCESS
-        txn = Tracer.current_transaction
-        if txn
+      def self.notice_error(e, options={})
+        if txn = Tracer.current_transaction
           txn.notice_error(e, options)
         elsif NewRelic::Agent.instance
           NewRelic::Agent.instance.error_collector.notice_error(e, options)
@@ -242,7 +255,7 @@ module NewRelic
 
         @exceptions = {}
         @metrics = TransactionMetrics.new
-        @guid = generate_guid
+        @guid = NewRelic::Agent::GuidGenerator.generate_guid
 
         @ignore_this_transaction = false
         @ignore_apdex = options.fetch(:ignore_apdex, false)
@@ -265,6 +278,10 @@ module NewRelic
         end
       end
 
+      def distributed_tracer
+        @distributed_tracer ||= DistributedTracer.new(self)
+      end
+
       def sampled?
         return unless Agent.config[:'distributed_tracing.enabled']
         if @sampled.nil?
@@ -273,12 +290,16 @@ module NewRelic
         @sampled
       end
 
+      def trace_id
+        @trace_id ||= NewRelic::Agent::GuidGenerator.generate_guid 32
+      end
+
+      def trace_id=(value)
+        @trace_id = value
+      end
+
       def priority
-        if @priority.nil?
-          @priority = rand.round(6)
-          @priority += 1 if sampled?
-        end
-        @priority
+        @priority ||= (sampled? ? 1.0 + rand : rand).round(NewRelic::PRIORITY_PRECISION)
       end
 
       def referer
@@ -349,8 +370,10 @@ module NewRelic
       end
 
       def best_name
-        @frozen_name  || @overridden_name ||
-          @default_name || NewRelic::Agent::UNKNOWN_METRIC
+        @frozen_name ||
+        @overridden_name ||
+        @default_name ||
+        NewRelic::Agent::UNKNOWN_METRIC
       end
 
       # For common interface with Trace
@@ -437,9 +460,9 @@ module NewRelic
 
         nest_initial_segment if nesting_max_depth == 1
         nested_name = self.class.nested_transaction_name options[:transaction_name]
-        result = create_segment nested_name
+        segment = create_segment nested_name
         set_default_transaction_name(options[:transaction_name], category)
-        result
+        segment
       end
 
       def nest_initial_segment
@@ -453,9 +476,6 @@ module NewRelic
         @ignore_trace = true
       end
 
-      WEB_SUMMARY_METRIC   = 'HttpDispatcher'.freeze
-      OTHER_SUMMARY_METRIC = 'OtherTransaction/all'.freeze
-
       def summary_metrics
         if @frozen_name.start_with?(CONTROLLER_PREFIX)
           [WEB_SUMMARY_METRIC]
@@ -523,8 +543,7 @@ module NewRelic
         record_total_time_metrics
         record_apdex unless ignore_apdex?
         record_queue_time
-        record_cross_app_metrics
-        record_distributed_tracing_metrics
+        distributed_tracer.record_metrics
 
         record_exceptions
         record_transaction_event
@@ -576,11 +595,7 @@ module NewRelic
           attributes.add_intrinsic_attribute(:synthetics_monitor_id, synthetics_monitor_id)
         end
 
-        if Agent.config[:'distributed_tracing.enabled']
-          assign_distributed_trace_intrinsics
-        elsif is_cross_app?
-          assign_cross_app_intrinsics
-        end
+        distributed_tracer.assign_intrinsics
       end
 
       def calculate_gc_time
@@ -588,6 +603,16 @@ module NewRelic
         NewRelic::Agent::StatsEngine::GCProfiler.record_delta(gc_start_snapshot, gc_stop_snapshot)
       end
 
+      # This method returns transport_duration in seconds. Transport duration
+      # is stored in milliseconds on the payload, but it's needed in seconds
+      # for metrics and intrinsics.
+      def calculate_transport_duration distributed_trace_payload
+        return unless distributed_trace_payload
+
+        duration = (start_time.to_f * 1000 - distributed_trace_payload.timestamp) / 1000
+        duration < 0 ? 0 : duration
+      end
+
       # The summary metrics recorded by this method all end up with a duration
       # equal to the transaction itself, and an exclusive time of zero.
       def record_summary_metrics(outermost_node_name)
@@ -614,14 +639,13 @@ module NewRelic
           :priority             => priority
         }
 
-        append_cat_info(@payload)
-        append_distributed_trace_info(@payload)
+        distributed_tracer.append_payload(@payload)
         append_apdex_perf_zone(@payload)
         append_synthetics_to(@payload)
       end
 
       def include_guid?
-        is_cross_app? || is_synthetics_request?
+        distributed_tracer.is_cross_app? || is_synthetics_request?
       end
 
       def is_synthetics_request?
@@ -653,10 +677,6 @@ module NewRelic
         info[4]
       end
 
-      APDEX_S = 'S'.freeze
-      APDEX_T = 'T'.freeze
-      APDEX_F = 'F'.freeze
-
       def append_apdex_perf_zone(payload)
         if recording_web_transaction?
           bucket = apdex_bucket(duration, apdex_t)
@@ -695,13 +715,21 @@ module NewRelic
           options[:metric]     = best_name
           options[:attributes] = @attributes
 
-          error_recorded = !!agent.error_collector.notice_error(exception, options) || error_recorded
+          span_id = options.delete :span_id
+          error_recorded = !!agent.error_collector.notice_error(exception, options, span_id) || error_recorded
         end
         payload[:error] = error_recorded if payload
       end
 
       # Do not call this.  Invoke the class method instead.
       def notice_error(error, options={}) # :nodoc:
+
+        # Only the last error is kept
+        if @current_segment
+          @current_segment.notice_error error, expected: options[:expected]
+          options[:span_id] = @current_segment.guid
+        end
+
         if @exceptions[error]
           @exceptions[error].merge! options
         else
@@ -713,8 +741,6 @@ module NewRelic
         agent.transaction_event_recorder.record payload
       end
 
-      QUEUE_TIME_METRIC = 'WebFrontend/QueueTime'.freeze
-
       def queue_time
         @apdex_start ? @start_time - @apdex_start : 0
       end
@@ -730,17 +756,9 @@ module NewRelic
         end
       end
 
-      APDEX_ALL_METRIC   = 'ApdexAll'.freeze
-
-      APDEX_METRIC       = 'Apdex'.freeze
-      APDEX_OTHER_METRIC = 'ApdexOther'.freeze
-
-      APDEX_TXN_METRIC_PREFIX       = 'Apdex/'.freeze
-      APDEX_OTHER_TXN_METRIC_PREFIX = 'ApdexOther/Transaction/'.freeze
-
       def had_error_affecting_apdex?
         @exceptions.each do |exception, options|
-          ignored        = NewRelic::Agent.instance.error_collector.error_is_ignored?(exception)
+          ignored = NewRelic::Agent.instance.error_collector.error_is_ignored?(exception)
           expected = options[:expected]
 
           return true unless ignored || expected
@@ -879,7 +897,6 @@ module NewRelic
         p.stime + p.utime
       end
 
-      JRUBY_CPU_TIME_ERROR = "Error calculating JRuby CPU Time".freeze
       def jruby_cpu_time
         return nil unless @@java_classes_loaded
         threadMBean = Java::JavaLangManagement::ManagementFactory.getThreadMXBean()
@@ -905,18 +922,6 @@ module NewRelic
       def sql_sampler
         agent.sql_sampler
       end
-
-      HEX_DIGITS = (0..15).map{|i| i.to_s(16)}
-      GUID_LENGTH = 16
-
-      # generate a random 64 bit uuid
-      def generate_guid
-        guid = ''
-        GUID_LENGTH.times do |a|
-          guid << HEX_DIGITS[rand(16)]
-        end
-        guid
-      end
     end
   end
 end

data/lib/new_relic/agent/transaction/abstract_segment.rb

@@ -3,7 +3,7 @@
 # See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
 
 require 'new_relic/agent/range_extensions'
-require 'securerandom'
+require 'new_relic/agent/guid_generator'
 
 module NewRelic
   module Agent
@@ -23,11 +23,12 @@ module NewRelic
         attr_reader :start_time, :end_time, :duration, :exclusive_duration, :guid
         attr_accessor :name, :parent, :children_time, :transaction
         attr_writer :record_metrics, :record_scoped_metric, :record_on_finish
+        attr_reader :noticed_error
 
         def initialize name=nil, start_time=nil
           @name = name
           @transaction = nil
-          @guid = SecureRandom.hex(8)
+          @guid = NewRelic::Agent::GuidGenerator.generate_guid
           @parent = nil
           @params = nil
           @start_time = start_time if start_time
@@ -42,6 +43,7 @@ module NewRelic
           @record_metrics = true
           @record_scoped_metric = true
           @record_on_finish = false
+          @noticed_error = nil
         end
 
         def start
@@ -119,6 +121,30 @@ module NewRelic
         def transaction_assigned
         end
 
+        def set_noticed_error noticed_error
+          if @noticed_error
+            NewRelic::Agent.logger.debug \
+              "Segment: #{name} overwriting previously noticed " \
+              "error: #{@noticed_error.inspect} with: #{noticed_error.inspect}"
+          end
+          @noticed_error = noticed_error
+        end
+
+        def notice_error exception, options={}
+          if Agent.config[:high_security]
+            NewRelic::Agent.logger.debug \
+              "Segment: #{name} ignores notice_error for " \
+              "error: #{exception.inspect} because :high_security is enabled"
+          else
+            NewRelic::Agent.instance.error_collector.notice_segment_error self, exception, options
+          end
+        end
+
+        def noticed_error_attributes
+          return unless @noticed_error
+          @noticed_error.attributes_from_notice_error
+        end
+
         protected
 
         attr_writer :range_recorded

data/lib/new_relic/agent/transaction/distributed_tracer.rb

@@ -0,0 +1,171 @@
+# 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.
+# frozen_string_literal: true
+
+require 'new_relic/agent/transaction/trace_context'
+require 'new_relic/agent/transaction/distributed_tracing'
+require 'new_relic/agent/distributed_tracing/cross_app_tracing'
+
+module NewRelic
+  module Agent
+    class Transaction
+      class DistributedTracer
+        include NewRelic::Agent::CrossAppTracing
+        include DistributedTracing
+        include TraceContext
+
+        attr_reader :transaction
+        attr_accessor :parent_transaction_id
+
+        def parent_guid
+          if trace_context_header_data
+            trace_context_header_data.parent_id
+          elsif distributed_trace_payload
+            distributed_trace_payload.id
+          end
+        end
+
+        def accept_incoming_request request, transport_type=nil
+          accept_incoming_transport_type request, transport_type
+          if trace_parent_header_present? request
+            accept_trace_context_incoming_request request
+          else
+            accept_distributed_tracing_incoming_request request
+          end
+        end
+
+        def caller_transport_type
+          @caller_transport_type ||= "Unknown"
+        end
+
+        def accept_transport_type_from_api value
+          @caller_transport_type = DistributedTraceTransportType.from value
+        end
+
+        def accept_incoming_transport_type request, transport_type
+          if transport_type.to_s == NewRelic::EMPTY_STR
+            @caller_transport_type = DistributedTraceTransportType.for_rack_request request
+          else
+            @caller_transport_type = DistributedTraceTransportType.from transport_type
+          end
+        end
+
+        def initialize transaction
+          @transaction = transaction
+        end
+
+        def record_metrics
+          record_cross_app_metrics
+          DistributedTraceMetrics.record_metrics_for_transaction transaction
+        end
+
+        def append_payload payload
+          append_cat_info payload
+          DistributedTraceIntrinsics.copy_from_transaction \
+            transaction,
+            trace_state_payload || distributed_trace_payload,
+            payload
+        end
+
+        def insert_headers request
+          insert_trace_context_header request
+          insert_distributed_trace_header request
+          insert_cross_app_header request
+        end
+
+        def consume_message_headers headers, tracer_state, transport_type
+          consume_message_distributed_tracing_headers headers, transport_type
+          consume_message_cross_app_tracing_headers headers, tracer_state
+          consume_message_synthetics_headers headers
+        rescue => e
+          NewRelic::Agent.logger.error "Error in consume_message_headers", e
+        end
+
+        def assign_intrinsics
+          if Agent.config[:'distributed_tracing.enabled']
+            DistributedTraceIntrinsics.copy_to_attributes transaction.payload, transaction.attributes
+          elsif is_cross_app?
+            assign_cross_app_intrinsics
+          end
+        end
+
+        def insert_distributed_trace_header request
+          return unless Agent.config[:'distributed_tracing.enabled']
+          return if Agent.config[:'exclude_newrelic_header']
+          payload = create_distributed_trace_payload
+          request[NewRelic::NEWRELIC_KEY] = payload.http_safe if payload
+        end
+
+        def insert_cat_headers headers
+          return unless CrossAppTracing.cross_app_enabled?
+          @is_cross_app_caller = true
+          insert_message_headers headers,
+            transaction.guid,
+            cat_trip_id,
+            cat_path_hash,
+            transaction.raw_synthetics_header
+        end
+
+        private
+
+        def consume_message_synthetics_headers headers
+          synthetics_header = headers[CrossAppTracing::NR_MESSAGE_BROKER_SYNTHETICS_HEADER]
+          if synthetics_header and
+             incoming_payload = ::JSON.load(deobfuscate(synthetics_header)) and
+             SyntheticsMonitor.is_valid_payload?(incoming_payload) and
+             SyntheticsMonitor.is_supported_version?(incoming_payload) and
+             SyntheticsMonitor.is_trusted?(incoming_payload)
+
+            transaction.raw_synthetics_header = synthetics_header
+            transaction.synthetics_payload = incoming_payload
+          end
+        rescue => e
+          NewRelic::Agent.logger.error "Error in consume_message_synthetics_header", e
+        end
+
+        def consume_message_distributed_tracing_headers headers, transport_type
+          return unless Agent.config[:'distributed_tracing.enabled']
+
+          accept_incoming_transport_type headers, transport_type
+
+          newrelic_trace_key = NewRelic::CANDIDATE_NEWRELIC_KEYS.detect do |key|
+            headers.has_key?(key)
+          end
+          return unless newrelic_trace_key && (payload = headers[newrelic_trace_key])
+
+          accept_distributed_trace_payload payload
+        end
+
+        def consume_message_cross_app_tracing_headers headers, tracer_state
+          return unless CrossAppTracing.cross_app_enabled?
+          return unless CrossAppTracing.message_has_crossapp_request_header?(headers)
+
+          accept_cross_app_payload headers, tracer_state
+          CrossAppTracing.assign_intrinsic_transaction_attributes tracer_state
+        end
+
+        def accept_cross_app_payload headers, tracer_state
+          encoded_id = headers[CrossAppTracing::NR_MESSAGE_BROKER_ID_HEADER]
+          decoded_id = encoded_id.nil? ? EMPTY_STRING : deobfuscate(encoded_id)
+
+          return unless CrossAppTracing.trusted_valid_cross_app_id?(decoded_id)
+          txn_header = headers[CrossAppTracing::NR_MESSAGE_BROKER_TXN_HEADER]
+          txn_info   = ::JSON.load(deobfuscate(txn_header))
+          payload    = CrossAppPayload.new(decoded_id, transaction, txn_info)
+
+          @cross_app_payload = payload
+        rescue => e
+          NewRelic::Agent.logger.debug("Failure deserializing encoded header in #{self.class}, #{e.class}, #{e.message}")
+          nil
+        end
+
+        def deobfuscate message
+          CrossAppTracing.obfuscator.deobfuscate message
+        end
+
+      end
+    end
+  end
+end
+