newrelic_rpm 7.0.0 → 8.8.0

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

@@ -17,26 +17,25 @@ module NewRelic
     class DistributedTracePayload
       extend Coerce
 
-      VERSION     = [0, 1].freeze
+      VERSION = [0, 1].freeze
       PARENT_TYPE = "App"
-      POUND       = '#'
+      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
           return nil unless connected?
 
@@ -50,7 +49,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
@@ -64,17 +63,17 @@ module NewRelic
           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
@@ -110,16 +109,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 +133,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)

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

@@ -17,12 +17,12 @@ 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'

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

@@ -11,24 +11,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,16 +36,16 @@ 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
+            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 \
@@ -58,8 +58,8 @@ module NewRelic
           end
 
           def parse format: NewRelic::FORMAT_NON_RACK,
-                    carrier: nil,
-                    trace_state_entry_key: nil
+            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
@@ -84,13 +84,13 @@ module NewRelic
           private
 
           def format_trace_parent trace_id: nil,
-                                  parent_id: nil,
-                                  trace_flags: nil
+            parent_id: nil,
+            trace_flags: nil
             sprintf TRACE_PARENT_FORMAT_STRING,
-                    VERSION,
-                    trace_id,
-                    parent_id,
-                    trace_flags
+              VERSION,
+              trace_id,
+              parent_id,
+              trace_flags
           end
 
           def extract_traceparent format, carrier
@@ -158,9 +158,9 @@ module NewRelic
             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
+              trace_state_entries: trace_state,
+              trace_state_size: trace_state_size,
+              trace_state_vendors: trace_state_vendors
           end
 
           def decode_payload payload
@@ -176,15 +176,15 @@ 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
+              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
+                trace_state_payload, \
+                trace_state_entries, \
+                trace_state_size, \
+                trace_state_vendors
             end
           end
 
@@ -237,9 +237,7 @@ module NewRelic
 
             joined_trace_state
           end
-
         end
-
       end
     end
   end

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

@@ -15,21 +15,21 @@ 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
+          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
+            transaction_id, sampled, priority, timestamp
         end
 
         include NewRelic::Coerce
@@ -57,7 +57,7 @@ module NewRelic
         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
@@ -71,19 +71,19 @@ module NewRelic
       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
+        id, transaction_id, sampled, priority, timestamp
         @version = version
         @parent_type_id = parent_type_id
         @parent_account_id = parent_account_id
@@ -110,15 +110,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

data/lib/new_relic/agent/distributed_tracing.rb

@@ -23,7 +23,7 @@ module NewRelic
     module DistributedTracing
       extend NewRelic::SupportabilityHelper
       extend self
-      
+
       # Adds the Distributed Trace headers so that the downstream service can participate in a
       # distributed trace. This method should be called every time an outbound call is made
       # since the header payload contains a timestamp.
@@ -34,7 +34,7 @@ module NewRelic
       # New Relic distributed tracing header by default. New Relic headers may be suppressed by
       # setting +exclude_new_relic_header+ to +true+ in your configuration file.
       #
-      # @param headers           [Hash]     Is a Hash to which the distributed trace headers 
+      # @param headers           [Hash]     Is a Hash to which the distributed trace headers
       #                                     will be inserted.
       #
       # @return           {Transaction}     The transaction the headers were inserted from,
@@ -42,7 +42,7 @@ module NewRelic
       #
       # @api public
       #
-      def insert_distributed_trace_headers headers={}
+      def insert_distributed_trace_headers headers = {}
         record_api_supportability_metric(:insert_distributed_trace_headers)
 
         unless Agent.config[:'distributed_tracing.enabled']
@@ -61,11 +61,11 @@ module NewRelic
         nil
       end
 
-      # Accepts distributed tracing headers from any source that has been packaged 
+      # Accepts distributed tracing headers from any source that has been packaged
       # as a Ruby Hash, thereby allowing the user to manually inject distributed
-      # tracing headers.  It is optimized to process +HTTP_TRACEPARENT+, +HTTP_TRACESTATE+, 
-      # and +HTTP_NEWRELIC+ as the given Hash keys.  which is the most common scenario 
-      # from Rack middleware in most Ruby applications.  However, the Hash keys are 
+      # tracing headers.  It is optimized to process +HTTP_TRACEPARENT+, +HTTP_TRACESTATE+,
+      # and +HTTP_NEWRELIC+ as the given Hash keys.  which is the most common scenario
+      # from Rack middleware in most Ruby applications.  However, the Hash keys are
       # case-insensitive and the "HTTP_" prefixes may also be omitted.
       #
       # Calling this method is not necessary in a typical HTTP trace as
@@ -75,13 +75,13 @@ module NewRelic
       # as calling after the headers are already created will have no effect.
       #
       # This method accepts both W3C trace context and New Relic distributed tracing headers.
-      # When both are present, only the W3C headers are utilized.  When W3C trace context 
+      # When both are present, only the W3C headers are utilized.  When W3C trace context
       # headers are present, New Relic headers are ignored regardless if W3C trace context
-      # headers are valid and parsable.  
+      # headers are valid and parsable.
       #
-      # @param headers         [Hash]     Incoming distributed trace headers as a Ruby 
+      # @param headers         [Hash]     Incoming distributed trace headers as a Ruby
       #                                   Hash object.  Hash keys are expected to be one of
-      #                                   +TRACEPARENT+, +TRACESTATE+, +NEWRELIC+ and are 
+      #                                   +TRACEPARENT+, +TRACESTATE+, +NEWRELIC+ and are
       #                                   case-insensitive, with or without "HTTP_" prefixes.
       #
       #                                   either as a JSON string or as a
@@ -113,14 +113,14 @@ module NewRelic
         # otherwise, fish for key/value pairs regardless of prefix and case-sensitivity.
         hdr = if transport_type.start_with? NewRelic::HTTP
           headers
-        else 
+        else
           # start with the most common case first
           hdr = {
             NewRelic::HTTP_TRACEPARENT_KEY => headers[NewRelic::TRACEPARENT_KEY],
-            NewRelic::HTTP_TRACESTATE_KEY => headers[NewRelic::TRACESTATE_KEY], 
+            NewRelic::HTTP_TRACESTATE_KEY => headers[NewRelic::TRACESTATE_KEY],
             NewRelic::HTTP_NEWRELIC_KEY => headers[NewRelic::NEWRELIC_KEY]
-          } 
-          
+          }
+
           # when not found, search for any casing for trace context headers, ignoring potential prefixes
           hdr[NewRelic::HTTP_TRACEPARENT_KEY] ||= variant_key_value headers, NewRelic::TRACEPARENT_KEY
           hdr[NewRelic::HTTP_TRACESTATE_KEY] ||= variant_key_value headers, NewRelic::TRACESTATE_KEY
@@ -134,7 +134,7 @@ module NewRelic
         NewRelic::Agent.logger.error 'error during accept_distributed_trace_headers', e
         nil
       end
-    
+
       private
 
       def has_variant_key? key, variants
@@ -142,9 +142,8 @@ module NewRelic
       end
 
       def variant_key_value headers, variants
-        (headers.detect{|k, v| has_variant_key?(k, variants)} || NewRelic::EMPTY_ARRAY)[1]
+        (headers.detect { |k, v| has_variant_key?(k, variants) } || NewRelic::EMPTY_ARRAY)[1]
       end
-
     end
   end
 end

data/lib/new_relic/agent/encoding_normalizer.rb

@@ -24,7 +24,7 @@ module NewRelic
           return object if object.empty?
           hash = {}
           object.each_pair do |k, v|
-            k = normalize_string(k)      if k.is_a?(String)
+            k = normalize_string(k) if k.is_a?(String)
             k = normalize_string(k.to_s) if k.is_a?(Symbol)
             hash[k] = normalize_object(v)
           end