newrelic_rpm 3.12.0.288 → 9.10.2

data/lib/new_relic/collection_helper.rb

@@ -1,81 +1,63 @@
-# 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.
-
-require 'new_relic/control'
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 module NewRelic
   module CollectionHelper
-  DEFAULT_TRUNCATION_SIZE=16 * 1024
-  DEFAULT_ARRAY_TRUNCATION_SIZE=128
-  # Transform parameter hash into a hash whose values are strictly
-  # strings
-  def normalize_params(params)
-    case params
-      when Hash
-        # optimize for empty hash since that is often what this is called with.
-        return params if params.empty?
-        new_params = {}
-        params.each do | key, value |
-          new_params[truncate(normalize_params(key),64)] = normalize_params(value)
-        end
-        new_params
-      when Symbol, FalseClass, TrueClass, nil
-        params
-      when Numeric
-        truncate(params.to_s)
-      when String
-        truncate(params)
-      when Array
-        params.first(DEFAULT_ARRAY_TRUNCATION_SIZE).map{|item| normalize_params(item)}
-    else
-      truncate(flatten(params))
-    end
-  end
-
-  # Return an array of strings (backtrace), cleaned up for readability
-  # Return nil if there is no backtrace
+    DEFAULT_TRUNCATION_SIZE = 16 * 1024
+    DEFAULT_ARRAY_TRUNCATION_SIZE = 128
+    # Transform parameter hash into a hash whose values are strictly
+    # strings
+    def normalize_params(params)
+      case params
+        when Hash
+          # Optimize for empty hash since that is often what this is called with.
+          return params if params.empty?
 
-  def strip_nr_from_backtrace(backtrace)
-    if backtrace && !Agent.config[:disable_backtrace_cleanup]
-      # this is for 1.9.1, where strings no longer have Enumerable
-      backtrace = backtrace.split("\n") if String === backtrace
-      backtrace = backtrace.map(&:to_s)
-      backtrace = backtrace.reject do |line|
-        line.include?(NewRelic::Control.newrelic_root) or
-        line =~ /^newrelic_rpm\s/
+          new_params = {}
+          params.each do |key, value|
+            new_params[truncate(normalize_params(key), 64)] = normalize_params(value)
+          end
+          new_params
+        when Symbol, FalseClass, TrueClass, nil
+          params
+        when Numeric
+          truncate(params.to_s)
+        when String
+          truncate(params)
+        when Array
+          params.first(DEFAULT_ARRAY_TRUNCATION_SIZE).map { |item| normalize_params(item) }
+        else
+          truncate(flatten(params))
       end
-      # rename methods back to their original state
-      backtrace = backtrace.collect {|line| line.gsub(/_without_(newrelic|trace)/, "")}
     end
-    backtrace
-  end
 
-  private
+    private
 
-  # Convert any kind of object to a short string.
-  def flatten(object)
-    case object
-      when nil then ''
-      when object.instance_of?(String) then object
-      when String then String.new(object)  # convert string subclasses to strings
-      else "#<#{object.class.to_s}>"
+    # Convert any kind of object to a short string.
+    def flatten(object)
+      case object
+        when nil then ''
+        when object.instance_of?(String) then object
+        when String then String.new(object) # convert string subclasses to strings
+        else +"#<#{object.class}>"
+      end
     end
-  end
-  def truncate(string, len=DEFAULT_TRUNCATION_SIZE)
-    case string
-    when Symbol then string
-    when nil then ""
-    when String
-      real_string = flatten(string)
-      if real_string.size > len
-        real_string = real_string.slice(0...len)
-        real_string << "..."
+
+    def truncate(string, len = DEFAULT_TRUNCATION_SIZE)
+      case string
+      when Symbol then string
+      when nil then EMPTY_STR
+      when String
+        real_string = flatten(string)
+        if real_string.size > len
+          real_string = real_string.slice(0...len)
+          real_string << '...'
+        end
+        real_string
+      else
+        truncate(flatten(string), len)
       end
-      real_string
-    else
-      truncate(flatten(string), len)
     end
   end
-  end
 end

data/lib/new_relic/constants.rb

@@ -0,0 +1,45 @@
+# 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
+  ASTERISK = '*'
+
+  PRIORITY_PRECISION = 6
+
+  EMPTY_ARRAY = [].freeze
+  EMPTY_HASH = {}.freeze
+  EMPTY_STR = ''
+
+  LANGUAGE = 'ruby'
+
+  HTTP = 'HTTP'
+  HTTPS = 'HTTPS'
+  UNKNOWN = 'Unknown'
+
+  FORMAT_NON_RACK = 0
+  FORMAT_RACK = 1
+
+  NEWRELIC_KEY = 'newrelic'
+  CANDIDATE_NEWRELIC_KEYS = [
+    NEWRELIC_KEY,
+    'NEWRELIC',
+    'NewRelic',
+    'Newrelic'
+  ].freeze
+
+  TRACEPARENT_KEY = 'traceparent'
+  TRACESTATE_KEY = 'tracestate'
+
+  STANDARD_OUT = 'STDOUT'
+
+  HTTP_TRACEPARENT_KEY = "HTTP_#{TRACEPARENT_KEY.upcase}"
+  HTTP_TRACESTATE_KEY = "HTTP_#{TRACESTATE_KEY.upcase}"
+  HTTP_NEWRELIC_KEY = "HTTP_#{NEWRELIC_KEY.upcase}"
+
+  CONNECT_RETRY_PERIODS = [15, 15, 30, 60, 120, 300]
+  MAX_RETRY_PERIOD = 300
+
+  SLASH = '/'
+  ROOT = SLASH
+end

data/lib/new_relic/control/class_methods.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
 
 module NewRelic
   class Control
@@ -9,7 +9,7 @@ module NewRelic
     module ClassMethods
       # Access the Control singleton, lazy initialized.  Default will instantiate a new
       # instance or pass false to defer
-      def instance(create=true)
+      def instance(create = true)
         @instance ||= create && new_instance
       end
 
@@ -35,8 +35,8 @@ module NewRelic
 
       # nb this does not 'load test' the framework, it loads the 'test framework'
       def load_test_framework
-        config = File.expand_path(File.join('..','..','..','..', "test","config","newrelic.yml"), __FILE__)
-        require "config/test_control"
+        config = File.expand_path(File.join('..', '..', '..', '..', 'test', 'config', 'newrelic.yml'), __FILE__)
+        require 'config/test_control'
         NewRelic::Control::Frameworks::Test.new(local_env, config)
       end
 
@@ -49,12 +49,12 @@ module NewRelic
           # maybe it is already loaded by some external system
           # i.e. rpm_contrib or user extensions?
         end
-        NewRelic::Control::Frameworks.const_get(framework.to_s.capitalize)
+        NewRelic::Control::Frameworks.const_get(NewRelic::LanguageSupport.camelize(framework.to_s))
       end
 
       # The root directory for the plugin or gem
       def newrelic_root
-        File.expand_path(File.join("..", "..", "..", ".."), __FILE__)
+        File.expand_path(File.join('..', '..', '..', '..'), __FILE__)
       end
     end
     extend ClassMethods

data/lib/new_relic/control/frameworks/external.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/control/frameworks/ruby'
 module NewRelic
@@ -11,7 +11,7 @@ module NewRelic
       # out specifically because in this context we are not monitoring
       # the running process, but actually external things.
       class External < NewRelic::Control::Frameworks::Ruby
-        def init_config(options={})
+        def init_config(options = {})
           super
         end
       end

data/lib/new_relic/control/frameworks/rails.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/control/frameworks/ruby'
 module NewRelic
@@ -10,9 +10,11 @@ module NewRelic
       # Rails specific configuration, instrumentation, environment values,
       # etc.
       class Rails < NewRelic::Control::Frameworks::Ruby
+        BROWSER_MONITORING_INSTALLED_SINGLETON = NewRelic::Agent.config
+        BROWSER_MONITORING_INSTALLED_VARIABLE = :@browser_monitoring_installed
 
         def env
-          @env ||= RAILS_ENV.dup
+          @env ||= (ENV['NEW_RELIC_ENV'] || RAILS_ENV.dup)
         end
 
         # Rails can return an empty string from this method, causing
@@ -43,85 +45,93 @@ module NewRelic
         # In versions of Rails prior to 2.0, the rails config was only available to
         # the init.rb, so it had to be passed on from there.  This is a best effort to
         # find a config and use that.
-        def init_config(options={})
+        def init_config(options = {})
           @config = options[:config]
-          # Install the dependency detection,
-          if rails_config && ::Rails.configuration.respond_to?(:after_initialize)
-            rails_config.after_initialize do
-              # This will insure we load all the instrumentation as late as possible.  If the agent
-              # is not enabled, it will load a limited amount of instrumentation.
-              DependencyDetection.detect!
-            end
+          install_dependency_detection
+          install_browser_monitoring_and_agent_hooks
+        rescue => e
+          ::NewRelic::Agent.logger.error('Failure during init_config for Rails. Is Rails required in a non-Rails ' \
+                                         'app? Set NEW_RELIC_FRAMEWORK=ruby to avoid this message. The Ruby agent ' \
+                                         'will continue running, but Rails-specific features may be missing. ' \
+                                         "#{e.class} - #{e.message}")
+        end
+
+        def install_dependency_detection
+          return unless rails_config && ::Rails.configuration.respond_to?(:after_initialize)
+
+          rails_config.after_initialize do
+            # This will insure we load all the instrumentation as late as
+            # possible. If the agent is not enabled, it will load a limited
+            # amount of instrumentation.
+            DependencyDetection.detect!
           end
+        end
+
+        def install_browser_monitoring_and_agent_hooks
+          return unless rails_config
+
           if !Agent.config[:agent_enabled]
-            # Might not be running if it does not think mongrel, thin, passenger, etc
-            # is running, if it thinks it's a rake task, or if the agent_enabled is false.
-            ::NewRelic::Agent.logger.info("New Relic Agent not running.")
+            # Might not be running if it does not think mongrel, thin,
+            # passenger, etc. is running, if it thinks it's a rake task, or
+            # if the agent_enabled is false.
+            ::NewRelic::Agent.logger.info('New Relic agent not running. Skipping browser monitoring and agent hooks.')
           else
-            install_developer_mode(rails_config) if Agent.config[:developer_mode]
             install_browser_monitoring(rails_config)
             install_agent_hooks(rails_config)
           end
-        rescue => e
-          ::NewRelic::Agent.logger.error("Failure during init_config for Rails. Is Rails required in a non-Rails app? Set NEW_RELIC_FRAMEWORK=ruby to avoid this message.",
-                                         "The Ruby agent will continue running, but Rails-specific features may be missing.",
-                                         e)
         end
 
         def install_agent_hooks(config)
-          return if @agent_hooks_installed
+          return if defined?(@agent_hooks_installed) && @agent_hooks_installed
+
           @agent_hooks_installed = true
           return if config.nil? || !config.respond_to?(:middleware)
+
           begin
             require 'new_relic/rack/agent_hooks'
             return unless NewRelic::Rack::AgentHooks.needed?
-            config.middleware.use NewRelic::Rack::AgentHooks
-            ::NewRelic::Agent.logger.debug("Installed New Relic Agent Hooks middleware")
+
+            config.middleware.use(NewRelic::Rack::AgentHooks)
+            ::NewRelic::Agent.logger.debug('Installed New Relic agent hooks middleware')
           rescue => e
-            ::NewRelic::Agent.logger.warn("Error installing New Relic Agent Hooks middleware", e)
+            ::NewRelic::Agent.logger.warn('Error installing New Relic agent hooks middleware', e)
           end
         end
 
         def install_browser_monitoring(config)
-          return if @browser_monitoring_installed
-          @browser_monitoring_installed = true
-          return if config.nil? || !config.respond_to?(:middleware) || !Agent.config[:'browser_monitoring.auto_instrument']
-          begin
-            require 'new_relic/rack/browser_monitoring'
-            config.middleware.use NewRelic::Rack::BrowserMonitoring
-            ::NewRelic::Agent.logger.debug("Installed New Relic Browser Monitoring middleware")
-          rescue => e
-            ::NewRelic::Agent.logger.warn("Error installing New Relic Browser Monitoring middleware", e)
-          end
-        end
+          @install_lock.synchronize do
+            return if browser_agent_already_installed?
+
+            mark_browser_agent_as_installed
+            return if config.nil? || !config.respond_to?(:middleware) || !Agent.config[:'browser_monitoring.auto_instrument']
 
-        def install_developer_mode(rails_config)
-          return if @installed
-          @installed = true
-          if rails_config && rails_config.respond_to?(:middleware)
             begin
-              require 'new_relic/rack/developer_mode'
-              rails_config.middleware.use NewRelic::Rack::DeveloperMode
-              ::NewRelic::Agent.logger.info("New Relic Agent Developer Mode enabled.")
-              if env == "production"
-                ::NewRelic::Agent.logger.warn("***New Relic Developer Mode is not intended to be enabled in production environments! We highly recommend setting developer_mode: false for the production environment in your newrelic.yml.")
-              end
+              require 'new_relic/rack/browser_monitoring'
+              config.middleware.use(NewRelic::Rack::BrowserMonitoring)
+              ::NewRelic::Agent.logger.debug('Installed New Relic Browser Monitoring middleware')
             rescue => e
-              ::NewRelic::Agent.logger.warn("Error installing New Relic Developer Mode", e)
+              ::NewRelic::Agent.logger.warn('Error installing New Relic Browser Monitoring middleware', e)
             end
-          elsif rails_config
-            ::NewRelic::Agent.logger.warn("Developer mode not available for Rails versions prior to 2.2")
           end
         end
 
+        def browser_agent_already_installed?
+          BROWSER_MONITORING_INSTALLED_SINGLETON.instance_variable_defined?(BROWSER_MONITORING_INSTALLED_VARIABLE) &&
+            BROWSER_MONITORING_INSTALLED_SINGLETON.instance_variable_get(BROWSER_MONITORING_INSTALLED_VARIABLE)
+        end
+
+        def mark_browser_agent_as_installed
+          BROWSER_MONITORING_INSTALLED_SINGLETON.instance_variable_set(BROWSER_MONITORING_INSTALLED_VARIABLE, true)
+        end
+
         def rails_version
-          @rails_version ||= NewRelic::VersionNumber.new(::Rails::VERSION::STRING)
+          @rails_version ||= Gem::Version.new(::Rails::VERSION::STRING)
         end
 
         protected
 
         def rails_vendor_root
-          File.join(root,'vendor','rails')
+          File.join(root, 'vendor', 'rails')
         end
 
         def install_shim

data/lib/new_relic/control/frameworks/rails3.rb

@@ -1,9 +1,8 @@
-# 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/control/frameworks/rails'
-require 'new_relic/rack/error_collector'
 
 module NewRelic
   class Control
@@ -14,9 +13,8 @@ module NewRelic
       # NewRelic::Control::Frameworks::Rails class, where the two do
       # not differ
       class Rails3 < NewRelic::Control::Frameworks::Rails
-
         def env
-          @env ||= ::Rails.env.to_s
+          @env ||= (ENV['NEW_RELIC_ENV'] || ::Rails.env.to_s)
         end
 
         def rails_root
@@ -24,11 +22,11 @@ module NewRelic
         end
 
         def vendor_root
-          @vendor_root ||= File.join(root,'vendor','rails')
+          @vendor_root ||= File.join(root, 'vendor', 'rails')
         end
 
         def version
-          @rails_version ||= NewRelic::VersionNumber.new(::Rails::VERSION::STRING)
+          @rails_version ||= Gem::Version.new(::Rails::VERSION::STRING)
         end
 
         protected

data/lib/new_relic/control/frameworks/rails4.rb

@@ -1,9 +1,9 @@
-# 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/control/frameworks/rails3'
-require 'new_relic/rack/error_collector'
+
 module NewRelic
   class Control
     module Frameworks

data/lib/new_relic/control/frameworks/rails_notifications.rb

@@ -0,0 +1,14 @@
+# 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/control/frameworks/rails4'
+
+module NewRelic
+  class Control
+    module Frameworks
+      class RailsNotifications < NewRelic::Control::Frameworks::Rails4
+      end
+    end
+  end
+end

data/lib/new_relic/control/frameworks/roda.rb

@@ -0,0 +1,20 @@
+# 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/control/frameworks/ruby'
+module NewRelic
+  class Control
+    module Frameworks
+      # Contains basic control logic for Roda
+      class Roda < NewRelic::Control::Frameworks::Ruby
+        protected
+
+        def install_shim
+          super
+          ::Roda.class_eval { include NewRelic::Agent::Instrumentation::ControllerInstrumentation::Shim }
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/control/frameworks/ruby.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
 
 module NewRelic
   class Control
@@ -8,15 +8,15 @@ module NewRelic
       # A control used when no framework is detected - the default.
       class Ruby < NewRelic::Control
         def env
-          @env ||= ENV['NEW_RELIC_ENV'] || ENV['RUBY_ENV'] ||
-                   ENV['RAILS_ENV']     || ENV['RACK_ENV'] || 'development'
+          @env ||= ENV['NEW_RELIC_ENV'] || ENV['RUBY_ENV'] || ENV['RAILS_ENV'] ||
+            ENV['APP_ENV'] || ENV['RACK_ENV'] || 'development'
         end
 
         def root
           @root ||= ENV['APP_ROOT'] || '.'
         end
 
-        def init_config(options={})
+        def init_config(options = {})
         end
       end
     end

data/lib/new_relic/control/frameworks/sinatra.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/control/frameworks/ruby'
 module NewRelic
@@ -8,6 +8,12 @@ module NewRelic
     module Frameworks
       # Contains basic control logic for Sinatra
       class Sinatra < NewRelic::Control::Frameworks::Ruby
+        protected
+
+        def install_shim
+          super
+          ::Sinatra::Base.class_eval { include NewRelic::Agent::Instrumentation::ControllerInstrumentation::Shim }
+        end
       end
     end
   end

data/lib/new_relic/control/frameworks.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
 
 module NewRelic
   class Control