newrelic_rpm 8.2.0 → 9.0.0

data/lib/new_relic/agent/sampler_collection.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 Agent
@@ -17,7 +17,7 @@ module NewRelic
         @samplers.each(&blk)
       end
 
-      def clear()
+      def clear
         @samplers.clear
       end
 
@@ -34,7 +34,6 @@ module NewRelic
         end
       end
 
-
       def poll_samplers
         @samplers.delete_if do |sampler|
           begin
@@ -49,7 +48,7 @@ module NewRelic
 
       def add_sampler(sampler_class)
         supported = sampler_class.supported_on_this_platform?
-        enabled   = sampler_class.enabled?
+        enabled = sampler_class.enabled?
         if supported && enabled
           if !sampler_class_registered?(sampler_class)
             sampler = sampler_class.new

data/lib/new_relic/agent/samplers/cpu_sampler.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/agent/sampler'
 
@@ -44,6 +44,7 @@ module NewRelic
           if defined?(JRuby)
             return JRUBY_VERSION >= '1.7.0'
           end
+
           true
         end
 

data/lib/new_relic/agent/samplers/delayed_job_sampler.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/agent/sampler'
 require 'new_relic/delayed_job_injection'
@@ -25,7 +25,7 @@ module NewRelic
         end
 
         def initialize
-          raise Unsupported, "DJ queue sampler disabled" if Agent.config[:disable_dj]
+          raise Unsupported, "DJ queue sampler disabled" if Agent.config[:'instrumentation.delayed_job'] == 'disabled'
           raise Unsupported, "DJ queue sampling unsupported with backend '#{::Delayed::Worker.backend}'" unless self.class.supported_backend?
           raise Unsupported, "No DJ worker present. Skipping DJ queue sampler" unless NewRelic::DelayedJobInjection.worker_name
         end
@@ -87,7 +87,7 @@ module NewRelic
           all_count = 0
           queue_counts(column_name).each do |column_val, count|
             all_count += count
-            column_val = "default" if column_val.nil? || column_val == ""
+            column_val = "default" if column_val.nil? || column_val == NewRelic::EMPTY_STR
             metric = "Workers/DelayedJob/queue_length/#{metric_node}/#{column_val}"
             NewRelic::Agent.record_metric(metric, count)
           end
@@ -102,9 +102,9 @@ module NewRelic
             ::Delayed::Job.count(:group => column_name,
               :conditions => [QUEUE_QUERY_CONDITION, now])
           else
-            ::Delayed::Job.where(QUEUE_QUERY_CONDITION, now).
-              group(column_name).
-              count
+            ::Delayed::Job.where(QUEUE_QUERY_CONDITION, now)
+              .group(column_name)
+              .count
           end
           result.to_a
         end

data/lib/new_relic/agent/samplers/memory_sampler.rb

@@ -1,13 +1,13 @@
-# 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/agent/sampler'
+require 'new_relic/helper'
 
 module NewRelic
   module Agent
     module Samplers
-
       class MemorySampler < NewRelic::Agent::Sampler
         named :memory
 
@@ -19,21 +19,21 @@ module NewRelic
           # macos, linux, solaris
           if defined? JRuby
             @sampler = JavaHeapSampler.new
-          elsif platform =~ /linux/
+          elsif platform.include?('linux')
             @sampler = ProcStatus.new
             if !@sampler.can_run?
-              ::NewRelic::Agent.logger.debug "Error attempting to use /proc/#{$$}/status file for reading memory. Using ps command instead."
+              ::NewRelic::Agent.logger.debug("Error attempting to use /proc/#{$$}/status file for reading memory. Using ps command instead.")
               @sampler = ShellPS.new("ps -o rsz")
             else
-              ::NewRelic::Agent.logger.debug "Using /proc/#{$$}/status for reading process memory."
+              ::NewRelic::Agent.logger.debug("Using /proc/#{$$}/status for reading process memory.")
             end
-          elsif platform =~ /darwin9/ # 10.5
+          elsif platform.include?('darwin9') # 10.5
             @sampler = ShellPS.new("ps -o rsz")
           elsif platform =~ /darwin(1|2)\d+/ # >= 10.6
             @sampler = ShellPS.new("ps -o rss")
-          elsif platform =~ /freebsd/
+          elsif platform.include?('freebsd')
             @sampler = ShellPS.new("ps -o rss")
-          elsif platform =~ /solaris/
+          elsif platform.include?('solaris')
             @sampler = ShellPS.new("/usr/bin/ps -o rss -p")
           end
 
@@ -46,12 +46,17 @@ module NewRelic
         end
 
         def self.platform
-          if RUBY_PLATFORM =~ /java/
-            %x[uname -s].downcase
+          if RUBY_PLATFORM.include?('java')
+            begin
+              NewRelic::Helper.run_command('uname -s').downcase
+            rescue NewRelic::CommandRunFailedError, NewRelic::CommandExecutableNotFoundError
+              'unknown'
+            end
           else
             RUBY_PLATFORM.downcase
           end
         end
+
         def platform
           NewRelic::Agent::Samplers::MemorySampler.platform
         end
@@ -70,21 +75,23 @@ module NewRelic
 
           def can_run?
             return false if @broken
+
             m = get_memory rescue nil
             m && m > 0
           end
 
           def get_sample
             return nil if @broken
+
             begin
               m = get_memory
               if m.nil?
-                ::NewRelic::Agent.logger.warn "Unable to get the resident memory for process #{$$}.  Disabling memory sampler."
+                ::NewRelic::Agent.logger.warn("Unable to get the resident memory for process #{$$}.  Disabling memory sampler.")
                 @broken = true
               end
               return m
             rescue => e
-              ::NewRelic::Agent.logger.warn "Unable to get the resident memory for process #{$$}. Disabling memory sampler.", e
+              ::NewRelic::Agent.logger.warn("Unable to get the resident memory for process #{$$}. Disabling memory sampler.", e)
               @broken = true
               return nil
             end
@@ -94,6 +101,7 @@ module NewRelic
         class JavaHeapSampler < Base
           def get_memory
             raise "Can't sample Java heap unless running in JRuby" unless defined? JRuby
+
             java.lang.Runtime.getRuntime.totalMemory / (1024 * 1024).to_f rescue nil
           end
 
@@ -116,8 +124,10 @@ module NewRelic
             # if for some reason the ps command doesn't work on the resident os,
             # then don't execute it any more.
             raise "Faulty command: `#{@command} #{process}`" if memory.nil? || memory <= 0
+
             memory
           end
+
           def to_s
             "shell command sampler: #{@command}"
           end
@@ -130,10 +140,11 @@ module NewRelic
         class ProcStatus < Base
           # Returns the amount of resident memory this process is using in MB
           def get_memory
-            proc_status = File.open(proc_status_file, "r") {|f| f.read_nonblock(4096).strip }
+            proc_status = File.open(proc_status_file, "r") { |f| f.read_nonblock(4096).strip }
             if proc_status =~ /RSS:\s*(\d+) kB/i
               return $1.to_f / 1024.0
             end
+
             raise "Unable to find RSS in #{proc_status_file}"
           end
 

data/lib/new_relic/agent/samplers/object_sampler.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/agent/sampler'
 

data/lib/new_relic/agent/samplers/vm_sampler.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/agent/sampler'
 require 'new_relic/agent/vm'
@@ -9,15 +9,16 @@ module NewRelic
   module Agent
     module Samplers
       class VMSampler < Sampler
-        GC_RUNS_METRIC                = 'RubyVM/GC/runs'.freeze
-        HEAP_LIVE_METRIC              = 'RubyVM/GC/heap_live'.freeze
-        HEAP_FREE_METRIC              = 'RubyVM/GC/heap_free'.freeze
-        THREAD_COUNT_METRIC           = 'RubyVM/Threads/all'.freeze
-        OBJECT_ALLOCATIONS_METRIC     = 'RubyVM/GC/total_allocated_object'.freeze
-        MAJOR_GC_METRIC               = 'RubyVM/GC/major_gc_count'.freeze
-        MINOR_GC_METRIC               = 'RubyVM/GC/minor_gc_count'.freeze
-        METHOD_INVALIDATIONS_METRIC   = 'RubyVM/CacheInvalidations/method'.freeze
+        GC_RUNS_METRIC = 'RubyVM/GC/runs'.freeze
+        HEAP_LIVE_METRIC = 'RubyVM/GC/heap_live'.freeze
+        HEAP_FREE_METRIC = 'RubyVM/GC/heap_free'.freeze
+        THREAD_COUNT_METRIC = 'RubyVM/Threads/all'.freeze
+        OBJECT_ALLOCATIONS_METRIC = 'RubyVM/GC/total_allocated_object'.freeze
+        MAJOR_GC_METRIC = 'RubyVM/GC/major_gc_count'.freeze
+        MINOR_GC_METRIC = 'RubyVM/GC/minor_gc_count'.freeze
+        METHOD_INVALIDATIONS_METRIC = 'RubyVM/CacheInvalidations/method'.freeze
         CONSTANT_INVALIDATIONS_METRIC = 'RubyVM/CacheInvalidations/constant'.freeze
+        CONSTANT_MISSES_METRIC = 'RubyVM/CacheMisses/constant'.freeze
 
         attr_reader :transaction_count
 
@@ -49,7 +50,7 @@ module NewRelic
           end
         end
 
-        def record_gc_runs_metric(snapshot, txn_count) #THREAD_LOCAL_ACCESS
+        def record_gc_runs_metric(snapshot, txn_count) # THREAD_LOCAL_ACCESS
           if snapshot.gc_total_time || snapshot.gc_runs
             if snapshot.gc_total_time
               gc_time = snapshot.gc_total_time - @last_snapshot.gc_total_time.to_f
@@ -59,30 +60,30 @@ module NewRelic
             end
             wall_clock_time = snapshot.taken_at - @last_snapshot.taken_at
             NewRelic::Agent.agent.stats_engine.tl_record_unscoped_metrics(GC_RUNS_METRIC) do |stats|
-              stats.call_count           += txn_count
-              stats.total_call_time      += gc_runs if gc_runs
+              stats.call_count += txn_count
+              stats.total_call_time += gc_runs if gc_runs
               stats.total_exclusive_time += gc_time if gc_time
-              stats.max_call_time         = (gc_time.nil? ? 0 : 1)
-              stats.sum_of_squares       += wall_clock_time
+              stats.max_call_time = (gc_time.nil? ? 0 : 1)
+              stats.sum_of_squares += wall_clock_time
             end
           end
         end
 
-        def record_delta(snapshot, key, metric, txn_count) #THREAD_LOCAL_ACCESS
+        def record_delta(snapshot, key, metric, txn_count) # THREAD_LOCAL_ACCESS
           value = snapshot.send(key)
           if value
             delta = value - @last_snapshot.send(key)
             NewRelic::Agent.agent.stats_engine.tl_record_unscoped_metrics(metric) do |stats|
-              stats.call_count      += txn_count
+              stats.call_count += txn_count
               stats.total_call_time += delta
             end
           end
         end
 
-        def record_gauge_metric(metric_name, value) #THREAD_LOCAL_ACCESS
+        def record_gauge_metric(metric_name, value) # THREAD_LOCAL_ACCESS
           NewRelic::Agent.agent.stats_engine.tl_record_unscoped_metrics(metric_name) do |stats|
-            stats.call_count      = value
-            stats.sum_of_squares  = 1
+            stats.call_count = value
+            stats.sum_of_squares = 1
           end
         end
 
@@ -114,6 +115,7 @@ module NewRelic
           record_delta(snap, :minor_gc_count, MINOR_GC_METRIC, tcount)
           record_delta(snap, :method_cache_invalidations, METHOD_INVALIDATIONS_METRIC, tcount)
           record_delta(snap, :constant_cache_invalidations, CONSTANT_INVALIDATIONS_METRIC, tcount)
+          record_delta(snap, :constant_cache_misses, CONSTANT_MISSES_METRIC, tcount)
           record_heap_live_metric(snap)
           record_heap_free_metric(snap)
           record_thread_count_metric(snap)

data/lib/new_relic/agent/span_event_aggregator.rb

@@ -1,9 +1,9 @@
-# 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 'newrelic_rpm' unless defined?( NewRelic )
-require 'new_relic/agent' unless defined?( NewRelic::Agent )
+require 'newrelic_rpm' unless defined?(NewRelic)
+require 'new_relic/agent' unless defined?(NewRelic::Agent)
 require 'new_relic/agent/event_aggregator'
 require 'new_relic/agent/priority_sampled_buffer'
 
@@ -14,33 +14,33 @@ module NewRelic
       capacity_key :'span_events.max_samples_stored'
 
       enabled_keys :'span_events.enabled',
-                   :'distributed_tracing.enabled'
+        :'distributed_tracing.enabled'
 
       def record(priority: nil, event: nil, &blk)
-        unless(event || priority && blk)
+        unless event || priority && blk
           raise ArgumentError, "Expected priority and block, or event"
         end
 
         return unless enabled?
 
         @lock.synchronize do
-          @buffer.append priority: priority, event: event, &blk
+          @buffer.append(priority: priority, event: event, &blk)
           notify_if_full
         end
       end
 
       SUPPORTABILITY_TOTAL_SEEN = "Supportability/SpanEvent/TotalEventsSeen".freeze
       SUPPORTABILITY_TOTAL_SENT = "Supportability/SpanEvent/TotalEventsSent".freeze
-      SUPPORTABILITY_DISCARDED  = "Supportability/SpanEvent/Discarded".freeze
+      SUPPORTABILITY_DISCARDED = "Supportability/SpanEvent/Discarded".freeze
 
       def after_harvest(metadata)
-        seen      = metadata[:seen]
-        sent      = metadata[:captured]
+        seen = metadata[:seen]
+        sent = metadata[:captured]
         discarded = seen - sent
 
         ::NewRelic::Agent.record_metric(SUPPORTABILITY_TOTAL_SEEN, count: seen)
         ::NewRelic::Agent.record_metric(SUPPORTABILITY_TOTAL_SENT, count: sent)
-        ::NewRelic::Agent.record_metric(SUPPORTABILITY_DISCARDED,  count: discarded)
+        ::NewRelic::Agent.record_metric(SUPPORTABILITY_DISCARDED, count: discarded)
 
         super
       end

data/lib/new_relic/agent/span_event_primitive.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
@@ -16,63 +15,63 @@ module NewRelic
       extend self
 
       # Strings for static keys of the event structure
-      ELLIPSIS             = '...'
-      TYPE_KEY             = 'type'
-      TRACE_ID_KEY         = 'traceId'
-      GUID_KEY             = 'guid'
-      PARENT_ID_KEY        = 'parentId'
-      GRANDPARENT_ID_KEY   = 'grandparentId'
-      TRANSACTION_ID_KEY   = 'transactionId'
-      SAMPLED_KEY          = 'sampled'
-      PRIORITY_KEY         = 'priority'
-      TIMESTAMP_KEY        = 'timestamp'
-      DURATION_KEY         = 'duration'
-      NAME_KEY             = 'name'
-      CATEGORY_KEY         = 'category'
-      HTTP_URL_KEY         = 'http.url'
-      HTTP_METHOD_KEY      = 'http.method'
+      ELLIPSIS = '...'
+      TYPE_KEY = 'type'
+      TRACE_ID_KEY = 'traceId'
+      GUID_KEY = 'guid'
+      PARENT_ID_KEY = 'parentId'
+      TRANSACTION_ID_KEY = 'transactionId'
+      SAMPLED_KEY = 'sampled'
+      PRIORITY_KEY = 'priority'
+      TIMESTAMP_KEY = 'timestamp'
+      DURATION_KEY = 'duration'
+      NAME_KEY = 'name'
+      CATEGORY_KEY = 'category'
+      HTTP_URL_KEY = 'http.url'
+      HTTP_METHOD_KEY = 'http.method'
       HTTP_STATUS_CODE_KEY = 'http.statusCode'
-      COMPONENT_KEY        = 'component'
-      DB_INSTANCE_KEY      = 'db.instance'
-      DB_STATEMENT_KEY     = 'db.statement'
-      PEER_ADDRESS_KEY     = 'peer.address'
-      PEER_HOSTNAME_KEY    = 'peer.hostname'
-      SPAN_KIND_KEY        = 'span.kind'
-      ENTRY_POINT_KEY      = 'nr.entryPoint'
-      TRUSTED_PARENT_KEY   = "trustedParentId"
-      TRACING_VENDORS_KEY  = "tracingVendors"
+      COMPONENT_KEY = 'component'
+      DB_INSTANCE_KEY = 'db.instance'
+      DB_STATEMENT_KEY = 'db.statement'
+      PEER_ADDRESS_KEY = 'peer.address'
+      PEER_HOSTNAME_KEY = 'peer.hostname'
+      SPAN_KIND_KEY = 'span.kind'
+      ENTRY_POINT_KEY = 'nr.entryPoint'
+      TRUSTED_PARENT_KEY = "trustedParentId"
+      TRACING_VENDORS_KEY = "tracingVendors"
       TRANSACTION_NAME_KEY = 'transaction.name'
 
       # Strings for static values of the event structure
-      EVENT_TYPE         = 'Span'
-      GENERIC_CATEGORY   = 'generic'
-      HTTP_CATEGORY      = 'http'
+      EVENT_TYPE = 'Span'
+      GENERIC_CATEGORY = 'generic'
+      HTTP_CATEGORY = 'http'
       DATASTORE_CATEGORY = 'datastore'
-      CLIENT             = 'client'
+      CLIENT = 'client'
 
       # Builds a Hash of error attributes as well as the Span ID when
       # an error is present.  Otherwise, returns nil when no error present.
-      def error_attributes segment
+      def error_attributes(segment)
         return if Agent.config[:high_security] || !segment.noticed_error
+
         segment.noticed_error.build_error_attributes
         segment.noticed_error_attributes
       end
 
-      def for_segment segment
+      def for_segment(segment)
         intrinsics = intrinsics_for(segment)
         intrinsics[CATEGORY_KEY] = GENERIC_CATEGORY
 
         [intrinsics, custom_attributes(segment), agent_attributes(segment)]
       end
 
-      def for_external_request_segment segment
+      def for_external_request_segment(segment)
         intrinsics = intrinsics_for(segment)
 
-        intrinsics[COMPONENT_KEY]   = segment.library
+        intrinsics[COMPONENT_KEY] = segment.library
         intrinsics[HTTP_METHOD_KEY] = segment.procedure
         intrinsics[HTTP_STATUS_CODE_KEY] = segment.http_status_code if segment.http_status_code
-        intrinsics[CATEGORY_KEY]    = HTTP_CATEGORY
-        intrinsics[SPAN_KIND_KEY]   = CLIENT
+        intrinsics[CATEGORY_KEY] = HTTP_CATEGORY
+        intrinsics[SPAN_KIND_KEY] = CLIENT
 
         agent_attributes = error_attributes(segment) || {}
 
@@ -80,10 +79,14 @@ module NewRelic
           agent_attributes[HTTP_URL_KEY] = truncate(segment.uri)
         end
 
+        if segment.respond_to?(:record_agent_attributes?) && segment.record_agent_attributes?
+          agent_attributes.merge!(agent_attributes(segment))
+        end
+
         [intrinsics, custom_attributes(segment), agent_attributes]
       end
 
-      def for_datastore_segment segment
+      def for_datastore_segment(segment)
         intrinsics = intrinsics_for(segment)
 
         intrinsics[COMPONENT_KEY] = segment.product
@@ -113,16 +116,16 @@ module NewRelic
 
       private
 
-      def intrinsics_for segment
+      def intrinsics_for(segment)
         intrinsics = {
-          TYPE_KEY           => EVENT_TYPE,
-          TRACE_ID_KEY       => segment.transaction.trace_id,
-          GUID_KEY           => segment.guid,
+          TYPE_KEY => EVENT_TYPE,
+          TRACE_ID_KEY => segment.transaction.trace_id,
+          GUID_KEY => segment.guid,
           TRANSACTION_ID_KEY => segment.transaction.guid,
-          PRIORITY_KEY       => segment.transaction.priority,
-          TIMESTAMP_KEY      => milliseconds_since_epoch(segment),
-          DURATION_KEY       => segment.duration,
-          NAME_KEY           => segment.name
+          PRIORITY_KEY => segment.transaction.priority,
+          TIMESTAMP_KEY => milliseconds_since_epoch(segment),
+          DURATION_KEY => segment.duration,
+          NAME_KEY => segment.name
         }
 
         # with infinite-tracing, transactions may or may not be sampled!
@@ -155,7 +158,7 @@ module NewRelic
         intrinsics
       end
 
-      def custom_attributes segment
+      def custom_attributes(segment)
         attributes = segment.attributes
         if attributes
           result = attributes.custom_attributes_for(NewRelic::Agent::AttributeFilter::DST_SPAN_EVENTS)
@@ -165,21 +168,24 @@ module NewRelic
         end
       end
 
-      def merge_and_freeze_attributes agent_attributes, error_attributes
-        return agent_attributes.freeze unless error_attributes
-        return error_attributes.freeze if agent_attributes.equal?(NewRelic::EMPTY_HASH)
-        agent_attributes.merge!(error_attributes).freeze
+      def merge_hashes(hash1, hash2)
+        return hash1 if hash2.nil? || hash2.empty?
+        return hash2 if hash1.nil? || hash1.empty?
+
+        hash1.merge!(hash2)
       end
 
-      def agent_attributes segment
+      def agent_attributes(segment)
         agent_attributes = segment.attributes
           .agent_attributes_for(NewRelic::Agent::AttributeFilter::DST_SPAN_EVENTS)
         error_attributes = error_attributes(segment)
-        return NewRelic::EMPTY_HASH unless agent_attributes || error_attributes
-        merge_and_freeze_attributes(agent_attributes, error_attributes)
+        code_attributes = segment.code_attributes
+        agent_attributes = merge_hashes(agent_attributes, error_attributes)
+        agent_attributes = merge_hashes(agent_attributes, code_attributes)
+        agent_attributes.freeze
       end
 
-      def parent_guid segment
+      def parent_guid(segment)
         if segment.parent
           segment.parent.guid
         elsif txn = segment.transaction
@@ -187,11 +193,11 @@ module NewRelic
         end
       end
 
-      def milliseconds_since_epoch segment
+      def milliseconds_since_epoch(segment)
         Integer(segment.start_time.to_f * 1000.0)
       end
 
-      def truncate value, max_size=255
+      def truncate(value, max_size = 255)
         value = value.to_s
         if value.bytesize > max_size
           value.byteslice(0, max_size - 2).chop! << ELLIPSIS
@@ -200,7 +206,7 @@ module NewRelic
         end
       end
 
-      def allowed? key
+      def allowed?(key)
         NewRelic::Agent.instance.attribute_filter.allows_key?(key, AttributeFilter::DST_SPAN_EVENTS)
       end
     end