newrelic_rpm 8.7.0 → 8.11.0

data/lib/new_relic/agent.rb

@@ -1,6 +1,6 @@
-# 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 'forwardable'
 
@@ -29,7 +29,7 @@ module NewRelic
     require 'new_relic/metric_spec'
     require 'new_relic/metric_data'
     require 'new_relic/noticed_error'
-    require 'new_relic/agent/noticible_error'
+    require 'new_relic/agent/noticeable_error'
     require 'new_relic/supportability_helper'
 
     require 'new_relic/agent/encoding_normalizer'
@@ -143,6 +143,8 @@ module NewRelic
     #
     def add_or_defer_method_tracer(receiver, method_name, metric_name, options)
       @tracer_lock.synchronize do
+        options[:code_information] = NewRelic::Agent::MethodTracerHelpers.code_information(receiver, method_name)
+
         if @agent
           receiver.send(:_nr_add_method_tracer_now, method_name, metric_name, options)
         else
@@ -196,15 +198,9 @@ module NewRelic
 
       if value.is_a?(Hash)
         stats = NewRelic::Agent::Stats.new
-
-        stats.call_count = value[:count] if value[:count]
-        stats.total_call_time = value[:total] if value[:total]
-        stats.total_exclusive_time = value[:total] if value[:total]
-        stats.min_call_time = value[:min] if value[:min]
-        stats.max_call_time = value[:max] if value[:max]
-        stats.sum_of_squares = value[:sum_of_squares] if value[:sum_of_squares]
-        value = stats
+        value = stats.hash_merge(value)
       end
+
       agent.stats_engine.tl_record_unscoped_metrics(metric_name, value)
     end
 
@@ -235,7 +231,7 @@ module NewRelic
     # @!group Recording custom errors
 
     # Set a filter to be applied to errors that the Ruby Agent will
-    # track.  The block should evalute to the exception to track
+    # track.  The block should evaluate to the exception to track
     # (which could be different from the original exception) or nil to
     # ignore this exception.
     #
@@ -287,7 +283,7 @@ module NewRelic
       record_api_supportability_metric(:notice_error)
 
       Transaction.notice_error(exception, options)
-      nil # don't return a noticed error datastructure. it can only hurt.
+      nil # don't return a noticed error data structure. it can only hurt.
     end
 
     # @!endgroup
@@ -417,7 +413,7 @@ module NewRelic
     #
     def add_instrumentation(file_pattern)
       record_api_supportability_metric(:add_instrumentation)
-      NewRelic::Control.instance.add_instrumentation file_pattern
+      NewRelic::Control.instance.add_instrumentation(file_pattern)
     end
 
     # Require agent testing helper methods
@@ -513,8 +509,8 @@ module NewRelic
     # @api public
     #
     def disable_transaction_tracing
-      Deprecator.deprecate :disable_transaction_tracing,
-        'disable_all_tracing or ignore_transaction'
+      Deprecator.deprecate(:disable_transaction_tracing,
+        'disable_all_tracing or ignore_transaction')
       record_api_supportability_metric(:disable_transaction_tracing)
       yield
     end
@@ -577,21 +573,25 @@ module NewRelic
     def add_custom_attributes(params) # THREAD_LOCAL_ACCESS
       record_api_supportability_metric(:add_custom_attributes)
 
-      if params.is_a? Hash
+      if params.is_a?(Hash)
         txn = Transaction.tl_current
         txn.add_custom_attributes(params) if txn
 
         segment = ::NewRelic::Agent::Tracer.current_segment
         if segment
-          # Make sure not to override existing segment-level custom attributes
-          segment_custom_keys = segment.attributes.custom_attributes.keys.map(&:to_sym)
-          segment.add_custom_attributes(params.reject { |k, _v| segment_custom_keys.include?(k.to_sym) })
+          add_new_segment_attributes(params, segment)
         end
       else
         ::NewRelic::Agent.logger.warn("Bad argument passed to #add_custom_attributes. Expected Hash but got #{params.class}")
       end
     end
 
+    def add_new_segment_attributes(params, segment)
+      # Make sure not to override existing segment-level custom attributes
+      segment_custom_keys = segment.attributes.custom_attributes.keys.map(&:to_sym)
+      segment.add_custom_attributes(params.reject { |k, _v| segment_custom_keys.include?(k.to_sym) })
+    end
+
     # Add custom attributes to the span event for the current span. Attributes will be visible on spans in the
     # New Relic Distributed Tracing UI and on span events in New Relic Insights.
     #
@@ -605,15 +605,15 @@ module NewRelic
     #
     # @see https://docs.newrelic.com/docs/using-new-relic/welcome-new-relic/get-started/glossary#span
     # @api public
-    def add_custom_span_attributes params
-      record_api_supportability_metric :add_custom_span_attributes
+    def add_custom_span_attributes(params)
+      record_api_supportability_metric(:add_custom_span_attributes)
 
-      if params.is_a? Hash
+      if params.is_a?(Hash)
         if segment = NewRelic::Agent::Tracer.current_segment
-          segment.add_custom_attributes params
+          segment.add_custom_attributes(params)
         end
       else
-        ::NewRelic::Agent.logger.warn "Bad argument passed to #add_custom_span_attributes. Expected Hash but got #{params.class}"
+        ::NewRelic::Agent.logger.warn("Bad argument passed to #add_custom_span_attributes. Expected Hash but got #{params.class}")
       end
     end
 
@@ -670,7 +670,7 @@ module NewRelic
 
     # Yield to a block that is run with a database metric name context.  This means
     # the Database instrumentation will use this for the metric name if it does not
-    # otherwise know about a model.  This is re-entrant.
+    # otherwise know about a model.  This is reentrant.
     #
     # @param [String,Class,#to_s] model the DB model class
     #
@@ -696,7 +696,7 @@ module NewRelic
     def notify(event_type, *args)
       agent.events.notify(event_type, *args)
     rescue
-      NewRelic::Agent.logger.debug "Ignoring exception during %p event notification" % [event_type]
+      NewRelic::Agent.logger.debug("Ignoring exception during %p event notification" % [event_type])
     end
 
     # @!group Trace and Entity metadata
@@ -756,7 +756,7 @@ module NewRelic
     def browser_timing_header(nonce = nil)
       record_api_supportability_metric(:browser_timing_header)
 
-      return "" unless agent
+      return EMPTY_STR unless agent
       agent.javascript_instrumentor.browser_timing_header(nonce)
     end
 

data/lib/new_relic/cli/command.rb

@@ -1,6 +1,6 @@
-# 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 'optparse'
 
@@ -15,8 +15,8 @@ module NewRelic
       # Capture a failure to execute the command.
       class CommandFailure < StandardError
         attr_reader :options
-        def initialize message, opt_parser = nil
-          super message
+        def initialize(message, opt_parser = nil)
+          super(message)
           @options = opt_parser
         end
       end
@@ -33,7 +33,7 @@ module NewRelic
         if Hash === command_line_args
           # command line args is an options hash
           command_line_args.each do |key, value|
-            instance_variable_set "@#{key}", value.to_s if value
+            instance_variable_set("@#{key}", value.to_s) if value
           end
         else
           # parse command line args.  Throw an exception on a bad arg.
@@ -65,13 +65,13 @@ module NewRelic
             script_name = 'newrelic'
           end
           opts.banner = "Usage: #{script_name} [ #{@command_names.join(" | ")} ] [options]"
-          opts.separator "use '#{script_name} <command> -h' to see detailed command options"
+          opts.separator("use '#{script_name} <command> -h' to see detailed command options")
           opts
         end
         extra = options.order!
         command = extra.shift
         # just make it a little easier on them
-        command = 'deployments' if command =~ /deploy/
+        command = 'deployments' if command.include?('deploy')
         if command.nil?
           STDERR.puts options
         elsif !@command_names.include?(command)

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

@@ -1,6 +1,6 @@
-# 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
 
 # This is a class for executing commands related to deployment
 # events.  It runs without loading the rails environment
@@ -27,7 +27,7 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
   #
   # Will throw CommandFailed exception if there's any error.
   #
-  def initialize command_line_args
+  def initialize(command_line_args)
     @control = NewRelic::Control.instance
     @environment = nil
     @changelog = nil
@@ -40,6 +40,7 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
     load_yaml_from_env(control.env)
     @appname ||= NewRelic::Agent.config[:app_name][0] || control.env || 'development'
     @license_key ||= NewRelic::Agent.config[:license_key]
+    @api_key ||= NewRelic::Agent.config[:api_key]
 
     setup_logging(control.env)
   end
@@ -64,33 +65,32 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
   def run
     begin
       @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
-      }.each do |k, v|
-        create_params["deployment[#{k}]"] = v unless v.nil? || v == ''
-      end
-      http = ::NewRelic::Agent::NewRelicService.new(nil, control.api_server).http_connection
-
-      uri = "/deployments.xml"
 
       if @license_key.nil? || @license_key.empty?
-        raise "license_key was not set in newrelic.yml for #{control.env}"
+        raise "license_key not set in newrelic.yml for #{control.env}. api_key also required to use New Relic REST API v2"
+      end
+
+      if !api_v1? && (@revision.nil? || @revision.empty?)
+        raise "revision required when using New Relic REST API v2 with api_key. Pass in revision using: -r, --revision=REV"
       end
-      request = Net::HTTP::Post.new(uri, {'x-license-key' => @license_key})
-      request.content_type = "application/octet-stream"
 
-      request.set_form_data(create_params)
+      request = if api_v1?
+        uri = "/deployments.xml"
+        create_request(uri, {'x-license-key' => @license_key}, "application/octet-stream").tap do |req|
+          set_params_v1(req)
+        end
+      else
+        uri = "/v2/applications/#{application_id}/deployments.json"
+        create_request(uri, {"Api-Key" => @api_key}, "application/json").tap do |req|
+          set_params_v2(req)
+        end
+      end
 
+      http = ::NewRelic::Agent::NewRelicService.new(nil, control.api_server).http_connection
       response = http.request(request)
 
-      if response.is_a? Net::HTTPSuccess
-        info "Recorded deployment to '#{@appname}' (#{@description || Time.now})"
+      if response.is_a?(Net::HTTPSuccess)
+        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
         raise NewRelic::Cli::Command::CommandFailure, "Deployment not recorded: #{err_string}"
@@ -102,20 +102,72 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
     rescue NewRelic::Cli::Command::CommandFailure
       raise
     rescue => e
-      err "Unexpected error attempting to connect to #{control.api_server}"
-      info "#{e}: #{e.backtrace.join("\n   ")}"
+      err("Unexpected error attempting to connect to #{control.api_server}")
+      info("#{e}: #{e.backtrace.join("\n   ")}")
       raise NewRelic::Cli::Command::CommandFailure.new(e.to_s)
     end
   end
 
+  def api_v1?
+    @api_key.nil? || @api_key.empty?
+  end
+
   private
 
+  def create_request(uri, headers, content_type)
+    Net::HTTP::Post.new(uri, headers).tap do |req|
+      req.content_type = content_type
+    end
+  end
+
+  def application_id
+    return @application_id if @application_id
+
+    # Need to connect to collector to acquire application id from the connect response
+    # but set monitor_mode false because we don't want to actually report anything
+    begin
+      NewRelic::Agent.manual_start(monitor_mode: false)
+      NewRelic::Agent.agent.connect_to_server
+      @application_id = NewRelic::Agent.config[:primary_application_id]
+    ensure
+      NewRelic::Agent.shutdown
+    end
+  end
+
+  def set_params_v1(request)
+    params = {
+      :application_id => @appname,
+      :host => NewRelic::Agent::Hostname.get,
+      :description => @description,
+      :user => @user,
+      :revision => @revision,
+      :changelog => @changelog
+    }.each_with_object({}) do |(k, v), h|
+      h["deployment[#{k}]"] = v unless v.nil? || v == ''
+    end
+    request.set_form_data(params)
+  end
+
+  def set_params_v2(request)
+    request.body = {
+      "deployment" => {
+        :description => @description,
+        :user => @user,
+        :revision => @revision,
+        :changelog => @changelog
+      }
+    }.to_json
+  end
+
   def options
-    OptionParser.new %Q(Usage: #{$0} #{self.class.command} [OPTIONS] ["description"] ), 40 do |o|
-      o.separator "OPTIONS:"
+    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 }
+        "Default is app_name setting in newrelic.yml. Available only when using API v1.") { |e| @appname = e }
+      o.on("-i", "--appid=ID", String,
+        "Set the application ID",
+        "If not provided, will connect to the New Relic collector to get it") { |i| @application_id = i }
       o.on("-e", "--environment=name", String,
         "Override the (RAILS|RUBY|RACK)_ENV setting",
         "currently: #{control.env}") { |e| @environment = e }
@@ -123,12 +175,12 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
         "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. Required when using New Relic REST API v2") { |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 }
       o.on("-c", "--changes",
         "Read in a change log from the standard input") { @changelog = STDIN.read }
-      yield o if block_given?
+      yield(o) if block_given?
     end
   end
 end

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

@@ -1,6 +1,6 @@
-# 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 'fileutils'
 require 'new_relic/version'
@@ -20,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 = "."
@@ -70,13 +70,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|
+    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 }
       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?
+      yield(o) if block_given?
     end
   end
 end

data/lib/new_relic/coerce.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
@@ -43,7 +42,7 @@ module NewRelic
       String(value)
     rescue => error
       log_failure(value.class, String, context, error)
-      ""
+      EMPTY_STR
     end
 
     def scalar(val)
@@ -61,7 +60,7 @@ module NewRelic
       end
     end
 
-    def int! value
+    def int!(value)
       return nil unless value_or_nil(value)
       Integer(value)
     end
@@ -69,16 +68,16 @@ module NewRelic
     # 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,6 +1,6 @@
-# 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
 
 module NewRelic
   module CollectionHelper
@@ -11,7 +11,7 @@ module NewRelic
     def normalize_params(params)
       case params
         when Hash
-          # optimize for empty hash since that is often what this is called with.
+          # 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|
@@ -39,14 +39,14 @@ module NewRelic
         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}>"
+        else String.new("#<#{object.class}>")
       end
     end
 
     def truncate(string, len = DEFAULT_TRUNCATION_SIZE)
       case string
       when Symbol then string
-      when nil then ""
+      when nil then EMPTY_STR
       when String
         real_string = flatten(string)
         if real_string.size > len

data/lib/new_relic/constants.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/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/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 module NewRelic
   class Control

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/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 require 'new_relic/control/frameworks/ruby'
 module NewRelic

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/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 require 'new_relic/control/frameworks/ruby'
 module NewRelic
@@ -73,7 +73,7 @@ module NewRelic
           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)
@@ -87,7 +87,7 @@ module NewRelic
             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
+              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)

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/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 require 'new_relic/control/frameworks/rails'
 

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/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/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/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 module NewRelic
   class Control

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/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 require 'new_relic/control/frameworks/ruby'
 module NewRelic

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/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
 module NewRelic
   class Control