newrelic_rpm 4.0.0.332 → 6.13.1

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

@@ -1,6 +1,6 @@
 # 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.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/agent/http_clients/uri_util'
 
@@ -12,8 +12,6 @@ module NewRelic
                     :host, :port, :user_agent, :request_method
 
         HTTP_ACCEPT_HEADER_KEY = "HTTP_ACCEPT".freeze
-        REQUEST_URI_KEY = "request_uri".freeze
-        WILDCARD = "*".freeze
 
         def initialize request
           @request_path = path_from_request request
@@ -36,12 +34,11 @@ module NewRelic
             txn.add_agent_attribute :'request.headers.referer', referer, AttributeFilter::DST_ERROR_COLLECTOR
           end
 
-          # This is temporary and aims to avoid collecting this attribute on transaction and error traces, 
-          # which already directly have a path value that the RPM UI depends on. We will either only
-          # collect request_uri as an agent attribute, in conjunction with UI work, or we will stop collecting
-          # this as an agent attribute (RUBY-1573)
-          if request_path && configured_to_collect?
-            txn.add_agent_attribute :request_uri, request_path, AttributeFilter::DST_TRANSACTION_EVENTS
+          if request_path
+            txn.add_agent_attribute :'request.uri',
+                                    request_path,
+                                    AttributeFilter::DST_TRANSACTION_TRACER |
+                                    AttributeFilter::DST_ERROR_COLLECTOR
           end
 
           if accept
@@ -119,11 +116,6 @@ module NewRelic
             env[key]
           end
         end
-
-        def configured_to_collect?
-          txn_event_attributes = NewRelic::Agent.config[:'transaction_events.attributes.include']
-          txn_event_attributes.any?{|attribute| attribute == REQUEST_URI_KEY || attribute == WILDCARD}
-        end
       end
     end
   end

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

@@ -1,8 +1,10 @@
 # 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.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/agent/transaction/abstract_segment'
+require 'new_relic/agent/span_event_primitive'
+require 'new_relic/agent/attributes'
 
 module NewRelic
   module Agent
@@ -11,19 +13,79 @@ module NewRelic
         # unscoped_metrics can be nil, a string, or array. we do this to save
         # object allocations. if allocations weren't important then we would
         # initialize it as an array that would be empty, have one item, or many items.
-        attr_reader :unscoped_metrics
+        attr_reader :unscoped_metrics, :custom_transaction_attributes
 
-        def initialize name = nil, unscoped_metrics=nil
+        def initialize name=nil, unscoped_metrics=nil, start_time=nil
           @unscoped_metrics = unscoped_metrics
-          super name
+          super name, start_time
         end
 
+        def attributes
+          @attributes ||= Attributes.new(NewRelic::Agent.instance.attribute_filter)
+        end
+
+        def add_agent_attribute(key, value, default_destinations=AttributeFilter::DST_SPAN_EVENTS)
+          attributes.add_agent_attribute(key, value, default_destinations)
+        end
+
+        def self.merge_untrusted_agent_attributes(attributes, prefix, default_destinations)
+          if segment = NewRelic::Agent::Tracer.current_segment
+            segment.merge_untrusted_agent_attributes(attributes, prefix, default_destinations)
+          else
+            NewRelic::Agent.logger.debug "Attempted to merge untrusted attributes without segment"
+          end
+        end
+
+        def merge_untrusted_agent_attributes(agent_attributes, prefix, default_destinations)
+          return if agent_attributes.nil?
+          attributes.merge_untrusted_agent_attributes(agent_attributes, prefix, default_destinations)
+        end
+
+        def add_custom_attributes(p)
+          attributes.merge_custom_attributes(p)
+        end
+
+        private
+
         def record_metrics
-          metric_cache.record_scoped_and_unscoped name, duration, exclusive_duration
+          if record_scoped_metric?
+            metric_cache.record_scoped_and_unscoped name, duration, exclusive_duration
+          else
+            append_unscoped_metric name
+          end
           if unscoped_metrics
             metric_cache.record_unscoped unscoped_metrics, duration, exclusive_duration
           end
         end
+
+        def append_unscoped_metric metric
+          if @unscoped_metrics
+            if Array === @unscoped_metrics
+              if unscoped_metrics.frozen?
+                @unscoped_metrics += [name]
+              else
+                @unscoped_metrics << name
+              end
+            else
+              @unscoped_metrics = [@unscoped_metrics, metric]
+            end
+          else
+            @unscoped_metrics = metric
+          end
+        end
+
+        def segment_complete
+          record_span_event if transaction.sampled?
+        end
+
+        def record_span_event
+          aggregator = ::NewRelic::Agent.agent.span_event_aggregator
+          priority   = transaction.priority
+
+          aggregator.record(priority: priority) do
+            SpanEventPrimitive.for_segment(self)
+          end
+        end
       end
     end
   end

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

@@ -1,6 +1,6 @@
 # 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.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/agent/transaction/transaction_sample_buffer'
 

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

@@ -1,6 +1,6 @@
 # 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.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/agent/transaction/transaction_sample_buffer'
 

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

@@ -1,6 +1,6 @@
 # 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.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/agent/transaction/trace_node'
 
@@ -11,14 +11,15 @@ module NewRelic
         class FinishedTraceError < StandardError; end
 
         attr_reader :start_time, :root_node
-        attr_accessor :transaction_name, :uri, :guid, :xray_session_id,
-                      :attributes, :node_count, :finished, :threshold,
-                      :profile
+        attr_accessor :transaction_name, :guid, :attributes,
+                      :node_count, :finished, :threshold, :profile
+
+        ROOT = "ROOT".freeze
 
         def initialize(start_time)
           @start_time = start_time
           @node_count = 0
-          @root_node = NewRelic::Agent::Transaction::TraceNode.new(0.0, "ROOT")
+          @root_node = NewRelic::Agent::Transaction::TraceNode.new(ROOT, 0.0, nil, nil, nil)
           @prepared = false
         end
 
@@ -27,18 +28,18 @@ module NewRelic
         end
 
         def count_nodes
-          self.node_count
+          node_count = 0
+          each_node do |node|
+            next if node == root_node
+            node_count +=1
+          end
+          node_count
         end
 
         def duration
           self.root_node.duration
         end
 
-        def forced?
-          return true if NewRelic::Coerce.int_or_nil(xray_session_id)
-          false
-        end
-
         def synthetics_resource_id
           intrinsic_attributes = attributes.intrinsic_attributes_for(NewRelic::Agent::AttributeFilter::DST_TRANSACTION_TRACER)
           intrinsic_attributes[:synthetics_resource_id]
@@ -51,7 +52,7 @@ module NewRelic
         def create_node(time_since_start, metric_name = nil)
           raise FinishedTraceError.new "Can't create additional node for finished trace." if self.finished
           self.node_count += 1
-          NewRelic::Agent::Transaction::TraceNode.new(time_since_start, metric_name)
+          NewRelic::Agent::Transaction::TraceNode.new(metric_name, time_since_start)
         end
 
         def each_node(&block)
@@ -84,18 +85,9 @@ module NewRelic
         end
 
         def prepare_sql_for_transmission!
-          strategy = NewRelic::Agent::Database.record_sql_method
           each_node do |node|
             next unless node[:sql]
-
-            case strategy
-            when :obfuscated
-              node[:sql] = NewRelic::Agent::Database.obfuscate_sql(node[:sql])
-            when :raw
-              node[:sql] = node[:sql].sql.to_s
-            else
-              node[:sql] = nil
-            end
+            node[:sql] = node[:sql].safe_sql
           end
         end
 
@@ -111,37 +103,46 @@ module NewRelic
           @root_node.each_node_with_nest_tracking(&block)
         end
 
-        def trace_tree
+        AGENT_ATTRIBUTES_KEY     = 'agentAttributes'.freeze
+        USER_ATTRIBUTES_KEY      = 'userAttributes'.freeze
+        INTRINSIC_ATTRIBUTES_KEY = 'intrinsics'.freeze
+
+        def attributes_for_tracer_destination
           destination = NewRelic::Agent::AttributeFilter::DST_TRANSACTION_TRACER
 
           agent_attributes     = self.attributes.agent_attributes_for(destination)
           custom_attributes    = self.attributes.custom_attributes_for(destination)
           intrinsic_attributes = self.attributes.intrinsic_attributes_for(destination)
 
+          {
+            AGENT_ATTRIBUTES_KEY     => agent_attributes,
+            USER_ATTRIBUTES_KEY      => custom_attributes,
+            INTRINSIC_ATTRIBUTES_KEY => intrinsic_attributes
+          }
+        end
+
+        def trace_tree attributes_hash
           [
             NewRelic::Coerce.float(self.start_time),
-            {},
-            {},
+            NewRelic::EMPTY_HASH,
+            NewRelic::EMPTY_HASH,
             self.root_node.to_array,
-            {
-              'agentAttributes' => agent_attributes,
-              'userAttributes'  => custom_attributes,
-              'intrinsics'      => intrinsic_attributes
-            }
+            attributes_hash
           ]
         end
 
         def to_collector_array(encoder)
+          attributes_hash = attributes_for_tracer_destination
           [
             NewRelic::Helper.time_to_millis(self.start_time),
             NewRelic::Helper.time_to_millis(self.root_node.duration),
             NewRelic::Coerce.string(self.transaction_name),
-            NewRelic::Coerce.string(self.uri),
-            encoder.encode(trace_tree),
+            NewRelic::Coerce.string(attributes_hash[AGENT_ATTRIBUTES_KEY][:'request.uri']),
+            encoder.encode(trace_tree(attributes_hash)),
             NewRelic::Coerce.string(self.guid),
             nil,
-            forced?,
-            NewRelic::Coerce.int_or_nil(xray_session_id),
+            false, # forced?,
+            nil, # NewRelic::Coerce.int_or_nil(xray_session_id),
             NewRelic::Coerce.string(self.synthetics_resource_id)
           ]
         end

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

@@ -0,0 +1,56 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+
+require 'new_relic/helper'
+require 'new_relic/agent/transaction/trace'
+require 'new_relic/agent/transaction/trace_node'
+
+module NewRelic
+  module Agent
+    class Transaction
+      module TraceBuilder
+        extend self
+
+        def build_trace transaction
+          trace = Trace.new transaction.start_time
+          trace.root_node.exit_timestamp = transaction.end_time - transaction.start_time
+          copy_attributes transaction, trace
+          first, *rest = transaction.segments
+          relationship_map = rest.group_by { |s| s.parent }
+          trace.root_node.children << process_segments(transaction, first, trace.root_node, relationship_map)
+          trace
+        end
+
+        private
+
+        # recursively builds a transaction trace from the flat list of segments
+        def process_segments transaction, segment, parent, relationship_map
+          current = create_trace_node transaction, segment, parent
+
+          if children = relationship_map[segment]
+            current.children = children.map! do |child|
+              process_segments transaction, child, current, relationship_map
+            end
+          end
+
+          current
+        end
+
+        def create_trace_node transaction, segment, parent
+          relative_start = segment.start_time - transaction.start_time
+          relative_end = segment.end_time - transaction.start_time
+          TraceNode.new segment.name, relative_start, relative_end, segment.params, parent
+        end
+
+        def copy_attributes transaction, trace
+          trace.transaction_name = transaction.best_name
+          trace.guid = transaction.guid
+          trace.attributes = transaction.attributes
+          trace.threshold = transaction.threshold
+          trace.finished = true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,168 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+module NewRelic
+  module Agent
+    class Transaction
+      module TraceContext
+        include NewRelic::Coerce
+
+        module AccountHelpers
+          extend self
+
+          def trace_state_entry_key
+            @trace_state_entry_key ||= if Agent.config[:trusted_account_key]
+              "#{Agent.config[:trusted_account_key]}@nr".freeze
+            elsif Agent.config[:account_id]
+              "#{Agent.config[:account_id]}@nr".freeze
+            end
+          end
+        end
+
+        SUPPORTABILITY_PREFIX             = "Supportability/TraceContext"
+        CREATE_PREFIX                     = "#{SUPPORTABILITY_PREFIX}/Create"
+        ACCEPT_PREFIX                     = "#{SUPPORTABILITY_PREFIX}/Accept"
+        TRACESTATE_PREFIX                 = "#{SUPPORTABILITY_PREFIX}/TraceState"
+
+        CREATE_SUCCESS_METRIC             = "#{CREATE_PREFIX}/Success"
+        CREATE_EXCEPTION_METRIC           = "#{CREATE_PREFIX}/Exception"
+
+        ACCEPT_SUCCESS_METRIC             = "#{ACCEPT_PREFIX}/Success"
+        ACCEPT_EXCEPTION_METRIC           = "#{ACCEPT_PREFIX}/Exception"
+        IGNORE_MULTIPLE_ACCEPT_METRIC     = "#{ACCEPT_PREFIX}/Ignored/Multiple"
+        IGNORE_ACCEPT_AFTER_CREATE_METRIC = "#{ACCEPT_PREFIX}/Ignored/CreateBeforeAccept"
+
+        NO_NR_ENTRY_TRACESTATE_METRIC     = "#{TRACESTATE_PREFIX}/NoNrEntry"
+        INVALID_TRACESTATE_PAYLOAD_METRIC = "#{TRACESTATE_PREFIX}/InvalidNrEntry"
+
+        attr_accessor :trace_context_header_data
+        attr_reader   :trace_state_payload
+
+        def trace_parent_header_present? request
+          request[NewRelic::HTTP_TRACEPARENT_KEY]
+        end
+
+        def accept_trace_context_incoming_request request
+          header_data = NewRelic::Agent::DistributedTracing::TraceContext.parse(
+            format: NewRelic::FORMAT_RACK,
+            carrier: request,
+            trace_state_entry_key: AccountHelpers.trace_state_entry_key,
+          )
+          return if header_data.nil?
+
+          accept_trace_context header_data
+        end
+        private :accept_trace_context_incoming_request
+
+        def insert_trace_context_header header, format=NewRelic::FORMAT_NON_RACK
+          return unless Agent.config[:'distributed_tracing.enabled']
+
+          NewRelic::Agent::DistributedTracing::TraceContext.insert \
+            format: format,
+            carrier: header,
+            trace_id: transaction.trace_id.rjust(32, '0').downcase,
+            parent_id: transaction.current_segment.guid,
+            trace_flags: transaction.sampled? ? 0x1 : 0x0,
+            trace_state: create_trace_state
+
+          @trace_context_inserted = true
+
+          NewRelic::Agent.increment_metric CREATE_SUCCESS_METRIC
+          true
+        rescue Exception => e
+          NewRelic::Agent.increment_metric CREATE_EXCEPTION_METRIC
+          NewRelic::Agent.logger.warn "Failed to create trace context payload", e
+          false
+        end
+
+        def create_trace_state
+          entry_key = AccountHelpers.trace_state_entry_key.dup
+          payload = create_trace_state_payload
+
+          if payload
+            entry = NewRelic::Agent::DistributedTracing::TraceContext.create_trace_state_entry \
+              entry_key,
+              payload.to_s
+          else
+            entry = NewRelic::EMPTY_STR
+          end
+
+          trace_context_header_data ? trace_context_header_data.trace_state(entry) : entry
+        end
+
+        def create_trace_state_payload
+          unless Agent.config[:'distributed_tracing.enabled']
+            NewRelic::Agent.logger.warn "Not configured to create WC3 trace context payload"
+            return
+          end
+
+
+          span_guid = Agent.config[:'span_events.enabled'] ? transaction.current_segment.guid : nil
+          transaction_guid = Agent.config[:'analytics_events.enabled'] ? transaction.guid : nil
+
+          TraceContextPayload.create \
+            parent_account_id: Agent.config[:account_id],
+            parent_app_id: Agent.config[:primary_application_id],
+            transaction_id: transaction_guid,
+            sampled: transaction.sampled?,
+            priority: float!(transaction.priority, NewRelic::PRIORITY_PRECISION),
+            id: span_guid
+        end
+
+        def assign_trace_state_payload
+          payload = @trace_context_header_data.trace_state_payload
+          unless payload
+            NewRelic::Agent.increment_metric NO_NR_ENTRY_TRACESTATE_METRIC
+            return false
+          end
+          unless payload.valid?
+            NewRelic::Agent.increment_metric INVALID_TRACESTATE_PAYLOAD_METRIC
+            return false
+          end
+          @trace_state_payload = payload
+        end
+
+        def accept_trace_context header_data
+          return if ignore_trace_context?
+
+          @trace_context_header_data = header_data
+          transaction.trace_id = header_data.trace_id
+          transaction.parent_span_id = header_data.parent_id
+
+          return false unless payload = assign_trace_state_payload
+
+          transaction.distributed_tracer.parent_transaction_id = payload.transaction_id
+
+          unless payload.sampled.nil?
+            transaction.sampled = payload.sampled
+            transaction.priority = payload.priority if payload.priority
+          end
+          NewRelic::Agent.increment_metric ACCEPT_SUCCESS_METRIC
+          true
+        rescue => e
+          NewRelic::Agent.increment_metric ACCEPT_EXCEPTION_METRIC
+          NewRelic::Agent.logger.warn "Failed to accept trace context payload", e
+          false
+        end
+
+        def ignore_trace_context?
+          if trace_context_header_data
+            NewRelic::Agent.increment_metric IGNORE_MULTIPLE_ACCEPT_METRIC
+            return true
+          elsif trace_context_inserted?
+            NewRelic::Agent.increment_metric IGNORE_ACCEPT_AFTER_CREATE_METRIC
+            return true
+          end
+          false
+        end
+
+        def trace_context_inserted?
+          @trace_context_inserted ||= false
+        end
+
+      end
+    end
+  end
+end