newrelic_rpm 6.15.0 → 8.13.1

data/lib/new_relic/agent/transaction/datastore_segment.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/agent/transaction/segment'
 require 'new_relic/agent/datastores/metric_helper'
@@ -11,33 +11,31 @@ module NewRelic
   module Agent
     class Transaction
       class DatastoreSegment < Segment
-
         UNKNOWN = 'unknown'.freeze
 
         attr_reader :product, :operation, :collection, :sql_statement, :nosql_statement, :host, :port_path_or_id
         attr_accessor :database_name, :record_sql
 
-
-        def initialize product, operation, collection = nil, host = nil, port_path_or_id = nil, database_name = nil, start_time = nil
+        def initialize(product, operation, collection = nil, host = nil, port_path_or_id = nil, database_name = nil, start_time = nil)
           @product = product
           @operation = operation
           @collection = collection
           @sql_statement = nil
           @nosql_statement = nil
           @record_sql = true
-          set_instance_info host, port_path_or_id
+          set_instance_info(host, port_path_or_id)
           @database_name = database_name ? database_name.to_s : nil
-          super Datastores::MetricHelper.scoped_metric_for(product, operation, collection),
+          super(Datastores::MetricHelper.scoped_metric_for(product, operation, collection),
                 nil,
-                start_time
+                start_time)
         end
 
-        def set_instance_info host = nil, port_path_or_id = nil
+        def set_instance_info(host = nil, port_path_or_id = nil)
           port_path_or_id = port_path_or_id.to_s if port_path_or_id
           host_present = host && !host.empty?
           ppi_present = port_path_or_id && !port_path_or_id.empty?
 
-          host = NewRelic::Agent::Hostname.get_external host if host_present
+          host = NewRelic::Agent::Hostname.get_external(host) if host_present
 
           case
           when host_present && ppi_present
@@ -57,15 +55,16 @@ module NewRelic
           end
         end
 
-        def notice_sql sql
-          _notice_sql sql
+        def notice_sql(sql)
+          _notice_sql(sql)
           nil
         end
 
         # @api private
-        def _notice_sql sql, config=nil, explainer=nil, binds=nil, name=nil
+        def _notice_sql(sql, config = nil, explainer = nil, binds = nil, name = nil)
           return unless record_sql?
-          @sql_statement = Database::Statement.new sql, config, explainer, binds, name, host, port_path_or_id, database_name
+
+          @sql_statement = Database::Statement.new(sql, config, explainer, binds, name, host, port_path_or_id, database_name)
         end
 
         # Method for simplifying attaching non-SQL data statements to a
@@ -85,8 +84,9 @@ module NewRelic
         #   please ensure all data passed to this method is safe to transmit to
         #   New Relic.
 
-        def notice_nosql_statement nosql_statement
+        def notice_nosql_statement(nosql_statement)
           return unless record_sql?
+
           @nosql_statement = Database.truncate_query(nosql_statement)
           nil
         end
@@ -120,8 +120,9 @@ module NewRelic
         NEWLINE = "\n".freeze
 
         def add_backtrace_parameter
-           return unless duration >= Agent.config[:'transaction_tracer.stack_trace_threshold']
-           params[:backtrace] = caller.join(NEWLINE)
+          return unless duration >= Agent.config[:'transaction_tracer.stack_trace_threshold']
+
+          params[:backtrace] = caller.join(NEWLINE)
         end
 
         def notice_sql_statement
@@ -138,8 +139,11 @@ module NewRelic
         end
 
         def record_span_event
+          # don't record a span event if the transaction is ignored
+          return if transaction.ignore?
+
           aggregator = ::NewRelic::Agent.agent.span_event_aggregator
-          priority   = transaction.priority
+          priority = transaction.priority
 
           aggregator.record(priority: priority) do
             SpanEventPrimitive.for_datastore_segment(self)

data/lib/new_relic/agent/transaction/distributed_tracer.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
@@ -26,12 +25,12 @@ module NewRelic
           end
         end
 
-        def accept_incoming_request request, transport_type=nil
-          accept_incoming_transport_type request, transport_type
-          if trace_parent_header_present? request
-            accept_trace_context_incoming_request request
+        def accept_incoming_request(request, transport_type = nil)
+          accept_incoming_transport_type(request, transport_type)
+          if trace_parent_header_present?(request)
+            accept_trace_context_incoming_request(request)
           else
-            accept_distributed_tracing_incoming_request request
+            accept_distributed_tracing_incoming_request(request)
           end
         end
 
@@ -39,126 +38,136 @@ module NewRelic
           @caller_transport_type ||= "Unknown"
         end
 
-        def accept_transport_type_from_api value
-          @caller_transport_type = DistributedTraceTransportType.from value
+        def accept_transport_type_from_api(value)
+          @caller_transport_type = DistributedTraceTransportType.from(value)
         end
 
-        def accept_incoming_transport_type request, transport_type
+        def accept_incoming_transport_type(request, transport_type)
           if transport_type.to_s == NewRelic::EMPTY_STR
-            @caller_transport_type = DistributedTraceTransportType.for_rack_request request
+            @caller_transport_type = DistributedTraceTransportType.for_rack_request(request)
           else
-            @caller_transport_type = DistributedTraceTransportType.from transport_type
+            @caller_transport_type = DistributedTraceTransportType.from(transport_type)
           end
         end
 
-        def initialize transaction
+        def initialize(transaction)
           @transaction = transaction
         end
 
         def record_metrics
           record_cross_app_metrics
-          DistributedTraceMetrics.record_metrics_for_transaction transaction
+          DistributedTraceMetrics.record_metrics_for_transaction(transaction)
         end
 
-        def append_payload payload
-          append_cat_info payload
-          DistributedTraceAttributes.copy_from_transaction \
+        def append_payload(payload)
+          append_cat_info(payload)
+          DistributedTraceAttributes.copy_from_transaction( \
             transaction,
             trace_state_payload || distributed_trace_payload,
             payload
+          )
         end
 
-        def log_request_headers headers, direction = "OUTGOING"
-          NewRelic::Agent.logger.debug "#{direction} REQUEST HEADERS: #{headers}"
+        def log_request_headers(headers, direction = "OUTGOING")
+          NewRelic::Agent.logger.debug("#{direction} REQUEST HEADERS: #{headers}")
         end
 
-        def insert_headers headers
-          insert_trace_context_header headers
-          insert_distributed_trace_header headers
-          insert_cross_app_header headers
-          log_request_headers headers
+        def insert_headers(headers)
+          return unless NewRelic::Agent.agent.connected?
+
+          insert_trace_context_header(headers)
+          insert_distributed_trace_header(headers)
+          insert_cross_app_header(headers)
+          log_request_headers(headers)
         end
 
-        def consume_message_headers headers, tracer_state, transport_type
-          log_request_headers headers, "INCOMING"
-          consume_message_distributed_tracing_headers headers, transport_type
-          consume_message_cross_app_tracing_headers headers, tracer_state
-          consume_message_synthetics_headers headers
+        def consume_message_headers(headers, tracer_state, transport_type)
+          log_request_headers(headers, "INCOMING")
+          consume_message_distributed_tracing_headers(headers, transport_type)
+          consume_message_cross_app_tracing_headers(headers, tracer_state)
+          consume_message_synthetics_headers(headers)
         rescue => e
-          NewRelic::Agent.logger.error "Error in consume_message_headers", e
+          NewRelic::Agent.logger.error("Error in consume_message_headers", e)
         end
 
         def assign_intrinsics
-          if Agent.config[:'distributed_tracing.enabled']
-            DistributedTraceAttributes.copy_to_attributes transaction.payload, transaction.attributes
+          if dt_enabled?
+            DistributedTraceAttributes.copy_to_attributes(transaction.payload, transaction.attributes)
           elsif is_cross_app?
             assign_cross_app_intrinsics
           end
         end
 
-        def insert_distributed_trace_header headers
-          return unless Agent.config[:'distributed_tracing.enabled']
+        def insert_distributed_trace_header(headers)
+          return unless dt_enabled?
           return if Agent.config[:'exclude_newrelic_header']
+
           payload = create_distributed_trace_payload
           headers[NewRelic::NEWRELIC_KEY] = payload.http_safe if payload
         end
 
-        def insert_cat_headers headers
+        def insert_cat_headers(headers)
           return unless CrossAppTracing.cross_app_enabled?
+
           @is_cross_app_caller = true
-          insert_message_headers headers,
+          insert_message_headers(headers,
             transaction.guid,
             cat_trip_id,
             cat_path_hash,
-            transaction.raw_synthetics_header
+            transaction.raw_synthetics_header)
         end
 
         private
 
-        def consume_message_synthetics_headers headers
+        def dt_enabled?
+          Agent.config[:'distributed_tracing.enabled']
+        end
+
+        def consume_message_synthetics_headers(headers)
           synthetics_header = headers[CrossAppTracing::NR_MESSAGE_BROKER_SYNTHETICS_HEADER]
           if synthetics_header and
-             incoming_payload = ::JSON.load(deobfuscate(synthetics_header)) and
-             SyntheticsMonitor.is_valid_payload?(incoming_payload) and
-             SyntheticsMonitor.is_supported_version?(incoming_payload) and
-             SyntheticsMonitor.is_trusted?(incoming_payload)
+              incoming_payload = ::JSON.load(deobfuscate(synthetics_header)) and
+              SyntheticsMonitor.is_valid_payload?(incoming_payload) and
+              SyntheticsMonitor.is_supported_version?(incoming_payload) and
+              SyntheticsMonitor.is_trusted?(incoming_payload)
 
             transaction.raw_synthetics_header = synthetics_header
             transaction.synthetics_payload = incoming_payload
           end
         rescue => e
-          NewRelic::Agent.logger.error "Error in consume_message_synthetics_header", e
+          NewRelic::Agent.logger.error("Error in consume_message_synthetics_header", e)
         end
 
-        def consume_message_distributed_tracing_headers headers, transport_type
-          return unless Agent.config[:'distributed_tracing.enabled']
+        def consume_message_distributed_tracing_headers(headers, transport_type)
+          return unless dt_enabled?
 
-          accept_incoming_transport_type headers, transport_type
+          accept_incoming_transport_type(headers, transport_type)
 
           newrelic_trace_key = NewRelic::CANDIDATE_NEWRELIC_KEYS.detect do |key|
             headers.has_key?(key)
           end
           return unless newrelic_trace_key && (payload = headers[newrelic_trace_key])
 
-          accept_distributed_trace_payload payload
+          accept_distributed_trace_payload(payload)
         end
 
-        def consume_message_cross_app_tracing_headers headers, tracer_state
+        def consume_message_cross_app_tracing_headers(headers, tracer_state)
           return unless CrossAppTracing.cross_app_enabled?
           return unless CrossAppTracing.message_has_crossapp_request_header?(headers)
 
-          accept_cross_app_payload headers, tracer_state
-          CrossAppTracing.assign_intrinsic_transaction_attributes tracer_state
+          accept_cross_app_payload(headers, tracer_state)
+          CrossAppTracing.assign_intrinsic_transaction_attributes(tracer_state)
         end
 
-        def accept_cross_app_payload headers, tracer_state
+        def accept_cross_app_payload(headers, tracer_state)
           encoded_id = headers[CrossAppTracing::NR_MESSAGE_BROKER_ID_HEADER]
           decoded_id = encoded_id.nil? ? EMPTY_STRING : deobfuscate(encoded_id)
 
           return unless CrossAppTracing.trusted_valid_cross_app_id?(decoded_id)
+
           txn_header = headers[CrossAppTracing::NR_MESSAGE_BROKER_TXN_HEADER]
-          txn_info   = ::JSON.load(deobfuscate(txn_header))
-          payload    = CrossAppPayload.new(decoded_id, transaction, txn_info)
+          txn_info = ::JSON.load(deobfuscate(txn_header))
+          payload = CrossAppPayload.new(decoded_id, transaction, txn_info)
 
           @cross_app_payload = payload
         rescue => e
@@ -166,12 +175,10 @@ module NewRelic
           nil
         end
 
-        def deobfuscate message
-          CrossAppTracing.obfuscator.deobfuscate message
+        def deobfuscate(message)
+          CrossAppTracing.obfuscator.deobfuscate(message)
         end
-
       end
     end
   end
 end
-

data/lib/new_relic/agent/transaction/distributed_tracing.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
@@ -14,21 +13,21 @@ module NewRelic
         attr_accessor :distributed_trace_payload
         attr_writer :distributed_trace_payload_created
 
-        SUPPORTABILITY_DISTRIBUTED_TRACE       = "Supportability/DistributedTrace"
-        CREATE_PREFIX                          = "#{SUPPORTABILITY_DISTRIBUTED_TRACE}/CreatePayload"
-        ACCEPT_PREFIX                          = "#{SUPPORTABILITY_DISTRIBUTED_TRACE}/AcceptPayload"
-        IGNORE_PREFIX                          = "#{ACCEPT_PREFIX}/Ignored"
-
-        CREATE_SUCCESS_METRIC                  = "#{CREATE_PREFIX}/Success"
-        CREATE_EXCEPTION_METRIC                = "#{CREATE_PREFIX}/Exception"
-        ACCEPT_SUCCESS_METRIC                  = "#{ACCEPT_PREFIX}/Success"
-        ACCEPT_EXCEPTION_METRIC                = "#{ACCEPT_PREFIX}/Exception"
-        ACCEPT_PARSE_EXCEPTION_METRIC          = "#{ACCEPT_PREFIX}/ParseException"
-
-        IGNORE_ACCEPT_AFTER_CREATE_METRIC      = "#{IGNORE_PREFIX}/CreateBeforeAccept"
-        IGNORE_MULTIPLE_ACCEPT_METRIC          = "#{IGNORE_PREFIX}/Multiple"
-        IGNORE_ACCEPT_NULL_METRIC              = "#{IGNORE_PREFIX}/Null"
-        IGNORE_ACCEPT_MAJOR_VERSION_METRIC     = "#{IGNORE_PREFIX}/MajorVersion"
+        SUPPORTABILITY_DISTRIBUTED_TRACE = "Supportability/DistributedTrace"
+        CREATE_PREFIX = "#{SUPPORTABILITY_DISTRIBUTED_TRACE}/CreatePayload"
+        ACCEPT_PREFIX = "#{SUPPORTABILITY_DISTRIBUTED_TRACE}/AcceptPayload"
+        IGNORE_PREFIX = "#{ACCEPT_PREFIX}/Ignored"
+
+        CREATE_SUCCESS_METRIC = "#{CREATE_PREFIX}/Success"
+        CREATE_EXCEPTION_METRIC = "#{CREATE_PREFIX}/Exception"
+        ACCEPT_SUCCESS_METRIC = "#{ACCEPT_PREFIX}/Success"
+        ACCEPT_EXCEPTION_METRIC = "#{ACCEPT_PREFIX}/Exception"
+        ACCEPT_PARSE_EXCEPTION_METRIC = "#{ACCEPT_PREFIX}/ParseException"
+
+        IGNORE_ACCEPT_AFTER_CREATE_METRIC = "#{IGNORE_PREFIX}/CreateBeforeAccept"
+        IGNORE_MULTIPLE_ACCEPT_METRIC = "#{IGNORE_PREFIX}/Multiple"
+        IGNORE_ACCEPT_NULL_METRIC = "#{IGNORE_PREFIX}/Null"
+        IGNORE_ACCEPT_MAJOR_VERSION_METRIC = "#{IGNORE_PREFIX}/MajorVersion"
         IGNORE_ACCEPT_UNTRUSTED_ACCOUNT_METRIC = "#{IGNORE_PREFIX}/UntrustedAccount"
 
         LBRACE = "{"
@@ -36,11 +35,11 @@ module NewRelic
 
         NEWRELIC_TRACE_KEY = "HTTP_NEWRELIC"
 
-        def accept_distributed_tracing_incoming_request request
+        def accept_distributed_tracing_incoming_request(request)
           return unless Agent.config[:'distributed_tracing.enabled']
           return unless payload = request[NEWRELIC_TRACE_KEY]
 
-          accept_distributed_trace_payload payload
+          accept_distributed_trace_payload(payload)
         end
 
         def distributed_trace_payload_created?
@@ -51,16 +50,16 @@ module NewRelic
           return unless Agent.config[:'distributed_tracing.enabled']
 
           @distributed_trace_payload_created = true
-          payload = DistributedTracePayload.for_transaction transaction
-          NewRelic::Agent.increment_metric CREATE_SUCCESS_METRIC
+          payload = DistributedTracePayload.for_transaction(transaction)
+          NewRelic::Agent.increment_metric(CREATE_SUCCESS_METRIC)
           payload
         rescue => e
-          NewRelic::Agent.increment_metric CREATE_EXCEPTION_METRIC
-          NewRelic::Agent.logger.warn "Failed to create distributed trace payload", e
+          NewRelic::Agent.increment_metric(CREATE_EXCEPTION_METRIC)
+          NewRelic::Agent.logger.warn("Failed to create distributed trace payload", e)
           nil
         end
 
-        def accept_distributed_trace_payload payload
+        def accept_distributed_trace_payload(payload)
           return unless Agent.config[:'distributed_tracing.enabled']
 
           return false if check_payload_ignored(payload)
@@ -72,11 +71,11 @@ module NewRelic
 
           assign_payload_and_sampling_params(payload)
 
-          NewRelic::Agent.increment_metric ACCEPT_SUCCESS_METRIC
+          NewRelic::Agent.increment_metric(ACCEPT_SUCCESS_METRIC)
           true
         rescue => e
-          NewRelic::Agent.increment_metric ACCEPT_EXCEPTION_METRIC
-          NewRelic::Agent.logger.warn "Failed to accept distributed trace payload", e
+          NewRelic::Agent.increment_metric(ACCEPT_EXCEPTION_METRIC)
+          NewRelic::Agent.logger.warn("Failed to accept distributed trace payload", e)
           false
         end
 
@@ -84,10 +83,10 @@ module NewRelic
 
         def check_payload_ignored(payload)
           if distributed_trace_payload
-            NewRelic::Agent.increment_metric IGNORE_MULTIPLE_ACCEPT_METRIC
+            NewRelic::Agent.increment_metric(IGNORE_MULTIPLE_ACCEPT_METRIC)
             return true
           elsif distributed_trace_payload_created?
-            NewRelic::Agent.increment_metric IGNORE_ACCEPT_AFTER_CREATE_METRIC
+            NewRelic::Agent.increment_metric(IGNORE_ACCEPT_AFTER_CREATE_METRIC)
             return true
           end
           false
@@ -96,7 +95,7 @@ module NewRelic
         def check_payload_present(payload)
           # We might be passed a Ruby `nil` object _or_ the JSON "null"
           if payload.nil? || payload == NULL_PAYLOAD
-            NewRelic::Agent.increment_metric IGNORE_ACCEPT_NULL_METRIC
+            NewRelic::Agent.increment_metric(IGNORE_ACCEPT_NULL_METRIC)
             return nil
           end
 
@@ -104,34 +103,34 @@ module NewRelic
         end
 
         def decode_payload(payload)
-          decoded = if payload.start_with? LBRACE
-            DistributedTracePayload.from_json payload
+          decoded = if payload.start_with?(LBRACE)
+            DistributedTracePayload.from_json(payload)
           else
-            DistributedTracePayload.from_http_safe payload
+            DistributedTracePayload.from_http_safe(payload)
           end
 
           return nil unless check_payload_present(decoded)
 
           decoded
         rescue => e
-          NewRelic::Agent.increment_metric ACCEPT_PARSE_EXCEPTION_METRIC
-          NewRelic::Agent.logger.warn "Error parsing distributed trace payload", e
+          NewRelic::Agent.increment_metric(ACCEPT_PARSE_EXCEPTION_METRIC)
+          NewRelic::Agent.logger.warn("Error parsing distributed trace payload", e)
           nil
         end
 
         def check_required_fields_present(payload)
           if \
             !payload.version.nil? &&
-            !payload.parent_account_id.nil? &&
-            !payload.parent_app_id.nil? &&
-            !payload.parent_type.nil? &&
-            (!payload.transaction_id.nil? || !payload.id.nil?) &&
-            !payload.trace_id.nil? &&
-            !payload.timestamp.nil?
+                !payload.parent_account_id.nil? &&
+                !payload.parent_app_id.nil? &&
+                !payload.parent_type.nil? &&
+                (!payload.transaction_id.nil? || !payload.id.nil?) &&
+                !payload.trace_id.nil? &&
+                !payload.timestamp.nil?
 
             true
           else
-            NewRelic::Agent.increment_metric ACCEPT_PARSE_EXCEPTION_METRIC
+            NewRelic::Agent.increment_metric(ACCEPT_PARSE_EXCEPTION_METRIC)
             false
           end
         end
@@ -140,7 +139,7 @@ module NewRelic
           if DistributedTracePayload.major_version_matches?(payload)
             true
           else
-            NewRelic::Agent.increment_metric IGNORE_ACCEPT_MAJOR_VERSION_METRIC
+            NewRelic::Agent.increment_metric(IGNORE_ACCEPT_MAJOR_VERSION_METRIC)
             false
           end
         end
@@ -148,7 +147,7 @@ module NewRelic
         def check_trusted_account(payload)
           compare_key = payload.trusted_account_key || payload.parent_account_id
           unless compare_key == NewRelic::Agent.config[:trusted_account_key]
-            NewRelic::Agent.increment_metric IGNORE_ACCEPT_UNTRUSTED_ACCOUNT_METRIC
+            NewRelic::Agent.increment_metric(IGNORE_ACCEPT_UNTRUSTED_ACCOUNT_METRIC)
             return false
           end
           true
@@ -157,6 +156,7 @@ module NewRelic
         def assign_payload_and_sampling_params(payload)
           @distributed_trace_payload = payload
           return if transaction.distributed_tracer.trace_context_header_data
+
           transaction.trace_id = payload.trace_id
           transaction.distributed_tracer.parent_transaction_id = payload.transaction_id
           transaction.parent_span_id = payload.id
@@ -170,4 +170,3 @@ module NewRelic
     end
   end
 end
-