appsignal 3.5.4 → 3.5.5

data/lib/appsignal/helpers/instrumentation.rb

@@ -68,9 +68,9 @@ module Appsignal
           namespace = Appsignal::Transaction::HTTP_REQUEST
           request   = ::Rack::Request.new(env)
         else
-          logger.error "Unrecognized name '#{name}': names must start with " \
-            "either 'perform_job' (for jobs and tasks) or 'process_action' " \
-            "(for HTTP requests)"
+          internal_logger.error "Unrecognized name '#{name}': names must " \
+            "start with either 'perform_job' (for jobs and tasks) or " \
+            "'process_action' (for HTTP requests)"
           return yield
         end
 
@@ -228,8 +228,8 @@ module Appsignal
         return unless active?
 
         unless error.is_a?(Exception)
-          logger.error "Appsignal.send_error: Cannot send error. The given " \
-            "value is not an exception: #{error.inspect}"
+          internal_logger.error "Appsignal.send_error: Cannot send error. " \
+            "The given value is not an exception: #{error.inspect}"
           return
         end
         transaction = Appsignal::Transaction.new(
@@ -319,8 +319,8 @@ module Appsignal
               "Appsignal.set_error called on location: #{call_location}"
         end
         unless exception.is_a?(Exception)
-          logger.error "Appsignal.set_error: Cannot set error. The given " \
-            "value is not an exception: #{exception.inspect}"
+          internal_logger.error "Appsignal.set_error: Cannot set error. " \
+            "The given value is not an exception: #{exception.inspect}"
           return
         end
         return if !active? || !Appsignal::Transaction.current?

data/lib/appsignal/helpers/metrics.rb

@@ -10,7 +10,7 @@ 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
 
@@ -37,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
 
@@ -48,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/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

@@ -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/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
 
@@ -123,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/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

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
@@ -43,7 +43,7 @@ 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!
         end

data/lib/appsignal/rack/sinatra_instrumentation.rb

@@ -15,7 +15,7 @@ module Appsignal
       def initialize(app, options = {})
         @app = app
         @options = options
-        Appsignal.logger.warn "Please remove Appsignal::Rack::SinatraInstrumentation " \
+        Appsignal.internal_logger.warn "Please remove Appsignal::Rack::SinatraInstrumentation " \
           "from your Sinatra::Base class. This is no longer needed."
       end
 
@@ -32,7 +32,7 @@ module Appsignal
       attr_reader :raise_errors_on
 
       def initialize(app, options = {})
-        Appsignal.logger.debug "Initializing Appsignal::Rack::SinatraBaseInstrumentation"
+        Appsignal.internal_logger.debug "Initializing Appsignal::Rack::SinatraBaseInstrumentation"
         @app = app
         @options = options
         @raise_errors_on = raise_errors?(@app)

data/lib/appsignal/rack/streaming_listener.rb

@@ -7,7 +7,7 @@ module Appsignal
     # @api private
     class StreamingListener
       def initialize(app, options = {})
-        Appsignal.logger.debug "Initializing Appsignal::Rack::StreamingListener"
+        Appsignal.internal_logger.debug "Initializing Appsignal::Rack::StreamingListener"
         @app = app
         @options = options
       end

data/lib/appsignal/span.rb

@@ -16,8 +16,8 @@ module Appsignal
 
     def add_error(error)
       unless error.is_a?(Exception)
-        Appsignal.logger.error "Appsignal::Span#add_error: Cannot add error. " \
-          "The given value is not an exception: #{error.inspect}"
+        Appsignal.internal_logger.error "Appsignal::Span#add_error: Cannot " \
+          "add error. The given value is not an exception: #{error.inspect}"
         return
       end
       return unless error

data/lib/appsignal/transaction.rb

@@ -26,7 +26,7 @@ module Appsignal
             Appsignal::Transaction.new(id, namespace, request, options)
         else
           # Otherwise, log the issue about trying to start another transaction
-          Appsignal.logger.warn_once_then_debug(
+          Appsignal.internal_logger.warn_once_then_debug(
             :transaction_id,
             "Trying to start new transaction with id " \
               "'#{id}', but a transaction with id '#{current.transaction_id}' " \
@@ -59,7 +59,7 @@ module Appsignal
       def complete_current!
         current.complete
       rescue => e
-        Appsignal.logger.error(
+        Appsignal.internal_logger.error(
           "Failed to complete transaction ##{current.transaction_id}. #{e.message}"
         )
       ensure
@@ -114,7 +114,7 @@ module Appsignal
 
     def complete
       if discarded?
-        Appsignal.logger.debug "Skipping transaction '#{transaction_id}' " \
+        Appsignal.internal_logger.debug "Skipping transaction '#{transaction_id}' " \
           "because it was manually discarded."
         return
       end
@@ -188,7 +188,7 @@ module Appsignal
     #   Breadcrumb reference
     def add_breadcrumb(category, action, message = "", metadata = {}, time = Time.now.utc)
       unless metadata.is_a? Hash
-        Appsignal.logger.error "add_breadcrumb: Cannot add breadcrumb. " \
+        Appsignal.internal_logger.error "add_breadcrumb: Cannot add breadcrumb. " \
           "The given metadata argument is not a Hash."
         return
       end
@@ -287,7 +287,7 @@ module Appsignal
 
       @ext.set_queue_start(start)
     rescue RangeError
-      Appsignal.logger.warn("Queue start value #{start} is too big")
+      Appsignal.internal_logger.warn("Queue start value #{start} is too big")
     end
 
     # Set the queue time based on the HTTP header or `:queue_start` env key
@@ -324,7 +324,7 @@ module Appsignal
       return unless key && data
 
       if !data.is_a?(Array) && !data.is_a?(Hash)
-        Appsignal.logger.error(
+        Appsignal.internal_logger.error(
           "Invalid sample data for '#{key}'. Value is not an Array or Hash: '#{data.inspect}'"
         )
         return
@@ -337,11 +337,11 @@ module Appsignal
     rescue RuntimeError => e
       begin
         inspected_data = data.inspect
-        Appsignal.logger.error(
+        Appsignal.internal_logger.error(
           "Error generating data (#{e.class}: #{e.message}) for '#{inspected_data}'"
         )
       rescue => e
-        Appsignal.logger.error(
+        Appsignal.internal_logger.error(
           "Error generating data (#{e.class}: #{e.message}). Can't inspect data."
         )
       end
@@ -362,7 +362,7 @@ module Appsignal
 
     def set_error(error)
       unless error.is_a?(Exception)
-        Appsignal.logger.error "Appsignal::Transaction#set_error: Cannot set error. " \
+        Appsignal.internal_logger.error "Appsignal::Transaction#set_error: Cannot set error. " \
           "The given value is not an exception: #{error.inspect}"
         return
       end
@@ -385,7 +385,7 @@ module Appsignal
         break unless error
 
         if causes.length >= ERROR_CAUSES_LIMIT
-          Appsignal.logger.debug "Appsignal::Transaction#set_error: Error has more " \
+          Appsignal.internal_logger.debug "Appsignal::Transaction#set_error: Error has more " \
             "than #{ERROR_CAUSES_LIMIT} error causes. Only the first #{ERROR_CAUSES_LIMIT} " \
             "will be reported."
           root_cause_missing = true
@@ -529,7 +529,7 @@ module Appsignal
         request.send options[:params_method]
       rescue => e
         # Getting params from the request has been know to fail.
-        Appsignal.logger.debug "Exception while getting params: #{e}"
+        Appsignal.internal_logger.debug "Exception while getting params: #{e}"
         nil
       end
     end

data/lib/appsignal/utils/deprecation_message.rb

@@ -3,12 +3,12 @@
 module Appsignal
   module Utils
     module DeprecationMessage
-      def self.message(message, logger = Appsignal.logger)
+      def self.message(message, logger = Appsignal.internal_logger)
         Kernel.warn "appsignal WARNING: #{message}"
         logger.warn message
       end
 
-      def deprecation_message(message, logger = Appsignal.logger)
+      def deprecation_message(message, logger = Appsignal.internal_logger)
         Appsignal::Utils::DeprecationMessage.message(message, logger)
       end
     end

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "3.5.4"
+  VERSION = "3.5.5"
 end

data/lib/appsignal.rb

@@ -46,7 +46,11 @@ module Appsignal
     # @see extension_loaded?
     attr_accessor :extension_loaded
     # @!attribute [rw] logger
-    #   Accessor for the AppSignal logger.
+    #   Accessor for the internal AppSignal logger.
+    #
+    #   Not to be confused with our logging feature.
+    #   This is part of our private internal API. Do not call this method
+    #   directly.
     #
     #   If no logger has been set, it will return a "in memory logger", using
     #   `in_memory_log`. Once AppSignal is started (using {.start}) the
@@ -57,7 +61,7 @@ module Appsignal
     #   @api private
     #   @return [Logger]
     #   @see start_logger
-    attr_writer :logger
+    attr_writer :internal_logger
 
     # @api private
     def testing?
@@ -91,11 +95,11 @@ module Appsignal
     # @since 0.7.0
     def start
       unless extension_loaded?
-        logger.info("Not starting appsignal, extension is not loaded")
+        internal_logger.info("Not starting appsignal, extension is not loaded")
         return
       end
 
-      logger.debug("Starting appsignal")
+      internal_logger.debug("Starting appsignal")
 
       @config ||= Config.new(
         Dir.pwd,
@@ -103,9 +107,9 @@ module Appsignal
       )
 
       if config.valid?
-        logger.level = config.log_level
+        internal_logger.level = config.log_level
         if config.active?
-          logger.info "Starting AppSignal #{Appsignal::VERSION} " \
+          internal_logger.info "Starting AppSignal #{Appsignal::VERSION} " \
             "(#{$PROGRAM_NAME}, Ruby #{RUBY_VERSION}, #{RUBY_PLATFORM})"
           config.write_to_environment
           Appsignal::Extension.start
@@ -120,10 +124,10 @@ module Appsignal
 
           collect_environment_metadata
         else
-          logger.info("Not starting, not active for #{config.env}")
+          internal_logger.info("Not starting, not active for #{config.env}")
         end
       else
-        logger.error("Not starting, no valid config for this environment")
+        internal_logger.error("Not starting, no valid config for this environment")
       end
     end
 
@@ -143,9 +147,9 @@ module Appsignal
     # @since 1.0.0
     def stop(called_by = nil)
       if called_by
-        logger.debug("Stopping appsignal (#{called_by})")
+        internal_logger.debug("Stopping appsignal (#{called_by})")
       else
-        logger.debug("Stopping appsignal")
+        internal_logger.debug("Stopping appsignal")
       end
       Appsignal::Extension.stop
     end
@@ -154,7 +158,7 @@ module Appsignal
       return unless active?
 
       Appsignal.start_logger
-      logger.debug("Forked process, resubscribing and restarting extension")
+      internal_logger.debug("Forked process, resubscribing and restarting extension")
       Appsignal::Extension.start
     end
 
@@ -162,7 +166,8 @@ module Appsignal
       Appsignal::Extension.get_server_state(key)
     end
 
-    # In memory logger used before any logger is started with {.start_logger}.
+    # In memory internal logger used before any internal logger is started with
+    # {.start_logger}.
     #
     # The contents of this logger are flushed to the logger in {.start_logger}.
     #
@@ -176,11 +181,12 @@ module Appsignal
       end
     end
 
-    def logger
-      @logger ||= Appsignal::Utils::IntegrationLogger.new(in_memory_log).tap do |l|
-        l.level = ::Logger::INFO
-        l.formatter = log_formatter("appsignal")
-      end
+    def internal_logger
+      @internal_logger ||=
+        Appsignal::Utils::IntegrationLogger.new(in_memory_log).tap do |l|
+          l.level = ::Logger::INFO
+          l.formatter = log_formatter("appsignal")
+        end
     end
 
     # @api private
@@ -192,7 +198,7 @@ module Appsignal
       end
     end
 
-    # Start the AppSignal logger.
+    # Start the AppSignal internal logger.
     #
     # Sets the log level and sets the logger. Uses a file-based logger or the
     # STDOUT-based logger. See the `:log` configuration option.
@@ -201,18 +207,18 @@ module Appsignal
     # @since 0.7.0
     def start_logger
       if config && config[:log] == "file" && config.log_file_path
-        start_file_logger(config.log_file_path)
+        start_internal_file_logger(config.log_file_path)
       else
-        start_stdout_logger
+        start_internal_stdout_logger
       end
 
-      logger.level =
+      internal_logger.level =
         if config
           config.log_level
         else
           Appsignal::Config::DEFAULT_LOG_LEVEL
         end
-      logger << @in_memory_log.string if @in_memory_log
+      internal_logger << @in_memory_log.string if @in_memory_log
     end
 
     # Returns if the C-extension was loaded properly.
@@ -255,18 +261,18 @@ module Appsignal
 
     private
 
-    def start_stdout_logger
-      @logger = Appsignal::Utils::IntegrationLogger.new($stdout)
-      logger.formatter = log_formatter("appsignal")
+    def start_internal_stdout_logger
+      @internal_logger = Appsignal::Utils::IntegrationLogger.new($stdout)
+      internal_logger.formatter = log_formatter("appsignal")
     end
 
-    def start_file_logger(path)
-      @logger = Appsignal::Utils::IntegrationLogger.new(path)
-      logger.formatter = log_formatter
+    def start_internal_file_logger(path)
+      @internal_logger = Appsignal::Utils::IntegrationLogger.new(path)
+      internal_logger.formatter = log_formatter
     rescue SystemCallError => error
-      start_stdout_logger
-      logger.warn "Unable to start logger with log path '#{path}'."
-      logger.warn error
+      start_internal_stdout_logger
+      internal_logger.warn "Unable to start internal logger with log path '#{path}'."
+      internal_logger.warn error
     end
 
     def collect_environment_metadata

data/spec/lib/appsignal/config_spec.rb

@@ -265,7 +265,7 @@ describe Appsignal::Config do
 
     context "with an overriden config file" do
       let(:config) do
-        project_fixture_config("production", {}, Appsignal.logger,
+        project_fixture_config("production", {}, Appsignal.internal_logger,
           File.join(project_fixture_path, "config", "appsignal.yml"))
       end
 
@@ -276,7 +276,7 @@ describe Appsignal::Config do
 
       context "with an invalid overriden config file" do
         let(:config) do
-          project_fixture_config("production", {}, Appsignal.logger,
+          project_fixture_config("production", {}, Appsignal.internal_logger,
             File.join(project_fixture_path, "config", "missing.yml"))
         end