newrelic_rpm 6.7.0.359 → 6.8.0.360

data/lib/new_relic/agent/distributed_trace_monitor.rb

@@ -2,6 +2,7 @@
 # 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/cross_app_tracing'
 
@@ -21,20 +22,9 @@ module NewRelic
         return unless txn = Tracer.current_transaction
 
         if txn.accept_distributed_trace_payload payload
-          txn.distributed_trace_payload.caller_transport_type = transport_type(request)
+          txn.distributed_trace_payload.caller_transport_type = DistributedTraceTransportType.for_rack_request(request)
         end
       end
-
-      URL_SCHEMES = {
-        'http'  => 'HTTP'.freeze,
-        'https' => 'HTTPS'.freeze
-      }
-
-      RACK_URL_SCHEME = 'rack.url_scheme'.freeze
-
-      def transport_type(request)
-        URL_SCHEMES[request[RACK_URL_SCHEME]]
-      end
     end
   end
 end

data/lib/new_relic/agent/distributed_trace_payload.rb

@@ -5,6 +5,8 @@ require 'json'
 require 'base64'
 require 'set'
 
+require 'new_relic/agent/distributed_trace_transport_type'
+
 module NewRelic
   module Agent
     #
@@ -32,35 +34,6 @@ module NewRelic
       TIMESTAMP_KEY              = 'ti'.freeze
       PRIORITY_KEY               = 'pr'.freeze
 
-      # Intrinsic Keys
-      PARENT_TYPE_INTRINSIC_KEY                = "parent.type".freeze
-      PARENT_APP_INTRINSIC_KEY                 = "parent.app".freeze
-      PARENT_ACCOUNT_ID_INTRINSIC_KEY          = "parent.account".freeze
-      PARENT_TRANSPORT_TYPE_INTRINSIC_KEY      = "parent.transportType".freeze
-      PARENT_TRANSPORT_DURATION_INTRINSIC_KEY  = "parent.transportDuration".freeze
-      GUID_INTRINSIC_KEY                       = "guid".freeze
-      TRACE_ID_INTRINSIC_KEY                   = "traceId".freeze
-      PARENT_ID_INTRINSIC_KEY                  = "parentId".freeze
-      PARENT_SPAN_ID_INTRINSIC_KEY             = "parentSpanId".freeze
-      SAMPLED_INTRINSIC_KEY                    = "sampled".freeze
-      COMMA                                    = ",".freeze
-
-      INTRINSIC_KEYS = [
-        PARENT_TYPE_INTRINSIC_KEY,
-        PARENT_APP_INTRINSIC_KEY,
-        PARENT_ACCOUNT_ID_INTRINSIC_KEY,
-        PARENT_TRANSPORT_TYPE_INTRINSIC_KEY,
-        PARENT_TRANSPORT_DURATION_INTRINSIC_KEY,
-        GUID_INTRINSIC_KEY,
-        TRACE_ID_INTRINSIC_KEY,
-        PARENT_ID_INTRINSIC_KEY,
-        PARENT_SPAN_ID_INTRINSIC_KEY,
-        SAMPLED_INTRINSIC_KEY
-      ].freeze
-
-      # Intrinsic Values
-      PARENT_TRANSPORT_TYPE_UNKNOWN = 'Unknown'.freeze
-
       class << self
 
         def for_transaction transaction
@@ -110,24 +83,12 @@ module NewRelic
           from_json decoded_payload
         end
 
-        def assign_initial_intrinsics transaction, transaction_payload
-          transaction_payload[GUID_INTRINSIC_KEY] = transaction.guid
-          transaction_payload[TRACE_ID_INTRINSIC_KEY] = transaction.trace_id
-          transaction_payload[SAMPLED_INTRINSIC_KEY] = transaction.sampled?
-        end
-
         def major_version_matches?(payload)
           payload.version[0] == VERSION[0]
         end
 
         private
 
-        # We use the presence of the account_id and primary_application in the
-        # config to tell if we have connected yet.
-        def connected?
-          Agent.config[:account_id] && Agent.config[:primary_application_id]
-        end
-
         def assign_trusted_account_key payload, account_id
           trusted_account_key = Agent.config[:trusted_account_key]
 
@@ -142,6 +103,10 @@ module NewRelic
             transaction.current_segment.guid
           end
         end
+
+        def connected?
+          Agent.instance.connected?
+        end
       end
 
       attr_accessor :version,
@@ -160,12 +125,12 @@ module NewRelic
 
       attr_reader :caller_transport_type
 
-      def caller_transport_type=(type)
-        @caller_transport_type = valid_transport_type_for(type)
+      def caller_transport_type= type
+        @caller_transport_type = DistributedTraceTransportType.from type
       end
 
       def initialize
-        @caller_transport_type = PARENT_TRANSPORT_TYPE_UNKNOWN
+        @caller_transport_type = DistributedTraceTransportType::UNKNOWN
       end
 
       # Represent this payload as a raw JSON string.
@@ -205,38 +170,6 @@ module NewRelic
       def http_safe
         Base64.strict_encode64 text
       end
-
-      def assign_intrinsics transaction, transaction_payload
-        transaction_payload[PARENT_TYPE_INTRINSIC_KEY] = parent_type
-        transaction_payload[PARENT_APP_INTRINSIC_KEY] = parent_app_id
-        transaction_payload[PARENT_ACCOUNT_ID_INTRINSIC_KEY] = parent_account_id
-        transaction_payload[PARENT_TRANSPORT_TYPE_INTRINSIC_KEY] = caller_transport_type
-        transaction_payload[PARENT_TRANSPORT_DURATION_INTRINSIC_KEY] = transaction.transport_duration
-        transaction_payload[GUID_INTRINSIC_KEY] = transaction.guid
-        transaction_payload[TRACE_ID_INTRINSIC_KEY] = trace_id
-        transaction_payload[PARENT_ID_INTRINSIC_KEY] = transaction.parent_id if transaction.parent_id
-        transaction_payload[PARENT_SPAN_ID_INTRINSIC_KEY] = id if id
-        transaction_payload[SAMPLED_INTRINSIC_KEY] = transaction.sampled?
-      end
-
-      private
-
-      ALLOWABLE_TRANSPORT_TYPES = Set.new(%w[
-        Unknown
-        HTTP
-        HTTPS
-        Kafka
-        JMS
-        IronMQ
-        AMQP
-        Queue
-        Other
-      ]).freeze
-
-      def valid_transport_type_for(value)
-        return value if ALLOWABLE_TRANSPORT_TYPES.include?(value)
-        PARENT_TRANSPORT_TYPE_UNKNOWN
-      end
     end
   end
 end

data/lib/new_relic/agent/distributed_trace_transport_type.rb

@@ -0,0 +1,43 @@
+# 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 DistributedTraceTransportType
+      extend self
+
+      UNKNOWN = 'Unknown'.freeze
+
+      ALLOWABLE_TRANSPORT_TYPES = Set.new(%w[
+        Unknown
+        HTTP
+        HTTPS
+        Kafka
+        JMS
+        IronMQ
+        AMQP
+        Queue
+        Other
+      ]).freeze
+
+      URL_SCHEMES = {
+        'http'  => 'HTTP'.freeze,
+        'https' => 'HTTPS'.freeze
+      }
+
+      RACK_URL_SCHEME = 'rack.url_scheme'.freeze
+
+      def from value
+        return value if ALLOWABLE_TRANSPORT_TYPES.include?(value)
+
+        UNKNOWN
+      end
+
+
+      def for_rack_request request
+        URL_SCHEMES[request[RACK_URL_SCHEME]]
+      end
+    end
+  end
+end

data/lib/new_relic/agent/guid_generator.rb

@@ -0,0 +1,28 @@
+# 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 GuidGenerator
+
+      HEX_DIGITS = (0..15).map{|i| i.to_s(16)}
+
+      module_function
+
+      # This method intentionally does not use SecureRandom, because it relies
+      # on urandom, which raises an exception in MRI when the interpreter runs
+      # out of allocated file descriptors.
+      # The guids generated by this method may not be _secure_, but they are
+      # random enough for our purposes.
+      def generate_guid length = 16
+        guid = ''
+        length.times do |a|
+          guid << HEX_DIGITS[rand(16)]
+        end
+        guid
+      end
+
+    end
+  end
+end

data/lib/new_relic/agent/logging.rb

@@ -93,6 +93,10 @@ module NewRelic
             message.inspect.to_json
           end
         end
+
+        def clear_tags!
+          # No-op; just avoiding issues with act-fluent-logger-rails
+        end
       end
 
 

data/lib/new_relic/agent/new_relic_service.rb

@@ -92,14 +92,16 @@ module NewRelic
         token = Agent.config[:security_policies_token]
 
         if token && !token.empty?
-          response = invoke_remote(:preconnect, [{'security_policies_token' => token}])
+          response = invoke_remote(:preconnect, [{'security_policies_token' => token, 'high_security' => false}])
 
           validator = SecurityPolicySettings::Validator.new(response)
           validator.validate_matching_agent_config!
 
           response
+        elsif Agent.config[:high_security]
+          invoke_remote(:preconnect, [{'high_security' => true}])
         else
-          invoke_remote(:preconnect, [])
+          invoke_remote(:preconnect, [{'high_security' => false}])
         end
       end
 
@@ -196,10 +198,10 @@ module NewRelic
         encoding = 'identity'
         if data.size > 64 * 1024
           encoding = Agent.config[:compressed_content_encoding]
-          data = if encoding == 'gzip'
-            Encoders::Compressed::Gzip.encode(data)
-          else
+          data = if encoding == 'deflate'
             Encoders::Compressed::Deflate.encode(data)
+          else
+            Encoders::Compressed::Gzip.encode(data)
           end
         end
         check_post_size(data, endpoint)

data/lib/new_relic/agent/span_event_aggregator.rb

@@ -12,6 +12,7 @@ module NewRelic
     class SpanEventAggregator < EventAggregator
       named :SpanEventAggregator
       capacity_key :'span_events.max_samples_stored'
+
       enabled_keys :'span_events.enabled',
                    :'distributed_tracing.enabled'
 

data/lib/new_relic/agent/span_event_primitive.rb

@@ -36,6 +36,8 @@ module NewRelic
       PEER_HOSTNAME_KEY    = 'peer.hostname'.freeze
       SPAN_KIND_KEY        = 'span.kind'.freeze
       ENTRY_POINT_KEY      = 'nr.entryPoint'.freeze
+      TRUSTED_PARENT_KEY   = "trustedParentId".freeze
+      TRACING_VENDORS_KEY  = "tracingVendors".freeze
 
       # Strings for static values of the event structure
       EVENT_TYPE         = 'Span'.freeze
@@ -51,7 +53,7 @@ module NewRelic
         intrinsics = intrinsics_for(segment)
         intrinsics[CATEGORY_KEY] = GENERIC_CATEGORY
 
-        [intrinsics, EMPTY_HASH, EMPTY_HASH]
+        [intrinsics, custom_attributes(segment.attributes), EMPTY_HASH]
       end
 
       def for_external_request_segment(segment)
@@ -68,7 +70,7 @@ module NewRelic
           agent_attributes[HTTP_URL_KEY] = truncate(segment.uri)
         end
 
-        [intrinsics, EMPTY_HASH, agent_attributes]
+        [intrinsics, custom_attributes(segment.attributes), agent_attributes]
       end
 
       def for_datastore_segment(segment)
@@ -96,7 +98,7 @@ module NewRelic
           agent_attributes[DB_STATEMENT_KEY] = truncate(segment.nosql_statement, 2000)
         end
 
-        [intrinsics, EMPTY_HASH, agent_attributes]
+        [intrinsics, custom_attributes(segment.attributes), agent_attributes]
       end
 
       private
@@ -115,19 +117,39 @@ module NewRelic
           NAME_KEY           => segment.name
         }
 
+        if segment.parent.nil?
+          intrinsics[ENTRY_POINT_KEY] = true
+          if segment.transaction
+            if segment.transaction.trace_context_header_data
+              intrinsics[TRACING_VENDORS_KEY] = segment.transaction.trace_context_header_data.trace_state_vendors
+            end
+            if segment.transaction.trace_state_payload
+              intrinsics[TRUSTED_PARENT_KEY] = segment.transaction.trace_state_payload.id
+            end
+          end
+        end
+
         parent_id = parent_guid(segment)
         intrinsics[PARENT_ID_KEY] = parent_id if parent_id
-
-        intrinsics[ENTRY_POINT_KEY] = true unless segment.parent
-
         intrinsics
       end
 
+      def custom_attributes attributes
+        if attributes
+          result = attributes.custom_attributes_for(NewRelic::Agent::AttributeFilter::DST_SPAN_EVENTS)
+          result.freeze
+        else
+          EMPTY_HASH
+        end
+      end
+
       def parent_guid(segment)
         if segment.parent
           segment.parent.guid
-        elsif segment.transaction && segment.transaction.distributed_trace?
+        elsif segment.transaction && segment.transaction.distributed_trace_payload
           segment.transaction.distributed_trace_payload.id
+        elsif segment.transaction && segment.transaction.trace_context_header_data
+          segment.transaction.trace_context_header_data.parent_id
         end
       end
 

data/lib/new_relic/agent/sql_sampler.rb

@@ -162,7 +162,7 @@ module NewRelic
         if transaction && transaction.distributed_trace_payload
           params = {}
           payload = transaction.distributed_trace_payload
-          payload.assign_intrinsics transaction, params
+          DistributedTraceIntrinsics.copy_from_transaction transaction, payload, params
           params[PRIORITY] = transaction.priority
         end
         params

data/lib/new_relic/agent/trace_context.rb

@@ -0,0 +1,244 @@
+# 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/trace_context_payload'
+
+module NewRelic
+  module Agent
+    class TraceContext
+      VERSION = 0x0
+      TRACE_PARENT = 'traceparent'.freeze
+      TRACE_STATE  = 'tracestate'.freeze
+
+      TRACE_PARENT_RACK = 'HTTP_TRACEPARENT'.freeze
+      TRACE_STATE_RACK  = 'HTTP_TRACESTATE'.freeze
+
+      FORMAT_HTTP = 0
+      FORMAT_RACK = 1
+
+      TRACE_PARENT_REGEX = /\A(?<version>[a-f\d]{2})-(?<trace_id>[a-f\d]{32})-(?<parent_id>[a-f\d]{16})-(?<trace_flags>\d{2})(?<undefined_fields>-[a-zA-Z\d-]*)?\z/.freeze
+
+      COMMA = ','.freeze
+      EMPTY_STRING = ''.freeze
+      EQUALS = '='.freeze
+      TRACE_ID_KEY = 'trace_id'.freeze
+      PARENT_ID_KEY = 'parent_id'.freeze
+      VERSION_KEY = 'version'.freeze
+      UNDEFINED_FIELDS_KEY = 'undefined_fields'.freeze
+      INVALID_TRACE_ID = ('0' * 32).freeze
+      INVALID_PARENT_ID = ('0' * 16).freeze
+      INVALID_VERSION = 'ff'.freeze
+
+      MAX_TRACE_STATE_SIZE = 512 # bytes
+      MAX_TRACE_STATE_ENTRY_SIZE = 128 # bytes
+
+      SUPPORTABILITY_TRACE_PARENT_PARSE_EXCEPTION = "Supportability/TraceContext/TraceParent/Parse/Exception".freeze
+      SUPPORTABILITY_TRACE_STATE_PARSE_EXCEPTION  = "Supportability/TraceContext/TraceState/Parse/Exception".freeze
+
+      class << self
+        def insert format: FORMAT_HTTP,
+                   carrier: nil,
+                   parent_id: nil,
+                   trace_id: nil,
+                   trace_flags: nil,
+                   trace_state: nil
+
+          trace_parent_header = trace_parent_header_for_format format
+          carrier[trace_parent_header] = format_trace_parent \
+            trace_id: trace_id,
+            parent_id: parent_id,
+            trace_flags: trace_flags
+
+          trace_state_header = trace_state_header_for_format format
+          carrier[trace_state_header] = trace_state if trace_state && !trace_state.empty?
+        end
+
+        def parse format: FORMAT_HTTP,
+                  carrier: nil,
+                  trace_state_entry_key: nil
+          trace_parent = extract_traceparent(format, carrier)
+          unless trace_parent_valid? trace_parent
+            NewRelic::Agent.increment_metric SUPPORTABILITY_TRACE_PARENT_PARSE_EXCEPTION
+            return
+          end
+
+          begin
+            if header_data = extract_tracestate(format, carrier, trace_state_entry_key)
+              header_data.trace_parent = trace_parent
+              header_data
+            end
+          rescue Exception
+            NewRelic::Agent.increment_metric SUPPORTABILITY_TRACE_STATE_PARSE_EXCEPTION
+          end
+        end
+
+        def create_trace_state_entry entry_key, payload
+          "#{entry_key}=#{payload}"
+        end
+
+        private
+
+        TRACE_PARENT_FORMAT_STRING = "%02x-%s-%s-%02x".freeze
+
+        def format_trace_parent trace_id: nil,
+                                parent_id: nil,
+                                trace_flags: nil
+          sprintf TRACE_PARENT_FORMAT_STRING,
+                  VERSION,
+                  trace_id,
+                  parent_id,
+                  trace_flags
+        end
+
+        def extract_traceparent format, carrier
+          header_name = trace_parent_header_for_format format
+          return unless header = carrier[header_name]
+          if matchdata = header.match(TRACE_PARENT_REGEX)
+            TRACE_PARENT_REGEX.named_captures.inject({}) do |hash, (name, (index))|
+              hash[name] = matchdata[index]
+              hash
+            end
+          end
+        end
+
+        def trace_parent_valid? trace_parent
+          return false if trace_parent.nil?
+          return false if trace_parent[TRACE_ID_KEY] == INVALID_TRACE_ID
+          return false if trace_parent[PARENT_ID_KEY] == INVALID_PARENT_ID
+          return false if trace_parent[VERSION_KEY] == INVALID_VERSION
+          return false if trace_parent[VERSION_KEY].to_i(16) == VERSION && !trace_parent[UNDEFINED_FIELDS_KEY].nil?
+
+          true
+        end
+
+        def trace_parent_header_for_format format
+          if format == FORMAT_RACK
+            TRACE_PARENT_RACK
+          else
+            TRACE_PARENT
+          end
+        end
+
+        def trace_state_header_for_format format
+          if format == FORMAT_RACK
+            TRACE_STATE_RACK
+          else
+            TRACE_STATE
+          end
+        end
+
+        def extract_tracestate format, carrier, trace_state_entry_key
+          header_name = trace_state_header_for_format format
+          header = carrier[header_name]
+          return HeaderData.create if header.nil? || header.empty?
+
+          payload = nil
+          trace_state_size = 0
+          trace_state_vendors = ''
+          trace_state = header.split(COMMA).map(&:strip)
+          trace_state.reject! do |entry|
+            vendor_id = entry.slice 0, entry.index(EQUALS)
+            if vendor_id == trace_state_entry_key
+              payload = entry.slice! trace_state_entry_key.size + 1, entry.size
+              true
+            else
+              trace_state_size += entry.size
+              trace_state_vendors << vendor_id << COMMA
+              false
+            end
+          end
+
+          trace_state_vendors.chomp! COMMA unless trace_state_vendors.empty?
+
+          HeaderData.create trace_state_payload: payload ? decode_payload(payload) : nil,
+                      trace_state_entries: trace_state,
+                      trace_state_size: trace_state_size,
+                      trace_state_vendors: trace_state_vendors
+        end
+
+        def decode_payload payload
+          TraceContextPayload.from_s payload
+        end
+      end
+
+      class HeaderData
+        class << self
+          def create trace_parent: nil,
+                     trace_state_payload: nil,
+                     trace_state_entries: nil,
+                     trace_state_size: 0,
+                     trace_state_vendors: nil
+            new trace_parent, \
+                trace_state_payload, \
+                trace_state_entries, \
+                trace_state_size, \
+                trace_state_vendors
+          end
+        end
+
+        def initialize trace_parent, trace_state_payload, trace_state_entries, trace_state_size, trace_state_vendors
+          @trace_parent = trace_parent
+          @trace_state_entries = trace_state_entries
+          @trace_state_payload = trace_state_payload
+          @trace_state_size = trace_state_size
+          @trace_state_vendors = trace_state_vendors
+        end
+
+        attr_accessor :trace_parent, :trace_state_payload, :trace_state_vendors
+
+        def trace_state trace_state_entry
+          @trace_state ||= join_trace_state trace_state_entry.size
+          @trace_state_entries = nil
+
+          trace_state_entry << @trace_state
+        end
+
+        def trace_id
+          @trace_parent[TRACE_ID_KEY]
+        end
+
+        def parent_id
+          @trace_parent[PARENT_ID_KEY]
+        end
+
+        private
+
+        def join_trace_state trace_state_entry_size
+          return @trace_state || EMPTY_STRING if @trace_state_entries.nil? || @trace_state_entries.empty?
+
+          max_size = MAX_TRACE_STATE_SIZE - trace_state_entry_size
+          return @trace_state_entries.join(COMMA).prepend(COMMA) if @trace_state_size < max_size
+
+          joined_trace_state = ''
+
+          used_size = 0
+
+          @trace_state_entries.each do |entry|
+            entry_size = entry.size + 1
+            break if used_size + entry_size > max_size
+            next if entry_size > MAX_TRACE_STATE_ENTRY_SIZE
+
+            joined_trace_state << COMMA << entry
+            used_size += entry_size
+          end
+
+          joined_trace_state
+        end
+
+      end
+
+      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
+    end
+  end
+end