appsignal 3.5.3 → 3.5.5

data/ext/appsignal_extension.c

@@ -759,28 +759,6 @@ static VALUE set_gauge(VALUE self, VALUE key, VALUE value, VALUE tags) {
   return Qnil;
 }
 
-static VALUE set_host_gauge(VALUE self, VALUE key, VALUE value) {
-  Check_Type(key, T_STRING);
-  Check_Type(value, T_FLOAT);
-
-  appsignal_set_host_gauge(
-      make_appsignal_string(key),
-      NUM2DBL(value)
-  );
-  return Qnil;
-}
-
-static VALUE set_process_gauge(VALUE self, VALUE key, VALUE value) {
-  Check_Type(key, T_STRING);
-  Check_Type(value, T_FLOAT);
-
-  appsignal_set_process_gauge(
-      make_appsignal_string(key),
-      NUM2DBL(value)
-  );
-  return Qnil;
-}
-
 static VALUE increment_counter(VALUE self, VALUE key, VALUE count, VALUE tags) {
   appsignal_data_t* tags_data;
 
@@ -941,8 +919,6 @@ void Init_appsignal_extension(void) {
 
   // Metrics
   rb_define_singleton_method(Extension, "set_gauge",              set_gauge,              3);
-  rb_define_singleton_method(Extension, "set_host_gauge",         set_host_gauge,         2);
-  rb_define_singleton_method(Extension, "set_process_gauge",      set_process_gauge,      2);
   rb_define_singleton_method(Extension, "increment_counter",      increment_counter,      3);
   rb_define_singleton_method(Extension, "add_distribution_value", add_distribution_value, 3);
 }

data/ext/base.rb

@@ -26,13 +26,16 @@ def report
   @report ||=
     begin
       rbconfig = RbConfig::CONFIG
+      patchlevel = rbconfig["PATCHLEVEL"]
+      patchlevel_label = "-p#{patchlevel}" if patchlevel
+      ruby_version = "#{RUBY_VERSION}#{patchlevel_label}"
       {
         "result" => {
           "status" => "incomplete"
         },
         "language" => {
           "name" => "ruby",
-          "version" => "#{rbconfig["RUBY_PROGRAM_VERSION"]}-p#{rbconfig["PATCHLEVEL"]}"
+          "version" => ruby_version
         },
         "download" => {
           "checksum" => "unverified"

data/gemfiles/redis-4.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'redis', "~> 4.0"
+
+gemspec :path => '../'

data/gemfiles/redis-5.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'redis', '~> 5.0'
+gem 'hiredis-client'
+
+gemspec :path => '../'

data/lib/appsignal/cli/diagnose/paths.rb

@@ -19,7 +19,6 @@ module Appsignal
             begin
               config = Appsignal.config
               log_file_path = config.log_file_path
-              makefile_log_path = File.join("ext", "mkmf.log")
               {
                 :package_install_path => {
                   :label => "AppSignal gem path",
@@ -37,9 +36,9 @@ module Appsignal
                   :label => "Log directory",
                   :path => log_file_path ? File.dirname(log_file_path) : ""
                 },
-                makefile_log_path => {
+                "ext/mkmf.log" => {
                   :label => "Makefile install log",
-                  :path => File.join(gem_path, makefile_log_path)
+                  :path => makefile_install_log_path
                 },
                 "appsignal.log" => {
                   :label => "AppSignal log",
@@ -54,8 +53,11 @@ module Appsignal
         def path_stat(path)
           {
             :path => path,
-            :exists => File.exist?(path)
+            :exists => false
           }.tap do |info|
+            next unless info[:path]
+
+            info[:exists] = File.exist?(path)
             next unless info[:exists]
 
             stat = File.stat(path)
@@ -84,9 +86,26 @@ module Appsignal
         end
 
         # Returns the AppSignal gem installation path. The root directory of
-        # this gem.
+        # this gem when installed.
         def gem_path
-          File.expand_path("../../../..", __dir__)
+          gemspec.full_gem_path
+        end
+
+        # Returns the AppSignal gem's Makefile log path, if it exists.
+        def makefile_install_log_path
+          possible_locations = [
+            # Installed gem location
+            File.join(gemspec.extension_dir, "mkmf.log"),
+            # Local development location
+            File.join(gem_path, "ext", "mkmf.log")
+          ]
+          possible_locations.find do |location|
+            File.exist?(location)
+          end || possible_locations.first
+        end
+
+        def gemspec
+          Gem.loaded_specs["appsignal"]
         end
       end
     end

data/lib/appsignal/cli/diagnose.rb

@@ -201,7 +201,7 @@ module Appsignal
           )
           Appsignal.config.write_to_environment
           Appsignal.start_logger
-          Appsignal.logger.info("Starting AppSignal diagnose")
+          Appsignal.internal_logger.info("Starting AppSignal diagnose")
         end
 
         def run_agent_diagnose_mode

data/lib/appsignal/config.rb

@@ -219,8 +219,8 @@ module Appsignal
     #   use. This will be overwritten by the file config and environment
     #   variables config.
     # @param logger [Logger] The logger to use for the AppSignal gem. This is
-    #   used by the configuration class only. Default: {Appsignal.logger}. See
-    #   also {Appsignal.start_logger}.
+    #   used by the configuration class only. Default:
+    #   {Appsignal.internal_logger}. See also {Appsignal.start_logger}.
     # @param config_file [String] Custom config file location. Default
     #   `config/appsignal.yml`.
     #
@@ -230,8 +230,13 @@ module Appsignal
     #   Configuration load order
     # @see https://docs.appsignal.com/ruby/instrumentation/integrating-appsignal.html
     #   How to integrate AppSignal manually
-    def initialize(root_path, env, initial_config = {}, logger = Appsignal.logger,
-      config_file = nil)
+    def initialize(
+      root_path,
+      env,
+      initial_config = {},
+      logger = Appsignal.internal_logger,
+      config_file = nil
+    )
       @config_file_error = false
       @root_path = root_path
       @config_file = config_file

data/lib/appsignal/environment.rb

@@ -10,9 +10,9 @@ module Appsignal
     #
     # The value of the environment metadata is given as a block that captures
     # errors that might be raised while fetching the value. It will not
-    # re-raise errors, but instead log them using the {Appsignal.logger}. This
-    # ensures AppSignal will not cause an error in the application when
-    # collecting this metadata.
+    # re-raise errors, but instead log them using the
+    # {Appsignal.internal_logger}. This ensures AppSignal will not cause an
+    # error in the application when collecting this metadata.
     #
     # @example Reporting a key and value
     #   Appsignal::Environment.report("ruby_version") { RUBY_VERSION }
@@ -34,8 +34,8 @@ module Appsignal
         when String
           key
         else
-          Appsignal.logger.error "Unable to report on environment metadata: " \
-            "Unsupported value type for #{key.inspect}"
+          Appsignal.internal_logger.error "Unable to report on environment " \
+            "metadata: Unsupported value type for #{key.inspect}"
           return
         end
 
@@ -43,7 +43,7 @@ module Appsignal
         begin
           yield
         rescue => e
-          Appsignal.logger.error \
+          Appsignal.internal_logger.error \
             "Unable to report on environment metadata #{key.inspect}:\n" \
               "#{e.class}: #{e}"
           return
@@ -56,26 +56,35 @@ module Appsignal
         when String
           yielded_value
         else
-          Appsignal.logger.error "Unable to report on environment metadata " \
-            "#{key.inspect}: Unsupported value type for " \
+          Appsignal.internal_logger.error "Unable to report on environment " \
+            "metadata #{key.inspect}: Unsupported value type for " \
             "#{yielded_value.inspect}"
           return
         end
 
       Appsignal::Extension.set_environment_metadata(key, value)
     rescue => e
-      Appsignal.logger.error "Unable to report on environment metadata:\n" \
-        "#{e.class}: #{e}"
+      Appsignal.internal_logger.error "Unable to report on environment " \
+        "metadata:\n#{e.class}: #{e}"
     end
 
     # @see report_supported_gems
     SUPPORTED_GEMS = %w[
       actioncable
+      actionmailer
       activejob
+      activerecord
       capistrano
       celluloid
       data_mapper
       delayed_job
+      dry-monitor
+      elasticsearch
+      excon
+      faraday
+      gvltools
+      hanami
+      hiredis
       mongo_ruby_driver
       padrino
       passenger
@@ -85,7 +94,9 @@ module Appsignal
       rails
       rake
       redis
+      redis-client
       resque
+      rom
       sequel
       shoryuken
       sidekiq
@@ -114,15 +125,15 @@ module Appsignal
         report("ruby_#{gem_name}_version") { gem_spec.version.to_s }
       end
     rescue => e
-      Appsignal.logger.error "Unable to report supported gems:\n" \
+      Appsignal.internal_logger.error "Unable to report supported gems:\n" \
         "#{e.class}: #{e}"
     end
 
     def self.report_enabled(feature)
       Appsignal::Environment.report("ruby_#{feature}_enabled") { true }
     rescue => e
-      Appsignal.logger.error "Unable to report integration enabled:\n" \
-        "#{e.class}: #{e}"
+      Appsignal.internal_logger.error "Unable to report integration " \
+        "enabled:\n#{e.class}: #{e}"
     end
   end
 end

data/lib/appsignal/event_formatter.rb

@@ -73,7 +73,7 @@ module Appsignal
       end
 
       def logger
-        Appsignal.logger
+        Appsignal.internal_logger
       end
     end
 

data/lib/appsignal/extension/jruby.rb

@@ -71,12 +71,6 @@ module Appsignal
         attach_function :appsignal_set_gauge,
           [:appsignal_string, :double, :pointer],
           :void
-        attach_function :appsignal_set_host_gauge,
-          [:appsignal_string, :double],
-          :void
-        attach_function :appsignal_set_process_gauge,
-          [:appsignal_string, :double],
-          :void
         attach_function :appsignal_increment_counter,
           [:appsignal_string, :double, :pointer],
           :void
@@ -248,14 +242,15 @@ module Appsignal
           [:pointer],
           :appsignal_string
 
-        Appsignal.extension_loaded = true
+        Appsignal.extension_loaded = true if Appsignal.respond_to? :extension_loaded=
       rescue LoadError => error
         error_message = "ERROR: AppSignal failed to load extension. " \
           "Please run `appsignal diagnose` and email us at support@appsignal.com\n" \
           "#{error.class}: #{error.message}"
-        Appsignal.logger.error(error_message)
+        Appsignal.internal_logger.error(error_message) if Appsignal.respond_to? :internal_logger
         Kernel.warn error_message
-        Appsignal.extension_loaded = false
+        Appsignal.extension_loaded = false if Appsignal.respond_to? :extension_loaded=
+        raise error if ENV["_APPSIGNAL_EXTENSION_INSTALL"] == "true"
       end
 
       def start
@@ -319,14 +314,6 @@ module Appsignal
         appsignal_set_gauge(make_appsignal_string(key), value, tags.pointer)
       end
 
-      def set_host_gauge(key, value)
-        appsignal_set_host_gauge(make_appsignal_string(key), value)
-      end
-
-      def set_process_gauge(key, value)
-        appsignal_set_process_gauge(make_appsignal_string(key), value)
-      end
-
       def increment_counter(key, value, tags)
         appsignal_increment_counter(make_appsignal_string(key), value, tags.pointer)
       end

data/lib/appsignal/extension.rb

@@ -12,7 +12,7 @@ rescue LoadError => error
   error_message = "ERROR: AppSignal failed to load extension. " \
     "Please run `appsignal diagnose` and email us at support@appsignal.com\n" \
     "#{error.class}: #{error.message}"
-  Appsignal.logger.error(error_message)
+  Appsignal.internal_logger.error(error_message)
   Kernel.warn error_message
   Appsignal.extension_loaded = false
 end

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