newrelic_rpm 3.12.0.288 → 9.10.2

data/lib/new_relic/agent/sql_sampler.rb

@@ -1,14 +1,10 @@
-# 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 'zlib'
-require 'base64'
 require 'digest/md5'
 
-require 'new_relic/agent'
-require 'new_relic/control'
-
 module NewRelic
   module Agent
     # This class contains the logic of recording slow SQL traces, which may
@@ -27,13 +23,6 @@ module NewRelic
     #
     # @api public
     class SqlSampler
-
-      # Module defining methods stubbed out when the agent is disabled
-      module Shim
-        def on_start_transaction(*args); end
-        def on_finishing_transaction(*args); end
-      end
-
       attr_reader :disabled
 
       # this is for unit tests only
@@ -56,13 +45,13 @@ module NewRelic
           NewRelic::Agent::Database.should_record_sql?(:slow_sql)
       end
 
-      def on_start_transaction(state, start_time, uri=nil)
+      def on_start_transaction(state, uri = nil)
         return unless enabled?
 
         state.sql_sampler_transaction_data = TransactionSqlData.new
 
-        if state.transaction_sample_builder
-          guid = state.transaction_sample_builder.sample.guid
+        if state.current_transaction
+          guid = state.current_transaction.guid
         end
 
         if Agent.config[:'slow_sql.enabled'] && state.sql_sampler_transaction_data
@@ -71,11 +60,11 @@ module NewRelic
       end
 
       def tl_transaction_data # only used for testing
-        TransactionState.tl_get.sql_sampler_transaction_data
+        Tracer.state.sql_sampler_transaction_data
       end
 
       # This is called when we are done with the transaction.
-      def on_finishing_transaction(state, name, time=Time.now)
+      def on_finishing_transaction(state, name)
         return unless enabled?
 
         data = state.sql_sampler_transaction_data
@@ -84,8 +73,8 @@ module NewRelic
         data.set_transaction_name(name)
         if data.sql_data.size > 0
           @samples_lock.synchronize do
-            ::NewRelic::Agent.logger.debug "Examining #{data.sql_data.size} slow transaction sql statement(s)"
-            save_slow_sql data
+            ::NewRelic::Agent.logger.debug("Examining #{data.sql_data.size} slow transaction sql statement(s)")
+            save_slow_sql(data)
           end
         end
       end
@@ -93,7 +82,7 @@ module NewRelic
       # this should always be called under the @samples_lock
       def save_slow_sql(transaction_sql_data)
         path = transaction_sql_data.path
-        uri  = transaction_sql_data.uri
+        uri = transaction_sql_data.uri
 
         transaction_sql_data.sql_data.each do |sql_item|
           normalized_sql = sql_item.normalize
@@ -150,17 +139,44 @@ module NewRelic
       # @api public
       # @deprecated Use {Datastores.notice_sql} instead.
       #
-      def notice_sql(sql, metric_name, config, duration, state=nil, &explainer) #THREAD_LOCAL_ACCESS sometimes
-        state ||= TransactionState.tl_get
+      def notice_sql(sql, metric_name, config, duration, state = nil, explainer = nil, binds = nil, name = nil) # THREAD_LOCAL_ACCESS sometimes
+        state ||= Tracer.state
+        data = state.sql_sampler_transaction_data
+        return unless data
+
+        if state.is_sql_recorded?
+          if duration > Agent.config[:'slow_sql.explain_threshold']
+            backtrace = caller.join("\n")
+            statement = Database::Statement.new(sql, config, explainer, binds, name)
+            data.sql_data << SlowSql.new(statement, metric_name, duration, backtrace)
+          end
+        end
+      end
+
+      PRIORITY = 'priority'.freeze
+
+      def distributed_trace_attributes(state)
+        transaction = state.current_transaction
+        params = nil
+        if transaction&.distributed_tracer&.distributed_trace_payload
+          params = {}
+          payload = transaction.distributed_tracer.distributed_trace_payload
+          DistributedTraceAttributes.copy_from_transaction(transaction, payload, params)
+          params[PRIORITY] = transaction.priority
+        end
+        params
+      end
+
+      def notice_sql_statement(statement, metric_name, duration)
+        state ||= Tracer.state
         data = state.sql_sampler_transaction_data
         return unless data
 
         if state.is_sql_recorded?
           if duration > Agent.config[:'slow_sql.explain_threshold']
             backtrace = caller.join("\n")
-            data.sql_data << SlowSql.new(Database.capture_query(sql),
-                                         metric_name, config,
-                                         duration, backtrace, &explainer)
+            params = distributed_trace_attributes(state)
+            data.sql_data << SlowSql.new(statement, metric_name, duration, backtrace, params)
           end
         end
       end
@@ -179,14 +195,14 @@ module NewRelic
       end
 
       def harvest!
-        return [] unless enabled?
+        return NewRelic::EMPTY_ARRAY unless enabled?
 
         slowest = []
         @samples_lock.synchronize do
           slowest = @sql_traces.values
           @sql_traces = {}
         end
-        slowest.each {|trace| trace.prepare_to_send }
+        slowest.each { |trace| trace.prepare_to_send }
         slowest
       end
 
@@ -218,39 +234,55 @@ module NewRelic
     end
 
     class SlowSql
-      attr_reader :sql
+      attr_reader :statement
       attr_reader :metric_name
       attr_reader :duration
       attr_reader :backtrace
 
-      def initialize(sql, metric_name, config, duration, backtrace=nil,
-                     &explainer)
-        @sql = sql
+      def initialize(statement, metric_name, duration, backtrace = nil, params = nil)
+        @statement = statement
         @metric_name = metric_name
-        @config = config
         @duration = duration
         @backtrace = backtrace
-        @explainer = explainer
+        @params = params
+      end
+
+      def sql
+        statement.sql
+      end
+
+      def base_params
+        params = @params || {}
+
+        if NewRelic::Agent.config[:'datastore_tracer.instance_reporting.enabled']
+          params[:host] = statement.host if statement.host
+          params[:port_path_or_id] = statement.port_path_or_id if statement.port_path_or_id
+        end
+        if NewRelic::Agent.config[:'datastore_tracer.database_name_reporting.enabled'] && statement.database_name
+          params[:database_name] = statement.database_name
+        end
+
+        params
       end
 
       def obfuscate
-        NewRelic::Agent::Database.obfuscate_sql(@sql)
+        NewRelic::Agent::Database.obfuscate_sql(statement)
       end
 
       def normalize
         NewRelic::Agent::Database::Obfuscator.instance \
-          .default_sql_obfuscator(@sql).gsub(/\?\s*\,\s*/, '').gsub(/\s/, '')
+          .default_sql_obfuscator(statement).gsub(/\?\s*\,\s*/, '').gsub(/\s/, '')
       end
 
       def explain
-        if @config && @explainer
-          NewRelic::Agent::Database.explain_sql(@sql, @config, &@explainer)
+        if statement.config && statement.explainer
+          NewRelic::Agent::Database.explain_sql(statement)
         end
       end
 
       # We can't serialize the explainer, so clear it before we transmit
       def prepare_to_send
-        @explainer = nil
+        statement.explainer = nil
       end
     end
 
@@ -265,9 +297,9 @@ module NewRelic
 
       def initialize(normalized_query, slow_sql, path, uri)
         super()
-        @params = {}
+        @params = slow_sql.base_params
         @sql_id = consistent_hash(normalized_query)
-        set_primary slow_sql, path, uri
+        set_primary(slow_sql, path, uri)
         record_data_point(float(slow_sql.duration))
       end
 
@@ -282,7 +314,7 @@ module NewRelic
 
       def aggregate(slow_sql, path, uri)
         if slow_sql.duration > max_call_time
-          set_primary slow_sql, path, uri
+          set_primary(slow_sql, path, uri)
         end
 
         record_data_point(float(slow_sql.duration))
@@ -309,7 +341,7 @@ module NewRelic
       include NewRelic::Coerce
 
       def to_collector_array(encoder)
-        [ string(@path),
+        [string(@path),
           string(@url),
           int(@sql_id),
           string(@sql),
@@ -318,15 +350,19 @@ module NewRelic
           Helper.time_to_millis(@total_call_time),
           Helper.time_to_millis(@min_call_time),
           Helper.time_to_millis(@max_call_time),
-          encoder.encode(@params) ]
+          encoder.encode(@params)]
       end
 
       private
 
+      # need to hash the same way in every process, to be able to aggregate slow SQL traces
       def consistent_hash(string)
-        # need to hash the same way in every process
-        Digest::MD5.hexdigest(string).hex \
-          .modulo(2**31-1)  # ensure sql_id fits in an INT(11)
+        if NewRelic::Agent.config[:'slow_sql.use_longer_sql_id']
+          Digest::SHA1.hexdigest(string).hex.modulo(2**63 - 1)
+        else
+          # from when sql_id needed to fit in an INT(11)
+          Digest::SHA1.hexdigest(string).hex.modulo(2**31 - 1)
+        end
       end
     end
   end

data/lib/new_relic/agent/stats.rb

@@ -1,9 +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
+
 module NewRelic
   module Agent
     class Stats
+      SKIP_MARSHALLING = [:@lock]
+
       attr_accessor :call_count
       attr_accessor :min_call_time
       attr_accessor :max_call_time
@@ -12,6 +15,7 @@ module NewRelic
       attr_accessor :sum_of_squares
 
       def initialize
+        @lock = Mutex.new
         reset
       end
 
@@ -34,33 +38,45 @@ module NewRelic
       end
 
       def merge!(other)
-        @min_call_time = other.min_call_time if min_time_less?(other)
-        @max_call_time = other.max_call_time if other.max_call_time > max_call_time
-        @total_call_time      += other.total_call_time
-        @total_exclusive_time += other.total_exclusive_time
-        @sum_of_squares       += other.sum_of_squares
-        @call_count += other.call_count
+        @lock.synchronize do
+          @min_call_time = other.min_call_time if min_time_less?(other)
+          @max_call_time = other.max_call_time if other.max_call_time > max_call_time
+          @total_call_time += other.total_call_time
+          @total_exclusive_time += other.total_exclusive_time
+          @sum_of_squares += other.sum_of_squares
+          @call_count += other.call_count
+        end
         self
       end
 
-      def to_s
-        "[#{'%2i' % call_count.to_i} calls #{'%.4f' % total_call_time.to_f}s / #{'%.4f' % total_exclusive_time.to_f}s ex]"
+      def hash_merge(hash)
+        @call_count = hash[:count] if hash[:count]
+        @total_call_time = hash[:total] if hash[:total]
+        @total_exclusive_time = hash[:total] if hash[:total]
+        @min_call_time = hash[:min] if hash[:min]
+        @max_call_time = hash[:max] if hash[:max]
+        @sum_of_squares = hash[:sum_of_squares] if hash[:sum_of_squares]
+        self
       end
 
       def to_json(*_)
         {
-          'call_count'           => call_count.to_i,
-          'min_call_time'        => min_call_time.to_f,
-          'max_call_time'        => max_call_time.to_f,
-          'total_call_time'      => total_call_time.to_f,
+          'call_count' => call_count.to_i,
+          'min_call_time' => min_call_time.to_f,
+          'max_call_time' => max_call_time.to_f,
+          'total_call_time' => total_call_time.to_f,
           'total_exclusive_time' => total_exclusive_time.to_f,
-          'sum_of_squares'       => sum_of_squares.to_f
+          'sum_of_squares' => sum_of_squares.to_f
         }.to_json(*_)
       end
 
-      def record(value=nil, aux=nil, &blk)
+      def to_s
+        "[#{'%2i' % call_count.to_i} calls #{'%.4f' % total_call_time.to_f}s / #{'%.4f' % total_exclusive_time.to_f}s ex]"
+      end
+
+      def record(value = nil, aux = nil, &blk)
         if blk
-          yield self
+          yield(self)
         else
           case value
           when Numeric
@@ -78,13 +94,15 @@ module NewRelic
       # will aggregate all data points collected over a specified period and upload
       # its data to the NewRelic server
       def record_data_point(value, exclusive_time = value)
-        @call_count += 1
-        @total_call_time += value
-        @min_call_time = value if value < @min_call_time || @call_count == 1
-        @max_call_time = value if value > @max_call_time
-        @total_exclusive_time += exclusive_time
-
-        @sum_of_squares += (value * value)
+        @lock.synchronize do
+          @call_count += 1
+          @total_call_time += value
+          @min_call_time = value if value < @min_call_time || @call_count == 1
+          @max_call_time = value if value > @max_call_time
+          @total_exclusive_time += exclusive_time
+
+          @sum_of_squares += (value * value)
+        end
         self
       end
 
@@ -92,7 +110,7 @@ module NewRelic
 
       # increments the call_count by one
       def increment_count(value = 1)
-        @call_count += value
+        @lock.synchronize { @call_count += value }
       end
 
       # Concerned about implicit usage of inspect relying on stats format, so
@@ -100,20 +118,20 @@ module NewRelic
       def inspect_full
         variables = instance_variables.map do |ivar|
           "#{ivar.to_s}=#{instance_variable_get(ivar).inspect}"
-        end.join(" ")
+        end.join(' ')
         "#<NewRelic::Agent::Stats #{variables}>"
       end
 
       def ==(other)
         other.class == self.class &&
-        (
-          @min_call_time        == other.min_call_time &&
-          @max_call_time        == other.max_call_time &&
-          @total_call_time      == other.total_call_time &&
-          @total_exclusive_time == other.total_exclusive_time &&
-          @sum_of_squares       == other.sum_of_squares &&
-          @call_count           == other.call_count
-        )
+          (
+            @min_call_time == other.min_call_time &&
+            @max_call_time == other.max_call_time &&
+            @total_call_time == other.total_call_time &&
+            @total_exclusive_time == other.total_exclusive_time &&
+            @sum_of_squares == other.sum_of_squares &&
+            @call_count == other.call_count
+          )
       end
 
       # Apdex-related accessors
@@ -122,37 +140,42 @@ module NewRelic
       alias_method :apdex_f, :total_exclusive_time
 
       def record_apdex(bucket, apdex_t)
-        case bucket
-        when :apdex_s then @call_count += 1
-        when :apdex_t then @total_call_time += 1
-        when :apdex_f then @total_exclusive_time += 1
-        end
-        if apdex_t
-          @min_call_time = apdex_t
-          @max_call_time = apdex_t
-        else
-          ::NewRelic::Agent.logger.warn("Attempted to set apdex_t to #{apdex_t.inspect}, backtrace = #{caller.join("\n")}")
+        @lock.synchronize do
+          case bucket
+          when :apdex_s then @call_count += 1
+          when :apdex_t then @total_call_time += 1
+          when :apdex_f then @total_exclusive_time += 1
+          end
+          if apdex_t
+            @min_call_time = apdex_t
+            @max_call_time = apdex_t
+          else
+            ::NewRelic::Agent.logger.warn("Attempted to set apdex_t to #{apdex_t.inspect}, backtrace = #{caller.join("\n")}")
+          end
         end
       end
 
-      protected
+      # Override marshalling methods to exclude @lock from being included in marshalled data
+      def marshal_dump
+        instance_variables.each_with_object({}) do |name, instance_copy|
+          next if SKIP_MARSHALLING.include?(name)
 
-      def min_time_less?(other)
-        (other.min_call_time < min_call_time && other.call_count > 0) || call_count == 0
+          instance_copy[name] = instance_variable_get(name)
+        end
       end
-    end
 
-    class ChainedStats
-      attr_accessor :scoped_stats, :unscoped_stats
-
-      def initialize(scoped_stats, unscoped_stats)
-        @scoped_stats = scoped_stats
-        @unscoped_stats = unscoped_stats
+      def marshal_load(marshalled_data)
+        marshalled_data.each do |name, value|
+          instance_variable_set(name, value) unless SKIP_MARSHALLING.include?(name)
+        end
+        # since the lock is excluded when marshalling, create a new lock when loading marshalled data
+        @lock = Mutex.new
       end
 
-      def method_missing(method, *args)
-        unscoped_stats.send(method, *args)
-        scoped_stats.send(method, *args)
+      protected
+
+      def min_time_less?(other)
+        (other.min_call_time < min_call_time && other.call_count > 0) || call_count == 0
       end
     end
   end

data/lib/new_relic/agent/stats_engine/gc_profiler.rb

@@ -1,8 +1,7 @@
-# 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
 
-# -*- coding: utf-8 -*-
 module NewRelic
   module Agent
     class StatsEngine
@@ -10,7 +9,9 @@ module NewRelic
         GCSnapshot = Struct.new(:gc_time_s, :gc_call_count)
 
         def self.init
+          @initialized ||= nil
           return @profiler if @initialized
+
           @profiler = if RailsBenchProfiler.enabled?
             RailsBenchProfiler.new
           elsif CoreGCProfiler.enabled?
@@ -21,7 +22,7 @@ module NewRelic
         end
 
         def self.reset
-          @profiler    = nil
+          @profiler = nil
           @initialized = nil
         end
 
@@ -29,15 +30,13 @@ module NewRelic
           init
           if @profiler
             GCSnapshot.new(@profiler.call_time_s, @profiler.call_count)
-          else
-            nil
           end
         end
 
         def self.record_delta(start_snapshot, end_snapshot)
           if @profiler && start_snapshot && end_snapshot
             elapsed_gc_time_s = end_snapshot.gc_time_s - start_snapshot.gc_time_s
-            num_calls         = end_snapshot.gc_call_count - start_snapshot.gc_call_count
+            num_calls = end_snapshot.gc_call_count - start_snapshot.gc_call_count
             record_gc_metric(num_calls, elapsed_gc_time_s)
 
             @profiler.reset
@@ -45,17 +44,17 @@ module NewRelic
           end
         end
 
-        def self.record_gc_metric(call_count, elapsed) #THREAD_LOCAL_ACCESS
+        def self.record_gc_metric(call_count, elapsed) # THREAD_LOCAL_ACCESS
           NewRelic::Agent.agent.stats_engine.tl_record_scoped_and_unscoped_metrics(gc_metric_name, GC_ROLLUP) do |stats|
-            stats.call_count           += call_count
-            stats.total_call_time      += elapsed
+            stats.call_count += call_count
+            stats.total_call_time += elapsed
             stats.total_exclusive_time += elapsed
           end
         end
 
         GC_ROLLUP = 'GC/Transaction/all'.freeze
-        GC_OTHER  = 'GC/Transaction/allOther'.freeze
-        GC_WEB    = 'GC/Transaction/allWeb'.freeze
+        GC_OTHER = 'GC/Transaction/allOther'.freeze
+        GC_WEB = 'GC/Transaction/allWeb'.freeze
 
         def self.gc_metric_name
           if NewRelic::Agent::Transaction.recording_web_transaction?
@@ -98,7 +97,7 @@ module NewRelic
 
           # When using GC::Profiler, it's important to periodically call
           # GC::Profiler.clear in order to avoid unbounded growth in the number
-          # of GC recordds that are stored. However, we actually do this
+          # of GC records that are stored. However, we actually do this
           # internally within MonotonicGCProfiler on calls to #total_time_s,
           # so the reset here is a no-op.
           def reset; end