newrelic_rpm 6.10.0.364 → 8.15.0

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

@@ -1,13 +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 'fileutils'
 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,12 +20,12 @@ 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
+    super(command_line_args)
     if @dest_dir.nil?
       # Install a newrelic.yml file into the local config directory.
-      if File.directory? "config"
+      if File.directory?("config")
         @dest_dir = "config"
       else
         @dest_dir = "."
@@ -43,7 +42,8 @@ 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 +60,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
@@ -72,15 +71,13 @@ Visit support.newrelic.com if you are experiencing installation issues.
   private
 
   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 }
+    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("-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 }
-      yield o if block_given?
+        "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

@@ -1,11 +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
 
 module NewRelic
   module Coerce
-
     module_function
 
     # We really don't want to send bad values to the collector, and it doesn't
@@ -15,36 +13,39 @@ 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
       log_failure(value, Integer, context, error)
       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
     rescue => error
       log_failure(value, Float, context, error)
       0.0
     end
 
-    def string(value, context=nil)
+    def string(value, context = nil)
       return value if value.nil?
+
       String(value)
     rescue => error
       log_failure(value.class, String, context, error)
-      ""
+      EMPTY_STR
     end
 
     def scalar(val)
@@ -54,8 +55,6 @@ module NewRelic
       when Float
         if val.finite?
           val
-        else
-          nil
         end
       when Symbol
         val.to_s
@@ -64,25 +63,28 @@ module NewRelic
       end
     end
 
-    def int! value
+    def int!(value)
       return nil unless value_or_nil(value)
+
       Integer(value)
     end
 
     # Use when you plan to perform a boolean check using the integer 1
     # for true and the integer 0 for false
     # String values will be converted to 0
-    def boolean_int! value
+    def boolean_int!(value)
       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
 
-    def value_or_nil value
+    def value_or_nil(value)
       return nil if value.nil? || (value.respond_to?(:empty?) && value.empty?)
+
       value
     end
 

data/lib/new_relic/collection_helper.rb

@@ -1,61 +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.
+# 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))
+    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 String.new("#<#{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

@@ -1,6 +1,5 @@
-# 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
@@ -28,7 +27,13 @@ module NewRelic
   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]
+  MIN_RETRY_PERIOD = 15
+  MAX_RETRY_PERIOD = 300
 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,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

@@ -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,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,18 +62,21 @@ 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)
           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
+
+            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)
@@ -82,15 +84,19 @@ module NewRelic
         end
 
         def install_browser_monitoring(config)
-          return if defined?(@browser_monitoring_installed) && @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)
+          @install_lock.synchronize do
+            return if defined?(@browser_monitoring_installed) && @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
         end
 
@@ -101,7 +107,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

@@ -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/rails'
 
@@ -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/rails4.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/rails3'
 

data/lib/new_relic/control/frameworks/rails_notifications.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/rails4'
 

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

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