newrelic_rpm 8.2.0 → 9.0.0

data/lib/new_relic/agent/external.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/tracing'
 require 'new_relic/agent/distributed_tracing/cross_app_tracing'
@@ -18,12 +18,12 @@ module NewRelic
     module External
       extend self
 
-      NON_HTTP_CAT_ID_HEADER  = 'NewRelicID'.freeze
+      NON_HTTP_CAT_ID_HEADER = 'NewRelicID'.freeze
       NON_HTTP_CAT_TXN_HEADER = 'NewRelicTransaction'.freeze
       NON_HTTP_CAT_SYNTHETICS_HEADER = 'NewRelicSynthetics'.freeze
       NON_HTTP_CAT_CONTENT_LENGTH = -1
 
-      # Process obfuscated +String+ indentifying a calling application and transaction that is also running a
+      # Process obfuscated +String+ identifying a calling application and transaction that is also running a
       # New Relic agent and save information in current transaction for inclusion in a trace. The +String+ is
       # generated by +get_request_metadata+ on the calling application.
       #
@@ -31,13 +31,13 @@ module NewRelic
       #
       # @api public
       #
-      def process_request_metadata request_metadata
+      def process_request_metadata(request_metadata)
         NewRelic::Agent.record_api_supportability_metric(:process_request_metadata)
         return unless CrossAppTracing.cross_app_enabled?
 
         state = NewRelic::Agent::Tracer.state
         if transaction = state.current_transaction
-          rmd = ::JSON.parse obfuscator.deobfuscate(request_metadata)
+          rmd = ::JSON.parse(obfuscator.deobfuscate(request_metadata))
 
           # handle/check ID
           #
@@ -48,24 +48,24 @@ module NewRelic
               payload = CrossAppPayload.new(id, transaction, txn_info)
               transaction.distributed_tracer.cross_app_payload = payload
 
-              CrossAppTracing.assign_intrinsic_transaction_attributes state
+              CrossAppTracing.assign_intrinsic_transaction_attributes(state)
             end
 
             # handle synthetics
             #
             if synth = rmd[NON_HTTP_CAT_SYNTHETICS_HEADER]
               transaction.synthetics_payload = synth
-              transaction.raw_synthetics_header = obfuscator.obfuscate ::JSON.dump(synth)
+              transaction.raw_synthetics_header = obfuscator.obfuscate(::JSON.dump(synth))
             end
 
           else
-            NewRelic::Agent.logger.error "error processing request metadata: invalid/non-trusted ID: '#{id}'"
+            NewRelic::Agent.logger.error("error processing request metadata: invalid/non-trusted ID: '#{id}'")
           end
 
           nil
         end
       rescue => e
-        NewRelic::Agent.logger.error 'error during process_request_metadata', e
+        NewRelic::Agent.logger.error('error during process_request_metadata', e)
       end
 
       # Obtain an obfuscated +String+ suitable for delivery across public networks that carries transaction
@@ -94,10 +94,10 @@ module NewRelic
 
           # obfuscate the generated response metadata JSON
           #
-          obfuscator.obfuscate ::JSON.dump(rmd)
+          obfuscator.obfuscate(::JSON.dump(rmd))
         end
       rescue => e
-        NewRelic::Agent.logger.error "error during get_response_metadata", e
+        NewRelic::Agent.logger.error("error during get_response_metadata", e)
       end
 
       private
@@ -105,7 +105,6 @@ module NewRelic
       def obfuscator
         CrossAppTracing.obfuscator
       end
-
     end
   end
 end

data/lib/new_relic/agent/guid_generator.rb

@@ -1,28 +1,30 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 module NewRelic
   module Agent
     module GuidGenerator
-
-      HEX_DIGITS = (0..15).map{|i| i.to_s(16)}
-
       module_function
 
+      MAX_RAND_16 = 16**16
+      MAX_RAND_32 = 16**32
       # This method intentionally does not use SecureRandom, because it relies
       # on urandom, which raises an exception in MRI when the interpreter runs
       # out of allocated file descriptors.
       # The guids generated by this method may not be _secure_, but they are
       # random enough for our purposes.
-      def generate_guid length = 16
-        guid = ''
-        length.times do |a|
-          guid << HEX_DIGITS[rand(16)]
-        end
-        guid
+      def generate_guid(length = 16)
+        guid = case length
+               when 16
+                 rand(MAX_RAND_16)
+               when 32
+                 rand(MAX_RAND_32)
+               else
+                 rand(16**length)
+        end.to_s(16)
+        guid.length < length ? guid.rjust(length, '0') : guid
       end
-
     end
   end
 end

data/lib/new_relic/agent/harvester.rb

@@ -1,15 +1,14 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 module NewRelic
   module Agent
     class Harvester
-
       attr_accessor :starting_pid
 
       # Inject target for after_fork call to avoid spawning thread in tests
-      def initialize(events, after_forker=NewRelic::Agent)
+      def initialize(events, after_forker = NewRelic::Agent)
         # We intentionally don't set our pid as started at this point.
         # Startup routines must call mark_started when they consider us set!
         @starting_pid = nil
@@ -22,8 +21,8 @@ module NewRelic
 
       def on_transaction(*_)
         return unless restart_in_children_enabled? &&
-                        needs_restart? &&
-                        harvest_thread_enabled?
+          needs_restart? &&
+          harvest_thread_enabled?
 
         restart_harvest_thread
       end

data/lib/new_relic/agent/heap.rb

@@ -1,12 +1,12 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 module NewRelic
   module Agent
     # This class implements a min Heap. The first element is always the one with the
     # lowest priority. It is a tree structure that is represented as an array. The
-    # relationship between between nodes in the tree and indices in the array are as
+    # relationship between nodes in the tree and indices in the array are as
     # follows:
     #
     # parent_index      = (child_index -  1) / 2
@@ -18,8 +18,7 @@ module NewRelic
     #
 
     class Heap
-
-      # @param [Array] items an optional array of items to intialize the heap
+      # @param [Array] items an optional array of items to initialize the heap
       #
       # @param [Callable] priority_fn an optional priority function used to
       #   to compute the priority for an item. If it's not supplied priority
@@ -27,7 +26,7 @@ module NewRelic
       def initialize(items = nil, &priority_fn)
         @items = []
         @priority_fn = priority_fn || ->(x) { x }
-        items.each{ |item| push(item) } if items
+        items.each { |item| push(item) } if items
       end
 
       def [](index)
@@ -90,12 +89,12 @@ module NewRelic
         @priority_fn.call(@items[index])
       end
 
-      def parent_index_for child_index
+      def parent_index_for(child_index)
         (child_index - 1) / 2
       end
 
-      def left_child_index_for parent_index
-        2 * parent_index + 1
+      def left_child_index_for(parent_index)
+        parent_index * 2 + 1
       end
 
       def right_sibling_smaller?(lchild_index)
@@ -135,6 +134,5 @@ module NewRelic
         @items[i], @items[j] = @items[j], @items[i]
       end
     end
-
   end
 end

data/lib/new_relic/agent/hostname.rb

@@ -1,7 +1,9 @@
-# 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 'socket'
+require 'new_relic/helper'
 
 module NewRelic
   module Agent
@@ -17,17 +19,22 @@ module NewRelic
         end
       end
 
-      # calling hostname with -f on some OS's (NetBSD, FreeBSD, Solaris)
-      # produces invalid option error, but doesn't raise exception.  Instead,
-      # we get back empty string.  So, solution here is to check for non-zero 
-      # exit status and retry the command without the -f flag.
+      # Pass '-f' to the external executable 'hostname' to request the fully
+      # qualified domain name (fqdn). For implementations of 'hostname' that
+      # do not support '-f' (such as the one OpenBSD ships with), fall back
+      # to calling 'hostname' without the '-f'. If both ways of calling
+      # 'hostname' fail, or in a context where 'hostname' is not even
+      # available (within an AWS Lambda function, for example), call the
+      # 'get' method which uses Socket instead of an external executable.
       def self.get_fqdn
-        fqdn = %x[hostname -f].chomp!
-        fqdn = %x[hostname].chomp! unless $?.exitstatus.zero?
-        fqdn
-      rescue => e
-        NewRelic::Agent.logger.debug "Unable to determine fqdn #{e}"
-        nil
+        begin
+          NewRelic::Helper.run_command('hostname -f')
+        rescue NewRelic::CommandRunFailedError
+          NewRelic::Helper.run_command('hostname')
+        end
+      rescue NewRelic::CommandExecutableNotFoundError, NewRelic::CommandRunFailedError => e
+        NewRelic::Agent.logger.debug("#{e.class} - #{e.message}")
+        get
       end
 
       def self.heroku_dyno_name_prefix(dyno_name)
@@ -50,11 +57,11 @@ module NewRelic
         ::
       ].freeze
 
-      def self.local? host_or_ip
+      def self.local?(host_or_ip)
         LOCALHOST.include?(host_or_ip)
       end
 
-      def self.get_external host_or_ip
+      def self.get_external(host_or_ip)
         local?(host_or_ip) ? get : host_or_ip
       end
     end

data/lib/new_relic/agent/http_clients/abstract.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
@@ -15,7 +14,6 @@ module NewRelic
       #
       # @api public
       class AbstractRequest
-
         def []
           raise NotImplementedError, MUST_IMPLEMENT_ERROR % [self.class, __method__]
         end
@@ -41,15 +39,15 @@ module NewRelic
         end
       end
 
-      # This class implements the adaptor pattern and is used internally provide 
+      # This class implements the adaptor pattern and is used internally provide
       # uniform access to the underlying HTTP Client's response object
       # NOTE: response_object should be non-nil!
       class AbstractResponse # :nodoc:
-
         def initialize(wrapped_response)
-          if wrapped_response.nil? 
+          if wrapped_response.nil?
             raise ArgumentError, WHINY_NIL_ERROR % self.class
           end
+
           @wrapped_response = wrapped_response
         end
 
@@ -57,24 +55,25 @@ module NewRelic
           !!status_code
         end
 
-        # most HTTP client libraries report the HTTP status code as an integer, so 
+        # most HTTP client libraries report the HTTP status code as an integer, so
         # we expect status_code to be set only if a non-zero value is present
         def status_code
           @status_code ||= get_status_code
         end
 
-        private 
+        private
 
         def get_status_code_using(method_name)
           return unless @wrapped_response.respond_to?(method_name)
+
           code = @wrapped_response.send(method_name).to_i
           code == 0 ? nil : code
         end
 
-        # Override this method to memoize a non-zero Integer representation 
+        # Override this method to memoize a non-zero Integer representation
         # of HTTP status code from the response object
         def get_status_code
-          get_status_code_using :code
+          get_status_code_using(:code)
         end
       end
     end

data/lib/new_relic/agent/http_clients/curb_wrappers.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
@@ -8,13 +7,12 @@ require_relative 'abstract'
 module NewRelic
   module Agent
     module HTTPClients
-
       class CurbRequest
         CURB = 'Curb'
         LHOST = 'host'
         UHOST = 'Host'
 
-        def initialize curlobj
+        def initialize(curlobj)
           @curlobj = curlobj
         end
 
@@ -34,7 +32,7 @@ module NewRelic
           @curlobj._nr_http_verb
         end
 
-        def []( key )
+        def [](key)
           @curlobj.headers[key]
         end
 
@@ -48,9 +46,8 @@ module NewRelic
       end
 
       class CurbResponse < AbstractResponse
-
-        def initialize wrapped_response
-          super wrapped_response
+        def initialize(wrapped_response)
+          super(wrapped_response)
           @headers = {}
         end
 
@@ -62,7 +59,7 @@ module NewRelic
           @headers.dup
         end
 
-        def append_header_data data
+        def append_header_data(data)
           key, value = data.split(/:\s*/, 2)
           @headers[key.downcase] = value
           @wrapped_response._nr_header_str ||= String.new
@@ -72,11 +69,9 @@ module NewRelic
         private
 
         def get_status_code
-          get_status_code_using :response_code
+          get_status_code_using(:response_code)
         end
       end
-
     end
-
   end
 end

data/lib/new_relic/agent/http_clients/excon_wrappers.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
@@ -9,8 +8,8 @@ module NewRelic
   module Agent
     module HTTPClients
       class ExconHTTPResponse < AbstractResponse
-        def initialize wrapped_response
-          super wrapped_response
+        def initialize(wrapped_response)
+          super(wrapped_response)
 
           # Since HTTP headers are case-insensitive, we normalize all of them to
           # upper case here, and then also in our [](key) implementation.
@@ -30,9 +29,9 @@ module NewRelic
 
         private
 
-        def get_attribute name
-          if @wrapped_response.respond_to?(name) 
-            @wrapped_response.send(name) 
+        def get_attribute(name)
+          if @wrapped_response.respond_to?(name)
+            @wrapped_response.send(name)
           else
             @wrapped_response[name]
           end
@@ -57,8 +56,8 @@ module NewRelic
 
           @method = @datum[:method].to_s.upcase
           @scheme = @datum[:scheme]
-          @port   = @datum[:port]
-          @path   = @datum[:path]
+          @port = @datum[:port]
+          @path = @datum[:path]
         end
 
         def type
@@ -87,7 +86,7 @@ module NewRelic
 
         def uri
           url = "#{@scheme}://#{host}:#{@port}#{@path}"
-          URIUtil.parse_and_normalize_url url
+          URIUtil.parse_and_normalize_url(url)
         end
       end
     end

data/lib/new_relic/agent/http_clients/http_rb_wrappers.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
@@ -10,7 +9,7 @@ module NewRelic
     module HTTPClients
       class HTTPResponse < AbstractResponse
         def [](key)
-          _, value = @wrapped_response.headers.find{ |k, _| key.downcase == k.downcase }
+          _, value = @wrapped_response.headers.find { |k, _| key.casecmp(k) == 0 }
           value unless value.nil?
         end
 
@@ -21,10 +20,10 @@ module NewRelic
 
       class HTTPRequest < AbstractRequest
         HTTP_RB = 'http.rb'
-        HOST    = 'host'
-        COLON   = ':'
+        HOST = 'host'
+        COLON = ':'
 
-        def initialize wrapped_request
+        def initialize(wrapped_request)
           @wrapped_request = wrapped_request
         end
 

data/lib/new_relic/agent/http_clients/httpclient_wrappers.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
@@ -9,10 +8,9 @@ module NewRelic
   module Agent
     module HTTPClients
       class HTTPClientResponse < AbstractResponse
-
         def [](key)
-          @wrapped_response.headers.each do |k,v|
-            if key.downcase == k.downcase
+          @wrapped_response.headers.each do |k, v|
+            if key.casecmp(k) == 0
               return v
             end
           end

data/lib/new_relic/agent/http_clients/net_http_wrappers.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
@@ -10,7 +9,6 @@ module NewRelic
   module Agent
     module HTTPClients
       class NetHTTPResponse < AbstractResponse
-
         def [](key)
           @wrapped_response[key]
         end
@@ -63,14 +61,14 @@ module NewRelic
             ::NewRelic::Agent::HTTPClients::URIUtil.parse_and_normalize_url(@request.path)
           else
             connection_address = @connection.address
-            if (connection_address =~ Resolv::IPv6::Regex)
+            if connection_address =~ Resolv::IPv6::Regex
               connection_address = "[#{connection_address}]"
             end
 
             scheme = @connection.use_ssl? ? 'https' : 'http'
             ::NewRelic::Agent::HTTPClients::URIUtil.parse_and_normalize_url(
               "#{scheme}://#{connection_address}:#{@connection.port}#{@request.path}"
-              )
+            )
           end
         end
       end

data/lib/new_relic/agent/http_clients/typhoeus_wrappers.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
@@ -9,20 +8,19 @@ module NewRelic
   module Agent
     module HTTPClients
       class TyphoeusHTTPResponse < AbstractResponse
-
         def [](key)
           unless headers.nil?
             result = headers[key]
 
             # Typhoeus 0.5.3 has a bug where asking the headers hash for a
-            # non-existent header will return the hash itself, not what we want.
+            # nonexistent header will return the hash itself, not what we want.
             result == headers ? nil : result
           end
         end
 
         def to_hash
           hash = {}
-          headers.each do |(k,v)|
+          headers.each do |(k, v)|
             hash[k] = v
           end
           hash
@@ -41,7 +39,7 @@ module NewRelic
           @uri = case request.url
             when ::URI then request.url
             else NewRelic::Agent::HTTPClients::URIUtil.parse_and_normalize_url(request.url)
-            end
+          end
         end
 
         TYPHOEUS = "Typhoeus".freeze
@@ -69,6 +67,7 @@ module NewRelic
 
         def [](key)
           return nil unless @request.options && @request.options[:headers]
+
           @request.options[:headers][key]
         end
 

data/lib/new_relic/agent/http_clients/uri_util.rb

@@ -1,5 +1,4 @@
 # -*- ruby -*-
-# 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,7 +13,6 @@ module NewRelic
   module Agent
     module HTTPClients
       module URIUtil
-
         def self.obfuscated_uri(url)
           parse_and_normalize_url(url).tap do |obfuscated|
             obfuscated.user = nil
@@ -45,7 +43,7 @@ module NewRelic
         QUESTION_MARK = "?"
 
         def self.strip_query_string(fragment)
-          if fragment.include? QUESTION_MARK
+          if fragment.include?(QUESTION_MARK)
             fragment.split(QUESTION_MARK).first
           else
             fragment

data/lib/new_relic/agent/instrumentation/action_cable_subscriber.rb

@@ -1,18 +1,16 @@
-# 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/instrumentation/notifications_subscriber'
 
 module NewRelic
   module Agent
     module Instrumentation
       class ActionCableSubscriber < NotificationsSubscriber
-
         PERFORM_ACTION = 'perform_action.action_cable'.freeze
 
-        def start(name, id, payload) #THREAD_LOCAL_ACCESS
-          return unless state.is_execution_traced?
-
+        def start_segment(name, id, payload) # THREAD_LOCAL_ACCESS
           finishable = if name == PERFORM_ACTION
             Tracer.start_transaction_or_segment(
               name: transaction_name_from_payload(payload),
@@ -22,21 +20,6 @@ module NewRelic
             Tracer.start_segment(name: metric_name_from_payload(name, payload))
           end
           push_segment(id, finishable)
-        rescue => e
-          log_notification_error e, name, 'start'
-        end
-
-        def finish(name, id, payload) #THREAD_LOCAL_ACCESS
-          return unless state.is_execution_traced?
-
-          if exception = exception_object(payload)
-            NewRelic::Agent.notice_error exception
-          end
-
-          finishable = pop_segment(id)
-          finishable.finish if finishable
-        rescue => e
-          log_notification_error e, name, 'finish'
         end
 
         private
@@ -46,13 +29,17 @@ module NewRelic
         end
 
         def metric_name_from_payload(name, payload)
-          "Ruby/ActionCable/#{payload[:channel_class]}/#{action_name(name)}"
+          "Ruby/ActionCable/#{metric_name(payload)}/#{action_name(name)}"
+        end
+
+        def metric_name(payload)
+          payload[:broadcasting] || payload[:channel_class]
         end
 
         DOT_ACTION_CABLE = '.action_cable'.freeze
 
         def action_name(name)
-          name.gsub DOT_ACTION_CABLE, NewRelic::EMPTY_STR
+          name.gsub(DOT_ACTION_CABLE, NewRelic::EMPTY_STR)
         end
       end
     end