newrelic_rpm 8.2.0 → 9.0.0

data/lib/new_relic/agent/null_logger.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
 
 # A stub object that we can use in place of a real Logger instance when
 # the agent is disabled.
@@ -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

@@ -1,20 +1,19 @@
-# 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 '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).delete("\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 = String.new('')
+        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

@@ -1,32 +1,40 @@
-# 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 ParameterFiltering
       extend self
 
-      ACTION_DISPATCH_PARAMETER_FILTER = "action_dispatch.parameter_filter".freeze
+      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
       end
 
       def filter_using_rails(params, filters)
-        return params if RAILS_FILTER_CLASS.nil?
+        return params unless rails_filter_class?
 
         pre_filtered_params = filter_rails_request_parameters(params)
         RAILS_FILTER_CLASS.new(filters).filter(pre_filtered_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
@@ -52,6 +60,12 @@ module NewRelic
         result.delete("action")
         result
       end
+
+      private
+
+      def rails_filter_class?
+        defined?(RAILS_FILTER_CLASS) && !RAILS_FILTER_CLASS.nil?
+      end
     end
   end
 end

data/lib/new_relic/agent/payload_metric_mapping.rb

@@ -1,12 +1,11 @@
 # -*- 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
 
 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

@@ -1,12 +1,11 @@
-# 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 '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
@@ -161,6 +160,7 @@ module NewRelic
 
         def start
           return if @started == true
+
           @started = true
           @thread = NewRelic::Agent::Threading::AgentThread.create('Pipe Channel Manager') do
             now = nil
@@ -168,7 +168,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
@@ -186,13 +186,18 @@ module NewRelic
                   merge_data_from_pipe(pipe) unless pipe == wake.out
                 end
 
-                wake.out.read(1) if ready_pipes.include?(wake.out)
+                begin
+                  wake.out.read_nonblock(1) if ready_pipes.include?(wake.out)
+                rescue IO::WaitReadable
+                  NewRelic::Agent.logger.error('Issue while reading from the ready pipe')
+                  NewRelic::Agent.logger.error("Ready pipes: #{ready_pipes.map(&:to_s)}, wake.out pipe: #{wake.out}")
+                end
               end
 
               break unless should_keep_listening?
             end
           end
-          sleep 0.001 # give time for the thread to spawn
+          sleep(0.001) # give time for the thread to spawn
         end
 
         def stop_listener_thread
@@ -203,6 +208,7 @@ module NewRelic
 
         def stop
           return unless @started == true
+
           stop_listener_thread
           close_all_pipes
           @wake.close
@@ -249,13 +255,13 @@ module NewRelic
         def unmarshal(data)
           Marshal.load(data)
         rescue StandardError => e
-          ::NewRelic::Agent.logger.error "Failure unmarshalling message from Resque child process", e
-          ::NewRelic::Agent.logger.debug Base64.encode64(data)
+          ::NewRelic::Agent.logger.error("Failure unmarshalling message from Resque child process", e)
+          ::NewRelic::Agent.logger.debug(Base64.encode64(data))
           nil
         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 +271,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

@@ -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
 
 module NewRelic
   module Agent
@@ -10,8 +10,7 @@ module NewRelic
 
       def initialize(channel_id)
         @channel_id = channel_id
-        @collector = NewRelic::Control::Server.new(:name => 'parent',
-                                                   :port => 0)
+        @collector = NewRelic::Control::Server.new({name: 'parent', port: 0})
         @pipe = NewRelic::Agent::PipeChannelManager.channels[@channel_id]
         if @pipe && @pipe.parent_pid != $$
           @pipe.after_fork_in_child
@@ -25,7 +24,7 @@ module NewRelic
       end
 
       def get_agent_commands
-        []
+        NewRelic::EMPTY_ARRAY
       end
 
       def analytic_event_data(events)
@@ -61,6 +60,10 @@ module NewRelic
         write_to_pipe(:sql_trace_data, sql) if sql
       end
 
+      def log_event_data(logs)
+        write_to_pipe(:log_event_data, logs) if logs
+      end
+
       def shutdown
         @pipe.close if @pipe
       end

data/lib/new_relic/agent/prepend_supportability.rb

@@ -1,11 +1,11 @@
-# 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 PrependSupportability
-      def self.record_metrics_for *classes
+      def self.record_metrics_for(*classes)
         classes.each do |klass|
           count = klass.send(:ancestors).index(klass)
           ::NewRelic::Agent.record_metric("Supportability/PrependedModules/#{klass}", count) if count > 0

data/lib/new_relic/agent/priority_sampled_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/heap'
 require 'new_relic/agent/event_buffer'
@@ -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
 
@@ -34,15 +34,13 @@ module NewRelic
           priority ||= priority_for(event)
           if priority_for(@items[0]) < priority
             heapify_items_array
-            incoming = event || blk.call
+            incoming = event || yield
             @items[0] = incoming
             @items.fix(0)
             incoming
-          else
-            nil
           end
         else
-          @items << (event || blk.call)
+          @items << (event || yield)
           @captured_lifetime += 1
           @items[-1]
         end
@@ -53,17 +51,17 @@ 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
         @items.to_a.dup
       end
 
-      def decrement_lifetime_counts_by n
+      def decrement_lifetime_counts_by(n)
         @captured_lifetime -= n
         @seen_lifetime -= n
       end
@@ -92,4 +90,3 @@ module NewRelic
     end
   end
 end
-

data/lib/new_relic/agent/range_extensions.rb

@@ -1,45 +1,25 @@
-# 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 RangeExtensions
       module_function
 
-      def intersects? r1, r2
-        r1.include?(r2.begin) || r2.include?(r1.begin)
-      end
-
-      def merge r1, r2
-        return unless intersects? r1, r2
-        range_min = r1.begin < r2.begin ? r1.begin : r2.begin
-        range_max = r1.end > r2.end ? r1.end : r2.end
-        range_min..range_max
-      end
-
-      # Takes an array of ranges and a range which it will
-      # merge into an existing range if they intersect, otherwise
-      # it will append this range to the end the array.
-      def merge_or_append range, ranges
-        ranges.each_with_index do |r, i|
-          if merged = merge(r, range)
-            ranges[i] = merged
-            return ranges
-          end
-        end
-        ranges.push range
+      def intersects?(r1, r2)
+        r1.begin > r2.begin ? r2.cover?(r1.begin) : r1.cover?(r2.begin)
       end
 
       # Computes the amount of overlap between range and an array of ranges.
       # For efficiency, it assumes that range intersects with each of the
       # ranges in the ranges array.
-      def compute_overlap range, ranges
+      def compute_overlap(range, ranges)
         ranges.inject(0) do |memo, other|
-          next memo unless intersects? range, other
-          lower_bound = range.begin > other.begin ? range.begin : other.begin
-          upper_bound = range.end < other.end ? range.end : other.end
-          memo += upper_bound - lower_bound
+          next memo unless intersects?(range, other)
+
+          memo += ([range.end, other.end].min) -
+            ([range.begin, other.begin].max)
         end
       end
     end

data/lib/new_relic/agent/rules_engine/replacement_rule.rb

@@ -1,13 +1,13 @@
-# 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 RulesEngine
       class ReplacementRule
         attr_reader(:terminate_chain, :each_segment, :ignore, :replace_all, :eval_order,
-                    :match_expression, :replacement)
+          :match_expression, :replacement)
 
         def initialize(options)
           if !options['match_expression']
@@ -18,12 +18,12 @@ module NewRelic
           end
 
           @match_expression = Regexp.new(options['match_expression'], Regexp::IGNORECASE)
-          @replacement      = options['replacement']
-          @ignore           = options['ignore'] || false
-          @eval_order       = options['eval_order'] || 0
-          @replace_all      = options['replace_all'] || false
-          @each_segment     = options['each_segment'] || false
-          @terminate_chain  = options['terminate_chain'] || false
+          @replacement = options['replacement']
+          @ignore = options['ignore'] || false
+          @eval_order = options['eval_order'] || 0
+          @replace_all = options['replace_all'] || false
+          @each_segment = options['each_segment'] || false
+          @terminate_chain = options['terminate_chain'] || false
         end
 
         def terminal?
@@ -36,7 +36,7 @@ module NewRelic
               segment.match(@match_expression)
             end
           else
-            string.match @match_expression
+            string.match(@match_expression)
           end
         end
 
@@ -56,9 +56,9 @@ module NewRelic
         end
 
         def apply_to_each_segment(string)
-          string        = string.dup
+          string = string.dup
           leading_slash = string.slice!(LEADING_SLASH_REGEX)
-          segments      = string.split(SEGMENT_SEPARATOR)
+          segments = string.split(SEGMENT_SEPARATOR)
 
           segments.map! do |segment|
             apply_replacement(segment)

data/lib/new_relic/agent/rules_engine/segment_terms_rule.rb

@@ -1,24 +1,23 @@
-# 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 RulesEngine
       class SegmentTermsRule
-        PREFIX_KEY                        = 'prefix'.freeze
-        TERMS_KEY                         = 'terms'.freeze
-        SEGMENT_PLACEHOLDER               = '*'.freeze
-        ADJACENT_PLACEHOLDERS_REGEX       = %r{((?:^|/)\*)(?:/\*)*}.freeze
+        PREFIX_KEY = 'prefix'.freeze
+        TERMS_KEY = 'terms'.freeze
+        SEGMENT_PLACEHOLDER = '*'.freeze
+        ADJACENT_PLACEHOLDERS_REGEX = %r{((?:^|/)\*)(?:/\*)*}.freeze
         ADJACENT_PLACEHOLDERS_REPLACEMENT = '\1'.freeze
-        VALID_PREFIX_SEGMENT_COUNT        = 2
 
         attr_reader :prefix, :terms
 
         def self.valid?(rule_spec)
           rule_spec[PREFIX_KEY].kind_of?(String) &&
-          rule_spec[TERMS_KEY].kind_of?(Array) &&
-          valid_prefix_segment_count?(rule_spec[PREFIX_KEY])
+            rule_spec[TERMS_KEY].kind_of?(Array) &&
+            valid_prefix_segment_count?(rule_spec[PREFIX_KEY])
         end
 
         def self.valid_prefix_segment_count?(prefix)
@@ -26,13 +25,13 @@ module NewRelic
           rindex = prefix.rindex(SEGMENT_SEPARATOR)
 
           (count == 2 && prefix[rindex + 1].nil?) ||
-          (count == 1 && !prefix[rindex + 1].nil?)
+            (count == 1 && !prefix[rindex + 1].nil?)
         end
 
         def initialize(options)
-          @prefix          = options[PREFIX_KEY]
-          @terms           = options[TERMS_KEY]
-          @trim_range      = (@prefix.size..-1)
+          @prefix = options[PREFIX_KEY]
+          @terms = options[TERMS_KEY]
+          @trim_range = (@prefix.size..-1)
         end
 
         def terminal?
@@ -50,7 +49,7 @@ module NewRelic
         end
 
         def apply(string)
-          rest          = string[@trim_range]
+          rest = string[@trim_range]
           leading_slash = rest.slice!(LEADING_SLASH_REGEX)
           segments = rest.split(SEGMENT_SEPARATOR, -1)
           segments.map! { |s| @terms.include?(s) ? s : SEGMENT_PLACEHOLDER }

data/lib/new_relic/agent/rules_engine.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/rules_engine/replacement_rule'
 require 'new_relic/agent/rules_engine/segment_terms_rule'
@@ -24,7 +24,7 @@ module NewRelic
       end
 
       def self.create_transaction_rules(connect_response)
-        txn_name_specs     = connect_response['transaction_name_rules']    || []
+        txn_name_specs = connect_response['transaction_name_rules'] || []
         segment_rule_specs = connect_response['transaction_segment_terms'] || []
 
         txn_name_rules = txn_name_specs.map { |s| ReplacementRule.new(s) }
@@ -36,7 +36,7 @@ module NewRelic
             # Build segment_rules in reverse order from which they're provided,
             # so that when we eliminate duplicates with #uniq!, we retain the last
             # instances of repeated rules.
-            segment_rules.unshift SegmentTermsRule.new(spec)
+            segment_rules.unshift(SegmentTermsRule.new(spec))
           end
         end
 
@@ -54,7 +54,7 @@ module NewRelic
         rules.uniq! { |rule| rule.prefix }
       end
 
-      def initialize(rules=[], segment_term_rules=[])
+      def initialize(rules = [], segment_term_rules = [])
         @rules = rules.sort
         @segment_term_rules = segment_term_rules
       end
@@ -72,6 +72,7 @@ module NewRelic
       def rename(original_string)
         renamed = apply_rules(@rules, original_string)
         return nil unless renamed
+
         renamed = apply_rules(@segment_term_rules, renamed)
         renamed
       end

data/lib/new_relic/agent/sampler.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
 #
 # A Sampler is used to capture meaningful metrics in a background thread
 # periodically.  They will be invoked about once a minute, each time the agent
@@ -12,9 +12,8 @@
 module NewRelic
   module Agent
     class Sampler
-
       # Exception denotes a sampler is not available and it will not be registered.
-      class Unsupported < StandardError;  end
+      class Unsupported < StandardError; end
 
       attr_reader :id
       @sampler_classes = []
@@ -52,7 +51,7 @@ module NewRelic
       # The ID passed in here is unused by our code, but is preserved in case
       # we have clients who are defining their own subclasses of this class, and
       # expecting to be able to call super with an ID.
-      def initialize(id=nil)
+      def initialize(id = nil)
         @id = id || self.class.shorthand_name
       end