newrelic_rpm 6.8.0.360 → 8.13.1

data/lib/new_relic/noticed_error.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 require 'new_relic/helper'
 require 'new_relic/agent/attribute_filter'
@@ -11,17 +11,28 @@ class NewRelic::NoticedError
   extend NewRelic::CollectionHelper
 
   attr_accessor :path, :timestamp, :message, :exception_class_name,
-                :request_uri, :request_port, :file_name, :line_number,
-                :stack_trace, :attributes_from_notice_error, :attributes,
-                :expected
+    :request_uri, :request_port, :file_name, :line_number,
+    :stack_trace, :attributes_from_notice_error, :attributes,
+    :expected
 
-  attr_reader   :exception_id, :is_internal
+  attr_reader :exception_id, :is_internal
 
-  STRIPPED_EXCEPTION_REPLACEMENT_MESSAGE = "Message removed by New Relic 'strip_exception_messages' setting".freeze
-  UNKNOWN_ERROR_CLASS_NAME = 'Error'.freeze
-  NIL_ERROR_MESSAGE = '<no message>'.freeze
+  STRIPPED_EXCEPTION_REPLACEMENT_MESSAGE = "Message removed by New Relic 'strip_exception_messages' setting"
+  UNKNOWN_ERROR_CLASS_NAME = 'Error'
+  NIL_ERROR_MESSAGE = '<no message>'
 
-  def initialize(path, exception, timestamp = Time.now)
+  USER_ATTRIBUTES = "userAttributes"
+  AGENT_ATTRIBUTES = "agentAttributes"
+  INTRINSIC_ATTRIBUTES = "intrinsics"
+
+  DESTINATION = NewRelic::Agent::AttributeFilter::DST_ERROR_COLLECTOR
+
+  ERROR_PREFIX_KEY = 'error'
+  ERROR_MESSAGE_KEY = "#{ERROR_PREFIX_KEY}.message"
+  ERROR_CLASS_KEY = "#{ERROR_PREFIX_KEY}.class"
+  ERROR_EXPECTED_KEY = "#{ERROR_PREFIX_KEY}.expected"
+
+  def initialize(path, exception, timestamp = Process.clock_gettime(Process::CLOCK_REALTIME), expected = false)
     @exception_id = exception.object_id
     @path = path
 
@@ -39,14 +50,14 @@ class NewRelic::NoticedError
 
     # replace error message if enabled
     if NewRelic::Agent.config[:'strip_exception_messages.enabled'] &&
-       !self.class.passes_message_allowlist(exception.class)
+        !self.class.passes_message_allowlist(exception.class)
       @message = STRIPPED_EXCEPTION_REPLACEMENT_MESSAGE
     end
 
     @attributes_from_notice_error = nil
     @attributes = nil
     @timestamp = timestamp
-    @expected = false
+    @expected = expected
   end
 
   def ==(other)
@@ -58,33 +69,21 @@ class NewRelic::NoticedError
   end
 
   def self.passes_message_allowlist(exception_class)
-    # For backwards compatibility until we remove :'strip_exception_messages.whitelist' config option
-
-    allowed = NewRelic::Agent.config[:'strip_exception_messages.allowed_classes'].concat(NewRelic::Agent.config[:'strip_exception_messages.whitelist'])
-
-    allowed.any? do |klass|
+    NewRelic::Agent.config[:'strip_exception_messages.allowed_classes'].any? do |klass|
       exception_class <= klass
     end
   end
 
   include NewRelic::Coerce
 
-  def to_collector_array(encoder=nil)
-    [ NewRelic::Helper.time_to_millis(timestamp),
+  def to_collector_array(encoder = nil)
+    [NewRelic::Helper.time_to_millis(timestamp),
       string(path),
       string(message),
       string(exception_class_name),
-      processed_attributes ]
+      processed_attributes]
   end
 
-  USER_ATTRIBUTES = "userAttributes".freeze
-  AGENT_ATTRIBUTES = "agentAttributes".freeze
-  INTRINSIC_ATTRIBUTES = "intrinsics".freeze
-
-  EMPTY_HASH = {}.freeze
-
-  DESTINATION = NewRelic::Agent::AttributeFilter::DST_ERROR_COLLECTOR
-
   # Note that we process attributes lazily and store the result. This is because
   # there is a possibility that a noticed error will be discarded and not sent back
   # as a traced error or TransactionError.
@@ -101,10 +100,10 @@ class NewRelic::NoticedError
 
   def base_parameters
     params = {}
-    params[:file_name]        = file_name   if file_name
-    params[:line_number]      = line_number if line_number
-    params[:stack_trace]      = stack_trace if stack_trace
-    params[:'error.expected'] = expected
+    params[:file_name] = file_name if file_name
+    params[:line_number] = line_number if line_number
+    params[:stack_trace] = stack_trace if stack_trace
+    params[ERROR_EXPECTED_KEY.to_sym] = expected
     params
   end
 
@@ -133,11 +132,19 @@ class NewRelic::NoticedError
     end
   end
 
+  def build_error_attributes
+    @attributes_from_notice_error ||= {}
+    @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
+
   def build_agent_attributes(merged_attributes)
     agent_attributes = if @attributes
       @attributes.agent_attributes_for(DESTINATION)
     else
-      EMPTY_HASH
+      NewRelic::EMPTY_HASH
     end
 
     # It's possible to override the request_uri from the transaction attributes
@@ -155,7 +162,7 @@ class NewRelic::NoticedError
     if @attributes
       @attributes.intrinsic_attributes_for(DESTINATION)
     else
-      EMPTY_HASH
+      NewRelic::EMPTY_HASH
     end
   end
 
@@ -179,6 +186,9 @@ class NewRelic::NoticedError
     if exception.nil?
       @exception_class_name = UNKNOWN_ERROR_CLASS_NAME
       @message = NIL_ERROR_MESSAGE
+    elsif exception.is_a?(NewRelic::Agent::NoticeableError)
+      @exception_class_name = exception.class_name
+      @message = exception.message
     else
       if defined?(Rails::VERSION::MAJOR) && Rails::VERSION::MAJOR < 5 && exception.respond_to?(:original_exception)
         exception = exception.original_exception || exception
@@ -187,5 +197,4 @@ class NewRelic::NoticedError
       @message = exception.to_s
     end
   end
-
 end

data/lib/new_relic/rack/agent_hooks.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 require 'new_relic/agent/event_listener'
 require 'new_relic/rack/agent_middleware'

data/lib/new_relic/rack/agent_middleware.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 require 'new_relic/agent/tracer'
 require 'new_relic/agent/instrumentation/controller_instrumentation'
@@ -13,10 +13,10 @@ module NewRelic
 
       attr_reader :transaction_options, :category, :target
 
-      def initialize(app, options={})
+      def initialize(app, options = {})
         @app = app
         @category = :middleware
-        @target   = self
+        @target = self
         @transaction_options = {
           :transaction_name => build_transaction_name
         }
@@ -33,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,152 +1,167 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 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
-    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 != "") && should_instrument?(env, status, headers)
-        response_string = autoinstrument_source(response, headers, js_to_inject)
-
-        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)
+        # Chunked transfer encoding is a streaming data transfer mechanism available only in HTTP/1.1
+        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,6 +1,6 @@
-# encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 # @api public
 module NewRelic

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/rpm/blob/master/LICENSE for complete details.
+# 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,63 +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.rb'
-
-    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