newrelic_rpm 8.10.1 → 8.12.0

data/lib/new_relic/latest_changes.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
@@ -31,8 +30,8 @@ EOS
 
       current_item = nil
       latest.each do |line|
-        if line.match(/^\s*\*.*/)
-          if line.match(/\(#{patch_level}\)/)
+        if line =~ /^\s*\*.*/
+          if line =~ /\(#{patch_level}\)/
             # Found a patch level item, so start tracking the lines!
             current_item = line
           else
@@ -53,10 +52,11 @@ EOS
       changes = []
       version_count = 0
       contents.each_line do |line|
-        if line.match(/##\s+v[\d.]+/)
+        if line =~ /##\s+v[\d.]+/
           version_count += 1
         end
         break if version_count >= 2
+
         changes << line.sub(/^  \* /, "* ").chomp
       end
       changes

data/lib/new_relic/local_environment.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
@@ -35,8 +34,8 @@ module NewRelic
     end
 
     def initialize
-      # Extend self with any any submodules of LocalEnvironment.  These can override
-      # the discover methods to discover new framworks and dispatchers.
+      # Extend self with any submodules of LocalEnvironment.  These can override
+      # the discover methods to discover new frameworks and dispatchers.
       NewRelic::LocalEnvironment.constants.each do |const|
         mod = NewRelic::LocalEnvironment.const_get(const)
         self.extend(mod) if mod.instance_of?(Module)
@@ -86,6 +85,7 @@ module NewRelic
     def check_for_torquebox
       return unless defined?(::JRuby) &&
         (org.torquebox::TorqueBox rescue nil)
+
       @discovered_dispatcher = :torquebox
     end
 
@@ -94,11 +94,13 @@ module NewRelic
         (((com.sun.grizzly.jruby.rack.DefaultRackApplicationFactory rescue nil) &&
           defined?(com::sun::grizzly::jruby::rack::DefaultRackApplicationFactory)) ||
          (jruby_rack? && defined?(::GlassFish::Server)))
+
       @discovered_dispatcher = :glassfish
     end
 
     def check_for_trinidad
       return unless defined?(::JRuby) && jruby_rack? && defined?(::Trinidad::Server)
+
       @discovered_dispatcher = :trinidad
     end
 
@@ -108,17 +110,20 @@ module NewRelic
 
     def check_for_webrick
       return unless defined?(::WEBrick) && defined?(::WEBrick::VERSION)
+
       @discovered_dispatcher = :webrick
     end
 
     def check_for_fastcgi
       return unless defined?(::FCGI)
+
       @discovered_dispatcher = :fastcgi
     end
 
     # this case covers starting by mongrel_rails
     def check_for_mongrel
       return unless defined?(::Mongrel) && defined?(::Mongrel::HttpServer)
+
       @discovered_dispatcher = :mongrel
     end
 
@@ -183,7 +188,7 @@ module NewRelic
     end
 
     def check_for_litespeed
-      if caller.pop =~ /fcgi-bin\/RailsRunner\.rb/
+      if caller.pop.include?('fcgi-bin/RailsRunner.rb')
         @discovered_dispatcher = :litespeed
       end
     end

data/lib/new_relic/metric_data.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,9 +8,11 @@ module NewRelic
   class MetricData
     # a NewRelic::MetricSpec object
     attr_reader :metric_spec
-    # the actual statistics object
+    # a NewRelic::Agent::Stats object
     attr_accessor :stats
 
+    include NewRelic::Coerce
+
     def initialize(metric_spec, stats)
       @original_spec = nil
       @metric_spec = metric_spec
@@ -22,8 +23,12 @@ module NewRelic
       (metric_spec.eql?(o.metric_spec)) && (stats.eql?(o.stats))
     end
 
-    def original_spec
-      @original_spec || @metric_spec
+    def hash
+      [metric_spec, stats].hash
+    end
+
+    def inspect
+      "#<MetricData metric_spec:#{metric_spec.inspect}, stats:#{stats.inspect}>"
     end
 
     # assigns a new metric spec, and retains the old metric spec as
@@ -33,8 +38,13 @@ module NewRelic
       @metric_spec = new_spec
     end
 
-    def hash
-      [metric_spec, stats].hash
+    def original_spec
+      @original_spec || @metric_spec
+    end
+
+    def to_collector_array(encoder = nil)
+      stat_key = {'name' => metric_spec.name, 'scope' => metric_spec.scope}
+      [stat_key, stats_collector_array(stat_key)]
     end
 
     def to_json(*a)
@@ -45,23 +55,18 @@ module NewRelic
       "#{metric_spec.name}(#{metric_spec.scope}): #{stats}"
     end
 
-    def inspect
-      "#<MetricData metric_spec:#{metric_spec.inspect}, stats:#{stats.inspect}>"
-    end
-
-    include NewRelic::Coerce
+    private
 
-    def to_collector_array(encoder = nil)
-      stat_key = {'name' => metric_spec.name, 'scope' => metric_spec.scope}
-      [stat_key,
-        [
-          int(stats.call_count, stat_key),
-          float(stats.total_call_time, stat_key),
-          float(stats.total_exclusive_time, stat_key),
-          float(stats.min_call_time, stat_key),
-          float(stats.max_call_time, stat_key),
-          float(stats.sum_of_squares, stat_key)
-        ]]
+    def stats_collector_array(stat_key)
+      [[:call_count, Integer], [:total_call_time, Float],
+        [:total_exclusive_time, Float], [:min_call_time, Float],
+        [:max_call_time, Float], [:sum_of_squares, Float]].map do |attr_types|
+        if attr_types[1].eql?(Integer)
+          int(stats.send(attr_types[0]), stat_key)
+        elsif attr_types[1].eql?(Float)
+          float(stats.send(attr_types[0]), stat_key)
+        end
+      end
     end
   end
 end

data/lib/new_relic/metric_spec.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
@@ -45,6 +44,7 @@ class NewRelic::MetricSpec
 
   def to_s
     return name if scope.empty?
+
     "#{name}:#{scope}"
   end
 
@@ -60,6 +60,7 @@ class NewRelic::MetricSpec
   def <=>(o)
     namecmp = self.name <=> o.name
     return namecmp if namecmp != 0
+
     return (self.scope || '') <=> (o.scope || '')
   end
 end

data/lib/new_relic/noticed_error.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
@@ -135,10 +134,8 @@ class NewRelic::NoticedError
 
   def build_error_attributes
     @attributes_from_notice_error ||= {}
-    @attributes_from_notice_error.merge!({
-      ERROR_MESSAGE_KEY => string(message),
-      ERROR_CLASS_KEY => string(exception_class_name)
-    })
+    @attributes_from_notice_error[ERROR_MESSAGE_KEY] = string(message)
+    @attributes_from_notice_error[ERROR_CLASS_KEY] = string(exception_class_name)
 
     @attributes_from_notice_error[ERROR_EXPECTED_KEY] = true if expected
   end
@@ -189,7 +186,7 @@ class NewRelic::NoticedError
     if exception.nil?
       @exception_class_name = UNKNOWN_ERROR_CLASS_NAME
       @message = NIL_ERROR_MESSAGE
-    elsif exception.is_a?(NewRelic::Agent::NoticibleError)
+    elsif exception.is_a?(NewRelic::Agent::NoticeableError)
       @exception_class_name = exception.class_name
       @message = exception.message
     else

data/lib/new_relic/rack/agent_hooks.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

data/lib/new_relic/rack/agent_middleware.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
@@ -34,11 +33,13 @@ module NewRelic
       # response code before it goes back to the client.
       def capture_http_response_code(state, result)
         return if NewRelic::Agent.config[:disable_middleware_instrumentation]
+
         super
       end
 
       def capture_response_content_type(state, result)
         return if NewRelic::Agent.config[:disable_middleware_instrumentation]
+
         super
       end
     end

data/lib/new_relic/rack/browser_monitoring.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
@@ -7,152 +6,161 @@ require 'rack'
 require 'new_relic/rack/agent_middleware'
 require 'new_relic/agent/instrumentation/middleware_proxy'
 
-module NewRelic::Rack
-  # This middleware is used by the agent for the Real user monitoring (RUM)
-  # feature, and will usually be automatically injected in the middleware chain.
-  # If automatic injection is not working, you may manually use it in your
-  # middleware chain instead.
-  #
-  # @api public
-  #
-  class BrowserMonitoring < AgentMiddleware
-    # The maximum number of bytes of the response body that we will
-    # examine in order to look for a RUM insertion point.
-    SCAN_LIMIT = 50_000
-
-    CONTENT_TYPE = 'Content-Type'.freeze
-    CONTENT_DISPOSITION = 'Content-Disposition'.freeze
-    CONTENT_LENGTH = 'Content-Length'.freeze
-    ATTACHMENT = 'attachment'.freeze
-    TEXT_HTML = 'text/html'.freeze
-
-    BODY_START = "<body".freeze
-    HEAD_START = "<head".freeze
-    GT = ">".freeze
-
-    def traced_call(env)
-      result = @app.call(env)
-      (status, headers, response) = result
-
-      js_to_inject = NewRelic::Agent.browser_timing_header
-      if (js_to_inject != NewRelic::EMPTY_STR) && should_instrument?(env, status, headers)
-        response_string = autoinstrument_source(response, headers, js_to_inject)
-        if headers.key?(CONTENT_LENGTH)
-          content_length = response_string ? response_string.bytesize : 0
-          headers[CONTENT_LENGTH] = content_length.to_s
-        end
-
-        env[ALREADY_INSTRUMENTED_KEY] = true
-        if response_string
-          response = Rack::Response.new(response_string, status, headers)
-          response.finish
+module NewRelic
+  module Rack
+    # This middleware is used by the agent for the Real user monitoring (RUM)
+    # feature, and will usually be automatically injected in the middleware chain.
+    # If automatic injection is not working, you may manually use it in your
+    # middleware chain instead.
+    #
+    # @api public
+    #
+    class BrowserMonitoring < AgentMiddleware
+      # The maximum number of bytes of the response body that we will
+      # examine in order to look for a RUM insertion point.
+      SCAN_LIMIT = 50_000
+
+      CONTENT_TYPE = 'Content-Type'.freeze
+      CONTENT_DISPOSITION = 'Content-Disposition'.freeze
+      CONTENT_LENGTH = 'Content-Length'.freeze
+      ATTACHMENT = 'attachment'.freeze
+      TEXT_HTML = 'text/html'.freeze
+
+      BODY_START = "<body".freeze
+      HEAD_START = "<head".freeze
+      GT = ">".freeze
+
+      ALREADY_INSTRUMENTED_KEY = "newrelic.browser_monitoring_already_instrumented"
+      CHARSET_RE = /<\s*meta[^>]+charset\s*=[^>]*>/im.freeze
+      X_UA_COMPATIBLE_RE = /<\s*meta[^>]+http-equiv\s*=\s*['"]x-ua-compatible['"][^>]*>/im.freeze
+
+      def traced_call(env)
+        result = @app.call(env)
+        (status, headers, response) = result
+
+        js_to_inject = NewRelic::Agent.browser_timing_header
+        if (js_to_inject != NewRelic::EMPTY_STR) && should_instrument?(env, status, headers)
+          response_string = autoinstrument_source(response, headers, js_to_inject)
+          if headers.key?(CONTENT_LENGTH)
+            content_length = response_string ? response_string.bytesize : 0
+            headers[CONTENT_LENGTH] = content_length.to_s
+          end
+
+          env[ALREADY_INSTRUMENTED_KEY] = true
+          if response_string
+            response = ::Rack::Response.new(response_string, status, headers)
+            response.finish
+          else
+            result
+          end
         else
           result
         end
-      else
-        result
       end
-    end
 
-    ALREADY_INSTRUMENTED_KEY = "newrelic.browser_monitoring_already_instrumented"
-
-    def should_instrument?(env, status, headers)
-      NewRelic::Agent.config[:'browser_monitoring.auto_instrument'] &&
-        status == 200 &&
-        !env[ALREADY_INSTRUMENTED_KEY] &&
-        is_html?(headers) &&
-        !is_attachment?(headers) &&
-        !is_streaming?(env, headers)
-    end
-
-    def is_html?(headers)
-      headers[CONTENT_TYPE] && headers[CONTENT_TYPE].include?(TEXT_HTML)
-    end
-
-    def is_attachment?(headers)
-      headers[CONTENT_DISPOSITION] && headers[CONTENT_DISPOSITION].include?(ATTACHMENT)
-    end
+      def should_instrument?(env, status, headers)
+        NewRelic::Agent.config[:'browser_monitoring.auto_instrument'] &&
+          status == 200 &&
+          !env[ALREADY_INSTRUMENTED_KEY] &&
+          html?(headers) &&
+          !attachment?(headers) &&
+          !streaming?(env, headers)
+      end
 
-    def is_streaming?(env, headers)
-      return true if headers && headers['Transfer-Encoding'] == 'chunked'
+      private
+
+      def autoinstrument_source(response, headers, js_to_inject)
+        source = gather_source(response)
+        close_old_response(response)
+        return nil unless source
+
+        # Only scan the first 50k (roughly) then give up.
+        beginning_of_source = source[0..SCAN_LIMIT]
+        meta_tag_positions = find_meta_tag_positions(beginning_of_source)
+        if body_start = find_body_start(beginning_of_source)
+          if insertion_index = find_insertion_index(meta_tag_positions, beginning_of_source, body_start)
+            source = source_injection(source, insertion_index, js_to_inject)
+          else
+            NewRelic::Agent.logger.debug("Skipping RUM instrumentation. Could not properly determine location to inject script.")
+          end
+        else
+          msg = "Skipping RUM instrumentation. Unable to find <body> tag in first #{SCAN_LIMIT} bytes of document."
+          NewRelic::Agent.logger.log_once(:warn, :rum_insertion_failure, msg)
+          NewRelic::Agent.logger.debug(msg)
+        end
 
-      defined?(ActionController::Live) &&
-        env['action_controller.instance'].class.included_modules.include?(ActionController::Live)
-    end
+        source
+      rescue => e
+        NewRelic::Agent.logger.debug("Skipping RUM instrumentation on exception.", e)
+        nil
+      end
 
-    CHARSET_RE = /<\s*meta[^>]+charset\s*=[^>]*>/im.freeze
-    X_UA_COMPATIBLE_RE = /<\s*meta[^>]+http-equiv\s*=\s*['"]x-ua-compatible['"][^>]*>/im.freeze
+      def html?(headers)
+        headers[CONTENT_TYPE] && headers[CONTENT_TYPE].include?(TEXT_HTML)
+      end
 
-    def autoinstrument_source(response, headers, js_to_inject)
-      source = gather_source(response)
-      close_old_response(response)
-      return nil unless source
+      def attachment?(headers)
+        headers[CONTENT_DISPOSITION] && headers[CONTENT_DISPOSITION].include?(ATTACHMENT)
+      end
 
-      # Only scan the first 50k (roughly) then give up.
-      beginning_of_source = source[0..SCAN_LIMIT]
+      def streaming?(env, headers)
+        return true if headers && headers['Transfer-Encoding'] == 'chunked'
 
-      if body_start = find_body_start(beginning_of_source)
-        meta_tag_positions = [
-          find_x_ua_compatible_position(beginning_of_source),
-          find_charset_position(beginning_of_source)
-        ].compact
+        defined?(ActionController::Live) &&
+          env['action_controller.instance'].class.included_modules.include?(ActionController::Live)
+      end
 
-        if !meta_tag_positions.empty?
-          insertion_index = meta_tag_positions.max
-        else
-          insertion_index = find_end_of_head_open(beginning_of_source) || body_start
-        end
+      def source_injection(source, insertion_index, js_to_inject)
+        source[0...insertion_index] <<
+          js_to_inject <<
+          source[insertion_index..-1]
+      end
 
-        if insertion_index
-          source = source[0...insertion_index] <<
-            js_to_inject <<
-            source[insertion_index..-1]
+      def find_insertion_index(tag_positions, source_beginning, body_start)
+        if !tag_positions.empty?
+          tag_positions.max
         else
-          NewRelic::Agent.logger.debug("Skipping RUM instrumentation. Could not properly determine location to inject script.")
+          find_end_of_head_open(source_beginning) || body_start
         end
-      else
-        msg = "Skipping RUM instrumentation. Unable to find <body> tag in first #{SCAN_LIMIT} bytes of document."
-        NewRelic::Agent.logger.log_once(:warn, :rum_insertion_failure, msg)
-        NewRelic::Agent.logger.debug(msg)
       end
 
-      source
-    rescue => e
-      NewRelic::Agent.logger.debug("Skipping RUM instrumentation on exception.", e)
-      nil
-    end
+      def find_meta_tag_positions(source_beginning)
+        [
+          find_x_ua_compatible_position(source_beginning),
+          find_charset_position(source_beginning)
+        ].compact
+      end
 
-    def gather_source(response)
-      source = nil
-      response.each { |fragment| source ? (source << fragment.to_s) : (source = fragment.to_s) }
-      source
-    end
+      def gather_source(response)
+        source = nil
+        response.each { |fragment| source ? (source << fragment.to_s) : (source = fragment.to_s) }
+        source
+      end
 
-    # Per "The Response > The Body" section of Rack spec, we should close
-    # if our response is able. http://rack.rubyforge.org/doc/SPEC.html
-    def close_old_response(response)
-      if response.respond_to?(:close)
-        response.close
+      # Per "The Response > The Body" section of Rack spec, we should close
+      # if our response is able. http://rack.rubyforge.org/doc/SPEC.html
+      def close_old_response(response)
+        response.close if response.respond_to?(:close)
       end
-    end
 
-    def find_body_start(beginning_of_source)
-      beginning_of_source.index(BODY_START)
-    end
+      def find_body_start(beginning_of_source)
+        beginning_of_source.index(BODY_START)
+      end
 
-    def find_x_ua_compatible_position(beginning_of_source)
-      match = X_UA_COMPATIBLE_RE.match(beginning_of_source)
-      match.end(0) if match
-    end
+      def find_x_ua_compatible_position(beginning_of_source)
+        match = X_UA_COMPATIBLE_RE.match(beginning_of_source)
+        match.end(0) if match
+      end
 
-    def find_charset_position(beginning_of_source)
-      match = CHARSET_RE.match(beginning_of_source)
-      match.end(0) if match
-    end
+      def find_charset_position(beginning_of_source)
+        match = CHARSET_RE.match(beginning_of_source)
+        match.end(0) if match
+      end
 
-    def find_end_of_head_open(beginning_of_source)
-      head_open = beginning_of_source.index(HEAD_START)
-      beginning_of_source.index(GT, head_open) + 1 if head_open
+      def find_end_of_head_open(beginning_of_source)
+        head_open = beginning_of_source.index(HEAD_START)
+        beginning_of_source.index(GT, head_open) + 1 if head_open
+      end
     end
   end
 end

data/lib/new_relic/rack.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

data/lib/new_relic/recipes/capistrano3.rb

@@ -1,11 +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
 
 require 'capistrano/framework'
+require_relative 'helpers/send_deployment'
 
 namespace :newrelic do
+  include SendDeployment
   # notifies New Relic of a deployment
   desc "Record a deployment in New Relic (newrelic.com)"
   task :notice_deployment do
@@ -19,62 +20,4 @@ namespace :newrelic do
       end
     end
   end
-
-  def send_deployment_notification_to_newrelic
-    environment = fetch(:newrelic_rails_env, fetch(:rack_env, fetch(:rails_env, fetch(:stage, "production"))))
-
-    require 'new_relic/cli/command'
-
-    begin
-      # allow overrides to be defined for revision, description, changelog, appname, and user
-      rev = fetch(:newrelic_revision)
-      description = fetch(:newrelic_desc)
-      changelog = fetch(:newrelic_changelog)
-      appname = fetch(:newrelic_appname)
-      user = fetch(:newrelic_user)
-      license_key = fetch(:newrelic_license_key)
-
-      has_scm_from_plugin = respond_to?(:scm_plugin_installed?) && scm_plugin_installed?
-      has_scm_from_config = defined?(scm) && !scm.nil? && scm != :none
-
-      if has_scm_from_plugin || has_scm_from_config
-        changelog ||= lookup_changelog
-        rev ||= fetch(:current_revision)
-      end
-
-      new_revision = rev
-      deploy_options = {
-        :environment => environment,
-        :revision => new_revision,
-        :changelog => changelog,
-        :description => description,
-        :appname => appname,
-        :user => user,
-        :license_key => license_key
-      }
-
-      debug("Uploading deployment to New Relic")
-      deployment = NewRelic::Cli::Deployments.new(deploy_options)
-      deployment.run
-      info("Uploaded deployment information to New Relic")
-    rescue NewRelic::Cli::Command::CommandFailure => e
-      info(e.message)
-    rescue => e
-      info("Error creating New Relic deployment (#{e})\n#{e.backtrace.join("\n")}")
-    end
-  end
-
-  def lookup_changelog
-    previous_revision = fetch(:previous_revision)
-    current_revision = fetch(:current_revision)
-    return unless current_revision && previous_revision
-
-    debug("Retrieving changelog for New Relic Deployment details")
-
-    if Rake::Task.task_defined?("git:check")
-      log_command = "git --no-pager log --no-color --pretty=format:'  * %an: %s' " +
-        "--abbrev-commit --no-merges #{previous_revision}..#{current_revision}"
-      `#{log_command}`
-    end
-  end
 end

data/lib/new_relic/recipes/capistrano_legacy.rb

@@ -1,9 +1,8 @@
-# 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
 
-make_notify_task = Proc.new do
+make_notify_task = proc do
   namespace(:newrelic) do
     # on all deployments, notify New Relic
     desc("Record a deployment in New Relic (newrelic.com)")