appsignal 3.7.0 → 3.7.1

data/ext/base.rb

@@ -190,6 +190,9 @@ def store_download_version_on_report
 end
 
 def http_proxy
+  proxy = try_http_proxy_value(ENV.fetch("APPSIGNAL_HTTP_PROXY", nil))
+  return [proxy, nil] if proxy
+
   proxy, error =
     begin
       [try_http_proxy_value(Gem.configuration[:http_proxy]), nil]

data/lib/appsignal/config.rb

@@ -8,7 +8,7 @@ require "tmpdir"
 
 module Appsignal
   class Config
-    include Appsignal::Utils::DeprecationMessage
+    include Appsignal::Utils::StdoutAndLoggerMessage
 
     DEFAULT_CONFIG = {
       :activejob_report_errors => "all",
@@ -320,20 +320,29 @@ module Appsignal
     end
 
     def log_file_path
+      return @log_file_path if defined? @log_file_path
+
       path = config_hash[:log_path] || (root_path && File.join(root_path, "log"))
-      return File.join(File.realpath(path), "appsignal.log") if path && File.writable?(path)
+      if path && File.writable?(path)
+        @log_file_path = File.join(File.realpath(path), "appsignal.log")
+        return @log_file_path
+      end
 
       system_tmp_dir = self.class.system_tmp_dir
       if File.writable? system_tmp_dir
         $stdout.puts "appsignal: Unable to log to '#{path}'. Logging to " \
-          "'#{system_tmp_dir}' instead. Please check the " \
-          "permissions for the application's (log) directory."
-        File.join(system_tmp_dir, "appsignal.log")
+          "'#{system_tmp_dir}' instead. " \
+          "Please check the permissions for the application's (log) " \
+          "directory."
+        @log_file_path = File.join(system_tmp_dir, "appsignal.log")
       else
         $stdout.puts "appsignal: Unable to log to '#{path}' or the " \
           "'#{system_tmp_dir}' fallback. Please check the permissions " \
           "for the application's (log) directory."
+        @log_file_path = nil
       end
+
+      @log_file_path
     end
 
     def valid?
@@ -476,7 +485,7 @@ module Appsignal
     def maintain_backwards_compatibility
       return unless config_hash.key?(:working_dir_path)
 
-      deprecation_message \
+      stdout_and_logger_warning \
         "The `working_dir_path` option is deprecated, please use " \
           "`working_directory_path` instead and specify the " \
           "full path to the working directory",
@@ -542,7 +551,7 @@ module Appsignal
           config[:send_session_data] = true # Set default value
         end
       else
-        deprecation_message "The `skip_session_data` config option is " \
+        stdout_and_logger_warning "The `skip_session_data` config option is " \
           "deprecated. Please use `send_session_data` instead.",
           logger
         # Not configured by user

data/lib/appsignal/event_formatter.rb

@@ -14,8 +14,6 @@ module Appsignal
   # @api private
   class EventFormatter
     class << self
-      include Appsignal::Utils::DeprecationMessage
-
       def formatters
         @formatters ||= {}
       end

data/lib/appsignal/helpers/instrumentation.rb

@@ -3,7 +3,7 @@
 module Appsignal
   module Helpers
     module Instrumentation # rubocop:disable Metrics/ModuleLength
-      include Appsignal::Utils::DeprecationMessage
+      include Appsignal::Utils::StdoutAndLoggerMessage
 
       # Creates an AppSignal transaction for the given block.
       #
@@ -207,7 +207,7 @@ module Appsignal
       )
         if tags
           call_location = caller(1..1).first
-          deprecation_message \
+          stdout_and_logger_warning \
             "The tags argument for `Appsignal.send_error` is deprecated. " \
               "Please use the block method to set tags instead.\n\n" \
               "  Appsignal.send_error(error) do |transaction|\n" \
@@ -217,7 +217,7 @@ module Appsignal
         end
         if namespace
           call_location = caller(1..1).first
-          deprecation_message \
+          stdout_and_logger_warning \
             "The namespace argument for `Appsignal.send_error` is deprecated. " \
               "Please use the block method to set the namespace instead.\n\n" \
               "  Appsignal.send_error(error) do |transaction|\n" \
@@ -300,7 +300,7 @@ module Appsignal
       def set_error(exception, tags = nil, namespace = nil)
         if tags
           call_location = caller(1..1).first
-          deprecation_message \
+          stdout_and_logger_warning \
             "The tags argument for `Appsignal.set_error` is deprecated. " \
               "Please use the block method to set tags instead.\n\n" \
               "  Appsignal.set_error(error) do |transaction|\n" \
@@ -310,7 +310,7 @@ module Appsignal
         end
         if namespace
           call_location = caller(1..1).first
-          deprecation_message \
+          stdout_and_logger_warning \
             "The namespace argument for `Appsignal.set_error` is deprecated. " \
               "Please use the block method to set the namespace instead.\n\n" \
               "  Appsignal.set_error(error) do |transaction|\n" \

data/lib/appsignal/helpers/metrics.rb

@@ -15,7 +15,7 @@ module Appsignal
       end
 
       def set_host_gauge(_key, _value)
-        Appsignal::Utils::DeprecationMessage.message \
+        Appsignal::Utils::StdoutAndLoggerMessage.warning \
           "The `set_host_gauge` method has been deprecated. " \
             "Calling this method has no effect. " \
             "Please remove method call in the following file to remove " \
@@ -23,7 +23,7 @@ module Appsignal
       end
 
       def set_process_gauge(_key, _value)
-        Appsignal::Utils::DeprecationMessage.message \
+        Appsignal::Utils::StdoutAndLoggerMessage.warning \
           "The `set_process_gauge` method has been deprecated. " \
             "Calling this method has no effect. " \
             "Please remove method call in the following file to remove " \

data/lib/appsignal/hooks/gvl.rb

@@ -16,7 +16,7 @@ module Appsignal
       end
 
       def install
-        Appsignal::Minutely.probes.register :gvl, Appsignal::Probes::GvlProbe
+        Appsignal::Probes.probes.register :gvl, Appsignal::Probes::GvlProbe
         ::GVLTools::GlobalTimer.enable if Appsignal.config[:enable_gvl_global_timer]
         ::GVLTools::WaitingThreads.enable if Appsignal.config[:enable_gvl_waiting_threads]
       end

data/lib/appsignal/hooks/mri.rb

@@ -11,7 +11,7 @@ module Appsignal
       end
 
       def install
-        Appsignal::Minutely.probes.register :mri, Appsignal::Probes::MriProbe
+        Appsignal::Probes.probes.register :mri, Appsignal::Probes::MriProbe
       end
     end
   end

data/lib/appsignal/hooks/sidekiq.rb

@@ -11,7 +11,7 @@ module Appsignal
 
       def install
         require "appsignal/integrations/sidekiq"
-        Appsignal::Minutely.probes.register :sidekiq, Appsignal::Probes::SidekiqProbe
+        Appsignal::Probes.probes.register :sidekiq, Appsignal::Probes::SidekiqProbe
 
         ::Sidekiq.configure_server do |config|
           config.error_handlers <<

data/lib/appsignal/hooks.rb

@@ -76,7 +76,7 @@ module Appsignal
       when :SidekiqPlugin
         require "appsignal/integrations/sidekiq"
         callers = caller
-        Appsignal::Utils::DeprecationMessage.message \
+        Appsignal::Utils::StdoutAndLoggerMessage.warning \
           "The constant Appsignal::Hooks::SidekiqPlugin has been deprecated. " \
             "Please update the constant name to Appsignal::Integrations::SidekiqMiddleware " \
             "in the following file to remove this message.\n#{callers.first}"

data/lib/appsignal/integrations/railtie.rb

@@ -14,7 +14,7 @@ module Appsignal
       end
 
       console do
-        Appsignal::Minutely.stop
+        Appsignal::Probes.stop
       end
 
       def self.initialize_appsignal(app)

data/lib/appsignal/probes.rb

@@ -2,6 +2,274 @@
 
 module Appsignal
   module Probes
+    class ProbeCollection
+      def initialize
+        @probes = {}
+      end
+
+      # @return [Integer] Number of probes that are registered.
+      def count
+        probes.count
+      end
+
+      # Clears all probes from the list.
+      # @return [void]
+      def clear
+        probes.clear
+      end
+
+      # Fetch a probe using its name.
+      # @param key [Symbol/String] The name of the probe to fetch.
+      # @return [Object] Returns the registered probe.
+      def [](key)
+        probes[key]
+      end
+
+      # @deprecated Use {Appsignal::Probes.register} instead.
+      def register(name, probe)
+        Appsignal::Utils::StdoutAndLoggerMessage.warning(
+          "The method 'Appsignal::Probes.probes.register' is deprecated. " \
+            "Use 'Appsignal::Probes.register' instead."
+        )
+        Appsignal::Probes.register(name, probe)
+      end
+
+      # @api private
+      def internal_register(name, probe)
+        if probes.key?(name)
+          logger.debug "A probe with the name `#{name}` is already " \
+            "registered. Overwriting the entry with the new probe."
+        end
+        probes[name] = probe
+      end
+
+      # @api private
+      def unregister(name)
+        probes.delete(name)
+      end
+
+      # @api private
+      def each(&block)
+        probes.each(&block)
+      end
+
+      private
+
+      attr_reader :probes
+
+      def logger
+        Appsignal.internal_logger
+      end
+    end
+
+    class << self
+      # @api private
+      def mutex
+        @mutex ||= Thread::Mutex.new
+      end
+
+      # @see ProbeCollection
+      # @return [ProbeCollection] Returns list of probes.
+      def probes
+        @probes ||= ProbeCollection.new
+      end
+
+      # Register a new minutely probe.
+      #
+      # Supported probe types are:
+      #
+      # - Lambda - A lambda is an object that listens to a `call` method call.
+      #   This `call` method is called every minute.
+      # - Class - A class object is an object that listens to a `new` and
+      #   `call` method call. The `new` method is called when the minutely
+      #   probe thread is started to initialize all probes. This allows probes
+      #   to load dependencies once beforehand. Their `call` method is called
+      #   every minute.
+      # - Class instance - A class instance object is an object that listens to
+      #   a `call` method call. The `call` method is called every minute.
+      #
+      # @example Register a new probe
+      #   Appsignal::Probes.register :my_probe, lambda {}
+      #
+      # @example Overwrite an existing registered probe
+      #   Appsignal::Probes.register :my_probe, lambda {}
+      #   Appsignal::Probes.register :my_probe, lambda { puts "hello" }
+      #
+      # @example Add a lambda as a probe
+      #   Appsignal::Probes.register :my_probe, lambda { puts "hello" }
+      #   # "hello" # printed every minute
+      #
+      # @example Add a probe instance
+      #   class MyProbe
+      #     def initialize
+      #       puts "started"
+      #     end
+      #
+      #     def call
+      #       puts "called"
+      #     end
+      #   end
+      #
+      #   Appsignal::Probes.register :my_probe, MyProbe.new
+      #   # "started" # printed immediately
+      #   # "called" # printed every minute
+      #
+      # @example Add a probe class
+      #   class MyProbe
+      #     def initialize
+      #       # Add things that only need to be done on start up for this probe
+      #       require "some/library/dependency"
+      #       @cache = {} # initialize a local cache variable
+      #       puts "started"
+      #     end
+      #
+      #     def call
+      #       puts "called"
+      #     end
+      #   end
+      #
+      #   Appsignal::Probes.register :my_probe, MyProbe
+      #   Appsignal::Probes.start # This is called for you
+      #   # "started" # Printed on Appsignal::Probes.start
+      #   # "called" # Repeated every minute
+      #
+      # @param name [Symbol/String] Name of the probe. Can be used with
+      #   {ProbeCollection#[]}. This name will be used in errors in the log and
+      #   allows overwriting of probes by registering new ones with the same
+      #   name.
+      # @param probe [Object] Any object that listens to the `call` method will
+      #   be used as a probe.
+      # @return [void]
+      def register(name, probe)
+        probes.internal_register(name, probe)
+
+        initialize_probe(name, probe) if started?
+      end
+
+      # Unregister a probe that's registered with {register}.
+      # Can also be used to unregister automatically registered probes by the
+      # gem.
+      #
+      # @example Unregister probes
+      #   # First register a probe
+      #   Appsignal::Probes.register :my_probe, lambda {}
+      #
+      #   # Then unregister a probe if needed
+      #   Appsignal::Probes.unregister :my_probe
+      #
+      # @param name [Symbol/String] Name of the probe used to {register} the
+      #   probe.
+      # @return [void]
+      def unregister(name)
+        probes.unregister(name)
+
+        uninitialize_probe(name)
+      end
+
+      # @api private
+      def start
+        stop
+        @started = true
+        @thread = Thread.new do
+          # Advise multi-threaded app servers to ignore this thread
+          # for the purposes of fork safety warnings
+          if Thread.current.respond_to?(:thread_variable_set)
+            Thread.current.thread_variable_set(:fork_safe, true)
+          end
+
+          sleep initial_wait_time
+          initialize_probes
+          loop do
+            logger = Appsignal.internal_logger
+            mutex.synchronize do
+              logger.debug("Gathering minutely metrics with #{probe_instances.count} probes")
+              probe_instances.each do |name, probe|
+                logger.debug("Gathering minutely metrics with '#{name}' probe")
+                probe.call
+              rescue => ex
+                logger.error "Error in minutely probe '#{name}': #{ex}"
+                logger.debug ex.backtrace.join("\n")
+              end
+            end
+            sleep wait_time
+          end
+        end
+      end
+
+      # Returns if the probes thread has been started. If the value is false or
+      # nil, it has not been started yet.
+      #
+      # @return [Boolean, nil]
+      def started?
+        @started
+      end
+
+      # Stop the minutely probes mechanism. Stop the thread and clear all probe
+      # instances.
+      def stop
+        defined?(@thread) && @thread.kill
+        @started = false
+        probe_instances.clear
+      end
+
+      # @api private
+      def wait_time
+        60 - Time.now.sec
+      end
+
+      private
+
+      def initial_wait_time
+        remaining_seconds = 60 - Time.now.sec
+        return remaining_seconds if remaining_seconds > 30
+
+        remaining_seconds + 60
+      end
+
+      def initialize_probes
+        probes.each do |name, probe|
+          initialize_probe(name, probe)
+        end
+      end
+
+      def initialize_probe(name, probe)
+        if probe.respond_to? :new
+          instance = probe.new
+          klass = probe
+        else
+          instance = probe
+          klass = instance.class
+        end
+        unless dependencies_present?(klass)
+          Appsignal.internal_logger.debug "Skipping '#{name}' probe, " \
+            "#{klass}.dependency_present? returned falsy"
+          return
+        end
+        mutex.synchronize do
+          probe_instances[name] = instance
+        end
+      rescue => error
+        logger = Appsignal.internal_logger
+        logger.error "Error while initializing minutely probe '#{name}': #{error}"
+        logger.debug error.backtrace.join("\n")
+      end
+
+      def uninitialize_probe(name)
+        mutex.synchronize do
+          probe_instances.delete(name)
+        end
+      end
+
+      def dependencies_present?(probe)
+        return true unless probe.respond_to? :dependencies_present?
+
+        probe.dependencies_present?
+      end
+
+      def probe_instances
+        @probe_instances ||= {}
+      end
+    end
   end
 end
 

data/lib/appsignal/utils/stdout_and_logger_message.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Appsignal
+  module Utils
+    # @api private
+    module StdoutAndLoggerMessage
+      def self.warning(message, logger = Appsignal.internal_logger)
+        Kernel.warn "appsignal WARNING: #{message}"
+        logger.warn message
+      end
+
+      def stdout_and_logger_warning(message, logger = Appsignal.internal_logger)
+        Appsignal::Utils::StdoutAndLoggerMessage.warning(message, logger)
+      end
+    end
+  end
+end

data/lib/appsignal/utils.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "appsignal/utils/deprecation_message"
+require "appsignal/utils/stdout_and_logger_message"
 require "appsignal/utils/data"
 require "appsignal/utils/hash_sanitizer"
 require "appsignal/utils/integration_logger"

data/lib/appsignal/version.rb

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

data/lib/appsignal.rb

@@ -5,7 +5,7 @@ require "securerandom"
 require "stringio"
 
 require "appsignal/logger"
-require "appsignal/utils/deprecation_message"
+require "appsignal/utils/stdout_and_logger_message"
 require "appsignal/helpers/instrumentation"
 require "appsignal/helpers/metrics"
 
@@ -120,7 +120,7 @@ module Appsignal
             Appsignal::Environment.report_enabled("allocation_tracking")
           end
 
-          Appsignal::Minutely.start if config[:enable_minutely_probes]
+          Appsignal::Probes.start if config[:enable_minutely_probes]
 
           collect_environment_metadata
         else
@@ -152,6 +152,7 @@ module Appsignal
         internal_logger.debug("Stopping appsignal")
       end
       Appsignal::Extension.stop
+      Appsignal::Probes.stop
     end
 
     def forked
@@ -218,7 +219,10 @@ module Appsignal
         else
           Appsignal::Config::DEFAULT_LOG_LEVEL
         end
-      internal_logger << @in_memory_log.string if @in_memory_log
+      return unless @in_memory_log
+
+      internal_logger << @in_memory_log.string
+      @in_memory_log = nil
     end
 
     # Returns if the C-extension was loaded properly.
@@ -287,6 +291,22 @@ module Appsignal
       end
       Appsignal::Environment.report_supported_gems
     end
+
+    # Alias constants that have moved with a warning message that points to the
+    # place to update the reference.
+    def const_missing(name)
+      case name
+      when :Minutely
+        callers = caller
+        Appsignal::Utils::StdoutAndLoggerMessage.warning \
+          "The constant Appsignal::Minutely has been deprecated. " \
+            "Please update the constant name to Appsignal::Probes " \
+            "in the following file to remove this message.\n#{callers.first}"
+        Appsignal::Probes
+      else
+        super
+      end
+    end
   end
 end
 
@@ -300,7 +320,6 @@ require "appsignal/event_formatter"
 require "appsignal/hooks"
 require "appsignal/probes"
 require "appsignal/marker"
-require "appsignal/minutely"
 require "appsignal/garbage_collection"
 require "appsignal/integrations/railtie" if defined?(::Rails)
 require "appsignal/transaction"

data/spec/lib/appsignal/config_spec.rb

@@ -757,7 +757,10 @@ describe Appsignal::Config do
     let(:out_stream) { std_stream }
     let(:output) { out_stream.read }
     let(:config) { project_fixture_config("production", :log_path => log_path) }
-    subject { capture_stdout(out_stream) { config.log_file_path } }
+
+    def log_file_path
+      capture_stdout(out_stream) { config.log_file_path }
+    end
 
     context "when path is writable" do
       let(:log_path) { File.join(tmp_dir, "writable-path") }
@@ -765,11 +768,11 @@ describe Appsignal::Config do
       after { FileUtils.rm_rf(log_path) }
 
       it "returns log file path" do
-        expect(subject).to eq File.join(log_path, "appsignal.log")
+        expect(log_file_path).to eq File.join(log_path, "appsignal.log")
       end
 
       it "prints no warning" do
-        subject
+        log_file_path
         expect(output).to be_empty
       end
     end
@@ -783,28 +786,47 @@ describe Appsignal::Config do
         before { FileUtils.chmod(0o777, system_tmp_dir) }
 
         it "returns returns the tmp location" do
-          expect(subject).to eq(File.join(system_tmp_dir, "appsignal.log"))
+          expect(log_file_path).to eq(File.join(system_tmp_dir, "appsignal.log"))
         end
 
         it "prints a warning" do
-          subject
+          log_file_path
           expect(output).to include "appsignal: Unable to log to '#{log_path}'. " \
             "Logging to '#{system_tmp_dir}' instead."
         end
+
+        it "prints a warning once" do
+          capture_stdout(out_stream) do
+            log_file_path
+            log_file_path
+          end
+          message = "appsignal: Unable to log to '#{log_path}'. " \
+            "Logging to '#{system_tmp_dir}' instead."
+          expect(output.scan(message).count).to eq(1)
+        end
       end
 
       context "when the /tmp fallback path is not writable" do
         before { FileUtils.chmod(0o555, system_tmp_dir) }
 
         it "returns nil" do
-          expect(subject).to be_nil
+          expect(log_file_path).to be_nil
         end
 
         it "prints a warning" do
-          subject
+          log_file_path
           expect(output).to include "appsignal: Unable to log to '#{log_path}' " \
             "or the '#{system_tmp_dir}' fallback."
         end
+
+        it "prints a warning once" do
+          capture_stdout(out_stream) do
+            log_file_path
+            log_file_path
+          end
+          message = "appsignal: Unable to log to '#{log_path}' or the '#{system_tmp_dir}' fallback."
+          expect(output.scan(message).count).to eq(1)
+        end
       end
     end
 
@@ -819,11 +841,11 @@ describe Appsignal::Config do
 
       context "when root_path is set" do
         it "returns returns the project log location" do
-          expect(subject).to eq File.join(config.root_path, "log/appsignal.log")
+          expect(log_file_path).to eq File.join(config.root_path, "log/appsignal.log")
         end
 
         it "prints no warning" do
-          subject
+          log_file_path
           expect(output).to be_empty
         end
       end
@@ -883,7 +905,7 @@ describe Appsignal::Config do
           end
 
           it "returns real path of log path" do
-            expect(subject).to eq(File.join(real_path, "appsignal.log"))
+            expect(log_file_path).to eq(File.join(real_path, "appsignal.log"))
           end
         end
       end

data/spec/lib/appsignal/hooks/gvl_spec.rb

@@ -93,7 +93,7 @@ describe Appsignal::Hooks::GvlHook do
           it "is added to minutely probes" do
             Appsignal::Hooks.load_hooks
 
-            expect(Appsignal::Minutely.probes[:gvl]).to be Appsignal::Probes::GvlProbe
+            expect(Appsignal::Probes.probes[:gvl]).to be Appsignal::Probes::GvlProbe
           end
         end
       end