newrelic_rpm 7.0.0 → 9.0.0

data/lib/new_relic/agent/instrumentation/httprb/prepend.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::Agent::Instrumentation
   module HTTPrb
@@ -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/httprb.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_relative 'httprb/instrumentation'
 require_relative 'httprb/chain'
@@ -14,16 +14,16 @@ DependencyDetection.defer do
   end
 
   executes do
-    ::NewRelic::Agent.logger.info "Installing http.rb Wrappers"
+    NewRelic::Agent.logger.info("Installing http.rb Wrappers")
     require 'new_relic/agent/distributed_tracing/cross_app_tracing'
     require 'new_relic/agent/http_clients/http_rb_wrappers'
   end
 
   executes do
     if use_prepend?
-      prepend_instrument HTTP::Client, ::NewRelic::Agent::Instrumentation::HTTPrb::Prepend
+      prepend_instrument HTTP::Client, NewRelic::Agent::Instrumentation::HTTPrb::Prepend
     else
-      chain_instrument ::NewRelic::Agent::Instrumentation::HTTPrb::Chain
+      chain_instrument NewRelic::Agent::Instrumentation::HTTPrb::Chain
     end
   end
 end

data/lib/new_relic/agent/instrumentation/ignore_actions.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
@@ -10,14 +10,14 @@ module NewRelic
           # We'll walk the superclass chain and see if
           # any class says 'yes, filter this one'.
 
-          while klass.respond_to? :newrelic_read_attr
+          while klass.respond_to?(:newrelic_read_attr)
             ignore_actions = klass.newrelic_read_attr(key)
 
             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 @@
+# 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::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,66 @@
+# 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
+    module Instrumentation
+      module Logger
+        def skip_instrumenting?
+          defined?(@skip_instrumenting) && @skip_instrumenting
+        end
+
+        # We support setting this on loggers which might not have
+        # instrumentation installed yet. This lets us disable in AgentLogger
+        # and AuditLogger without them having to know the inner details.
+        def self.mark_skip_instrumenting(logger)
+          return if logger.frozen?
+
+          logger.instance_variable_set(:@skip_instrumenting, true)
+        end
+
+        def self.clear_skip_instrumenting(logger)
+          return if logger.frozen?
+
+          logger.instance_variable_set(:@skip_instrumenting, false)
+        end
+
+        def mark_skip_instrumenting
+          return if frozen?
+
+          @skip_instrumenting = true
+        end
+
+        def clear_skip_instrumenting
+          return if frozen?
+
+          @skip_instrumenting = false
+        end
+
+        def self.enabled?
+          NewRelic::Agent.config[:'instrumentation.logger'] != 'disabled'
+        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
+
+            unless ::NewRelic::Agent.agent.nil?
+              ::NewRelic::Agent.agent.log_event_aggregator.record(formatted_message, severity)
+              formatted_message = LocalLogDecorator.decorate(formatted_message)
+            end
+
+            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 @@
+# 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::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,26 @@
+# 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_relative 'logger/instrumentation'
+require_relative 'logger/chain'
+require_relative 'logger/prepend'
+
+DependencyDetection.defer do
+  named :logger
+
+  depends_on do
+    defined?(Logger) &&
+      NewRelic::Agent.config[:'application_logging.enabled']
+  end
+
+  executes do
+    NewRelic::Agent.logger.info("Installing Logger instrumentation")
+
+    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/chain.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
@@ -8,8 +7,8 @@ module NewRelic::Agent::Instrumentation
     module Chain
       extend Helper
 
-      def self.instrument! target_class
-        instrument_methods target_class, client_methods
+      def self.instrument!(target_class)
+        instrument_methods(target_class, client_methods)
       end
     end
   end

data/lib/new_relic/agent/instrumentation/memcache/dalli.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
@@ -9,12 +8,13 @@ module NewRelic
       module Memcache
         module Dalli
           extend Helper
+
           module_function
 
           def instrument!
             if supports_datastore_instances?
               instrument_methods(::Dalli::Client, dalli_methods)
-              instrument_multi_method :get_multi
+              instrument_multi_method(:get_multi)
               instrument_send_multiget
               instrument_server_for_key
             else
@@ -22,19 +22,19 @@ module NewRelic
             end
           end
 
-          def instrument_multi_method method_name
-            visibility = NewRelic::Helper.instance_method_visibility ::Dalli::Client, method_name
+          def instrument_multi_method(method_name)
+            visibility = NewRelic::Helper.instance_method_visibility(::Dalli::Client, method_name)
             method_name_without = :"#{method_name}_without_newrelic_trace"
 
             ::Dalli::Client.class_eval do
-              alias_method method_name_without, method_name
+              alias_method(method_name_without, method_name)
 
-              define_method method_name do |*args, &block|
-                get_multi_with_newrelic_tracing(method_name) { __send__ method_name_without, *args, &block }
+              define_method(method_name) do |*args, &block|
+                get_multi_with_newrelic_tracing(method_name) { __send__(method_name_without, *args, &block) }
               end
 
-              __send__ visibility, method_name
-              __send__ visibility, method_name_without
+              __send__(visibility, method_name)
+              __send__(visibility, method_name_without)
             end
           end
 
@@ -42,21 +42,33 @@ module NewRelic
             ::Dalli::Ring.class_eval do
               include NewRelic::Agent::Instrumentation::Memcache::Tracer
 
-              alias_method :server_for_key_without_newrelic_trace, :server_for_key
+              alias_method(:server_for_key_without_newrelic_trace, :server_for_key)
 
-              def server_for_key key
-                server_for_key_with_newrelic_tracing { server_for_key_without_newrelic_trace key }
+              def server_for_key(key)
+                server_for_key_with_newrelic_tracing { server_for_key_without_newrelic_trace(key) }
               end
             end
           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
 
-              def send_multiget keys
-                send_multiget_with_newrelic_tracing(keys) { send_multiget_without_newrelic_trace keys }
+              # TODO: Dalli - 3.1.0 renamed send_multiget to pipelined_get, but the method is otherwise the same
+              if Gem::Version.new(::Dalli::VERSION) >= Gem::Version.new('3.1.0')
+                alias_method(:pipelined_get_without_newrelic_trace, :pipelined_get)
+                def pipelined_get(keys)
+                  send_multiget_with_newrelic_tracing(keys) { pipelined_get_without_newrelic_trace(keys) }
+                end
+              else
+                alias_method(:send_multiget_without_newrelic_trace, :send_multiget)
+                def send_multiget(keys)
+                  send_multiget_with_newrelic_tracing(keys) { send_multiget_without_newrelic_trace(keys) }
+                end
               end
             end
           end
@@ -65,6 +77,7 @@ module NewRelic
         module DalliCAS
           extend Dalli
           extend Helper
+
           module_function
 
           def should_instrument?
@@ -72,12 +85,11 @@ module NewRelic
           end
 
           def instrument!
-            instrument_methods ::Dalli::Client, dalli_cas_methods
-            instrument_multi_method :get_multi_cas
+            instrument_methods(::Dalli::Client, dalli_cas_methods)
+            instrument_multi_method(:get_multi_cas)
           end
         end
       end
     end
   end
 end
-

data/lib/new_relic/agent/instrumentation/memcache/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
@@ -6,12 +5,17 @@
 module NewRelic::Agent::Instrumentation
   module Memcache
     module Helper
-      DATASTORE_INSTANCES_SUPPORTED_VERSION = Gem::Version.new '2.6.4'
+      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]
@@ -33,24 +37,23 @@ module NewRelic::Agent::Instrumentation
 
       def instrument_methods(client_class, requested_methods = METHODS)
         supported_methods_for(client_class, requested_methods).each do |method_name|
-          visibility = NewRelic::Helper.instance_method_visibility client_class, method_name
+          visibility = NewRelic::Helper.instance_method_visibility(client_class, method_name)
           method_name_without = :"#{method_name}_without_newrelic_trace"
 
           client_class.class_eval do
             include NewRelic::Agent::Instrumentation::Memcache::Tracer
 
-            alias_method method_name_without, method_name
+            alias_method(method_name_without, method_name)
 
-            define_method method_name do |*args, &block|
-              with_newrelic_tracing(method_name, *args) { __send__ method_name_without, *args, &block }
+            define_method(method_name) do |*args, &block|
+              with_newrelic_tracing(method_name, *args) { __send__(method_name_without, *args, &block) }
             end
 
-            __send__ visibility, method_name
-            __send__ visibility, method_name_without
+            __send__(visibility, method_name)
+            __send__(visibility, method_name_without)
           end
         end
       end
     end
   end
 end
-

data/lib/new_relic/agent/instrumentation/memcache/instrumentation.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,18 +11,19 @@ module NewRelic::Agent::Instrumentation
       MULTIGET_METRIC_NAME = "get_multi_request"
       MEMCACHED = "Memcached"
 
-      def with_newrelic_tracing operation, *args
-        segment = NewRelic::Agent::Tracer.start_datastore_segment \
+      def with_newrelic_tracing(operation, *args)
+        segment = NewRelic::Agent::Tracer.start_datastore_segment( \
           product: MEMCACHED,
           operation: operation
+        )
 
         begin
           NewRelic::Agent::Tracer.capture_segment_error(segment) { yield }
         ensure
           if NewRelic::Agent.config[:capture_memcache_keys]
-            segment.notice_nosql_statement "#{operation} #{args.first.inspect}"
+            segment.notice_nosql_statement("#{operation} #{args.first.inspect}")
           end
-          segment.finish if segment
+          ::NewRelic::Agent::Transaction::Segment.finish(segment)
         end
       end
 
@@ -37,51 +37,53 @@ module NewRelic::Agent::Instrumentation
               end
             end
           rescue => e
-            ::NewRelic::Agent.logger.warn "Unable to set instance info on datastore segment: #{e.message}"
+            ::NewRelic::Agent.logger.warn("Unable to set instance info on datastore segment: #{e.message}")
           end
         end
       end
 
-      def get_multi_with_newrelic_tracing method_name
-        segment = NewRelic::Agent::Tracer.start_segment \
+      def get_multi_with_newrelic_tracing(method_name)
+        segment = NewRelic::Agent::Tracer.start_segment( \
           name: "Ruby/Memcached/Dalli/#{method_name}"
+        )
 
         begin
           NewRelic::Agent::Tracer.capture_segment_error(segment) { yield }
         ensure
-          segment.finish if segment
+          ::NewRelic::Agent::Transaction::Segment.finish(segment)
         end
       end
 
-      def send_multiget_with_newrelic_tracing keys
-        segment = ::NewRelic::Agent::Tracer.start_datastore_segment \
+      def send_multiget_with_newrelic_tracing(keys)
+        segment = ::NewRelic::Agent::Tracer.start_datastore_segment( \
           product: MEMCACHED,
           operation: MULTIGET_METRIC_NAME
+        )
 
         begin
           assign_instance_to(segment, self)
           NewRelic::Agent::Tracer.capture_segment_error(segment) { yield }
         ensure
           if ::NewRelic::Agent.config[:capture_memcache_keys]
-            segment.notice_nosql_statement "#{MULTIGET_METRIC_NAME} #{keys.inspect}"
+            segment.notice_nosql_statement("#{MULTIGET_METRIC_NAME} #{keys.inspect}")
           end
-          segment.finish if segment
+          ::NewRelic::Agent::Transaction::Segment.finish(segment)
         end
       end
 
-      def assign_instance_to segment, server
+      def assign_instance_to(segment, server)
         host = port_path_or_id = nil
-        if server.hostname.start_with? SLASH
+        if server.hostname.start_with?(SLASH)
           host = LOCALHOST
           port_path_or_id = server.hostname
         else
           host = server.hostname
           port_path_or_id = server.port
         end
-        segment.set_instance_info host, port_path_or_id
+        segment.set_instance_info(host, port_path_or_id)
       rescue => e
-        ::NewRelic::Agent.logger.debug "Failed to retrieve memcached instance info: #{e.message}"
-        segment.set_instance_info UNKNOWN, UNKNOWN
+        ::NewRelic::Agent.logger.debug("Failed to retrieve memcached instance info: #{e.message}")
+        segment.set_instance_info(UNKNOWN, UNKNOWN)
       end
     end
   end

data/lib/new_relic/agent/instrumentation/memcache/prepend.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
@@ -7,9 +6,10 @@ module NewRelic::Agent::Instrumentation
   module Memcache
     module Prepend
       extend Helper
+
       module_function
 
-      def client_prepender client_class
+      def client_prepender(client_class)
         Module.new do
           extend Helper
           include NewRelic::Agent::Instrumentation::Memcache::Tracer
@@ -23,22 +23,28 @@ module NewRelic::Agent::Instrumentation
       end
 
       def dalli_cas_prependers
-        yield ::Dalli::Client, dalli_client_prepender(dalli_cas_methods)
-        yield ::Dalli::Client, dalli_get_multi_prepender(:get_multi_cas)
+        yield(::Dalli::Client, dalli_client_prepender(dalli_cas_methods))
+        yield(::Dalli::Client, dalli_get_multi_prepender(:get_multi_cas))
       end
 
       def dalli_prependers
         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
-          yield ::Dalli::Ring, dalli_ring_prepender
+          yield(::Dalli::Client, dalli_client_prepender(dalli_methods))
+          yield(::Dalli::Client, dalli_get_multi_prepender(:get_multi))
+
+          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)
+          yield(::Dalli::Client, dalli_client_prepender(client_methods))
         end
       end
 
-      def dalli_client_prepender supported_methods
+      def dalli_client_prepender(supported_methods)
         Module.new do
           extend Helper
           include NewRelic::Agent::Instrumentation::Memcache::Tracer
@@ -51,7 +57,7 @@ module NewRelic::Agent::Instrumentation
         end
       end
 
-      def dalli_get_multi_prepender method_name
+      def dalli_get_multi_prepender(method_name)
         Module.new do
           extend Helper
           include NewRelic::Agent::Instrumentation::Memcache::Tracer
@@ -67,7 +73,7 @@ module NewRelic::Agent::Instrumentation
           extend Helper
           include NewRelic::Agent::Instrumentation::Memcache::Tracer
 
-          def server_for_key key
+          def server_for_key(key)
             server_for_key_with_newrelic_tracing { super }
           end
         end
@@ -78,11 +84,18 @@ module NewRelic::Agent::Instrumentation
           extend Helper
           include NewRelic::Agent::Instrumentation::Memcache::Tracer
 
-          def send_multiget keys
-            send_multiget_with_newrelic_tracing(keys) { super }
+          # TODO: Dalli - 3.1.0 renamed send_multiget to pipelined_get, but the method is otherwise the same
+          if Gem::Version.new(::Dalli::VERSION) >= Gem::Version.new('3.1.0')
+            def pipelined_get(keys)
+              send_multiget_with_newrelic_tracing(keys) { super }
+            end
+          else
+            def send_multiget(keys)
+              send_multiget_with_newrelic_tracing(keys) { super }
+            end
           end
         end
       end
     end
   end
-end
+end