newrelic_rpm 6.3.0.355 → 6.8.0.360

data/lib/new_relic/agent/trace_context_payload.rb

@@ -0,0 +1,134 @@
+# 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/distributed_trace_transport_type'
+require 'new_relic/coerce'
+
+module NewRelic
+  module Agent
+    class TraceContextPayload
+      VERSION = 0
+      PARENT_TYPE = 0
+      DELIMITER = "-".freeze
+      SUPPORTABILITY_PARSE_EXCEPTION = "Supportability/TraceContext/Parse/Exception".freeze
+
+      TRUE_CHAR = '1'.freeze
+      FALSE_CHAR = '0'.freeze
+
+      PARENT_TYPES = %w(App Browser Mobile).map(&:freeze).freeze
+
+      class << self
+        def create version: VERSION,
+                   parent_type: PARENT_TYPE,
+                   parent_account_id: nil,
+                   parent_app_id: nil,
+                   id: nil,
+                   transaction_id: nil,
+                   sampled: nil,
+                   priority: nil,
+                   timestamp: now_ms
+
+          new version, parent_type, parent_account_id, parent_app_id, id,
+              transaction_id, sampled, priority, timestamp
+        end
+
+        include NewRelic::Coerce
+
+        def from_s payload_string
+          attrs = payload_string.split(DELIMITER)
+
+          payload = create \
+            version: int!(attrs[0]),
+            parent_type: int!(attrs[1]),
+            parent_account_id: attrs[2],
+            parent_app_id: attrs[3],
+            id: value_or_nil(attrs[4]),
+            transaction_id: value_or_nil(attrs[5]),
+            sampled: value_or_nil(attrs[6]) ? boolean_int!(attrs[6]) == 1 : nil,
+            priority: float!(attrs[7]),
+            timestamp: int!(attrs[8])
+          handle_invalid_payload message: 'payload missing attributes' unless payload.valid?
+          payload
+        rescue => e
+          handle_invalid_payload error: e
+        end
+
+        private
+
+        def now_ms
+          (Time.now.to_f * 1000).round
+        end
+
+        def handle_invalid_payload error: nil, message: nil
+          NewRelic::Agent.increment_metric SUPPORTABILITY_PARSE_EXCEPTION
+          if error
+            NewRelic::Agent.logger.warn "Error parsing trace context payload", error
+          elsif message
+            NewRelic::Agent.logger.warn "Error parsing trace context payload: #{message}"
+          end
+        end
+      end
+
+      attr_accessor :version,
+                    :parent_type_id,
+                    :parent_account_id,
+                    :parent_app_id,
+                    :id,
+                    :transaction_id,
+                    :sampled,
+                    :priority,
+                    :timestamp
+
+      alias_method :sampled?, :sampled
+
+      def initialize version, parent_type_id, parent_account_id, parent_app_id,
+                     id, transaction_id, sampled, priority, timestamp
+        @version = version
+        @parent_type_id = parent_type_id
+        @parent_account_id = parent_account_id
+        @parent_app_id = parent_app_id
+        @id = id
+        @transaction_id = transaction_id
+        @sampled = sampled
+        @priority = priority
+        @timestamp = timestamp
+      end
+
+      attr_reader :caller_transport_type
+
+      def caller_transport_type= type
+        @caller_transport_type = DistributedTraceTransportType.from type
+      end
+
+      def parent_type
+        @parent_type_string ||= PARENT_TYPES[@parent_type_id]
+      end
+
+      def valid?
+        version \
+          && parent_type_id \
+          && !parent_account_id.empty? \
+          && !parent_app_id.empty? \
+          && timestamp
+      rescue
+        false
+      end
+
+      EMPTY = "".freeze
+
+      def to_s
+        result = version.to_s
+        result << DELIMITER << parent_type_id.to_s
+        result << DELIMITER << parent_account_id
+        result << DELIMITER << parent_app_id
+        result << DELIMITER << (id || EMPTY)
+        result << DELIMITER << (transaction_id || EMPTY)
+        result << DELIMITER << (sampled ? TRUE_CHAR : FALSE_CHAR)
+        result << DELIMITER << priority.to_s
+        result << DELIMITER << timestamp.to_s
+        result
+      end
+    end
+  end
+end

data/lib/new_relic/agent/trace_context_request_monitor.rb

@@ -0,0 +1,42 @@
+# 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/distributed_trace_transport_type'
+require 'new_relic/agent/inbound_request_monitor'
+require 'new_relic/agent/trace_context'
+
+module NewRelic
+  module Agent
+    class TraceContextRequestMonitor < InboundRequestMonitor
+      TRACEPARENT = 'HTTP_TRACEPARENT'.freeze
+
+      def on_finished_configuring(events)
+        return unless enabled?
+        events.subscribe(:before_call, &method(:on_before_call))
+      end
+
+      def on_before_call(request)
+        return unless enabled? && request[TRACEPARENT]
+        trace_context = TraceContext.parse(
+          format: TraceContext::FORMAT_RACK,
+          carrier: request,
+          trace_state_entry_key: TraceContext::AccountHelpers.trace_state_entry_key,
+        )
+        return if trace_context.nil?
+
+        return unless txn = Tracer.current_transaction
+
+        if txn.accept_trace_context trace_context
+          txn.trace_state_payload.caller_transport_type = DistributedTraceTransportType.for_rack_request(request)
+        end
+      end
+
+      W3C_FORMAT = "w3c".freeze
+
+      def enabled?
+        NewRelic::Agent.config[:'distributed_tracing.enabled'] && (NewRelic::Agent.config[:'distributed_tracing.format'] == W3C_FORMAT)
+      end
+    end
+  end
+end

data/lib/new_relic/agent/tracer.rb

@@ -39,6 +39,38 @@ module NewRelic
           state.current_transaction
         end
 
+        # Returns the trace_id of the current_transaction, or +nil+ if
+        # none exists.
+        #
+        # @api public
+        def current_trace_id
+          if txn = current_transaction
+            txn.trace_id
+          end
+        end
+        alias_method :trace_id, :current_trace_id
+
+        # Returns the id of the current span, or +nil+ if none exists.
+        #
+        # @api public
+        def current_span_id
+          if span = current_segment
+            span.guid
+          end
+        end
+        alias_method :span_id, :current_span_id
+
+        # Returns a boolean indicating whether the current_transaction
+        # is sampled, or +nil+ if there is no current transaction.
+        #
+        # @api public
+        def transaction_sampled?
+          if txn = current_transaction
+            txn.sampled?
+          end
+        end
+        alias_method :sampled?, :transaction_sampled?
+
         # Runs the given block of code in a transaction.
         #
         # @param [String] name reserved for New Relic internal use

data/lib/new_relic/agent/transaction.rb

@@ -5,13 +5,15 @@
 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/trace_context'
 require 'new_relic/agent/transaction/distributed_tracing'
 require 'new_relic/agent/cross_app_tracing'
 require 'new_relic/agent/transaction_time_aggregator'
 require 'new_relic/agent/deprecator'
+require 'new_relic/agent/guid_generator'
 
 module NewRelic
   module Agent
@@ -21,6 +23,7 @@ module NewRelic
     # @api public
     class Transaction
       include Tracing
+      include TraceContext
       include DistributedTracing
       include CrossAppTracing
 
@@ -70,7 +73,9 @@ module NewRelic
                   :nesting_max_depth,
                   :segments,
                   :end_time,
-                  :duration
+                  :duration,
+                  :parent_transaction_id,
+                  :parent_span_id
 
       attr_writer :sampled,
                   :priority
@@ -242,7 +247,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)
@@ -273,6 +278,10 @@ module NewRelic
         @sampled
       end
 
+      def trace_id
+        @trace_id ||= NewRelic::Agent::GuidGenerator.generate_guid 32
+      end
+
       def priority
         if @priority.nil?
           @priority = rand.round(6)
@@ -355,8 +364,6 @@ module NewRelic
 
       # For common interface with Trace
       alias_method :transaction_name, :best_name
-
-      attr_accessor :xray_session_id
       # End common interface
 
       def promoted_transaction_name(name)
@@ -526,7 +533,7 @@ module NewRelic
         record_apdex unless ignore_apdex?
         record_queue_time
         record_cross_app_metrics
-        record_distributed_tracing_metrics
+        DistributedTraceMetrics.record_metrics_for_transaction self
 
         record_exceptions
         record_transaction_event
@@ -578,8 +585,8 @@ module NewRelic
           attributes.add_intrinsic_attribute(:synthetics_monitor_id, synthetics_monitor_id)
         end
 
-        if Agent.config[:'distributed_tracing.enabled']
-          assign_distributed_trace_intrinsics
+        if Agent.config[:'distributed_tracing.enabled'] || trace_context_enabled?
+          DistributedTraceIntrinsics.copy_to_attributes @payload, attributes
         elsif is_cross_app?
           assign_cross_app_intrinsics
         end
@@ -590,6 +597,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)
@@ -618,6 +635,7 @@ module NewRelic
 
         append_cat_info(@payload)
         append_distributed_trace_info(@payload)
+        append_trace_context_info(@payload)
         append_apdex_perf_zone(@payload)
         append_synthetics_to(@payload)
       end
@@ -907,18 +925,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
@@ -27,7 +27,7 @@ module NewRelic
         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

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

@@ -3,6 +3,8 @@
 # See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
 
 require 'new_relic/agent/distributed_trace_payload'
+require 'new_relic/agent/distributed_trace_intrinsics'
+require 'new_relic/agent/distributed_trace_metrics'
 
 module NewRelic
   module Agent
@@ -10,15 +12,14 @@ module NewRelic
       module DistributedTracing
         attr_accessor :distributed_trace_payload
 
-        def distributed_trace?
-          !!distributed_trace_payload
-        end
-
         SUPPORTABILITY_CREATE_PAYLOAD_SUCCESS   = "Supportability/DistributedTrace/CreatePayload/Success".freeze
         SUPPORTABILITY_CREATE_PAYLOAD_EXCEPTION = "Supportability/DistributedTrace/CreatePayload/Exception".freeze
 
         def create_distributed_trace_payload
-          return unless Agent.config[:'distributed_tracing.enabled']
+          unless Agent.config[:'distributed_tracing.enabled'] && (Agent.config[:'distributed_tracing.format'] == NR_FORMAT)
+            NewRelic::Agent.logger.warn "Not configured to create New Relic distributed trace payload"
+            return
+          end
           self.distributed_trace_payload_created = true
           payload = DistributedTracePayload.for_transaction self
           NewRelic::Agent.increment_metric SUPPORTABILITY_CREATE_PAYLOAD_SUCCESS
@@ -33,7 +34,10 @@ module NewRelic
         SUPPORTABILITY_ACCEPT_PAYLOAD_EXCEPTION = "Supportability/DistributedTrace/AcceptPayload/Exception".freeze
 
         def accept_distributed_trace_payload payload
-          return unless Agent.config[:'distributed_tracing.enabled']
+          unless Agent.config[:'distributed_tracing.enabled'] && (Agent.config[:'distributed_tracing.format'] == NR_FORMAT)
+            NewRelic::Agent.logger.warn "Not configured to accept New Relic distributed trace payload"
+            return
+          end
           return false if check_payload_ignored(payload)
           return false unless check_payload_present(payload)
           return false unless payload = decode_payload(payload)
@@ -51,21 +55,6 @@ module NewRelic
           false
         end
 
-        def trace_id
-          if distributed_trace_payload
-            distributed_trace_payload.trace_id
-          else
-            guid
-          end
-        end
-
-        def parent_id
-          # The payload comes from our parent transaction, so its ID
-          # is our parent ID.
-          #
-          distributed_trace_payload && distributed_trace_payload.transaction_id
-        end
-
         def distributed_trace_payload_created?
           @distributed_trace_payload_created ||=  false
         end
@@ -74,29 +63,16 @@ module NewRelic
 
         def append_distributed_trace_info transaction_payload
           return unless Agent.config[:'distributed_tracing.enabled']
-          if distributed_trace_payload
-            distributed_trace_payload.assign_intrinsics self, transaction_payload
-          else
-            DistributedTracePayload.assign_initial_intrinsics self, transaction_payload
-          end
+          DistributedTraceIntrinsics.copy_from_transaction \
+            self,
+            distributed_trace_payload,
+            transaction_payload
         end
 
-        def assign_distributed_trace_intrinsics
-          return unless Agent.config[:'distributed_tracing.enabled']
-          DistributedTracePayload::INTRINSIC_KEYS.each do |key|
-            next unless @payload.key? key
-            attributes.add_intrinsic_attribute key, @payload[key]
-          end
-          nil
-        end
+        NR_FORMAT = "newrelic".freeze
 
-        # 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 transport_duration
-          return unless distributed_trace_payload
-          duration = (start_time.to_f * 1000 - distributed_trace_payload.timestamp) / 1000
-          duration < 0 ? 0 : duration
+        def nr_distributed_tracing_enabled?
+          Agent.config[:'distributed_tracing.enabled'] && (Agent.config[:'distributed_tracing.format'] == NR_FORMAT) && Agent.instance.connected?
         end
 
         private
@@ -189,72 +165,15 @@ module NewRelic
 
         def assign_payload_and_sampling_params(payload)
           self.distributed_trace_payload = payload
+          @trace_id = payload.trace_id
+          @parent_transaction_id = payload.transaction_id
+          @parent_span_id = payload.id
 
           unless payload.sampled.nil?
             self.sampled = payload.sampled
             self.priority = payload.priority if payload.priority
           end
         end
-
-        ALL_SUFFIX = "all".freeze
-        ALL_WEB_SUFFIX = "allWeb".freeze
-        ALL_OTHER_SUFFIX = "allOther".freeze
-
-        def transaction_type_suffix
-          if Transaction.recording_web_transaction?
-            ALL_WEB_SUFFIX
-          else
-            ALL_OTHER_SUFFIX
-          end
-        end
-
-        def record_distributed_tracing_metrics
-          return unless Agent.config[:'distributed_tracing.enabled']
-
-          record_caller_by_duration_metrics
-          record_transport_duration_metrics
-          record_errors_by_caller_metrics
-        end
-
-        DURATION_BY_CALLER_UNKOWN_PREFIX = "DurationByCaller/Unknown/Unknown/Unknown/Unknown".freeze
-
-        def record_caller_by_duration_metrics
-          prefix = if distributed_trace?
-            payload = distributed_trace_payload
-            "DurationByCaller/#{payload.parent_type}/#{payload.parent_account_id}/#{payload.parent_app_id}/#{payload.caller_transport_type}"
-          else
-            DURATION_BY_CALLER_UNKOWN_PREFIX
-          end
-
-          metrics.record_unscoped "#{prefix}/#{ALL_SUFFIX}",              duration
-          metrics.record_unscoped "#{prefix}/#{transaction_type_suffix}", duration
-        end
-
-        def record_transport_duration_metrics
-          return unless distributed_trace?
-
-          payload = distributed_trace_payload
-          prefix = "TransportDuration/#{payload.parent_type}/#{payload.parent_account_id}/#{payload.parent_app_id}/#{payload.caller_transport_type}"
-
-          metrics.record_unscoped "#{prefix}/#{ALL_SUFFIX}",              transport_duration
-          metrics.record_unscoped "#{prefix}/#{transaction_type_suffix}", transport_duration
-        end
-
-        ERRORS_BY_CALLER_UNKOWN_PREFIX = "ErrorsByCaller/Unknown/Unknown/Unknown/Unknown".freeze
-
-        def record_errors_by_caller_metrics
-          return unless exceptions.size > 0
-
-          prefix = if distributed_trace?
-            payload = distributed_trace_payload
-            "ErrorsByCaller/#{payload.parent_type}/#{payload.parent_account_id}/#{payload.parent_app_id}/#{payload.caller_transport_type}"
-          else
-            ERRORS_BY_CALLER_UNKOWN_PREFIX
-          end
-
-          metrics.record_unscoped "#{prefix}/#{ALL_SUFFIX}",              1
-          metrics.record_unscoped "#{prefix}/#{transaction_type_suffix}", 1
-        end
       end
     end
   end