newrelic_rpm 8.2.0 → 9.0.0

data/lib/new_relic/agent/sql_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 'zlib'
 require 'base64'
@@ -46,7 +46,7 @@ module NewRelic
           NewRelic::Agent::Database.should_record_sql?(:slow_sql)
       end
 
-      def on_start_transaction(state, uri=nil)
+      def on_start_transaction(state, uri = nil)
         return unless enabled?
 
         state.sql_sampler_transaction_data = TransactionSqlData.new
@@ -74,8 +74,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
@@ -83,7 +83,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
@@ -140,7 +140,7 @@ module NewRelic
       # @api public
       # @deprecated Use {Datastores.notice_sql} instead.
       #
-      def notice_sql(sql, metric_name, config, duration, state=nil, explainer=nil, binds=nil, name=nil) #THREAD_LOCAL_ACCESS sometimes
+      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
@@ -162,7 +162,7 @@ module NewRelic
         if transaction && transaction.distributed_tracer.distributed_trace_payload
           params = {}
           payload = transaction.distributed_tracer.distributed_trace_payload
-          DistributedTraceAttributes.copy_from_transaction transaction, payload, params
+          DistributedTraceAttributes.copy_from_transaction(transaction, payload, params)
           params[PRIORITY] = transaction.priority
         end
         params
@@ -176,7 +176,7 @@ module NewRelic
         if state.is_sql_recorded?
           if duration > Agent.config[:'slow_sql.explain_threshold']
             backtrace = caller.join("\n")
-            params = distributed_trace_attributes state
+            params = distributed_trace_attributes(state)
             data.sql_data << SlowSql.new(statement, metric_name, duration, backtrace, params)
           end
         end
@@ -196,14 +196,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
 
@@ -240,7 +240,7 @@ module NewRelic
       attr_reader :duration
       attr_reader :backtrace
 
-      def initialize(statement, metric_name, duration, backtrace=nil, params=nil)
+      def initialize(statement, metric_name, duration, backtrace = nil, params = nil)
         @statement = statement
         @metric_name = metric_name
         @duration = duration
@@ -300,7 +300,7 @@ module NewRelic
         super()
         @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
 
@@ -315,7 +315,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))
@@ -342,7 +342,7 @@ module NewRelic
       include NewRelic::Coerce
 
       def to_collector_array(encoder)
-        [ string(@path),
+        [string(@path),
           string(@url),
           int(@sql_id),
           string(@sql),
@@ -351,7 +351,7 @@ 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
@@ -359,10 +359,10 @@ module NewRelic
       # need to hash the same way in every process, to be able to aggregate slow SQL traces
       def consistent_hash(string)
         if NewRelic::Agent.config[:'slow_sql.use_longer_sql_id']
-          Digest::SHA1.hexdigest(string).hex.modulo(2**63-1)
+          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)
+          Digest::SHA1.hexdigest(string).hex.modulo(2**31 - 1)
         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/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
@@ -106,14 +124,14 @@ module NewRelic
 
       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,17 +140,36 @@ 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
+        @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
-        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
+
+      # 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)
+
+          instance_copy[name] = instance_variable_get(name)
+        end
+      end
+
+      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
 
       protected

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/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
 
-# -*- coding: utf-8 -*-
 module NewRelic
   module Agent
     class StatsEngine
@@ -12,6 +11,7 @@ module NewRelic
         def self.init
           @initialized ||= nil
           return @profiler if @initialized
+
           @profiler = if RailsBenchProfiler.enabled?
             RailsBenchProfiler.new
           elsif CoreGCProfiler.enabled?
@@ -22,7 +22,7 @@ module NewRelic
         end
 
         def self.reset
-          @profiler    = nil
+          @profiler = nil
           @initialized = nil
         end
 
@@ -30,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
@@ -46,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?

data/lib/new_relic/agent/stats_engine/stats_hash.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
 
 # A Hash-like class for storing metric data.
 #
@@ -30,13 +30,12 @@ require 'new_relic/agent/internal_agent_error'
 module NewRelic
   module Agent
     class StatsHash
-
       attr_accessor :started_at, :harvested_at
 
-      def initialize(started_at=Process.clock_gettime(Process::CLOCK_REALTIME))
+      def initialize(started_at = Process.clock_gettime(Process::CLOCK_REALTIME))
         @started_at = started_at.to_f
-        @scoped     = Hash.new { |h, k| h[k] = NewRelic::Agent::Stats.new }
-        @unscoped   = Hash.new { |h, k| h[k] = NewRelic::Agent::Stats.new }
+        @scoped = Hash.new { |h, k| h[k] = NewRelic::Agent::Stats.new }
+        @unscoped = Hash.new { |h, k| h[k] = NewRelic::Agent::Stats.new }
       end
 
       def marshal_dump
@@ -45,7 +44,7 @@ module NewRelic
 
       def marshal_load(data)
         @started_at = data.shift
-        @scoped   = Hash.new { |h, k| h[k] = NewRelic::Agent::Stats.new }
+        @scoped = Hash.new { |h, k| h[k] = NewRelic::Agent::Stats.new }
         @unscoped = Hash.new { |h, k| h[k] = NewRelic::Agent::Stats.new }
         @scoped.merge!(data.shift)
         @unscoped.merge!(data.shift)
@@ -57,7 +56,7 @@ module NewRelic
 
       def to_h
         hash = {}
-        @scoped.each   { |k, v| hash[k] = v }
+        @scoped.each { |k, v| hash[k] = v }
         @unscoped.each { |k, v| hash[NewRelic::MetricSpec.new(k)] = v }
         hash
       end
@@ -77,11 +76,11 @@ module NewRelic
 
       def each
         @scoped.each do |k, v|
-          yield k, v
+          yield(k, v)
         end
         @unscoped.each do |k, v|
           spec = NewRelic::MetricSpec.new(k)
-          yield spec, v
+          yield(spec, v)
         end
       end
 
@@ -99,7 +98,7 @@ module NewRelic
         end
       end
 
-      def record(metric_specs, value=nil, aux=nil, &blk)
+      def record(metric_specs, value = nil, aux = nil, &blk)
         Array(metric_specs).each do |metric_spec|
           if metric_spec.scope.empty?
             key = metric_spec.name
@@ -122,13 +121,13 @@ module NewRelic
       def handle_stats_lookup_error(key, hash, error)
         # This only happen in the case of a corrupted default_proc
         # Side-step it manually, notice the issue, and carry on....
-        NewRelic::Agent.instance.error_collector. \
-          notice_agent_error(StatsHashLookupError.new(error, hash, key))
+        NewRelic::Agent.instance.error_collector \
+          .notice_agent_error(StatsHashLookupError.new(error, hash, key))
         stats = NewRelic::Agent::Stats.new
         hash[key] = stats
         # Try to restore the default_proc so we won't continually trip the error
         if hash.respond_to?(:default_proc=)
-          hash.default_proc = Proc.new { |h, k| h[k] = NewRelic::Agent::Stats.new }
+          hash.default_proc = proc { |h, k| h[k] = NewRelic::Agent::Stats.new }
         end
         stats
       end

data/lib/new_relic/agent/stats_engine.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/stats_engine/gc_profiler'
 require 'new_relic/agent/stats_engine/stats_hash'
@@ -13,8 +13,8 @@ module NewRelic
       attr_accessor :metric_rules
 
       def initialize
-        @stats_lock   = Mutex.new
-        @stats_hash   = StatsHash.new
+        @stats_lock = Mutex.new
+        @stats_hash = StatsHash.new
         @metric_rules = RulesEngine.new
       end
 
@@ -60,12 +60,12 @@ module NewRelic
       #
       # @api private
       #
-      def tl_record_unscoped_metrics(metric_names, value=nil, aux=nil, &blk)
+      def tl_record_unscoped_metrics(metric_names, value = nil, aux = nil, &blk)
         state = NewRelic::Agent::Tracer.state
         record_unscoped_metrics(state, metric_names, value, aux, &blk)
       end
 
-      def record_unscoped_metrics(state, metric_names, value=nil, aux=nil, &blk)
+      def record_unscoped_metrics(state, metric_names, value = nil, aux = nil, &blk)
         txn = state.current_transaction
         if txn
           txn.metrics.record_unscoped(metric_names, value, aux, &blk)
@@ -96,12 +96,12 @@ module NewRelic
       #
       # @api private
       #
-      def tl_record_scoped_and_unscoped_metrics(scoped_metric, summary_metrics=nil, value=nil, aux=nil, &blk)
+      def tl_record_scoped_and_unscoped_metrics(scoped_metric, summary_metrics = nil, value = nil, aux = nil, &blk)
         state = NewRelic::Agent::Tracer.state
         record_scoped_and_unscoped_metrics(state, scoped_metric, summary_metrics, value, aux, &blk)
       end
 
-      def record_scoped_and_unscoped_metrics(state, scoped_metric, summary_metrics=nil, value=nil, aux=nil, &blk)
+      def record_scoped_and_unscoped_metrics(state, scoped_metric, summary_metrics = nil, value = nil, aux = nil, &blk)
         txn = state.current_transaction
         if txn
           txn.metrics.record_scoped_and_unscoped(scoped_metric, value, aux, &blk)

data/lib/new_relic/agent/synthetics_event_aggregator.rb

@@ -1,7 +1,7 @@
 # -*- ruby -*-
-# 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/event_aggregator'
 require 'new_relic/agent/timestamp_sampled_buffer'
@@ -13,24 +13,24 @@ module NewRelic
 
       named :SyntheticsEventAggregator
       capacity_key :'synthetics.events_limit'
-      enabled_key :'analytics_events.enabled'
+      enabled_key :'transaction_events.enabled'
       buffer_class TimestampSampledBuffer
 
-      def record event
+      def record(event)
         return unless enabled?
 
         @lock.synchronize do
-          @buffer.append event: event, priority: -event[0][TIMESTAMP]
+          @buffer.append(event: event, priority: -event[0][TIMESTAMP])
         end
       end
 
       private
 
-      def after_harvest metadata
-        record_dropped_synthetics metadata
+      def after_harvest(metadata)
+        record_dropped_synthetics(metadata)
       end
 
-      def record_dropped_synthetics metadata
+      def record_dropped_synthetics(metadata)
         num_dropped = metadata[:seen] - metadata[:captured]
         return unless num_dropped > 0
 
@@ -42,4 +42,3 @@ module NewRelic
     end
   end
 end
-