newrelic_rpm 8.10.1 → 8.11.0

data/lib/new_relic/agent/transaction_sampler.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/agent/transaction_time_aggregator.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
@@ -108,7 +107,7 @@ module NewRelic
         end
 
         # ObjectSpace is faster on MRI, but disabled by default on JRuby for
-        # perfomance reasons. We have two implmentations of `thread_by_id`
+        # performance reasons. We have two implementations of `thread_by_id`
         # based on ruby implementation.
         if RUBY_ENGINE == 'jruby'
           def thread_by_id(thread_id)

data/lib/new_relic/agent/utilization/aws.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/agent/utilization/azure.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
@@ -10,7 +9,7 @@ module NewRelic
         vendor_name "azure"
         endpoint "http://169.254.169.254/metadata/instance/compute?api-version=2017-03-01"
         headers "Metadata" => "true"
-        keys ["vmId", "name", "vmSize", "location"]
+        keys %w[vmId name vmSize location]
         key_transforms :to_sym
       end
     end

data/lib/new_relic/agent/utilization/gcp.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
@@ -12,7 +11,7 @@ module NewRelic
         vendor_name "gcp"
         endpoint "http://metadata.google.internal/computeMetadata/v1/instance/?recursive=true"
         headers "Metadata-Flavor" => "Google"
-        keys ["id", "machineType", "name", "zone"]
+        keys %w[id machineType name zone]
         key_transforms :to_sym
 
         MACH_TYPE = 'machineType'.freeze

data/lib/new_relic/agent/utilization/pcf.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
@@ -10,7 +9,7 @@ module NewRelic
     module Utilization
       class PCF < Vendor
         vendor_name "pcf"
-        keys ["CF_INSTANCE_GUID", "CF_INSTANCE_IP", "MEMORY_LIMIT"]
+        keys %w[CF_INSTANCE_GUID CF_INSTANCE_IP MEMORY_LIMIT]
         key_transforms [:downcase, :to_sym]
 
         def detect

data/lib/new_relic/agent/utilization/vendor.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
@@ -74,7 +73,7 @@ module NewRelic
 
         def request_metadata
           processed_headers = headers
-          raise if processed_headers.values.include?(:error)
+          raise if processed_headers.value?(:error)
 
           Timeout.timeout(1) do
             response = nil

data/lib/new_relic/agent/utilization_data.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/agent/vm/jruby_vm.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/agent/vm/monotonic_gc_profiler.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/agent/vm/mri_vm.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
@@ -24,24 +23,35 @@ module NewRelic
         end
 
         def gather_gc_stats(snap)
-          if supports?(:gc_runs)
-            snap.gc_runs = GC.count
-          end
+          gather_gc_runs(snap) if supports?(:gc_runs)
+          gather_derived_stats(snap) if GC.respond_to?(:stat)
+        end
+
+        def gather_gc_runs(snap)
+          snap.gc_runs = GC.count
+        end
 
-          if GC.respond_to?(:stat)
-            gc_stats = GC.stat
-            snap.total_allocated_object = gc_stats[:total_allocated_objects] || gc_stats[:total_allocated_object]
-            snap.major_gc_count = gc_stats[:major_gc_count]
-            snap.minor_gc_count = gc_stats[:minor_gc_count]
-            snap.heap_live = gc_stats[:heap_live_slots] || gc_stats[:heap_live_slot] || gc_stats[:heap_live_num]
-            snap.heap_free = gc_stats[:heap_free_slots] || gc_stats[:heap_free_slot] || gc_stats[:heap_free_num]
+        def gather_derived_stats(snap)
+          stat = GC.stat
+          snap.total_allocated_object = derive_from_gc_stats(%i[total_allocated_objects total_allocated_object], stat)
+          snap.major_gc_count = derive_from_gc_stats(:major_gc_count, stat)
+          snap.minor_gc_count = derive_from_gc_stats(:minor_gc_count, stat)
+          snap.heap_live = derive_from_gc_stats(%i[heap_live_slots heap_live_slot heap_live_num], stat)
+          snap.heap_free = derive_from_gc_stats(%i[heap_free_slots heap_free_slot heap_free_num], stat)
+        end
+
+        def derive_from_gc_stats(keys, stat)
+          Array(keys).each do |key|
+            value = stat[key]
+            return value if value
           end
+          nil
         end
 
         def gather_gc_time(snap)
-          if supports?(:gc_total_time)
-            snap.gc_total_time = NewRelic::Agent.instance.monotonic_gc_profiler.total_time_s
-          end
+          return unless supports?(:gc_total_time)
+
+          snap.gc_total_time = NewRelic::Agent.instance.monotonic_gc_profiler.total_time_s
         end
 
         def gather_ruby_vm_stats(snap)
@@ -52,18 +62,18 @@ module NewRelic
           if supports?(:constant_cache_invalidations)
             snap.constant_cache_invalidations = gather_constant_cache_invalidations
           end
+
+          if supports?(:constant_cache_misses)
+            snap.constant_cache_misses = gather_constant_cache_misses
+          end
         end
 
         def gather_constant_cache_invalidations
-          # Ruby >= 3.2 uses :constant_cache
-          # see: https://github.com/ruby/ruby/pull/5433 and https://bugs.ruby-lang.org/issues/18589
-          # TODO: now that 3.2+ provides more granual cache invalidation data, should we report it instead of summing?
-          if RUBY_VERSION >= '3.2.0'
-            RubyVM.stat[:constant_cache].values.sum
-          # Ruby < 3.2 uses :global_constant_state
-          else
-            RubyVM.stat[:global_constant_state]
-          end
+          RubyVM.stat[RUBY_VERSION >= '3.2.0' ? :constant_cache_invalidations : :global_constant_state]
+        end
+
+        def gather_constant_cache_misses
+          RubyVM.stat[:constant_cache_misses]
         end
 
         def gather_thread_stats(snap)
@@ -84,6 +94,8 @@ module NewRelic
             RUBY_VERSION >= '2.1.0' && RUBY_VERSION < '3.0.0'
           when :constant_cache_invalidations
             RUBY_VERSION >= '2.1.0'
+          when :constant_cache_misses
+            RUBY_VERSION >= '3.2.0'
           else
             false
           end

data/lib/new_relic/agent/vm/snapshot.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
@@ -10,7 +9,7 @@ module NewRelic
         attr_accessor :gc_total_time, :gc_runs, :major_gc_count, :minor_gc_count,
           :total_allocated_object, :heap_live, :heap_free,
           :method_cache_invalidations, :constant_cache_invalidations,
-          :thread_count, :taken_at
+          :constant_cache_misses, :thread_count, :taken_at
 
         def initialize
           @taken_at = Process.clock_gettime(Process::CLOCK_REALTIME)

data/lib/new_relic/agent/vm.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/agent/worker_loop.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/agent.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
@@ -30,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'
@@ -199,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
 
@@ -238,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.
     #
@@ -290,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
@@ -586,15 +579,19 @@ module NewRelic
 
         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.
     #
@@ -673,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
     #

data/lib/new_relic/cli/command.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
@@ -72,7 +71,7 @@ module NewRelic
         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,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
@@ -41,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
@@ -65,29 +65,28 @@ 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)
@@ -109,14 +108,66 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
     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:")
       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 }
@@ -124,7 +175,7 @@ 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",

data/lib/new_relic/cli/commands/install.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/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

data/lib/new_relic/collection_helper.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
@@ -12,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|

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,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/frameworks/external.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/frameworks/rails.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/frameworks/rails3.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/frameworks/rails4.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/frameworks/rails_notifications.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/frameworks/ruby.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/frameworks/sinatra.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/frameworks.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