newrelic_rpm 8.0.0 → 8.4.0

data/lib/new_relic/agent/instrumentation/delayed_job/instrumentation.rb

@@ -3,23 +3,22 @@
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
 
-
 module NewRelic
   module Agent
     module Instrumentation
       module DelayedJob
-
         def initialize_with_tracing
           yield
           worker_name = case
                         when self.respond_to?(:name) then self.name
                         when self.class.respond_to?(:default_name) then self.class.default_name
-                        end
+          end
           NewRelic::DelayedJobInjection.worker_name = worker_name
-  
+
+          # TODO: Refactor the last line of this condition so that it can be evaluated in both prepend and chain instrumentation
           if defined?(::Delayed::Job) && ::Delayed::Job.method_defined?(:invoke_job) &&
-            !(::Delayed::Job.method_defined?(:invoke_job_without_new_relic) )
-  
+              !(::Delayed::Job.method_defined?(:invoke_job_without_new_relic))
+
             ::NewRelic::Agent.logger.info 'Installing DelayedJob instrumentation [part 2/2]'
             install_newrelic_job_tracer
             NewRelic::Control.instance.init_plugin :dispatcher => :delayed_job
@@ -27,7 +26,6 @@ module NewRelic
             NewRelic::Agent.logger.warn("Did not find a Delayed::Job class responding to invoke_job, aborting DJ instrumentation")
           end
         end
-
       end
 
       module DelayedJobTracer
@@ -45,9 +43,7 @@ module NewRelic
             yield
           end
         end
-
       end
     end
   end
 end
-

data/lib/new_relic/agent/instrumentation/delayed_job_instrumentation.rb

@@ -14,11 +14,11 @@ module NewRelic
         module Naming
           module_function
 
-          CLASS_METHOD_DELIMITER     = '.'.freeze
-          INSTANCE_METHOD_DELIMITER  = '#'.freeze
+          CLASS_METHOD_DELIMITER = '.'.freeze
+          INSTANCE_METHOD_DELIMITER = '#'.freeze
           LEGACY_DJ_FORMAT_DELIMITER = ';'.freeze
-          LEGACY_DJ_FORMAT_PREFIX    = 'LOAD'.freeze
-          LEGACY_DJ_DEFAULT_CLASS    = '(unknown class)'.freeze
+          LEGACY_DJ_FORMAT_PREFIX = 'LOAD'.freeze
+          LEGACY_DJ_DEFAULT_CLASS = '(unknown class)'.freeze
 
           def name_from_payload(payload_object)
             if payload_object.is_a? ::Delayed::PerformableMethod

data/lib/new_relic/agent/instrumentation/excon/middleware.rb

@@ -11,7 +11,7 @@ module ::Excon
         @stack = stack
       end
 
-      def request_call(datum) #THREAD_LOCAL_ACCESS
+      def request_call(datum) # THREAD_LOCAL_ACCESS
         begin
           # Only instrument this request if we haven't already done so, because
           # we can get request_call multiple times for requests marked as
@@ -45,7 +45,7 @@ module ::Excon
         @stack.error_call(datum)
       end
 
-      def finish_trace(datum) #THREAD_LOCAL_ACCESS
+      def finish_trace(datum) # THREAD_LOCAL_ACCESS
         segment = datum[:connection] && datum[:connection].instance_variable_get(TRACE_DATA_IVAR)
         if segment
           begin

data/lib/new_relic/agent/instrumentation/excon.rb

@@ -51,4 +51,3 @@ DependencyDetection.defer do
     end
   end
 end
-

data/lib/new_relic/agent/instrumentation/grape/chain.rb

@@ -14,7 +14,7 @@ module NewRelic::Agent::Instrumentation
               Grape::Instrumentation.capture_transaction env, self
             end
           end
-    
+
           alias_method :call_without_new_relic, :call
           alias_method :call, :call_with_new_relic
         end
@@ -22,4 +22,3 @@ module NewRelic::Agent::Instrumentation
     end
   end
 end
-

data/lib/new_relic/agent/instrumentation/grape/instrumentation.rb

@@ -7,7 +7,6 @@ require 'new_relic/agent/parameter_filtering'
 module NewRelic::Agent::Instrumentation
   module Grape
     module Instrumentation
-
       extend self
 
       # Since 1.2.0, the class `Grape::API` no longer refers to an API instance, rather, what used to be `Grape::API` is `Grape::API::Instance`
@@ -37,12 +36,12 @@ module NewRelic::Agent::Instrumentation
         end
       end
 
-      API_ENDPOINT   = 'api.endpoint'.freeze
-      API_VERSION    = 'api.version'.freeze
-      FORMAT_REGEX   = /\(\/?\.[\:\w]*\)/.freeze # either :format (< 0.12.0) or .ext (>= 0.12.0)
-      VERSION_REGEX  = /:version(\/|$)/.freeze
-      MIN_VERSION    = Gem::Version.new("0.2.0")
-      PIPE_STRING    = '|'.freeze
+      API_ENDPOINT = 'api.endpoint'.freeze
+      API_VERSION = 'api.version'.freeze
+      FORMAT_REGEX = /\(\/?\.[\:\w]*\)/.freeze # either :format (< 0.12.0) or .ext (>= 0.12.0)
+      VERSION_REGEX = /:version(\/|$)/.freeze
+      MIN_VERSION = Gem::Version.new("0.2.0")
+      PIPE_STRING = '|'.freeze
 
       def handle_transaction(endpoint, class_name, version)
         return unless endpoint && route = endpoint.route

data/lib/new_relic/agent/instrumentation/grape.rb

@@ -11,7 +11,7 @@ DependencyDetection.defer do
   # not shipping yet, overloading the name interferes with the plugin.
   named :grape_instrumentation
   configure_with :grape
-  
+
   depends_on do
     defined?(::Grape::VERSION) &&
       Gem::Version.new(::Grape::VERSION) >= ::NewRelic::Agent::Instrumentation::Grape::Instrumentation::MIN_VERSION
@@ -37,9 +37,8 @@ DependencyDetection.defer do
     if use_prepend?
       instrumented_class = ::NewRelic::Agent::Instrumentation::Grape::Instrumentation.instrumented_class
       prepend_instrument instrumented_class, ::NewRelic::Agent::Instrumentation::Grape::Prepend
-    else 
+    else
       chain_instrument ::NewRelic::Agent::Instrumentation::Grape::Chain
     end
   end
-
 end

data/lib/new_relic/agent/instrumentation/httpclient/chain.rb

@@ -4,7 +4,7 @@
 
 module NewRelic::Agent::Instrumentation
   module HTTPClient
-    module Chain 
+    module Chain
       def self.instrument!
         ::HTTPClient.class_eval do
           include NewRelic::Agent::Instrumentation::HTTPClient::Instrumentation
@@ -14,7 +14,7 @@ module NewRelic::Agent::Instrumentation
               do_get_block_without_newrelic(req, proxy, conn, &block)
             end
           end
-    
+
           alias :do_get_block_without_newrelic :do_get_block
           alias :do_get_block :do_get_block_with_newrelic
         end
@@ -22,4 +22,3 @@ module NewRelic::Agent::Instrumentation
     end
   end
 end
-

data/lib/new_relic/agent/instrumentation/httpclient/instrumentation.rb

@@ -35,4 +35,3 @@ module NewRelic::Agent::Instrumentation
     end
   end
 end
-

data/lib/new_relic/agent/instrumentation/httpclient/prepend.rb

@@ -2,7 +2,6 @@
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
-
 module NewRelic::Agent::Instrumentation
   module HTTPClient
     module Prepend
@@ -14,4 +13,3 @@ module NewRelic::Agent::Instrumentation
     end
   end
 end
-

data/lib/new_relic/agent/instrumentation/httprb/chain.rb

@@ -12,11 +12,11 @@ module NewRelic::Agent::Instrumentation
           def perform_with_newrelic_trace(request, options)
             with_tracing(request) { perform_without_newrelic_trace(request, options) }
           end
-       
+
           alias perform_without_newrelic_trace perform
           alias perform perform_with_newrelic_trace
         end
       end
     end
   end
-end
+end

data/lib/new_relic/agent/instrumentation/httprb/instrumentation.rb

@@ -6,25 +6,25 @@ module NewRelic::Agent::Instrumentation
   module HTTPrb
     def with_tracing(request)
       wrapped_request = ::NewRelic::Agent::HTTPClients::HTTPRequest.new(request)
-  
+
       begin
         segment = NewRelic::Agent::Tracer.start_external_request_segment(
           library: wrapped_request.type,
           uri: wrapped_request.uri,
           procedure: wrapped_request.method
         )
-  
+
         segment.add_request_headers wrapped_request
-  
+
         response = NewRelic::Agent::Tracer.capture_segment_error(segment) { yield }
-  
+
         wrapped_response = ::NewRelic::Agent::HTTPClients::HTTPResponse.new response
         segment.process_response_headers wrapped_response
-  
+
         response
       ensure
         segment.finish if segment
       end
     end
   end
-end
+end

data/lib/new_relic/agent/instrumentation/httprb/prepend.rb

@@ -8,7 +8,7 @@ module NewRelic::Agent::Instrumentation
       include NewRelic::Agent::Instrumentation::HTTPrb
 
       def perform(request, options)
-        with_tracing(request) { super }        
+        with_tracing(request) { super }
       end
     end
   end

data/lib/new_relic/agent/instrumentation/ignore_actions.rb

@@ -15,9 +15,9 @@ module NewRelic
 
             should_filter = case ignore_actions
             when Hash
-              only_actions   = Array(ignore_actions[:only])
+              only_actions = Array(ignore_actions[:only])
               except_actions = Array(ignore_actions[:except])
-              action_name    = action_name.to_sym
+              action_name = action_name.to_sym
 
               only_actions.include?(action_name) || (!except_actions.empty? && !except_actions.include?(action_name))
             else
@@ -38,4 +38,3 @@ module NewRelic
     end
   end
 end
-

data/lib/new_relic/agent/instrumentation/logger/chain.rb

@@ -0,0 +1,21 @@
+# 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.
+
+module NewRelic::Agent::Instrumentation
+  module Logger
+    def self.instrument!
+      ::Logger.class_eval do
+        include NewRelic::Agent::Instrumentation::Logger
+
+        alias_method :format_message_without_new_relic, :format_message
+
+        def format_message(severity, datetime, progname, msg)
+          format_message_with_tracing(severity, datetime, progname, msg) do
+            format_message_without_new_relic(severity, datetime, progname, msg)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/logger/instrumentation.rb

@@ -0,0 +1,58 @@
+# 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.
+
+module NewRelic
+  module Agent
+    module Instrumentation
+      module Logger
+        def skip_instrumenting?
+          defined?(@skip_instrumenting) && @skip_instrumenting
+        end
+
+        def mark_skip_instrumenting
+          @skip_instrumenting = true
+        end
+
+        def clear_skip_instrumenting
+          @skip_instrumenting = false
+        end
+
+        LINES = "Logging/lines".freeze
+        SIZE = "Logging/size".freeze
+
+        def line_metric_name_by_severity(severity)
+          @line_metrics ||= {}
+          @line_metrics[severity] ||= "Logging/lines/#{severity}".freeze
+        end
+
+        def size_metric_name_by_severity(severity)
+          @size_metrics ||= {}
+          @size_metrics[severity] ||= "Logging/size/#{severity}".freeze
+        end
+
+        def format_message_with_tracing(severity, datetime, progname, msg)
+          formatted_message = yield
+          return formatted_message if skip_instrumenting?
+
+          begin
+            # It's critical we don't instrument logging from metric recording
+            # methods within NewRelic::Agent, or we'll stack overflow!!
+            mark_skip_instrumenting
+
+            NewRelic::Agent.increment_metric(LINES)
+            NewRelic::Agent.increment_metric(line_metric_name_by_severity(severity))
+
+            size = formatted_message.nil? ? 0 : formatted_message.bytesize
+            NewRelic::Agent.record_metric(SIZE, size)
+            NewRelic::Agent.record_metric(size_metric_name_by_severity(severity), size)
+
+            return formatted_message
+          ensure
+            clear_skip_instrumenting
+          end
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/logger/prepend.rb

@@ -0,0 +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.
+
+module NewRelic::Agent::Instrumentation
+  module Logger::Prepend
+    include NewRelic::Agent::Instrumentation::Logger
+
+    def format_message(severity, datetime, progname, msg)
+      format_message_with_tracing(severity, datetime, progname, msg) { super }
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/logger.rb

@@ -0,0 +1,25 @@
+# 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.
+
+require_relative 'logger/instrumentation'
+require_relative 'logger/chain'
+require_relative 'logger/prepend'
+
+DependencyDetection.defer do
+  named :logger
+
+  depends_on { defined?(::Logger) }
+
+  executes do
+    ::NewRelic::Agent.logger.info "Installing Logger instrumentation"
+  end
+
+  executes do
+    if use_prepend?
+      prepend_instrument ::Logger, NewRelic::Agent::Instrumentation::Logger::Prepend
+    else
+      chain_instrument NewRelic::Agent::Instrumentation::Logger
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/memcache/dalli.rb

@@ -9,6 +9,7 @@ module NewRelic
       module Memcache
         module Dalli
           extend Helper
+
           module_function
 
           def instrument!
@@ -51,7 +52,11 @@ module NewRelic
           end
 
           def instrument_send_multiget
-            ::Dalli::Server.class_eval do
+            if supports_binary_protocol?
+              ::Dalli::Protocol::Binary
+            else
+              ::Dalli::Server
+            end.class_eval do
               include NewRelic::Agent::Instrumentation::Memcache::Tracer
               alias_method :send_multiget_without_newrelic_trace, :send_multiget
 
@@ -65,6 +70,7 @@ module NewRelic
         module DalliCAS
           extend Dalli
           extend Helper
+
           module_function
 
           def should_instrument?
@@ -80,4 +86,3 @@ module NewRelic
     end
   end
 end
-

data/lib/new_relic/agent/instrumentation/memcache/helper.rb

@@ -7,11 +7,16 @@ module NewRelic::Agent::Instrumentation
   module Memcache
     module Helper
       DATASTORE_INSTANCES_SUPPORTED_VERSION = Gem::Version.new '2.6.4'
+      BINARY_PROTOCOL_SUPPORTED_VERSION = Gem::Version.new '3.0.2'
 
       def supports_datastore_instances?
         DATASTORE_INSTANCES_SUPPORTED_VERSION <= Gem::Version.new(::Dalli::VERSION)
       end
 
+      def supports_binary_protocol?
+        BINARY_PROTOCOL_SUPPORTED_VERSION <= Gem::Version.new(::Dalli::VERSION)
+      end
+
       def client_methods
         [:get, :get_multi, :set, :add, :incr, :decr, :delete, :replace, :append,
           :prepend, :cas, :single_get, :multi_get, :single_cas, :multi_cas]
@@ -53,4 +58,3 @@ module NewRelic::Agent::Instrumentation
     end
   end
 end
-

data/lib/new_relic/agent/instrumentation/memcache/prepend.rb

@@ -7,6 +7,7 @@ module NewRelic::Agent::Instrumentation
   module Memcache
     module Prepend
       extend Helper
+
       module_function
 
       def client_prepender client_class
@@ -31,7 +32,13 @@ module NewRelic::Agent::Instrumentation
         if supports_datastore_instances?
           yield ::Dalli::Client, dalli_client_prepender(dalli_methods)
           yield ::Dalli::Client, dalli_get_multi_prepender(:get_multi)
-          yield ::Dalli::Server, dalli_server_prepender
+
+          if supports_binary_protocol?
+            yield ::Dalli::Protocol::Binary, dalli_server_prepender
+          else
+            yield ::Dalli::Server, dalli_server_prepender
+          end
+
           yield ::Dalli::Ring, dalli_ring_prepender
         else
           yield ::Dalli::Client, dalli_client_prepender(client_methods)
@@ -85,4 +92,4 @@ module NewRelic::Agent::Instrumentation
       end
     end
   end
-end
+end

data/lib/new_relic/agent/instrumentation/middleware_proxy.rb

@@ -15,7 +15,7 @@ module NewRelic
       class MiddlewareProxy
         include MiddlewareTracing
 
-        ANONYMOUS_CLASS   = "AnonymousClass".freeze
+        ANONYMOUS_CLASS = "AnonymousClass".freeze
         OBJECT_CLASS_NAME = "Object".freeze
 
         # This class is used to wrap classes that are passed to
@@ -50,7 +50,7 @@ module NewRelic
           )
         end
 
-        def self.wrap(target, is_app=false)
+        def self.wrap(target, is_app = false)
           if needs_wrapping?(target)
             self.new(target, is_app)
           else
@@ -60,13 +60,13 @@ module NewRelic
 
         attr_reader :target, :category, :transaction_options
 
-        def initialize(target, is_app=false)
-          @target            = target
-          @is_app            = is_app
-          @category          = determine_category
+        def initialize(target, is_app = false)
+          @target = target
+          @is_app = is_app
+          @category = determine_category
           @target_class_name = determine_class_name
-          @transaction_name  = "#{determine_prefix}#{@target_class_name}/call"
-          @transaction_options  = {
+          @transaction_name = "#{determine_prefix}#{@target_class_name}/call"
+          @transaction_options = {
             :transaction_name => @transaction_name
           }
         end
@@ -93,7 +93,7 @@ module NewRelic
 
           name = clazz.name
           name = clazz.superclass.name if name.nil? || name == ""
-          name = ANONYMOUS_CLASS       if name.nil? || name == OBJECT_CLASS_NAME
+          name = ANONYMOUS_CLASS if name.nil? || name == OBJECT_CLASS_NAME
           name
         end
 
@@ -104,7 +104,6 @@ module NewRelic
             @target.class
           end
         end
-
       end
     end
   end

data/lib/new_relic/agent/instrumentation/middleware_tracing.rb

@@ -27,10 +27,9 @@ module NewRelic
   module Agent
     module Instrumentation
       module MiddlewareTracing
-
         TXN_STARTED_KEY = 'newrelic.transaction_started'
-        CONTENT_TYPE    = 'Content-Type'
-        CONTENT_LENGTH  = 'Content-Length'
+        CONTENT_TYPE = 'Content-Type'
+        CONTENT_LENGTH = 'Content-Length'
 
         def _nr_has_middleware_tracing
           true
@@ -71,7 +70,7 @@ module NewRelic
           if result.is_a?(Array) && state.current_transaction
             _, headers, _ = result
             length = headers[CONTENT_LENGTH]
-            length = length.reduce(0){|sum, h| sum + h.to_i} if length.is_a?(Array)
+            length = length.reduce(0) { |sum, h| sum + h.to_i } if length.is_a?(Array)
             state.current_transaction.response_content_length = length
           end
         end
@@ -98,7 +97,7 @@ module NewRelic
 
             events.notify(:before_call, env) if first_middleware
 
-            result = (target == self) ? traced_call(env) : target.call(env)
+            result = target == self ? traced_call(env) : target.call(env)
 
             if first_middleware
               capture_response_attributes(state, result)

data/lib/new_relic/agent/instrumentation/mongodb_command_subscriber.rb

@@ -19,11 +19,11 @@ module NewRelic
           end
         end
 
-        ERROR_KEYS = %w{ writeErrors writeConcernError writeConcernErrors }.freeze
+        ERROR_KEYS = %w[ writeErrors writeConcernError writeConcernErrors ].freeze
 
         def error_key_present?(event)
           if reply = event.reply
-            ERROR_KEYS.detect{ |key| reply[key] }
+            ERROR_KEYS.detect { |key| reply[key] }
           end
         rescue
           false
@@ -35,7 +35,7 @@ module NewRelic
             segment = segments.delete(event.operation_id)
             return unless segment
 
-            # operations that succeed but have errors return CommandSucceeded 
+            # operations that succeed but have errors return CommandSucceeded
             # with an error_key that is populated with error specfics
             if error_key = error_key_present?(event)
               # taking the last error as there can potentially be many
@@ -76,7 +76,7 @@ module NewRelic
         def operation(command_name)
           # from 2.0 to 2.5, :findandmodify was the command_name
           if command_name == :findandmodify
-            :findAndModify 
+            :findAndModify
           else
             command_name
           end

data/lib/new_relic/agent/instrumentation/net_http/chain.rb

@@ -4,7 +4,6 @@
 
 require_relative 'instrumentation'
 
-
 module NewRelic::Agent::Instrumentation
   module NetHTTP
     module Chain
@@ -14,12 +13,12 @@ module NewRelic::Agent::Instrumentation
 
           def request_with_newrelic_trace(request, *args, &block)
             request_with_tracing(request) { request_without_newrelic_trace(request, *args, &block) }
-          end  
-    
+          end
+
           alias request_without_newrelic_trace request
           alias request request_with_newrelic_trace
         end
       end
     end
   end
-end
+end

data/lib/new_relic/agent/instrumentation/net_http/instrumentation.rb

@@ -2,8 +2,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.
 
-module NewRelic 
-  module Agent 
+module NewRelic
+  module Agent
     module Instrumentation
       module NetHTTP
         def request_with_tracing(request)
@@ -14,11 +14,11 @@ module NewRelic
             uri: wrapped_request.uri,
             procedure: wrapped_request.method
           )
-  
+
           begin
             response = nil
             segment.add_request_headers wrapped_request
-  
+
             # RUBY-1244 Disable further tracing in request to avoid double
             # counting if connection wasn't started (which calls request again).
             NewRelic::Agent.disable_all_tracing do
@@ -26,7 +26,7 @@ module NewRelic
                 yield
               end
             end
-  
+
             wrapped_response = NewRelic::Agent::HTTPClients::NetHTTPResponse.new response
             segment.process_response_headers wrapped_response
             response