newrelic_rpm 7.0.0 → 8.8.0

data/lib/new_relic/cli/commands/deployments.rb

@@ -10,7 +10,7 @@ require 'net/http'
 require 'new_relic/agent/hostname'
 
 # We need to use the Control object but we don't want to load
-# the rails/merb environment.  The defined? clause is so that
+# the rails environment.  The defined? clause is so that
 # it won't load it twice, something it does when run inside a test
 require 'new_relic/control' unless defined? NewRelic::Control
 
@@ -30,8 +30,8 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
   def initialize command_line_args
     @control = NewRelic::Control.instance
     @environment = nil
-    @changelog   = nil
-    @user        = nil
+    @changelog = nil
+    @user = nil
     super(command_line_args)
     @description ||= @leftover && @leftover.join(" ")
     @user ||= ENV['USER']
@@ -66,12 +66,12 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
       @description = nil if @description && @description.strip.empty?
       create_params = {}
       {
-            :application_id => @appname,
-            :host => NewRelic::Agent::Hostname.get,
-            :description => @description,
-            :user => @user,
-            :revision => @revision,
-            :changelog => @changelog
+        :application_id => @appname,
+        :host => NewRelic::Agent::Hostname.get,
+        :description => @description,
+        :user => @user,
+        :revision => @revision,
+        :changelog => @changelog
       }.each do |k, v|
         create_params["deployment[#{k}]"] = v unless v.nil? || v == ''
       end
@@ -90,9 +90,9 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
       response = http.request(request)
 
       if response.is_a? Net::HTTPSuccess
-        info "Recorded deployment to '#{@appname}' (#{@description || Time.now })"
+        info "Recorded deployment to '#{@appname}' (#{@description || Time.now})"
       else
-        err_string = REXML::Document.new(response.body).elements['errors/error'].map(&:to_s).join("; ") rescue  response.message
+        err_string = REXML::Document.new(response.body).elements['errors/error'].map(&:to_s).join("; ") rescue response.message
         raise NewRelic::Cli::Command::CommandFailure, "Deployment not recorded: #{err_string}"
       end
     rescue SystemCallError, SocketError => e
@@ -111,26 +111,24 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
   private
 
   def options
-    OptionParser.new %Q{Usage: #{$0} #{self.class.command} [OPTIONS] ["description"] }, 40 do |o|
+    OptionParser.new %Q(Usage: #{$0} #{self.class.command} [OPTIONS] ["description"] ), 40 do |o|
       o.separator "OPTIONS:"
       o.on("-a", "--appname=NAME", String,
-             "Set the application name.",
-             "Default is app_name setting in newrelic.yml") { | e | @appname = e }
+        "Set the application name.",
+        "Default is app_name setting in newrelic.yml") { |e| @appname = e }
       o.on("-e", "--environment=name", String,
-               "Override the (RAILS|MERB|RUBY|RACK)_ENV setting",
-               "currently: #{control.env}") { | e | @environment = e }
+        "Override the (RAILS|RUBY|RACK)_ENV setting",
+        "currently: #{control.env}") { |e| @environment = e }
       o.on("-u", "--user=USER", String,
-             "Specify the user deploying, for information only",
-             "Default: #{@user || '<none>'}") { | u | @user = u }
+        "Specify the user deploying, for information only",
+        "Default: #{@user || '<none>'}") { |u| @user = u }
       o.on("-r", "--revision=REV", String,
-             "Specify the revision being deployed") { | r | @revision = r }
+        "Specify the revision being deployed") { |r| @revision = r }
       o.on("-l", "--license-key=KEY", String,
-             "Specify the license key of the account for the app being deployed") { | l | @license_key = l }
+        "Specify the license key of the account for the app being deployed") { |l| @license_key = l }
       o.on("-c", "--changes",
-             "Read in a change log from the standard input") { @changelog = STDIN.read }
+        "Read in a change log from the standard input") { @changelog = STDIN.read }
       yield o if block_given?
     end
   end
-
-
 end

data/lib/new_relic/cli/commands/install.rb

@@ -7,7 +7,6 @@ require 'new_relic/version'
 require 'erb'
 
 class NewRelic::Cli::Install < NewRelic::Cli::Command
-
   NO_LICENSE_KEY = "<PASTE LICENSE KEY HERE>"
 
   def self.command; "install"; end
@@ -21,7 +20,7 @@ class NewRelic::Cli::Install < NewRelic::Cli::Command
   # Will throw CommandFailed exception if there's any error.
   #
   attr_reader :dest_dir, :license_key, :generated_for_user, :quiet, :src_file, :app_name
-  def initialize command_line_args={}
+  def initialize command_line_args = {}
     @dest_dir = nil
     super command_line_args
     if @dest_dir.nil?
@@ -43,7 +42,7 @@ class NewRelic::Cli::Install < NewRelic::Cli::Command
     if File.exist?(dest_file) && !@force
       raise NewRelic::Cli::Command::CommandFailure, "newrelic.yml file already exists.  Use --force flag to overwrite."
     end
-    File.open(dest_file, 'w') { | out | out.puts(content) }
+    File.open(dest_file, 'w') { |out| out.puts(content) }
 
     puts <<-EOF unless quiet
 
@@ -60,11 +59,10 @@ you receive upon registration.
 
 Visit support.newrelic.com if you are experiencing installation issues.
     EOF
-
   end
 
   def content
-    @src_file ||= File.expand_path(File.join(File.dirname(__FILE__),"..","..","..","..","newrelic.yml"))
+    @src_file ||= File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "..", "newrelic.yml"))
     template = File.read(@src_file)
     ERB.new(template).result(binding)
   end
@@ -73,14 +71,12 @@ Visit support.newrelic.com if you are experiencing installation issues.
 
   def options
     OptionParser.new "Usage: #{$0} #{self.class.command} [ OPTIONS] 'application name'", 40 do |o|
-      o.on("-f", "--force", "Overwrite newrelic.yml if it exists") { | e | @force = true }
+      o.on("-f", "--force", "Overwrite newrelic.yml if it exists") { |e| @force = true }
       o.on("-l", "--license_key=NAME", String,
-             "Use the given license key") { | e | @license_key = e }
+        "Use the given license key") { |e| @license_key = e }
       o.on("-d", "--destdir=name", String,
-               "Write the newrelic.yml to the given directory, default is '.'") { | e | @dest_dir = e }
+        "Write the newrelic.yml to the given directory, default is '.'") { |e| @dest_dir = e }
       yield o if block_given?
     end
   end
-
-
 end

data/lib/new_relic/coerce.rb

@@ -5,7 +5,6 @@
 
 module NewRelic
   module Coerce
-
     module_function
 
     # We really don't want to send bad values to the collector, and it doesn't
@@ -15,14 +14,14 @@ module NewRelic
     # to provide documentation of expected types on to_collector_array methods,
     # and to log failures if totally invalid data gets into outgoing data
 
-    def int(value, context=nil)
+    def int(value, context = nil)
       Integer(value)
     rescue => error
       log_failure(value, Integer, context, error)
       0
     end
 
-    def int_or_nil(value, context=nil)
+    def int_or_nil(value, context = nil)
       return nil if value.nil?
       Integer(value)
     rescue => error
@@ -30,7 +29,7 @@ module NewRelic
       nil
     end
 
-    def float(value, context=nil)
+    def float(value, context = nil)
       result = Float(value)
       raise "Value #{result.inspect} is not finite." unless result.finite?
       result
@@ -39,7 +38,7 @@ module NewRelic
       0.0
     end
 
-    def string(value, context=nil)
+    def string(value, context = nil)
       return value if value.nil?
       String(value)
     rescue => error
@@ -54,8 +53,6 @@ module NewRelic
       when Float
         if val.finite?
           val
-        else
-          nil
         end
       when Symbol
         val.to_s
@@ -76,7 +73,7 @@ module NewRelic
       value.to_i
     end
 
-    def float! value, precision=NewRelic::PRIORITY_PRECISION
+    def float! value, precision = NewRelic::PRIORITY_PRECISION
       return nil unless value_or_nil(value)
       value.to_f.round(precision)
     end

data/lib/new_relic/collection_helper.rb

@@ -4,58 +4,59 @@
 
 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))
+    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
-  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.to_s}>"
+      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 ""
+      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

@@ -28,10 +28,6 @@ module NewRelic
   TRACEPARENT_KEY = "traceparent"
   TRACESTATE_KEY = "tracestate"
 
-  # Right now, old and new Rubies are the same.  Intention is to use "(...)" for
-  # Ruby 2.7+ for argument delegation, but doing so is a breaking API change.
-  ARGS_FOR_RUBY_VERSION = RUBY_VERSION < "2.7.0" ? "*args, &block" : "*args, &block"
-
   HTTP_TRACEPARENT_KEY = "HTTP_#{TRACEPARENT_KEY.upcase}"
   HTTP_TRACESTATE_KEY = "HTTP_#{TRACESTATE_KEY.upcase}"
   HTTP_NEWRELIC_KEY = "HTTP_#{NEWRELIC_KEY.upcase}"

data/lib/new_relic/control/class_methods.rb

@@ -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,7 +35,7 @@ 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__)
+        config = File.expand_path(File.join('..', '..', '..', '..', "test", "config", "newrelic.yml"), __FILE__)
         require "config/test_control"
         NewRelic::Control::Frameworks::Test.new(local_env, config)
       end

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

@@ -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

@@ -10,9 +10,8 @@ module NewRelic
       # Rails specific configuration, instrumentation, environment values,
       # etc.
       class Rails < NewRelic::Control::Frameworks::Ruby
-
         def env
-          @env ||= ( ENV['NEW_RELIC_ENV'] || RAILS_ENV.dup )
+          @env ||= (ENV['NEW_RELIC_ENV'] || RAILS_ENV.dup)
         end
 
         # Rails can return an empty string from this method, causing
@@ -43,7 +42,7 @@ 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)
@@ -63,8 +62,8 @@ module NewRelic
           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)
+            "The Ruby agent will continue running, but Rails-specific features may be missing.",
+            e)
         end
 
         def install_agent_hooks(config)
@@ -103,7 +102,7 @@ module NewRelic
         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

@@ -13,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 ||= ( ENV['NEW_RELIC_ENV'] || ::Rails.env.to_s )
+          @env ||= (ENV['NEW_RELIC_ENV'] || ::Rails.env.to_s)
         end
 
         def rails_root
@@ -23,7 +22,7 @@ module NewRelic
         end
 
         def vendor_root
-          @vendor_root ||= File.join(root,'vendor','rails')
+          @vendor_root ||= File.join(root, 'vendor', 'rails')
         end
 
         def version

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

@@ -9,14 +9,14 @@ module NewRelic
       class Ruby < NewRelic::Control
         def env
           @env ||= ENV['NEW_RELIC_ENV'] || ENV['RUBY_ENV'] || ENV['RAILS_ENV'] ||
-                   ENV['APP_ENV']       || ENV['RACK_ENV'] || 'development'
+            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

@@ -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/instance_methods.rb

@@ -8,7 +8,6 @@ require 'new_relic/agent/agent_logger'
 
 module NewRelic
   class Control
-
     # Contains methods that relate to the runtime usage of the control
     # object. Note that these are subject to override in the
     # NewRelic::Control::Framework classes that are actually instantiated
@@ -47,7 +46,7 @@ module NewRelic
       # Subclasses are not allowed to override, but must implement
       # init_config({}) which is called one or more times.
       #
-      def init_plugin(options={})
+      def init_plugin(options = {})
         env = determine_env(options)
 
         configure_agent(env, options)
@@ -87,10 +86,10 @@ module NewRelic
 
         if @started_in_env && @started_in_env != env
           Agent.logger.error("Attempted to start agent in #{env.inspect} environment, but agent was already running in #{@started_in_env.inspect}",
-                             "The agent will continue running in #{@started_in_env.inspect}. To alter this, ensure the desired environment is set before the agent starts.")
+            "The agent will continue running in #{@started_in_env.inspect}. To alter this, ensure the desired environment is set before the agent starts.")
         else
           Agent.logger.info("Starting the New Relic agent version #{NewRelic::VERSION::STRING} in #{env.inspect} environment.",
-                            "To prevent agent startup add a NEW_RELIC_AGENT_ENABLED=false environment variable or modify the #{env.inspect} section of your newrelic.yml.")
+            "To prevent agent startup add a NEW_RELIC_AGENT_ENABLED=false environment variable or modify the #{env.inspect} section of your newrelic.yml.")
         end
 
         env
@@ -164,7 +163,7 @@ module NewRelic
 
       protected
 
-      def initialize(local_env, config_file_override=nil)
+      def initialize(local_env, config_file_override = nil)
         @install_lock = Mutex.new
         @local_env = local_env
         @started_in_env = nil

data/lib/new_relic/control/instrumentation.rb

@@ -7,7 +7,6 @@ module NewRelic
     # Contains methods that relate to adding and executing files that
     # contain instrumentation for the Ruby Agent
     module Instrumentation
-
       # Adds a list of files in Dir.glob format
       # (e.g. '/app/foo/**/*_instrumentation.rb')
       # This requires the files within a rescue block, so that any
@@ -57,15 +56,46 @@ module NewRelic
 
         # Instrumentation for the key code points inside rails for monitoring by NewRelic.
         # note this file is loaded only if the newrelic agent is enabled (through config/newrelic.yml)
-        instrumentation_path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'agent','instrumentation'))
+        instrumentation_path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'agent', 'instrumentation'))
         @instrumentation_files <<
-        File.join(instrumentation_path, '*.rb') <<
-        File.join(instrumentation_path, app.to_s, '*.rb')
-        @instrumentation_files.each { | pattern |  load_instrumentation_files pattern }
+          File.join(instrumentation_path, '*.rb') <<
+          File.join(instrumentation_path, app.to_s, '*.rb')
+        @instrumentation_files.each { |pattern| load_instrumentation_files pattern }
         DependencyDetection.detect!
+        ruby_22_deprecation
+        rails_32_deprecation
         ::NewRelic::Agent.logger.info "Finished instrumentation"
       end
     end
+
+    def rails_32_deprecation
+      return unless defined?(Rails::VERSION) && Gem::Version.new(Rails::VERSION::STRING) <= Gem::Version.new('3.2')
+      deprecation_msg = 'The Ruby Agent is dropping support for Rails 3.2 ' \
+        'in a future major release. Please upgrade your Rails version to continue receiving support. ' \
+
+      Agent.logger.log_once(
+        :warn,
+        :deprecated_rails_version,
+        deprecation_msg
+      )
+
+      ::NewRelic::Agent.record_metric("Supportability/Deprecated/Rails32", 1)
+    end
+
+    def ruby_22_deprecation
+      return unless RUBY_VERSION <= '2.2.0'
+      deprecation_msg = 'The Ruby Agent is dropping support for Ruby 2.2 ' \
+        'in version 9.0.0. Please upgrade your Ruby version to continue receiving support. ' \
+
+      ::NewRelic::Agent.logger.log_once(
+        :warn,
+        :deprecated_ruby_version,
+        deprecation_msg
+      )
+
+      ::NewRelic::Agent.record_metric("Supportability/Deprecated/Ruby22", 1)
+    end
+
     include Instrumentation
   end
 end

data/lib/new_relic/control/server_methods.rb

@@ -4,9 +4,8 @@
 
 module NewRelic
   class Control
-
     # Structs holding info for the remote server and proxy server
-    class Server < Struct.new :name, :port #:nodoc:
+    class Server < Struct.new :name, :port # :nodoc:
       def to_s; "#{name}:#{port}"; end
     end
 
@@ -22,7 +21,7 @@ module NewRelic
         @api_server ||= NewRelic::Control::Server.new(Agent.config[:api_host], Agent.config[:api_port])
       end
 
-      def server_from_host(hostname=nil)
+      def server_from_host(hostname = nil)
         NewRelic::Control::Server.new(hostname || Agent.config[:host], Agent.config[:port])
       end
     end

data/lib/new_relic/control.rb

@@ -23,7 +23,6 @@ require 'new_relic/agent'
 require 'new_relic/delayed_job_injection'
 
 module NewRelic
-
   # The Control is a singleton responsible for the startup and
   # initialization sequence.  The initializer uses a LocalEnvironment to
   # detect the framework and instantiates the framework specific

data/lib/new_relic/dependency_detection.rb

@@ -3,7 +3,6 @@
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 module DependencyDetection
-
   module_function
 
   @items = []
@@ -33,7 +32,7 @@ module DependencyDetection
   end
 
   def dependency_by_name(name)
-    @items.find {|i| i.name == name }
+    @items.find { |i| i.name == name }
   end
 
   def installed?(name)
@@ -56,7 +55,6 @@ module DependencyDetection
     attr_reader :dependencies
     attr_reader :prepend_conflicts
 
-
     def executed!
       @executed = true
     end
@@ -95,19 +93,19 @@ module DependencyDetection
       yield
     end
 
-    def prepend_instrument target_class, instrumenting_module, supportability_name=nil
+    def prepend_instrument target_class, instrumenting_module, supportability_name = nil
       log_and_instrument("Prepend", instrumenting_module, supportability_name) do
         target_class.send :prepend, instrumenting_module
       end
     end
 
-    def chain_instrument instrumenting_module, supportability_name=nil
+    def chain_instrument instrumenting_module, supportability_name = nil
       log_and_instrument("MethodChaining", instrumenting_module, supportability_name) do
         instrumenting_module.instrument!
       end
     end
 
-    def chain_instrument_target target, instrumenting_module, supportability_name=nil
+    def chain_instrument_target target, instrumenting_module, supportability_name = nil
       NewRelic::Agent.logger.info "Installing deferred #{target} instrumentation"
       log_and_instrument("MethodChaining", instrumenting_module, supportability_name) do
         instrumenting_module.instrument! target
@@ -134,7 +132,7 @@ module DependencyDetection
         begin
           dep.call
         rescue => err
-          NewRelic::Agent.logger.error( "Error while detecting #{self.name}:", err )
+          NewRelic::Agent.logger.error("Error while detecting #{self.name}:", err)
           false
         end
       end
@@ -148,7 +146,7 @@ module DependencyDetection
       !(disabled_configured? || deprecated_disabled_configured?)
     end
 
-    # TODO: Remove in 8.0
+    # TODO: MAJOR VERSION
     # will only return true if a disabled key is found and is truthy
     def deprecated_disabled_configured?
       return false if self.name.nil?
@@ -222,7 +220,7 @@ module DependencyDetection
         begin
           conflict.call
         rescue => err
-          NewRelic::Agent.logger.error( "Error while checking prepend conflicts #{self.name}:", err )
+          NewRelic::Agent.logger.error("Error while checking prepend conflicts #{self.name}:", err)
           false # assumes no conflicts exist since `prepend` is preferred method of instrumenting
         end
       end