newrelic_rpm 7.0.0 → 9.0.0

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

@@ -1,4 +1,3 @@
-# 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
@@ -17,27 +16,25 @@ module NewRelic
     class DistributedTracePayload
       extend Coerce
 
-      VERSION     = [0, 1].freeze
+      VERSION = [0, 1].freeze
       PARENT_TYPE = "App"
-      POUND       = '#'
 
       # Key names for serialization
-      VERSION_KEY           = 'v'
-      DATA_KEY              = 'd'
-      PARENT_TYPE_KEY       = 'ty'
+      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'
+      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
+        def for_transaction(transaction)
           return nil unless connected?
 
           payload = new
@@ -50,7 +47,7 @@ module NewRelic
 
           payload.id = current_segment_id(transaction)
           payload.transaction_id = transaction.guid
-          payload.timestamp = (Time.now.to_f * 1000).round
+          payload.timestamp = Process.clock_gettime(Process::CLOCK_REALTIME, :millisecond)
           payload.trace_id = transaction.trace_id
           payload.sampled = transaction.sampled?
           payload.priority = transaction.priority
@@ -58,30 +55,31 @@ module NewRelic
           payload
         end
 
-        def from_json serialized_payload
-          raw_payload = JSON.parse serialized_payload
+        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.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.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
+        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)
@@ -90,7 +88,7 @@ module NewRelic
 
         private
 
-        def assign_trusted_account_key payload, account_id
+        def assign_trusted_account_key(payload, account_id)
           trusted_account_key = Agent.config[:trusted_account_key]
 
           if account_id != trusted_account_key
@@ -110,16 +108,16 @@ module NewRelic
       end
 
       attr_accessor :version,
-                    :parent_type,
-                    :parent_account_id,
-                    :parent_app_id,
-                    :trusted_account_key,
-                    :id,
-                    :transaction_id,
-                    :trace_id,
-                    :sampled,
-                    :priority,
-                    :timestamp
+        :parent_type,
+        :parent_account_id,
+        :parent_app_id,
+        :trusted_account_key,
+        :id,
+        :transaction_id,
+        :trace_id,
+        :sampled,
+        :priority,
+        :timestamp
 
       alias_method :sampled?, :sampled
 
@@ -134,17 +132,17 @@ module NewRelic
         }
 
         result[DATA_KEY] = {
-          PARENT_TYPE_KEY       => parent_type,
+          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,
+          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][ID_KEY] = id if id
         result[DATA_KEY][TRUSTED_ACCOUNT_KEY] = trusted_account_key if trusted_account_key
 
         JSON.dump(result)
@@ -158,7 +156,7 @@ module NewRelic
       #
       # @api public
       def http_safe
-        Base64.strict_encode64 text
+        Base64.strict_encode64(text)
       end
     end
   end

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

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

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

@@ -1,4 +1,3 @@
-# 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
@@ -11,24 +10,24 @@ module NewRelic
       class TraceContext
         VERSION = 0x0
 
-        COMMA             = ','
-        EQUALS            = '='
-        INVALID_TRACE_ID  = ('0' * 32)
+        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})"
+        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_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"
 
@@ -36,33 +35,34 @@ module NewRelic
         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_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 \
+          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
+            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
+          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
+            unless trace_parent_valid?(trace_parent)
+              NewRelic::Agent.increment_metric(SUPPORTABILITY_TRACE_PARENT_PARSE_EXCEPTION)
               return nil
             end
 
@@ -72,30 +72,31 @@ module NewRelic
                 header_data
               end
             rescue Exception
-              NewRelic::Agent.increment_metric SUPPORTABILITY_TRACE_STATE_PARSE_EXCEPTION
+              NewRelic::Agent.increment_metric(SUPPORTABILITY_TRACE_STATE_PARSE_EXCEPTION)
               return nil
             end
           end
 
-          def create_trace_state_entry entry_key, payload
+          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
+          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
+          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]
@@ -104,7 +105,7 @@ module NewRelic
             end
           end
 
-          def trace_parent_valid? trace_parent
+          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
@@ -114,7 +115,7 @@ module NewRelic
             true
           end
 
-          def trace_parent_header_for_format format
+          def trace_parent_header_for_format(format)
             if format == NewRelic::FORMAT_RACK
               NewRelic::HTTP_TRACEPARENT_KEY
             else
@@ -122,7 +123,7 @@ module NewRelic
             end
           end
 
-          def trace_state_header_for_format format
+          def trace_state_header_for_format(format)
             if format == NewRelic::FORMAT_RACK
               NewRelic::HTTP_TRACESTATE_KEY
             else
@@ -130,8 +131,8 @@ module NewRelic
             end
           end
 
-          def extract_tracestate format, carrier, trace_state_entry_key
-            header_name = trace_state_header_for_format format
+          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?
 
@@ -143,9 +144,9 @@ module NewRelic
               if entry == NewRelic::EMPTY_STR
                 false
               else
-                vendor_id = entry.slice 0, entry.index(EQUALS)
+                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
+                  payload = entry.slice!(trace_state_entry_key.size + 1, entry.size)
                   true
                 else
                   trace_state_size += entry.size
@@ -155,19 +156,19 @@ module NewRelic
               end
             end
 
-            trace_state_vendors.chomp! COMMA
+            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
+            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
+          def decode_payload(payload)
+            TraceContextPayload.from_s(payload)
           rescue
             if payload
-              NewRelic::Agent.increment_metric SUPPORTABILITY_TRACE_STATE_INVALID_NR_ENTRY
+              NewRelic::Agent.increment_metric(SUPPORTABILITY_TRACE_STATE_INVALID_NR_ENTRY)
             end
             return nil
           end
@@ -175,20 +176,20 @@ module NewRelic
 
         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
+            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
+          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
@@ -199,11 +200,11 @@ module NewRelic
 
           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
+          def trace_state(trace_state_entry)
+            @trace_state ||= join_trace_state(trace_state_entry.size)
             @trace_state_entries = nil
 
-            trace_state_entry << @trace_state
+            trace_state_entry = "#{trace_state_entry}#{@trace_state}"
           end
 
           def trace_id
@@ -216,7 +217,7 @@ module NewRelic
 
           private
 
-          def join_trace_state trace_state_entry_size
+          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
@@ -237,9 +238,7 @@ module NewRelic
 
             joined_trace_state
           end
-
         end
-
       end
     end
   end

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

@@ -1,6 +1,6 @@
-# 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 'new_relic/coerce'
 
@@ -15,29 +15,29 @@ module NewRelic
       TRUE_CHAR = '1'.freeze
       FALSE_CHAR = '0'.freeze
 
-      PARENT_TYPES = %w(App Browser Mobile).map(&:freeze).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
+        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
+        def from_s(payload_string)
           attrs = payload_string.split(DELIMITER)
 
-          payload = create \
+          payload = create( \
             version: int!(attrs[0]),
             parent_type: int!(attrs[1]),
             parent_account_id: attrs[2],
@@ -47,43 +47,44 @@ module NewRelic
             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?
+          )
+          handle_invalid_payload(message: 'payload missing attributes') unless payload.valid?
           payload
         rescue => e
-          handle_invalid_payload error: e
+          handle_invalid_payload(error: e)
           raise
         end
 
         private
 
         def now_ms
-          (Time.now.to_f * 1000).round
+          Process.clock_gettime(Process::CLOCK_REALTIME, :millisecond)
         end
 
-        def handle_invalid_payload error: nil, message: nil
-          NewRelic::Agent.increment_metric SUPPORTABILITY_PARSE_EXCEPTION
+        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
+            NewRelic::Agent.logger.warn("Error parsing trace context payload", error)
           elsif message
-            NewRelic::Agent.logger.warn "Error parsing trace context payload: #{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
+        :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
+      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
@@ -110,15 +111,15 @@ module NewRelic
       end
 
       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 = version.to_s # required
+        result << DELIMITER << parent_type_id.to_s # required
+        result << DELIMITER << parent_account_id # required
+        result << DELIMITER << parent_app_id # required
         result << DELIMITER << (id || NewRelic::EMPTY_STR)
         result << DELIMITER << (transaction_id || NewRelic::EMPTY_STR)
         result << DELIMITER << (sampled ? TRUE_CHAR : FALSE_CHAR)
         result << DELIMITER << sprintf("%.6f", priority)
-        result << DELIMITER << timestamp.to_s
+        result << DELIMITER << timestamp.to_s # required
         result
       end
     end