newrelic_rpm 8.0.0 → 8.4.0

data/lib/new_relic/agent/monitors/cross_app_monitor.rb

@@ -12,27 +12,28 @@ module NewRelic
   module Agent
     module DistributedTracing
       class CrossAppMonitor < InboundRequestMonitor
-
-        NEWRELIC_ID_HEADER      = 'X-NewRelic-ID'.freeze
-        NEWRELIC_TXN_HEADER     = 'X-NewRelic-Transaction'.freeze
+        NEWRELIC_ID_HEADER = 'X-NewRelic-ID'.freeze
+        NEWRELIC_TXN_HEADER = 'X-NewRelic-Transaction'.freeze
         NEWRELIC_APPDATA_HEADER = 'X-NewRelic-App-Data'.freeze
 
-        NEWRELIC_ID_HEADER_KEY    = 'HTTP_X_NEWRELIC_ID'.freeze
-        NEWRELIC_TXN_HEADER_KEY   = 'HTTP_X_NEWRELIC_TRANSACTION'.freeze
+        NEWRELIC_ID_HEADER_KEY = 'HTTP_X_NEWRELIC_ID'.freeze
+        NEWRELIC_TXN_HEADER_KEY = 'HTTP_X_NEWRELIC_TRANSACTION'.freeze
         CONTENT_LENGTH_HEADER_KEY = 'HTTP_CONTENT_LENGTH'.freeze
 
         def on_finished_configuring(events)
-          Deprecator.deprecate('cross_application_tracer')
-          ::NewRelic::Agent.logger.warn(
-            "[DEPRECATED] Cross application tracing is enabled. Distributed tracing is replacing cross application tracing as the default means of tracing between services. To continue using cross application tracing, enable it with `cross_application_tracer.enabled: true` and `distributed_tracing.enabled: false`"
-          )
+          if CrossAppTracing.cross_app_enabled?
+            Deprecator.deprecate('cross_application_tracer')
+            ::NewRelic::Agent.logger.warn(
+              "[DEPRECATED] Cross application tracing is enabled. Distributed tracing is replacing cross application tracing as the default means of tracing between services. To continue using cross application tracing, enable it with `cross_application_tracer.enabled: true` and `distributed_tracing.enabled: false`"
+            )
+          end
 
           register_event_listeners(events)
         end
 
         def path_hash(txn_name, seed)
-          rotated    = ((seed << 1) | (seed >> 31)) & 0xffffffff
-          app_name   = NewRelic::Agent.config[:app_name].first
+          rotated = ((seed << 1) | (seed >> 31)) & 0xffffffff
+          app_name = NewRelic::Agent.config[:app_name].first
           identifier = "#{app_name};#{txn_name}"
           sprintf("%08x", rotated ^ hash_transaction_name(identifier))
         end
@@ -43,10 +44,10 @@ module NewRelic
         #   :before_call will save our cross application request id to the thread
         #   :after_call will write our response headers/metrics and clean up the thread
         def register_event_listeners(events)
-          NewRelic::Agent.logger.
-            debug("Wiring up Cross Application Tracing to events after finished configuring")
+          NewRelic::Agent.logger
+            .debug("Wiring up Cross Application Tracing to events after finished configuring")
 
-          events.subscribe(:before_call) do |env| #THREAD_LOCAL_ACCESS
+          events.subscribe(:before_call) do |env| # THREAD_LOCAL_ACCESS
             if id = decoded_id(env) and should_process_request?(id)
               state = NewRelic::Agent::Tracer.state
 
@@ -61,7 +62,7 @@ module NewRelic
             end
           end
 
-          events.subscribe(:after_call) do |env, (_status_code, headers, _body)| #THREAD_LOCAL_ACCESS
+          events.subscribe(:after_call) do |env, (_status_code, headers, _body)| # THREAD_LOCAL_ACCESS
             state = NewRelic::Agent::Tracer.state
 
             insert_response_header(state, env, headers)
@@ -90,7 +91,9 @@ module NewRelic
         def set_response_headers(transaction, response_headers, content_length)
           payload = obfuscator.obfuscate(
             ::JSON.dump(
-              transaction.distributed_tracer.cross_app_payload.as_json_array(content_length)))
+              transaction.distributed_tracer.cross_app_payload.as_json_array(content_length)
+            )
+          )
 
           response_headers[NEWRELIC_APPDATA_HEADER] = payload
         end

data/lib/new_relic/agent/monitors/distributed_tracing_monitor.rb

@@ -13,7 +13,7 @@ module NewRelic
 
         def on_before_call(request)
           unless NewRelic::Agent.config[:'distributed_tracing.enabled']
-            NewRelic::Agent.logger.warn "Not configured to accept distributed trace headers" 
+            NewRelic::Agent.logger.warn "Not configured to accept distributed trace headers"
             return
           end
 
@@ -24,4 +24,4 @@ module NewRelic
       end
     end
   end
-end
+end

data/lib/new_relic/agent/monitors/inbound_request_monitor.rb

@@ -16,7 +16,6 @@ require 'json'
 module NewRelic
   module Agent
     class InboundRequestMonitor
-
       attr_reader :obfuscator
 
       def initialize(events)

data/lib/new_relic/agent/monitors/synthetics_monitor.rb

@@ -5,7 +5,7 @@
 module NewRelic
   module Agent
     class SyntheticsMonitor < InboundRequestMonitor
-      SYNTHETICS_HEADER_KEY  = 'HTTP_X_NEWRELIC_SYNTHETICS'.freeze
+      SYNTHETICS_HEADER_KEY = 'HTTP_X_NEWRELIC_SYNTHETICS'.freeze
 
       SUPPORTED_VERSION = 1
       EXPECTED_PAYLOAD_LENGTH = 5
@@ -14,7 +14,7 @@ module NewRelic
         events.subscribe(:before_call, &method(:on_before_call))
       end
 
-      def on_before_call(request) #THREAD_LOCAL_ACCESS
+      def on_before_call(request) # THREAD_LOCAL_ACCESS
         encoded_header = request[SYNTHETICS_HEADER_KEY]
         return unless encoded_header
 
@@ -27,11 +27,10 @@ module NewRelic
 
         txn = Tracer.current_transaction
         txn.raw_synthetics_header = encoded_header
-        txn.synthetics_payload    = incoming_payload
+        txn.synthetics_payload = incoming_payload
       end
 
       class << self
-
         def is_supported_version?(incoming_payload)
           incoming_payload.first == SUPPORTED_VERSION
         end
@@ -46,11 +45,9 @@ module NewRelic
         end
 
         def reject_messaging_synthetics_header headers
-          headers.reject {|k,_| k == CrossAppTracing::NR_MESSAGE_BROKER_SYNTHETICS_HEADER}
+          headers.reject { |k, _| k == CrossAppTracing::NR_MESSAGE_BROKER_SYNTHETICS_HEADER }
         end
-
       end
-
     end
   end
 end

data/lib/new_relic/agent/monitors.rb

@@ -21,7 +21,6 @@ module NewRelic
         @cross_app_monitor = NewRelic::Agent::DistributedTracing::CrossAppMonitor.new events
         @distributed_tracing_monitor = NewRelic::Agent::DistributedTracing::Monitor.new events
       end
-
     end
   end
-end
+end

data/lib/new_relic/agent/new_relic_service/encoders.rb

@@ -12,14 +12,14 @@ module NewRelic
     class NewRelicService
       module Encoders
         module Identity
-          def self.encode(data, opts=nil)
+          def self.encode(data, opts = nil)
             data
           end
         end
 
         module Compressed
           module Deflate
-            def self.encode(data, opts=nil)
+            def self.encode(data, opts = nil)
               Zlib::Deflate.deflate(data, Zlib::DEFAULT_COMPRESSION)
             end
           end
@@ -27,7 +27,7 @@ module NewRelic
           module Gzip
             BINARY = "BINARY".freeze
 
-            def self.encode(data, opts=nil)
+            def self.encode(data, opts = nil)
               output = StringIO.new
               output.set_encoding BINARY
               gz = Zlib::GzipWriter.new(output, Zlib::DEFAULT_COMPRESSION, Zlib::DEFAULT_STRATEGY)
@@ -40,7 +40,7 @@ module NewRelic
         end
 
         module Base64CompressedJSON
-          def self.encode(data, opts={})
+          def self.encode(data, opts = {})
             if !opts[:skip_normalization] && Agent.config[:normalize_json_string_encodings]
               data = NewRelic::Agent::EncodingNormalizer.normalize_object(data)
             end

data/lib/new_relic/agent/new_relic_service/json_marshaller.rb

@@ -27,7 +27,7 @@ module NewRelic
           ::NewRelic::Agent.logger.warn "Failed trying to watch for problematic yajl-ruby version.", err
         end
 
-        def dump(ruby, opts={})
+        def dump(ruby, opts = {})
           prepared = prepare(ruby, opts)
 
           if !opts[:skip_normalization] && Agent.config[:normalize_json_string_encodings]

data/lib/new_relic/agent/new_relic_service/marshaller.rb

@@ -6,7 +6,7 @@ module NewRelic
   module Agent
     class NewRelicService
       class Marshaller
-        def prepare(data, options={})
+        def prepare(data, options = {})
           encoder = options[:encoder] || default_encoder
           if data.respond_to?(:to_collector_array)
             data.to_collector_array(encoder)

data/lib/new_relic/agent/new_relic_service/security_policy_settings.rb

@@ -6,7 +6,7 @@ module NewRelic
   module Agent
     class NewRelicService
       module SecurityPolicySettings
-        EXPECTED_SECURITY_POLICIES = %w(
+        EXPECTED_SECURITY_POLICIES = %w[
           record_sql
           attributes_include
           allow_raw_exception_messages
@@ -14,12 +14,13 @@ module NewRelic
           custom_parameters
           custom_instrumentation_editor
           message_parameters
-          job_arguments).map(&:freeze)
+          job_arguments
+        ].map(&:freeze)
 
         def self.preliminary_settings(security_policies)
           enabled_key = 'enabled'.freeze
           settings = EXPECTED_SECURITY_POLICIES.inject({}) do |memo, policy_name|
-            memo[policy_name] =  {enabled_key => security_policies[policy_name][enabled_key]}
+            memo[policy_name] = {enabled_key => security_policies[policy_name][enabled_key]}
             memo
           end
           {'security_policies' => settings}

data/lib/new_relic/agent/new_relic_service.rb

@@ -35,7 +35,7 @@ module NewRelic
       attr_accessor :request_timeout
       attr_reader :collector, :marshaller, :agent_id
 
-      def initialize(license_key=nil, collector=control.server)
+      def initialize(license_key = nil, collector = control.server)
         @license_key = license_key
         @collector = collector
         @configured_collector = collector
@@ -69,7 +69,7 @@ module NewRelic
         @agent_id = id
       end
 
-      def connect(settings={})
+      def connect(settings = {})
         @request_headers_map = nil
         security_policies = nil
         if response = preconnect
@@ -128,7 +128,7 @@ module NewRelic
 
       def metric_data(stats_hash)
         timeslice_start = stats_hash.started_at
-        timeslice_end  = stats_hash.harvested_at || Process.clock_gettime(Process::CLOCK_REALTIME)
+        timeslice_end = stats_hash.harvested_at || Process.clock_gettime(Process::CLOCK_REALTIME)
         metric_data_array = build_metric_data_array(stats_hash)
         result = invoke_remote(
           :metric_data,
@@ -289,7 +289,7 @@ module NewRelic
         # Jruby 1.6.8 requires a gem for full ssl support and will throw
         # an error when use_ssl=(true) is called and jruby-openssl isn't
         # installed
-        conn.use_ssl     = true
+        conn.use_ssl = true
         conn.verify_mode = OpenSSL::SSL::VERIFY_PEER
         set_cert_store(conn)
       rescue StandardError, LoadError
@@ -299,7 +299,7 @@ module NewRelic
 
       def set_cert_store(conn)
         if NewRelic::Agent.config[:ca_bundle_path]
-          conn.cert_store  = ssl_cert_store
+          conn.cert_store = ssl_cert_store
         else
           ::NewRelic::Agent.logger.debug("Using default security certificates")
         end
@@ -388,15 +388,15 @@ module NewRelic
       def generate_remote_method_uri(method)
         params = {
           'protocol_version' => PROTOCOL_VERSION,
-          'license_key'      => license_key,
-          'run_id'           => @agent_id,
-          'method'           => method,
-          'marshal_format'   => 'json', # Other formats are explicitly
-                                        # ruled out; see the initializer
+          'license_key' => license_key,
+          'run_id' => @agent_id,
+          'method' => method,
+          'marshal_format' => 'json' # Other formats are explicitly
+          # ruled out; see the initializer
         }
 
         uri = "/agent_listener/invoke_raw_method?"
-        uri << params.map do |k,v|
+        uri << params.map do |k, v|
           next unless v
           "#{k}=#{v}"
         end.compact.join('&')
@@ -426,29 +426,22 @@ module NewRelic
         size = data.size
 
         # Preconnect needs to always use the configured collector host, not the redirect host
-        # endpoint_specific_collector = (method == :preconnect) ? @configured_collector : @collector
-
-        # This is a temporary workaround due to errors occurring on the staging collector. The prod collector does not have the same issue.
-        # The staging collector does not respond correctly when using the configured collector host for preconnect, so must use the redirect host
-        # Once this issue is resolved on the staging collector, use the original line that is commented out above.
-        endpoint_specific_collector = if method == :preconnect && (@configured_collector && @configured_collector.name != 'staging-collector.newrelic.com')
-                                        ::NewRelic::Agent.logger.debug "Using configured collector for preconnect: #{@configured_collector}"
-                                        @configured_collector
-                                      else
-                                        ::NewRelic::Agent.logger.debug "Using redirect host for collector: #{@collector}"
-                                        @collector
-                                      end
+        # We reset it here so we are always using the configured collector during our creation of the new connection
+        # and we also don't want to keep the previous redirect host around anymore
+        if method == :preconnect
+          @collector = @configured_collector
+        end
 
         uri = remote_method_uri(method)
-        full_uri = "#{endpoint_specific_collector}#{uri}"
+        full_uri = "#{@collector}#{uri}"
 
         @audit_logger.log_request(full_uri, payload, @marshaller)
         request_send_ts = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-        response = send_request(:data      => data,
-                                :uri       => uri,
-                                :encoding  => encoding,
-                                :collector => endpoint_specific_collector,
-                                :endpoint  => method)
+        response = send_request(:data => data,
+          :uri       => uri,
+          :encoding  => encoding,
+          :collector => @collector,
+          :endpoint  => method)
         response_check_ts = Process.clock_gettime(Process::CLOCK_MONOTONIC)
         @marshaller.load(decompress_response(response))
       ensure
@@ -519,7 +512,7 @@ module NewRelic
       def send_request(opts)
         headers = {
           'Content-Encoding' => opts[:encoding],
-          'Host'             => opts[:collector].name
+          'Host' => opts[:collector].name
         }
         headers.merge!(@request_headers_map) if @request_headers_map
 
@@ -533,10 +526,10 @@ module NewRelic
         request.content_type = "application/octet-stream"
         request.body = opts[:data]
 
-        response     = nil
-        attempts     = 0
+        response = nil
+        attempts = 0
         max_attempts = 2
-        endpoint     = opts[:endpoint]
+        endpoint = opts[:endpoint]
 
         begin
           attempts += 1

data/lib/new_relic/agent/noticible_error.rb

@@ -5,7 +5,6 @@
 
 module NewRelic
   module Agent
-
     # This class is used for instrumentations that have exceptions or error classes
     # not derived from Ruby's usual Exception or StandardError or in situations
     # where we do not have such Exception object to work with.
@@ -17,6 +16,5 @@ module NewRelic
         @message = message
       end
     end
-
   end
 end

data/lib/new_relic/agent/null_logger.rb

@@ -8,9 +8,13 @@ module NewRelic
   module Agent
     class NullLogger
       def fatal(*args); end
+
       def error(*args); end
-      def warn(*args);  end
-      def info(*args);  end
+
+      def warn(*args); end
+
+      def info(*args); end
+
       def debug(*args); end
 
       def method_missing(method, *args, &blk)

data/lib/new_relic/agent/obfuscator.rb

@@ -2,19 +2,18 @@
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
-#require 'base64'
+# require 'base64'
 
 module NewRelic
   module Agent
     class Obfuscator
-
       attr_reader :key_bytes
 
       EMPTY_KEY_BYTES = [0]
       PACK_FORMAT = 'm'
 
       # RUM uses a shortened key, so just trim it up front
-      def initialize(key, length=nil)
+      def initialize(key, length = nil)
         if key.nil? || key.empty?
           @key_bytes = EMPTY_KEY_BYTES
         else
@@ -24,26 +23,25 @@ module NewRelic
       end
 
       def obfuscate(text)
-        [ encode(text) ].pack(PACK_FORMAT).gsub(/\n/, '')
+        [encode(text)].pack(PACK_FORMAT).gsub(/\n/, '')
       end
 
       def deobfuscate(text)
-        encode(text.unpack(PACK_FORMAT).first )
+        encode(text.unpack(PACK_FORMAT).first)
       end
 
       def encode(text)
         return text unless key_bytes
 
         encoded = ""
-        encoded.force_encoding('binary') if encoded.respond_to?( :force_encoding )
+        encoded.force_encoding('binary') if encoded.respond_to?(:force_encoding)
         index = 0
         text.each_byte do |byte|
           encoded.concat((byte ^ key_bytes[index % key_bytes.length]))
-          index+=1
+          index += 1
         end
         encoded
       end
-
     end
   end
 end

data/lib/new_relic/agent/parameter_filtering.rb

@@ -9,17 +9,25 @@ module NewRelic
 
       ACTION_DISPATCH_PARAMETER_FILTER = "action_dispatch.parameter_filter".freeze
 
-      RAILS_FILTER_CLASS = if defined?(ActiveSupport::ParameterFilter)
-         ActiveSupport::ParameterFilter
-      elsif defined?(ActionDispatch::Http::ParameterFilter)
-        ActionDispatch::Http::ParameterFilter
+      if defined?(Rails) && Gem::Version.new(::Rails::VERSION::STRING) >= Gem::Version.new('5.0.0')
+        Rails.application.config.to_prepare do
+          RAILS_FILTER_CLASS = if defined?(ActiveSupport::ParameterFilter)
+            ActiveSupport::ParameterFilter
+          elsif defined?(ActionDispatch::Http::ParameterFilter)
+            ActionDispatch::Http::ParameterFilter
+          end
+        end
       else
-        nil
+        RAILS_FILTER_CLASS = if defined?(ActiveSupport::ParameterFilter)
+          ActiveSupport::ParameterFilter
+        elsif defined?(ActionDispatch::Http::ParameterFilter)
+          ActionDispatch::Http::ParameterFilter
+        end
       end
 
       def apply_filters(env, params)
         if filters = env[ACTION_DISPATCH_PARAMETER_FILTER]
-          params = filter_using_rails(params, filters) 
+          params = filter_using_rails(params, filters)
         end
         params = filter_rack_file_data(env, params)
         params
@@ -36,7 +44,7 @@ module NewRelic
         content_type = env["CONTENT_TYPE"]
         multipart = content_type && content_type.start_with?("multipart")
 
-        params.inject({}) do |memo, (k,v)|
+        params.inject({}) do |memo, (k, v)|
           if multipart && v.is_a?(Hash) && v[:tempfile]
             memo[k] = "[FILE]"
           else

data/lib/new_relic/agent/payload_metric_mapping.rb

@@ -6,7 +6,6 @@
 module NewRelic
   module Agent
     module PayloadMetricMapping
-
       # this logic was extracted from TransactionEventAggregator for reuse by
       # the ErrorEventAggregator
 
@@ -28,7 +27,7 @@ module NewRelic
 
         private
 
-        def map_metric(metric_name, to_add={})
+        def map_metric(metric_name, to_add = {})
           to_add.values.each(&:freeze)
 
           mappings = SPEC_MAPPINGS.fetch(metric_name, {})
@@ -41,18 +40,18 @@ module NewRelic
       # All Transactions
       # Don't need to use the transaction-type specific metrics since this is
       # scoped to just one transaction, so Datastore/all has what we want.
-      map_metric('Datastore/all',         :total_call_time => 'databaseDuration')
-      map_metric('Datastore/all',         :call_count      => 'databaseCallCount')
-      map_metric('GC/Transaction/all',    :total_call_time => 'gcCumulative')
+      map_metric('Datastore/all', :total_call_time => 'databaseDuration')
+      map_metric('Datastore/all', :call_count => 'databaseCallCount')
+      map_metric('GC/Transaction/all', :total_call_time => 'gcCumulative')
 
       # Web Metrics
       map_metric('WebFrontend/QueueTime', :total_call_time => 'queueDuration')
-      map_metric('External/allWeb',       :total_call_time => 'externalDuration')
-      map_metric('External/allWeb',       :call_count      => 'externalCallCount')
+      map_metric('External/allWeb', :total_call_time => 'externalDuration')
+      map_metric('External/allWeb', :call_count => 'externalCallCount')
 
       # Background Metrics
-      map_metric('External/allOther',     :total_call_time => 'externalDuration')
-      map_metric('External/allOther',     :call_count      => 'externalCallCount')
+      map_metric('External/allOther', :total_call_time => 'externalDuration')
+      map_metric('External/allOther', :call_count => 'externalCallCount')
     end
   end
 end

data/lib/new_relic/agent/pipe_channel_manager.rb

@@ -6,7 +6,6 @@ require 'base64'
 
 module NewRelic
   module Agent
-
     #--
     # Manages the registering and servicing of pipes used by child
     # processes to report data to their parent, rather than directly
@@ -128,7 +127,7 @@ module NewRelic
       end
 
       class Listener
-        attr_reader   :thread
+        attr_reader :thread
 
         # This attr_accessor intentionally provides unsynchronized access to the
         # @pipes hash. It is used to look up the write end of the pipe from
@@ -168,7 +167,7 @@ module NewRelic
               clean_up_pipes
 
               pipes_to_listen_to = @pipes_lock.synchronize do
-                @pipes.values.map{|pipe| pipe.out} + [wake.out]
+                @pipes.values.map { |pipe| pipe.out } + [wake.out]
               end
 
               if now
@@ -255,7 +254,7 @@ module NewRelic
         end
 
         def should_keep_listening?
-          @started || @pipes_lock.synchronize { @pipes.values.find{|pipe| !pipe.in.closed?} }
+          @started || @pipes_lock.synchronize { @pipes.values.find { |pipe| !pipe.in.closed? } }
         end
 
         def clean_up_pipes
@@ -265,13 +264,13 @@ module NewRelic
                 pipe.close unless pipe.closed?
               end
             end
-            @pipes.reject! {|id, pipe| pipe.out.closed? }
+            @pipes.reject! { |id, pipe| pipe.out.closed? }
           end
         end
 
         def find_pipe_for_handle(out_handle)
           @pipes_lock.synchronize do
-            @pipes.values.find{|pipe| pipe.out == out_handle }
+            @pipes.values.find { |pipe| pipe.out == out_handle }
           end
         end
       end

data/lib/new_relic/agent/pipe_service.rb

@@ -11,7 +11,7 @@ module NewRelic
       def initialize(channel_id)
         @channel_id = channel_id
         @collector = NewRelic::Control::Server.new(:name => 'parent',
-                                                   :port => 0)
+          :port => 0)
         @pipe = NewRelic::Agent::PipeChannelManager.channels[@channel_id]
         if @pipe && @pipe.parent_pid != $$
           @pipe.after_fork_in_child

data/lib/new_relic/agent/priority_sampled_buffer.rb

@@ -15,12 +15,12 @@ module NewRelic
       def initialize(capacity)
         super
         @captured_lifetime = 0
-        @seen_lifetime     = 0
+        @seen_lifetime = 0
       end
 
       def heapify_items_array
         if @items.is_a?(Array)
-          @items = Heap.new(@items) { |x| priority_for(x) } 
+          @items = Heap.new(@items) { |x| priority_for(x) }
         end
       end
 
@@ -38,8 +38,6 @@ module NewRelic
             @items[0] = incoming
             @items.fix(0)
             incoming
-          else
-            nil
           end
         else
           @items << (event || blk.call)
@@ -53,10 +51,10 @@ module NewRelic
       def capacity=(new_capacity)
         @capacity = new_capacity
         old_items = @items.to_a
-        old_seen  = @seen
+        old_seen = @seen
         reset!
         old_items.each { |i| append(event: i) }
-        @seen     = old_seen
+        @seen = old_seen
       end
 
       def to_a
@@ -92,4 +90,3 @@ module NewRelic
     end
   end
 end
-