appsignal 3.4.13 → 3.6.1

data/lib/appsignal/helpers/metrics.rb

@@ -10,22 +10,24 @@ module Appsignal
           Appsignal::Utils::Data.generate(tags)
         )
       rescue RangeError
-        Appsignal.logger
+        Appsignal.internal_logger
           .warn("Gauge value #{value} for key '#{key}' is too big")
       end
 
-      def set_host_gauge(key, value)
-        Appsignal::Extension.set_host_gauge(key.to_s, value.to_f)
-      rescue RangeError
-        Appsignal.logger
-          .warn("Host gauge value #{value} for key '#{key}' is too big")
+      def set_host_gauge(_key, _value)
+        Appsignal::Utils::DeprecationMessage.message \
+          "The `set_host_gauge` method has been deprecated. " \
+            "Calling this method has no effect. " \
+            "Please remove method call in the following file to remove " \
+            "this message.\n#{caller.first}"
       end
 
-      def set_process_gauge(key, value)
-        Appsignal::Extension.set_process_gauge(key.to_s, value.to_f)
-      rescue RangeError
-        Appsignal.logger
-          .warn("Process gauge value #{value} for key '#{key}' is too big")
+      def set_process_gauge(_key, _value)
+        Appsignal::Utils::DeprecationMessage.message \
+          "The `set_process_gauge` method has been deprecated. " \
+            "Calling this method has no effect. " \
+            "Please remove method call in the following file to remove " \
+            "this message.\n#{caller.first}"
       end
 
       def increment_counter(key, value = 1.0, tags = {})
@@ -35,7 +37,7 @@ module Appsignal
           Appsignal::Utils::Data.generate(tags)
         )
       rescue RangeError
-        Appsignal.logger
+        Appsignal.internal_logger
           .warn("Counter value #{value} for key '#{key}' is too big")
       end
 
@@ -46,7 +48,7 @@ module Appsignal
           Appsignal::Utils::Data.generate(tags)
         )
       rescue RangeError
-        Appsignal.logger
+        Appsignal.internal_logger
           .warn("Distribution value #{value} for key '#{key}' is too big")
       end
     end

data/lib/appsignal/hooks/active_job.rb

@@ -56,7 +56,7 @@ module Appsignal
           super
         rescue Exception => exception # rubocop:disable Lint/RescueException
           job_status = :failed
-          transaction.set_error(exception)
+          transaction_set_error(transaction, exception)
           raise exception
         ensure
           if transaction
@@ -82,6 +82,14 @@ module Appsignal
               tags.merge(:status => :processed)
           end
         end
+
+        private
+
+        def transaction_set_error(transaction, exception)
+          return if Appsignal.config[:activejob_report_errors] == "none"
+
+          transaction.set_error(exception)
+        end
       end
 
       module ActiveJobHelpers

data/lib/appsignal/hooks/redis.rb

@@ -8,6 +8,7 @@ module Appsignal
 
       def dependencies_present?
         defined?(::Redis) &&
+          !defined?(::RedisClient) &&
           Appsignal.config &&
           Appsignal.config[:instrument_redis]
       end

data/lib/appsignal/hooks/redis_client.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Appsignal
+  class Hooks
+    # @api private
+    class RedisClientHook < Appsignal::Hooks::Hook
+      register :redis_client
+
+      def dependencies_present?
+        defined?(::RedisClient) &&
+          Appsignal.config &&
+          Appsignal.config[:instrument_redis]
+      end
+
+      def install
+        require "appsignal/integrations/redis_client"
+        ::RedisClient::RubyConnection.prepend Appsignal::Integrations::RedisClientIntegration
+        Appsignal::Environment.report_enabled("redis")
+
+        return unless defined?(::RedisClient::HiredisConnection)
+
+        ::RedisClient::HiredisConnection.prepend Appsignal::Integrations::RedisClientIntegration
+        Appsignal::Environment.report_enabled("hiredis")
+      end
+    end
+  end
+end

data/lib/appsignal/hooks.rb

@@ -32,12 +32,12 @@ module Appsignal
         return unless dependencies_present?
         return if installed?
 
-        Appsignal.logger.debug("Installing #{name} hook")
+        Appsignal.internal_logger.debug("Installing #{name} hook")
         begin
           install
           @installed = true
         rescue => ex
-          logger = Appsignal.logger
+          logger = Appsignal.internal_logger
           logger.error("Error while installing #{name} hook: #{ex}")
           logger.debug ex.backtrace.join("\n")
         end
@@ -103,6 +103,7 @@ require "appsignal/hooks/passenger"
 require "appsignal/hooks/puma"
 require "appsignal/hooks/rake"
 require "appsignal/hooks/redis"
+require "appsignal/hooks/redis_client"
 require "appsignal/hooks/resque"
 require "appsignal/hooks/sequel"
 require "appsignal/hooks/shoryuken"

data/lib/appsignal/integrations/hanami.rb

@@ -6,7 +6,7 @@ module Appsignal
   module Integrations
     module HanamiPlugin
       def self.init
-        Appsignal.logger.debug("Loading Hanami integration")
+        Appsignal.internal_logger.debug("Loading Hanami integration")
 
         hanami_app_config = ::Hanami.app.config
         Appsignal.config = Appsignal::Config.new(

data/lib/appsignal/integrations/padrino.rb

@@ -7,7 +7,7 @@ module Appsignal
     # @api private
     module PadrinoPlugin
       def self.init
-        Appsignal.logger.debug("Loading Padrino (#{Padrino::VERSION}) integration")
+        Appsignal.internal_logger.debug("Loading Padrino (#{Padrino::VERSION}) integration")
 
         root = Padrino.mounted_root
         Appsignal.config = Appsignal::Config.new(root, Padrino.env)

data/lib/appsignal/integrations/railtie.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Appsignal.logger.debug("Loading Rails (#{Rails.version}) integration")
+Appsignal.internal_logger.debug("Loading Rails (#{Rails.version}) integration")
 
 require "appsignal/utils/rails_helper"
 require "appsignal/rack/rails_instrumentation"

data/lib/appsignal/integrations/redis_client.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Appsignal
+  module Integrations
+    module RedisClientIntegration
+      def write(command)
+        sanitized_command =
+          if command[0] == :eval
+            "#{command[1]}#{" ?" * (command.size - 3)}"
+          else
+            "#{command[0]}#{" ?" * (command.size - 1)}"
+          end
+
+        Appsignal.instrument "query.redis", @config.id, sanitized_command do
+          super
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/integrations/sidekiq.rb

@@ -9,7 +9,7 @@ module Appsignal
     #
     # @api private
     class SidekiqErrorHandler
-      def call(exception, sidekiq_context)
+      def call(exception, sidekiq_context, _sidekiq_config = nil)
         transaction =
           if Appsignal::Transaction.current?
             Appsignal::Transaction.current
@@ -168,7 +168,7 @@ module Appsignal
         # Sidekiq issue #1761: in dev mode, it's possible to have jobs enqueued
         # which haven't been loaded into memory yet so the YAML can't be
         # loaded.
-        Appsignal.logger.warn "Unable to load YAML: #{error.message}"
+        Appsignal.internal_logger.warn "Unable to load YAML: #{error.message}"
         default
       end
     end

data/lib/appsignal/integrations/sinatra.rb

@@ -3,7 +3,7 @@
 require "appsignal"
 require "appsignal/rack/sinatra_instrumentation"
 
-Appsignal.logger.debug("Loading Sinatra (#{Sinatra::VERSION}) integration")
+Appsignal.internal_logger.debug("Loading Sinatra (#{Sinatra::VERSION}) integration")
 
 app_settings = ::Sinatra::Application.settings
 Appsignal.config = Appsignal::Config.new(

data/lib/appsignal/logger.rb

@@ -17,6 +17,8 @@ module Appsignal
       FATAL => 7
     }.freeze
 
+    attr_reader :level
+
     # Create a new logger instance
     #
     # @param group Name of the group for this logger.

data/lib/appsignal/minutely.rb

@@ -108,7 +108,7 @@ module Appsignal
       attr_reader :probes
 
       def logger
-        Appsignal.logger
+        Appsignal.internal_logger
       end
     end
 
@@ -132,7 +132,7 @@ module Appsignal
           sleep initial_wait_time
           initialize_probes
           loop do
-            logger = Appsignal.logger
+            logger = Appsignal.internal_logger
             logger.debug("Gathering minutely metrics with #{probe_instances.count} probes")
             probe_instances.each do |name, probe|
               logger.debug("Gathering minutely metrics with '#{name}' probe")
@@ -181,13 +181,13 @@ module Appsignal
           klass = instance.class
         end
         unless dependencies_present?(klass)
-          Appsignal.logger.debug "Skipping '#{name}' probe, " \
+          Appsignal.internal_logger.debug "Skipping '#{name}' probe, " \
             "#{klass}.dependency_present? returned falsy"
           return
         end
         probe_instances[name] = instance
       rescue => error
-        logger = Appsignal.logger
+        logger = Appsignal.internal_logger
         logger.error "Error while initializing minutely probe '#{name}': #{error}"
         logger.debug error.backtrace.join("\n")
       end

data/lib/appsignal/probes/gvl.rb

@@ -22,7 +22,7 @@ module Appsignal
       end
 
       def initialize(appsignal: Appsignal, gvl_tools: ::GVLTools)
-        Appsignal.logger.debug("Initializing GVL probe")
+        Appsignal.internal_logger.debug("Initializing GVL probe")
         @appsignal = appsignal
         @gvl_tools = gvl_tools
       end

data/lib/appsignal/probes/helpers.rb

@@ -47,7 +47,7 @@ module Appsignal
         # Auto detect hostname as fallback. May be inaccurate.
         @hostname =
           config[:hostname] || Socket.gethostname
-        Appsignal.logger.debug "Probe helper: Using hostname config " \
+        Appsignal.internal_logger.debug "Probe helper: Using hostname config " \
           "option '#{@hostname.inspect}' as hostname"
 
         @hostname

data/lib/appsignal/probes/mri.rb

@@ -11,7 +11,7 @@ module Appsignal
       end
 
       def initialize(appsignal: Appsignal, gc_profiler: Appsignal::GarbageCollection.profiler)
-        Appsignal.logger.debug("Initializing VM probe")
+        Appsignal.internal_logger.debug("Initializing VM probe")
         @appsignal = appsignal
         @gc_profiler = gc_profiler
       end

data/lib/appsignal/probes/sidekiq.rb

@@ -59,7 +59,7 @@ module Appsignal
         @adapter = is_sidekiq7 ? Sidekiq7Adapter : Sidekiq6Adapter
 
         config_string = " with config: #{config}" unless config.empty?
-        Appsignal.logger.debug("Initializing Sidekiq probe#{config_string}")
+        Appsignal.internal_logger.debug("Initializing Sidekiq probe#{config_string}")
         require "sidekiq/api"
       end
 
@@ -78,9 +78,9 @@ module Appsignal
         redis_info = adapter.redis_info
         return unless redis_info
 
-        gauge "connection_count", redis_info.fetch("connected_clients")
-        gauge "memory_usage", redis_info.fetch("used_memory")
-        gauge "memory_usage_rss", redis_info.fetch("used_memory_rss")
+        gauge "connection_count", redis_info["connected_clients"]
+        gauge "memory_usage", redis_info["used_memory"]
+        gauge "memory_usage_rss", redis_info["used_memory_rss"]
       end
 
       def track_stats
@@ -112,6 +112,8 @@ module Appsignal
 
       # Track a gauge metric with the `sidekiq_` prefix
       def gauge(key, value, tags = {})
+        return if value.nil?
+
         tags[:hostname] = hostname if hostname
         Appsignal.set_gauge "sidekiq_#{key}", value, tags
       end
@@ -121,14 +123,14 @@ module Appsignal
 
         if config.key?(:hostname)
           @hostname = config[:hostname]
-          Appsignal.logger.debug "Sidekiq probe: Using hostname config " \
-            "option #{@hostname.inspect} as hostname"
+          Appsignal.internal_logger.debug "Sidekiq probe: Using hostname " \
+            "config option #{@hostname.inspect} as hostname"
           return @hostname
         end
 
         host = adapter.hostname
-        Appsignal.logger.debug "Sidekiq probe: Using Redis server hostname " \
-          "#{host.inspect} as hostname"
+        Appsignal.internal_logger.debug "Sidekiq probe: Using Redis server " \
+          "hostname #{host.inspect} as hostname"
         @hostname = host
       end
     end

data/lib/appsignal/rack/body_wrapper.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module Appsignal
+  # @api private
+  module Rack
+    class BodyWrapper
+      def self.wrap(original_body, appsignal_transaction)
+        # The logic of how Rack treats a response body differs based on which methods
+        # the body responds to. This means that to support the Rack 3.x spec in full
+        # we need to return a wrapper which matches the API of the wrapped body as closely
+        # as possible. Pick the wrapper from the most specific to the least specific.
+        # See https://github.com/rack/rack/blob/main/SPEC.rdoc#the-body-
+        #
+        # What is important is that our Body wrapper responds to the same methods Rack
+        # (or a webserver) would be checking and calling, and passes through that functionality
+        # to the original body. This can be done using delegation via i.e. SimpleDelegate
+        # but we also need "close" to get called correctly so that the Appsignal transaction
+        # gets completed - which will not happen, for example, when #to_ary gets called
+        # just on the delegated Rack body.
+        #
+        # This comment https://github.com/rails/rails/pull/49627#issuecomment-1769802573
+        # is of particular interest to understand why this has to be somewhat complicated.
+        if original_body.respond_to?(:to_path)
+          PathableBodyWrapper.new(original_body, appsignal_transaction)
+        elsif original_body.respond_to?(:to_ary)
+          ArrayableBodyWrapper.new(original_body, appsignal_transaction)
+        elsif !original_body.respond_to?(:each) && original_body.respond_to?(:call)
+          # This body only supports #call, so we must be running a Rack 3 application
+          # It is possible that a body exposes both `each` and `call` in the hopes of
+          # being backwards-compatible with both Rack 3.x and Rack 2.x, however
+          # this is not going to work since the SPEC says that if both are available,
+          # `each` should be used and `call` should be ignored.
+          # So for that case we can drop by to our default EnumerableBodyWrapper
+          CallableBodyWrapper.new(original_body, appsignal_transaction)
+        else
+          EnumerableBodyWrapper.new(original_body, appsignal_transaction)
+        end
+      end
+
+      def initialize(body, appsignal_transaction)
+        @body_already_closed = false
+        @body = body
+        @transaction = appsignal_transaction
+      end
+
+      # This must be present in all Rack bodies and will be called by the serving adapter
+      def close
+        # The @body_already_closed check is needed so that if `to_ary`
+        # of the body has already closed itself (as prescribed) we do not
+        # attempt to close it twice
+        if !@body_already_closed && @body.respond_to?(:close)
+          Appsignal.instrument("response_body_close.rack") { @body.close }
+        end
+        @body_already_closed = true
+      rescue Exception => error # rubocop:disable Lint/RescueException
+        @transaction.set_error(error)
+        raise error
+      ensure
+        complete_transaction!
+      end
+
+      def complete_transaction!
+        # We need to call the Transaction class method and not
+        # @transaction.complete because the transaction is still
+        # thread-local and it needs to remove itself from the
+        # thread variables correctly, which does not happen on
+        # Transaction#complete.
+        #
+        # In the future it would be a good idea to ensure
+        # that the current transaction is the same as @transaction,
+        # or allow @transaction to complete itself and remove
+        # itself from Thread.current
+        Appsignal::Transaction.complete_current!
+      end
+    end
+
+    # The standard Rack body wrapper which exposes "each" for iterating
+    # over the response body. This is supported across all 3 major Rack
+    # versions.
+    #
+    # @api private
+    class EnumerableBodyWrapper < BodyWrapper
+      def each(&blk)
+        # This is a workaround for the Rails bug when there was a bit too much
+        # eagerness in implementing to_ary, see:
+        # https://github.com/rails/rails/pull/44953
+        # https://github.com/rails/rails/pull/47092
+        # https://github.com/rails/rails/pull/49627
+        # https://github.com/rails/rails/issues/49588
+        # While the Rack SPEC does not mandate `each` to be callable
+        # in a blockless way it is still a good idea to have it in place.
+        return enum_for(:each) unless block_given?
+
+        Appsignal.instrument("process_response_body.rack", "Process Rack response body (#each)") do
+          @body.each(&blk)
+        end
+      rescue Exception => error # rubocop:disable Lint/RescueException
+        @transaction.set_error(error)
+        raise error
+      end
+    end
+
+    # The callable response bodies are a new Rack 3.x feature, and would not work
+    # with older Rack versions. They must not respond to `each` because
+    # "If it responds to each, you must call each and not call". This is why
+    # it inherits from BodyWrapper directly and not from EnumerableBodyWrapper
+    #
+    # @api private
+    class CallableBodyWrapper < BodyWrapper
+      def call(stream)
+        # `stream` will be closed by the app we are calling, no need for us
+        # to close it ourselves
+        Appsignal.instrument("process_response_body.rack", "Process Rack response body (#call)") do
+          @body.call(stream)
+        end
+      rescue Exception => error # rubocop:disable Lint/RescueException
+        @transaction.set_error(error)
+        raise error
+      end
+    end
+
+    # "to_ary" takes precedence over "each" and allows the response body
+    # to be read eagerly. If the body supports that method, it takes precedence
+    # over "each":
+    # "Middleware may call to_ary directly on the Body and return a new Body in its place"
+    # One could "fold" both the to_ary API and the each() API into one Body object, but
+    # to_ary must also call "close" after it executes - and in the Rails implementation
+    # this pecularity was not handled properly.
+    #
+    # @api private
+    class ArrayableBodyWrapper < EnumerableBodyWrapper
+      def to_ary
+        @body_already_closed = true
+        Appsignal.instrument(
+          "process_response_body.rack",
+          "Process Rack response body (#to_ary)"
+        ) do
+          @body.to_ary
+        end
+      rescue Exception => error # rubocop:disable Lint/RescueException
+        @transaction.set_error(error)
+        raise error
+      ensure
+        # We do not call "close" on ourselves as the only action
+        # we need to complete is completing the transaction.
+        complete_transaction!
+      end
+    end
+
+    # Having "to_path" on a body allows Rack to serve out a static file, or to
+    # pass that file to the downstream webserver for sending using X-Sendfile
+    class PathableBodyWrapper < EnumerableBodyWrapper
+      def to_path
+        Appsignal.instrument("response_body_to_path.rack") { @body.to_path }
+      rescue Exception => error # rubocop:disable Lint/RescueException
+        @transaction.set_error(error)
+        raise error
+      end
+    end
+  end
+end

data/lib/appsignal/rack/generic_instrumentation.rb

@@ -7,7 +7,7 @@ module Appsignal
   module Rack
     class GenericInstrumentation
       def initialize(app, options = {})
-        Appsignal.logger.debug "Initializing Appsignal::Rack::GenericInstrumentation"
+        Appsignal.internal_logger.debug "Initializing Appsignal::Rack::GenericInstrumentation"
         @app = app
         @options = options
       end
@@ -16,7 +16,9 @@ module Appsignal
         if Appsignal.active?
           call_with_appsignal_monitoring(env)
         else
-          @app.call(env)
+          nil_transaction = Appsignal::Transaction::NilTransaction.new
+          status, headers, obody = @app.call(env)
+          [status, headers, Appsignal::Rack::BodyWrapper.wrap(obody, nil_transaction)]
         end
       end
 
@@ -27,19 +29,30 @@ module Appsignal
           Appsignal::Transaction::HTTP_REQUEST,
           request
         )
+        # We need to complete the transaction if there is an exception inside the `call`
+        # of the app. If there isn't one and the app returns us a Rack response triplet, we let
+        # the BodyWrapper complete the transaction when #close gets called on it
+        # (guaranteed by the webserver)
+        complete_transaction_without_body = false
         begin
           Appsignal.instrument("process_action.generic") do
-            @app.call(env)
+            status, headers, obody = @app.call(env)
+            [status, headers, Appsignal::Rack::BodyWrapper.wrap(obody, transaction)]
           end
         rescue Exception => error # rubocop:disable Lint/RescueException
           transaction.set_error(error)
+          complete_transaction_without_body = true
           raise error
         ensure
-          transaction.set_action_if_nil(env["appsignal.route"] || "unknown")
+          default_action = env["appsignal.route"] || env["appsignal.action"] || "unknown"
+          transaction.set_action_if_nil(default_action)
           transaction.set_metadata("path", request.path)
           transaction.set_metadata("method", request.request_method)
           transaction.set_http_or_background_queue_start
-          Appsignal::Transaction.complete_current!
+
+          # Transaction gets completed when the body gets read out, except in cases when
+          # the app failed before returning us the Rack response triplet.
+          Appsignal::Transaction.complete_current! if complete_transaction_without_body
         end
       end
     end

data/lib/appsignal/rack/rails_instrumentation.rb

@@ -7,7 +7,7 @@ module Appsignal
   module Rack
     class RailsInstrumentation
       def initialize(app, options = {})
-        Appsignal.logger.debug "Initializing Appsignal::Rack::RailsInstrumentation"
+        Appsignal.internal_logger.debug "Initializing Appsignal::Rack::RailsInstrumentation"
         @app = app
         @options = options
       end
@@ -16,7 +16,9 @@ module Appsignal
         if Appsignal.active?
           call_with_appsignal_monitoring(env)
         else
-          @app.call(env)
+          nil_transaction = Appsignal::Transaction::NilTransaction.new
+          status, headers, obody = @app.call(env)
+          [status, headers, Appsignal::Rack::BodyWrapper.wrap(obody, nil_transaction)]
         end
       end
 
@@ -28,10 +30,17 @@ module Appsignal
           request,
           :params_method => :filtered_parameters
         )
+        # We need to complete the transaction if there is an exception exception inside the `call`
+        # of the app. If there isn't one and the app returns us a Rack response triplet, we let
+        # the BodyWrapper complete the transaction when #close gets called on it
+        # (guaranteed by the webserver)
+        complete_transaction_without_body = false
         begin
-          @app.call(env)
+          status, headers, obody = @app.call(env)
+          [status, headers, Appsignal::Rack::BodyWrapper.wrap(obody, transaction)]
         rescue Exception => error # rubocop:disable Lint/RescueException
           transaction.set_error(error)
+          complete_transaction_without_body = true
           raise error
         ensure
           controller = env["action_controller.instance"]
@@ -43,9 +52,12 @@ module Appsignal
           begin
             transaction.set_metadata("method", request.request_method)
           rescue => error
-            Appsignal.logger.error("Unable to report HTTP request method: '#{error}'")
+            Appsignal.internal_logger.error("Unable to report HTTP request method: '#{error}'")
           end
-          Appsignal::Transaction.complete_current!
+
+          # Transaction gets completed when the body gets read out, except in cases when
+          # the app failed before returning us the Rack response triplet.
+          Appsignal::Transaction.complete_current! if complete_transaction_without_body
         end
       end