newrelic_rpm 4.0.0.332 → 6.13.1

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

@@ -0,0 +1,165 @@
+# 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
+
+require 'json'
+require 'base64'
+
+module NewRelic
+  module Agent
+    #
+    # This class contains properties related to distributed traces.
+    # To obtain an instance, call
+    # {DistributedTracing#create_distributed_trace_payload}
+    #
+    # @api public
+    class DistributedTracePayload
+      extend Coerce
+
+      VERSION     = [0, 1].freeze
+      PARENT_TYPE = "App"
+      POUND       = '#'
+
+      # Key names for serialization
+      VERSION_KEY           = 'v'
+      DATA_KEY              = 'd'
+      PARENT_TYPE_KEY       = 'ty'
+      PARENT_ACCOUNT_ID_KEY = 'ac'
+      PARENT_APP_KEY        = 'ap'
+      TRUSTED_ACCOUNT_KEY   = 'tk'
+      ID_KEY                = 'id'
+      TX_KEY                = 'tx'
+      TRACE_ID_KEY          = 'tr'
+      SAMPLED_KEY           = 'sa'
+      TIMESTAMP_KEY         = 'ti'
+      PRIORITY_KEY          = 'pr'
+
+      class << self
+
+        def for_transaction transaction
+          return nil unless connected?
+
+          payload = new
+          payload.version = VERSION
+          payload.parent_type = PARENT_TYPE
+          payload.parent_account_id = Agent.config[:account_id]
+          payload.parent_app_id = Agent.config[:primary_application_id]
+
+          assign_trusted_account_key(payload, payload.parent_account_id)
+
+          payload.id = current_segment_id(transaction)
+          payload.transaction_id = transaction.guid
+          payload.timestamp = (Time.now.to_f * 1000).round
+          payload.trace_id = transaction.trace_id
+          payload.sampled = transaction.sampled?
+          payload.priority = transaction.priority
+
+          payload
+        end
+
+        def from_json serialized_payload
+          raw_payload = JSON.parse serialized_payload
+          return raw_payload if raw_payload.nil?
+          payload_data = raw_payload[DATA_KEY]
+
+          payload = new
+          payload.version             = raw_payload[VERSION_KEY]
+          payload.parent_type         = payload_data[PARENT_TYPE_KEY]
+          payload.parent_account_id   = payload_data[PARENT_ACCOUNT_ID_KEY]
+          payload.parent_app_id       = payload_data[PARENT_APP_KEY]
+          payload.trusted_account_key = payload_data[TRUSTED_ACCOUNT_KEY]
+          payload.timestamp           = payload_data[TIMESTAMP_KEY]
+          payload.id                  = payload_data[ID_KEY]
+          payload.transaction_id      = payload_data[TX_KEY]
+          payload.trace_id            = payload_data[TRACE_ID_KEY]
+          payload.sampled             = payload_data[SAMPLED_KEY]
+          payload.priority            = payload_data[PRIORITY_KEY]
+
+          payload
+        end
+
+        def from_http_safe http_safe_payload
+          decoded_payload = Base64.strict_decode64 http_safe_payload
+          from_json decoded_payload
+        end
+
+        def major_version_matches?(payload)
+          payload.version[0] == VERSION[0]
+        end
+
+        private
+
+        def assign_trusted_account_key payload, account_id
+          trusted_account_key = Agent.config[:trusted_account_key]
+
+          if account_id != trusted_account_key
+            payload.trusted_account_key = trusted_account_key
+          end
+        end
+
+        def current_segment_id(transaction)
+          if Agent.config[:'span_events.enabled'] && transaction.current_segment
+            transaction.current_segment.guid
+          end
+        end
+
+        def connected?
+          Agent.instance.connected?
+        end
+      end
+
+      attr_accessor :version,
+                    :parent_type,
+                    :parent_account_id,
+                    :parent_app_id,
+                    :trusted_account_key,
+                    :id,
+                    :transaction_id,
+                    :trace_id,
+                    :sampled,
+                    :priority,
+                    :timestamp
+
+      alias_method :sampled?, :sampled
+
+      # Represent this payload as a raw JSON string.
+      #
+      # @return [String] Payload translated to JSON
+      #
+      # @api public
+      def text
+        result = {
+          VERSION_KEY => version
+        }
+
+        result[DATA_KEY] = {
+          PARENT_TYPE_KEY       => parent_type,
+          PARENT_ACCOUNT_ID_KEY => parent_account_id,
+          PARENT_APP_KEY        => parent_app_id,
+          TX_KEY                => transaction_id,
+          TRACE_ID_KEY          => trace_id,
+          SAMPLED_KEY           => sampled,
+          PRIORITY_KEY          => priority,
+          TIMESTAMP_KEY         => timestamp,
+        }
+
+        result[DATA_KEY][ID_KEY]              = id if id
+        result[DATA_KEY][TRUSTED_ACCOUNT_KEY] = trusted_account_key if trusted_account_key
+
+        JSON.dump(result)
+      end
+
+      # Encode this payload as a string suitable for passing via an
+      # HTTP header.
+      #
+      # @return [String] Payload translated to JSON and encoded for
+      #                  inclusion in headers
+      #
+      # @api public
+      def http_safe
+        Base64.strict_encode64 text
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# 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
+    module DistributedTraceTransportType
+      extend self
+
+      ALLOWABLE_TRANSPORT_TYPES = [
+        NewRelic::UNKNOWN,
+        NewRelic::HTTP,
+        NewRelic::HTTPS,
+        "Kafka",
+        "JMS",
+        "IronMQ",
+        "AMQP",
+        "Queue",
+        "Other",
+      ].freeze
+
+      URL_SCHEMES = {
+        'http'  => NewRelic::HTTP,
+        'https' => NewRelic::HTTPS,
+      }.freeze
+
+      RACK_URL_SCHEME = 'rack.url_scheme'
+
+      def from value
+        ALLOWABLE_TRANSPORT_TYPES.include?(value) ? value : NewRelic::UNKNOWN
+      end
+
+      def for_rack_request request
+        URL_SCHEMES[request[RACK_URL_SCHEME]]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,246 @@
+# 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
+
+require_relative 'trace_context_payload'
+
+module NewRelic
+  module Agent
+    module DistributedTracing
+      class TraceContext
+        VERSION = 0x0
+
+        COMMA             = ','
+        EQUALS            = '='
+        INVALID_TRACE_ID  = ('0' * 32)
+        INVALID_PARENT_ID = ('0' * 16)
+        INVALID_VERSION   = 'ff'
+
+        TRACE_ID_KEY          = 'trace_id'
+        TRACE_FLAGS_KEY       = 'trace_flags'
+        PARENT_ID_KEY         = 'parent_id'
+        VERSION_KEY           = 'version'
+        UNDEFINED_FIELDS_KEY  = 'undefined_fields'
+
+        TP_VERSION          = "(?<#{VERSION_KEY}>[a-f\\d]{2})"
+        TP_TRACE_ID         = "(?<#{TRACE_ID_KEY}>[a-f\\d]{32})"
+        TP_PARENT_ID        = "(?<#{PARENT_ID_KEY}>[a-f\\d]{16})"
+        TP_TRACE_FLAGS      = "(?<#{TRACE_FLAGS_KEY}>\\d{2})"
+        TP_UNDEFINED_FIELDS = "(?<#{UNDEFINED_FIELDS_KEY}>-[a-zA-Z\\d-]*)"
+        TRACE_PARENT_REGEX  = /\A#{TP_VERSION}-#{TP_TRACE_ID}-#{TP_PARENT_ID}-#{TP_TRACE_FLAGS}#{TP_UNDEFINED_FIELDS}?\z/
+
+        TRACE_PARENT_FORMAT_STRING = "%02x-%s-%s-%02x"
+
+        MAX_TRACE_STATE_SIZE = 512 # bytes
+        MAX_TRACE_STATE_ENTRY_SIZE = 128 # bytes
+
+        SUPPORTABILITY_TRACE_PARENT_PARSE_EXCEPTION = "Supportability/TraceContext/TraceParent/Parse/Exception"
+        SUPPORTABILITY_TRACE_STATE_PARSE_EXCEPTION  = "Supportability/TraceContext/TraceState/Parse/Exception"
+        SUPPORTABILITY_TRACE_STATE_INVALID_NR_ENTRY = "Supportability/TraceContext/TraceState/InvalidNrEntry"
+
+        class << self
+          def insert format: NewRelic::FORMAT_NON_RACK,
+                     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: NewRelic::FORMAT_NON_RACK,
+                    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 nil
+            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
+              return nil
+            end
+          end
+
+          def create_trace_state_entry entry_key, payload
+            "#{entry_key}=#{payload}".dup
+          end
+
+          private
+
+          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 == NewRelic::FORMAT_RACK
+              NewRelic::HTTP_TRACEPARENT_KEY
+            else
+              NewRelic::TRACEPARENT_KEY
+            end
+          end
+
+          def trace_state_header_for_format format
+            if format == NewRelic::FORMAT_RACK
+              NewRelic::HTTP_TRACESTATE_KEY
+            else
+              NewRelic::TRACESTATE_KEY
+            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 = String.new
+            trace_state = header.split(COMMA).map(&:strip)
+            trace_state.reject! do |entry|
+              if entry == NewRelic::EMPTY_STR
+                false
+              else
+                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
+            end
+
+            trace_state_vendors.chomp! COMMA
+
+            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
+          rescue
+            if payload
+              NewRelic::Agent.increment_metric SUPPORTABILITY_TRACE_STATE_INVALID_NR_ENTRY
+            end
+            return nil
+          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 = nil
+            @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 || NewRelic::EMPTY_STR 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 = ''.dup
+
+            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
+
+      end
+    end
+  end
+end