newrelic_rpm 8.7.0 → 8.11.0

data/lib/new_relic/agent/transaction/external_request_segment.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
@@ -22,16 +21,17 @@ module NewRelic
         EXTERNAL_ALL_OTHER = "External/allOther"
         MISSING_STATUS_CODE = "MissingHTTPStatusCode"
 
-        attr_reader :library, :uri, :procedure
-        attr_reader :http_status_code
+        attr_reader :library, :uri, :procedure, :http_status_code
+        attr_writer :record_agent_attributes
 
-        def initialize library, uri, procedure, start_time = nil # :nodoc:
+        def initialize(library, uri, procedure, start_time = nil) # :nodoc:
           @library = library
           @uri = HTTPClients::URIUtil.obfuscated_uri(uri)
           @procedure = procedure
           @host_header = nil
           @app_data = nil
           @http_status_code = nil
+          @record_agent_attributes = false
           super(nil, nil, start_time)
         end
 
@@ -43,6 +43,14 @@ module NewRelic
           @host_header || uri.host
         end
 
+        # By default external request segments only have errors and the http
+        # url recorded as agent attributes. To have all the agent attributes
+        # recorded, use the attr_writer like so `segment.record_agent_attributes = true`
+        # See: SpanEventPrimitive#for_external_request_segment
+        def record_agent_attributes?
+          @record_agent_attributes
+        end
+
         # This method adds New Relic request headers to a given request made to an
         # external API and checks to see if a host header is used for the request.
         # If a host header is used, it updates the segment name to match the host
@@ -52,16 +60,16 @@ module NewRelic
         # object (must belong to a subclass of NewRelic::Agent::HTTPClients::AbstractRequest)
         #
         # @api public
-        def add_request_headers request
-          process_host_header request
+        def add_request_headers(request)
+          process_host_header(request)
           synthetics_header = transaction && transaction.raw_synthetics_header
-          insert_synthetics_header request, synthetics_header if synthetics_header
+          insert_synthetics_header(request, synthetics_header) if synthetics_header
 
           return unless record_metrics?
 
-          transaction.distributed_tracer.insert_headers request
+          transaction.distributed_tracer.insert_headers(request)
         rescue => e
-          NewRelic::Agent.logger.error "Error in add_request_headers", e
+          NewRelic::Agent.logger.error("Error in add_request_headers", e)
         end
 
         # This method extracts app data from an external response if present. If
@@ -71,11 +79,11 @@ module NewRelic
         # @param [Hash] response a hash of response headers
         #
         # @api public
-        def read_response_headers response
+        def read_response_headers(response)
           return unless record_metrics? && CrossAppTracing.cross_app_enabled?
           return unless CrossAppTracing.response_has_crossapp_header?(response)
           unless data = CrossAppTracing.extract_appdata(response)
-            NewRelic::Agent.logger.debug "Couldn't extract_appdata from external segment response"
+            NewRelic::Agent.logger.debug("Couldn't extract_appdata from external segment response")
             return
           end
 
@@ -83,10 +91,10 @@ module NewRelic
             @app_data = data
             update_segment_name
           else
-            NewRelic::Agent.logger.debug "External segment response has invalid cross_app_id"
+            NewRelic::Agent.logger.debug("External segment response has invalid cross_app_id")
           end
         rescue => e
-          NewRelic::Agent.logger.error "Error in read_response_headers", e
+          NewRelic::Agent.logger.error("Error in read_response_headers", e)
         end
 
         def cross_app_request? # :nodoc:
@@ -131,7 +139,7 @@ module NewRelic
               ]
             }
 
-            # flag cross app in the state so transaction knows to add bits to paylaod
+            # flag cross app in the state so transaction knows to add bits to payload
             #
             transaction.distributed_tracer.is_cross_app_caller = true
 
@@ -141,11 +149,11 @@ module NewRelic
 
             # obfuscate the generated request metadata JSON
             #
-            obfuscator.obfuscate ::JSON.dump(rmd)
+            obfuscator.obfuscate(::JSON.dump(rmd))
 
           end
         rescue => e
-          NewRelic::Agent.logger.error "error during get_request_metadata", e
+          NewRelic::Agent.logger.error("error during get_request_metadata", e)
         end
 
         # Process obfuscated +String+ sent from a called application that is also running a New Relic agent and
@@ -156,24 +164,24 @@ module NewRelic
         #
         # @api public
         #
-        def process_response_metadata response_metadata
+        def process_response_metadata(response_metadata)
           NewRelic::Agent.record_api_supportability_metric(:process_response_metadata)
           if transaction
             app_data = ::JSON.parse(obfuscator.deobfuscate(response_metadata))[APP_DATA_KEY]
 
             # validate cross app id
             #
-            if Array === app_data and CrossAppTracing.trusted_valid_cross_app_id? app_data[0]
+            if Array === app_data and CrossAppTracing.trusted_valid_cross_app_id?(app_data[0])
               @app_data = app_data
               update_segment_name
             else
-              NewRelic::Agent.logger.error "error processing response metadata: invalid/non-trusted ID"
+              NewRelic::Agent.logger.error("error processing response metadata: invalid/non-trusted ID")
             end
           end
 
           nil
         rescue => e
-          NewRelic::Agent.logger.error "error during process_response_metadata", e
+          NewRelic::Agent.logger.error("error during process_response_metadata", e)
         end
 
         def record_metrics
@@ -181,24 +189,24 @@ module NewRelic
           super
         end
 
-        def process_response_headers response # :nodoc:
-          set_http_status_code response
-          read_response_headers response
+        def process_response_headers(response) # :nodoc:
+          set_http_status_code(response)
+          read_response_headers(response)
         end
 
         private
 
         # Only sets the http_status_code if response.status_code is non-empty value
-        def set_http_status_code response
-          if response.respond_to? :status_code
+        def set_http_status_code(response)
+          if response.respond_to?(:status_code)
             @http_status_code = response.status_code if response.has_status_code?
           else
-            NewRelic::Agent.logger.warn "Cannot extract HTTP Status Code from response #{response.class.to_s}"
-            NewRelic::Agent.record_metric "#{name}/#{MISSING_STATUS_CODE}", 1
+            NewRelic::Agent.logger.warn("Cannot extract HTTP Status Code from response #{response.class.to_s}")
+            NewRelic::Agent.record_metric("#{name}/#{MISSING_STATUS_CODE}", 1)
           end
         end
 
-        def insert_synthetics_header request, header
+        def insert_synthetics_header(request, header)
           request[NR_SYNTHETICS_HEADER] = header
         end
 
@@ -211,7 +219,7 @@ module NewRelic
           super
         end
 
-        def process_host_header request
+        def process_host_header(request)
           if @host_header = request.host_from_header
             update_segment_name
           end

data/lib/new_relic/agent/transaction/message_broker_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/distributed_tracing/cross_app_tracing'
@@ -66,7 +66,7 @@ module NewRelic
           @destination_name = destination_name
           @headers = headers
           super(nil, nil, start_time)
-          params.merge! parameters if parameters
+          params.merge!(parameters) if parameters
         end
 
         def name
@@ -85,12 +85,12 @@ module NewRelic
 
         def transaction_assigned
           if headers && transaction && action == :produce && record_metrics?
-            transaction.distributed_tracer.insert_distributed_trace_header headers
-            transaction.distributed_tracer.insert_cat_headers headers
-            transaction.distributed_tracer.log_request_headers headers
+            transaction.distributed_tracer.insert_distributed_trace_header(headers)
+            transaction.distributed_tracer.insert_cat_headers(headers)
+            transaction.distributed_tracer.log_request_headers(headers)
           end
         rescue => e
-          NewRelic::Agent.logger.error "Error during message header processing", e
+          NewRelic::Agent.logger.error("Error during message header processing", e)
         end
       end
     end

data/lib/new_relic/agent/transaction/request_attributes.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/http_clients/uri_util'
 
@@ -13,56 +13,56 @@ module NewRelic
 
         HTTP_ACCEPT_HEADER_KEY = "HTTP_ACCEPT".freeze
 
-        def initialize request
-          @request_path = path_from_request request
-          @referer = referer_from_request request
-          @accept = attribute_from_env request, HTTP_ACCEPT_HEADER_KEY
-          @content_length = content_length_from_request request
-          @content_type = attribute_from_request request, :content_type
-          @host = attribute_from_request request, :host
-          @port = port_from_request request
-          @user_agent = attribute_from_request request, :user_agent
-          @request_method = attribute_from_request request, :request_method
+        def initialize(request)
+          @request_path = path_from_request(request)
+          @referer = referer_from_request(request)
+          @accept = attribute_from_env(request, HTTP_ACCEPT_HEADER_KEY)
+          @content_length = content_length_from_request(request)
+          @content_type = attribute_from_request(request, :content_type)
+          @host = attribute_from_request(request, :host)
+          @port = port_from_request(request)
+          @user_agent = attribute_from_request(request, :user_agent)
+          @request_method = attribute_from_request(request, :request_method)
         end
 
-        def assign_agent_attributes txn
+        def assign_agent_attributes(txn)
           default_destinations = AttributeFilter::DST_TRANSACTION_TRACER |
             AttributeFilter::DST_TRANSACTION_EVENTS |
             AttributeFilter::DST_ERROR_COLLECTOR
 
           if referer
-            txn.add_agent_attribute :'request.headers.referer', referer, AttributeFilter::DST_ERROR_COLLECTOR
+            txn.add_agent_attribute(:'request.headers.referer', referer, AttributeFilter::DST_ERROR_COLLECTOR)
           end
 
           if request_path
-            txn.add_agent_attribute :'request.uri',
+            txn.add_agent_attribute(:'request.uri',
               request_path,
               AttributeFilter::DST_TRANSACTION_TRACER |
-                AttributeFilter::DST_ERROR_COLLECTOR
+                AttributeFilter::DST_ERROR_COLLECTOR)
           end
 
           if accept
-            txn.add_agent_attribute :'request.headers.accept', accept, default_destinations
+            txn.add_agent_attribute(:'request.headers.accept', accept, default_destinations)
           end
 
           if content_length
-            txn.add_agent_attribute :'request.headers.contentLength', content_length, default_destinations
+            txn.add_agent_attribute(:'request.headers.contentLength', content_length, default_destinations)
           end
 
           if content_type
-            txn.add_agent_attribute :'request.headers.contentType', content_type, default_destinations
+            txn.add_agent_attribute(:'request.headers.contentType', content_type, default_destinations)
           end
 
           if host
-            txn.add_agent_attribute :'request.headers.host', host, default_destinations
+            txn.add_agent_attribute(:'request.headers.host', host, default_destinations)
           end
 
           if user_agent
-            txn.add_agent_attribute :'request.headers.userAgent', user_agent, default_destinations
+            txn.add_agent_attribute(:'request.headers.userAgent', user_agent, default_destinations)
           end
 
           if request_method
-            txn.add_agent_attribute :'request.method', request_method, default_destinations
+            txn.add_agent_attribute(:'request.method', request_method, default_destinations)
           end
         end
 
@@ -71,9 +71,9 @@ module NewRelic
         # Make a safe attempt to get the referer from a request object, generally successful when
         # it's a Rack request.
 
-        def referer_from_request request
+        def referer_from_request(request)
           if referer = attribute_from_request(request, :referer)
-            HTTPClients::URIUtil.strip_query_string referer.to_s
+            HTTPClients::URIUtil.strip_query_string(referer.to_s)
           end
         end
 
@@ -87,31 +87,31 @@ module NewRelic
 
         ROOT_PATH = "/".freeze
 
-        def path_from_request request
+        def path_from_request(request)
           path = attribute_from_request(request, :path) || ''
           path = HTTPClients::URIUtil.strip_query_string(path)
           path.empty? ? ROOT_PATH : path
         end
 
-        def content_length_from_request request
+        def content_length_from_request(request)
           if content_length = attribute_from_request(request, :content_length)
             content_length.to_i
           end
         end
 
-        def port_from_request request
+        def port_from_request(request)
           if port = attribute_from_request(request, :port)
             port.to_i
           end
         end
 
-        def attribute_from_request request, attribute_method
-          if request.respond_to? attribute_method
+        def attribute_from_request(request, attribute_method)
+          if request.respond_to?(attribute_method)
             request.send(attribute_method)
           end
         end
 
-        def attribute_from_env request, key
+        def attribute_from_env(request, key)
           if env = attribute_from_request(request, :env)
             env[key]
           end

data/lib/new_relic/agent/transaction/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/abstract_segment'
 require 'new_relic/agent/span_event_primitive'
@@ -15,9 +15,9 @@ module NewRelic
         # initialize it as an array that would be empty, have one item, or many items.
         attr_reader :unscoped_metrics, :custom_transaction_attributes
 
-        def initialize name = nil, unscoped_metrics = nil, start_time = nil
+        def initialize(name = nil, unscoped_metrics = nil, start_time = nil)
           @unscoped_metrics = unscoped_metrics
-          super name, start_time
+          super(name, start_time)
         end
 
         def attributes
@@ -32,7 +32,7 @@ module NewRelic
           if segment = NewRelic::Agent::Tracer.current_segment
             segment.merge_untrusted_agent_attributes(attributes, prefix, default_destinations)
           else
-            NewRelic::Agent.logger.debug "Attempted to merge untrusted attributes without segment"
+            NewRelic::Agent.logger.debug("Attempted to merge untrusted attributes without segment")
           end
         end
 
@@ -49,16 +49,16 @@ module NewRelic
 
         def record_metrics
           if record_scoped_metric?
-            metric_cache.record_scoped_and_unscoped name, duration, exclusive_duration
+            metric_cache.record_scoped_and_unscoped(name, duration, exclusive_duration)
           else
-            append_unscoped_metric name
+            append_unscoped_metric(name)
           end
           if unscoped_metrics
-            metric_cache.record_unscoped unscoped_metrics, duration, exclusive_duration
+            metric_cache.record_unscoped(unscoped_metrics, duration, exclusive_duration)
           end
         end
 
-        def append_unscoped_metric metric
+        def append_unscoped_metric(metric)
           if @unscoped_metrics
             if Array === @unscoped_metrics
               if unscoped_metrics.frozen?

data/lib/new_relic/agent/transaction/slowest_sample_buffer.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/transaction_sample_buffer'
 

data/lib/new_relic/agent/transaction/synthetics_sample_buffer.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/transaction_sample_buffer'
 

data/lib/new_relic/agent/transaction/trace.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/trace_node'
 
@@ -50,7 +50,7 @@ module NewRelic
         end
 
         def create_node(time_since_start, metric_name = nil)
-          raise FinishedTraceError.new "Can't create additional node for finished trace." if self.finished
+          raise FinishedTraceError.new("Can't create additional node for finished trace.") if self.finished
           self.node_count += 1
           NewRelic::Agent::Transaction::TraceNode.new(metric_name, time_since_start)
         end
@@ -121,7 +121,7 @@ module NewRelic
           }
         end
 
-        def trace_tree attributes_hash
+        def trace_tree(attributes_hash)
           [
             NewRelic::Coerce.float(self.start_time),
             NewRelic::EMPTY_HASH,

data/lib/new_relic/agent/transaction/trace_builder.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/helper'
 require 'new_relic/agent/transaction/trace'
@@ -12,10 +12,10 @@ module NewRelic
       module TraceBuilder
         extend self
 
-        def build_trace transaction
-          trace = Trace.new transaction.start_time
+        def build_trace(transaction)
+          trace = Trace.new(transaction.start_time)
           trace.root_node.exit_timestamp = transaction.end_time - transaction.start_time
-          copy_attributes transaction, trace
+          copy_attributes(transaction, trace)
           first, *rest = transaction.segments
           relationship_map = rest.group_by { |s| s.parent }
           trace.root_node.children << process_segments(transaction, first, trace.root_node, relationship_map)
@@ -25,25 +25,25 @@ module NewRelic
         private
 
         # recursively builds a transaction trace from the flat list of segments
-        def process_segments transaction, segment, parent, relationship_map
-          current = create_trace_node transaction, segment, parent
+        def process_segments(transaction, segment, parent, relationship_map)
+          current = create_trace_node(transaction, segment, parent)
 
           if children = relationship_map[segment]
             current.children = children.map! do |child|
-              process_segments transaction, child, current, relationship_map
+              process_segments(transaction, child, current, relationship_map)
             end
           end
 
           current
         end
 
-        def create_trace_node transaction, segment, parent
+        def create_trace_node(transaction, segment, parent)
           relative_start = segment.start_time - transaction.start_time
           relative_end = segment.end_time - transaction.start_time
-          TraceNode.new segment.name, relative_start, relative_end, segment.params, parent
+          TraceNode.new(segment.name, relative_start, relative_end, segment.params, parent)
         end
 
-        def copy_attributes transaction, trace
+        def copy_attributes(transaction, trace)
           trace.transaction_name = transaction.best_name
           trace.guid = transaction.guid
           trace.attributes = transaction.attributes

data/lib/new_relic/agent/transaction/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
@@ -40,11 +39,11 @@ module NewRelic
         attr_accessor :trace_context_header_data
         attr_reader :trace_state_payload
 
-        def trace_parent_header_present? request
+        def trace_parent_header_present?(request)
           request[NewRelic::HTTP_TRACEPARENT_KEY]
         end
 
-        def accept_trace_context_incoming_request request
+        def accept_trace_context_incoming_request(request)
           header_data = NewRelic::Agent::DistributedTracing::TraceContext.parse(
             format: NewRelic::FORMAT_RACK,
             carrier: request,
@@ -52,28 +51,29 @@ module NewRelic
           )
           return if header_data.nil?
 
-          accept_trace_context header_data
+          accept_trace_context(header_data)
         end
         private :accept_trace_context_incoming_request
 
-        def insert_trace_context_header header, format = NewRelic::FORMAT_NON_RACK
+        def insert_trace_context_header(header, format = NewRelic::FORMAT_NON_RACK)
           return unless Agent.config[:'distributed_tracing.enabled']
 
-          NewRelic::Agent::DistributedTracing::TraceContext.insert \
+          NewRelic::Agent::DistributedTracing::TraceContext.insert( \
             format: format,
             carrier: header,
             trace_id: transaction.trace_id.rjust(32, '0').downcase,
             parent_id: transaction.current_segment.guid,
             trace_flags: transaction.sampled? ? 0x1 : 0x0,
             trace_state: create_trace_state
+          )
 
           @trace_context_inserted = true
 
-          NewRelic::Agent.increment_metric CREATE_SUCCESS_METRIC
+          NewRelic::Agent.increment_metric(CREATE_SUCCESS_METRIC)
           true
         rescue Exception => e
-          NewRelic::Agent.increment_metric CREATE_EXCEPTION_METRIC
-          NewRelic::Agent.logger.warn "Failed to create trace context payload", e
+          NewRelic::Agent.increment_metric(CREATE_EXCEPTION_METRIC)
+          NewRelic::Agent.logger.warn("Failed to create trace context payload", e)
           false
         end
 
@@ -82,9 +82,10 @@ module NewRelic
           payload = create_trace_state_payload
 
           if payload
-            entry = NewRelic::Agent::DistributedTracing::TraceContext.create_trace_state_entry \
+            entry = NewRelic::Agent::DistributedTracing::TraceContext.create_trace_state_entry( \
               entry_key,
               payload.to_s
+            )
           else
             entry = NewRelic::EMPTY_STR
           end
@@ -94,36 +95,37 @@ module NewRelic
 
         def create_trace_state_payload
           unless Agent.config[:'distributed_tracing.enabled']
-            NewRelic::Agent.logger.warn "Not configured to create WC3 trace context payload"
+            NewRelic::Agent.logger.warn("Not configured to create WC3 trace context payload")
             return
           end
 
           span_guid = Agent.config[:'span_events.enabled'] ? transaction.current_segment.guid : nil
           transaction_guid = Agent.config[:'transaction_events.enabled'] ? transaction.guid : nil
 
-          TraceContextPayload.create \
+          TraceContextPayload.create( \
             parent_account_id: Agent.config[:account_id],
             parent_app_id: Agent.config[:primary_application_id],
             transaction_id: transaction_guid,
             sampled: transaction.sampled?,
             priority: float!(transaction.priority, NewRelic::PRIORITY_PRECISION),
             id: span_guid
+          )
         end
 
         def assign_trace_state_payload
           payload = @trace_context_header_data.trace_state_payload
           unless payload
-            NewRelic::Agent.increment_metric NO_NR_ENTRY_TRACESTATE_METRIC
+            NewRelic::Agent.increment_metric(NO_NR_ENTRY_TRACESTATE_METRIC)
             return false
           end
           unless payload.valid?
-            NewRelic::Agent.increment_metric INVALID_TRACESTATE_PAYLOAD_METRIC
+            NewRelic::Agent.increment_metric(INVALID_TRACESTATE_PAYLOAD_METRIC)
             return false
           end
           @trace_state_payload = payload
         end
 
-        def accept_trace_context header_data
+        def accept_trace_context(header_data)
           return if ignore_trace_context?
 
           @trace_context_header_data = header_data
@@ -138,20 +140,20 @@ module NewRelic
             transaction.sampled = payload.sampled
             transaction.priority = payload.priority if payload.priority
           end
-          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 trace context payload", e
+          NewRelic::Agent.increment_metric(ACCEPT_EXCEPTION_METRIC)
+          NewRelic::Agent.logger.warn("Failed to accept trace context payload", e)
           false
         end
 
         def ignore_trace_context?
           if trace_context_header_data
-            NewRelic::Agent.increment_metric IGNORE_MULTIPLE_ACCEPT_METRIC
+            NewRelic::Agent.increment_metric(IGNORE_MULTIPLE_ACCEPT_METRIC)
             return true
           elsif trace_context_inserted?
-            NewRelic::Agent.increment_metric IGNORE_ACCEPT_AFTER_CREATE_METRIC
+            NewRelic::Agent.increment_metric(IGNORE_ACCEPT_AFTER_CREATE_METRIC)
             return true
           end
           false