appsignal 3.7.0 → 3.7.2

data/spec/lib/appsignal_spec.rb

@@ -87,7 +87,7 @@ describe Appsignal do
         end
 
         it "should start minutely" do
-          expect(Appsignal::Minutely).to receive(:start)
+          expect(Appsignal::Probes).to receive(:start)
           Appsignal.start
         end
       end
@@ -98,7 +98,7 @@ describe Appsignal do
         end
 
         it "should not start minutely" do
-          expect(Appsignal::Minutely).to_not receive(:start)
+          expect(Appsignal::Probes).to_not receive(:start)
           Appsignal.start
         end
       end
@@ -151,13 +151,20 @@ describe Appsignal do
   end
 
   describe ".stop" do
-    it "should call stop on the extension" do
+    it "calls stop on the extension" do
       expect(Appsignal.internal_logger).to receive(:debug).with("Stopping appsignal")
       expect(Appsignal::Extension).to receive(:stop)
       Appsignal.stop
       expect(Appsignal.active?).to be_falsy
     end
 
+    it "stops the minutely probes" do
+      Appsignal::Probes.start
+      expect(Appsignal::Probes.started?).to be_truthy
+      Appsignal.stop
+      expect(Appsignal::Probes.started?).to be_falsy
+    end
+
     context "with context specified" do
       it "should log the context" do
         expect(Appsignal.internal_logger).to receive(:debug).with("Stopping appsignal (something)")
@@ -1121,7 +1128,14 @@ describe Appsignal do
     let(:log_path) { File.join(tmp_dir, "log") }
     let(:log_file) { File.join(log_path, "appsignal.log") }
 
-    before { FileUtils.mkdir_p(log_path) }
+    before do
+      FileUtils.mkdir_p(log_path)
+      # Clear state from previous test
+      Appsignal.internal_logger = nil
+      if Appsignal.instance_variable_defined?(:@in_memory_log)
+        Appsignal.remove_instance_variable(:@in_memory_log)
+      end
+    end
     after { FileUtils.rm_rf(log_path) }
 
     def initialize_config
@@ -1130,6 +1144,7 @@ describe Appsignal do
         :log_path => log_path
       )
       Appsignal.internal_logger.error("Log in memory")
+      expect(Appsignal.in_memory_log.string).to_not be_empty
     end
 
     context "when the log path is writable" do
@@ -1154,6 +1169,10 @@ describe Appsignal do
         it "amends in memory log to log file" do
           expect(log_file_contents).to include "[ERROR] appsignal: Log in memory"
         end
+
+        it "clears the in memory log after writing to the new logger" do
+          expect(Appsignal.in_memory_log.string).to be_empty
+        end
       end
 
       context "when the log file is not writable" do
@@ -1178,8 +1197,11 @@ describe Appsignal do
           expect(output).to include "[ERROR] appsignal: Log in memory"
         end
 
+        it "clears the in memory log after writing to the new logger" do
+          expect(Appsignal.in_memory_log.string).to be_empty
+        end
+
         it "outputs a warning" do
-          puts output
           expect(output).to include \
             "[WARN] appsignal: Unable to start internal logger with log path '#{log_file}'.",
             "[WARN] appsignal: Permission denied"
@@ -1237,6 +1259,10 @@ describe Appsignal do
       it "amends in memory log to stdout" do
         expect(output).to include "[ERROR] appsignal: Log in memory"
       end
+
+      it "clears the in memory log after writing to the new logger" do
+        expect(Appsignal.in_memory_log.string).to be_empty
+      end
     end
 
     describe "#logger#level" do

data/spec/lib/puma/appsignal_spec.rb

@@ -32,10 +32,14 @@ RSpec.describe "Puma plugin" do
   # StatsD server used for these tests.
   # Open a UDPSocket and listen for messages sent by the AppSignal Puma plugin.
   class StatsdServer
+    def initialize(statsd_port)
+      @statsd_port = statsd_port
+    end
+
     def start
       stop
       @socket = UDPSocket.new
-      @socket.bind("127.0.0.1", 8125)
+      @socket.bind("127.0.0.1", @statsd_port)
 
       loop do
         # Listen for messages and track them on the messages Array.
@@ -115,13 +119,15 @@ RSpec.describe "Puma plugin" do
 
   def run_plugin(stats_data, plugin, &block)
     Puma._set_stats = stats_data
-    @statsd = StatsdServer.new
+    ENV["APPSIGNAL_STATSD_PORT"] = "8126"
+    @statsd = StatsdServer.new(ENV.fetch("APPSIGNAL_STATSD_PORT"))
     @server_thread = Thread.new { @statsd.start }
     @server_thread.abort_on_exception = true
     @client_thread = Thread.new { start_plugin(plugin) }
     @client_thread.abort_on_exception = true
     wait_for(:puma_client_wait, &block)
   ensure
+    ENV["APPSIGNAL_STATSD_PORT"] = nil
     Puma._set_stats = nil
     # Stop all threads in test and stop listening on the UDPSocket
     @client_thread.kill if defined?(@client_thread) && @client_thread

data/spec/spec_helper.rb

@@ -171,11 +171,11 @@ RSpec.configure do |config|
   def stop_minutely_probes
     thread =
       begin
-        Appsignal::Minutely.class_variable_get(:@@thread) # Fetch old thread
+        Appsignal::Probes.class_variable_get(:@@thread) # Fetch old thread
       rescue NameError
         nil
       end
-    Appsignal::Minutely.stop
+    Appsignal::Probes.stop
     thread&.join # Wait for old thread to exit
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.7.2
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-22 00:00:00.000000000 Z
+date: 2024-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -263,7 +263,6 @@ files:
 - lib/appsignal/integrations/webmachine.rb
 - lib/appsignal/logger.rb
 - lib/appsignal/marker.rb
-- lib/appsignal/minutely.rb
 - lib/appsignal/probes.rb
 - lib/appsignal/probes/gvl.rb
 - lib/appsignal/probes/helpers.rb
@@ -279,12 +278,12 @@ files:
 - lib/appsignal/transmitter.rb
 - lib/appsignal/utils.rb
 - lib/appsignal/utils/data.rb
-- lib/appsignal/utils/deprecation_message.rb
 - lib/appsignal/utils/hash_sanitizer.rb
 - lib/appsignal/utils/integration_logger.rb
 - lib/appsignal/utils/json.rb
 - lib/appsignal/utils/query_params_sanitizer.rb
 - lib/appsignal/utils/rails_helper.rb
+- lib/appsignal/utils/stdout_and_logger_message.rb
 - lib/appsignal/version.rb
 - lib/puma/plugin/appsignal.rb
 - lib/sequel/extensions/appsignal_integration.rb
@@ -364,10 +363,10 @@ files:
 - spec/lib/appsignal/integrations/webmachine_spec.rb
 - spec/lib/appsignal/logger_spec.rb
 - spec/lib/appsignal/marker_spec.rb
-- spec/lib/appsignal/minutely_spec.rb
 - spec/lib/appsignal/probes/gvl_spec.rb
 - spec/lib/appsignal/probes/mri_spec.rb
 - spec/lib/appsignal/probes/sidekiq_spec.rb
+- spec/lib/appsignal/probes_spec.rb
 - spec/lib/appsignal/rack/generic_instrumentation_spec.rb
 - spec/lib/appsignal/rack/rails_instrumentation_spec.rb
 - spec/lib/appsignal/rack/sinatra_instrumentation_spec.rb
@@ -453,7 +452,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com

data/lib/appsignal/minutely.rb

@@ -1,206 +0,0 @@
-# frozen_string_literal: true
-
-module Appsignal
-  class Minutely
-    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
-
-      # 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::Minutely.probes.register :my_probe, lambda {}
-      #
-      # @example Overwrite an existing registered probe
-      #   Appsignal::Minutely.probes.register :my_probe, lambda {}
-      #   Appsignal::Minutely.probes.register :my_probe, lambda { puts "hello" }
-      #
-      # @example Add a lambda as a probe
-      #   Appsignal::Minutely.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::Minutely.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::Minutely.probes.register :my_probe, MyProbe
-      #   Appsignal::Minutely.start # This is called for you
-      #   # "started" # Printed on Appsignal::Minutely.start
-      #   # "called" # Repeated every minute
-      #
-      # @param name [Symbol/String] Name of the probe. Can be used with {[]}.
-      #   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)
-        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 each(&block)
-        probes.each(&block)
-      end
-
-      private
-
-      attr_reader :probes
-
-      def logger
-        Appsignal.internal_logger
-      end
-    end
-
-    class << self
-      # @see ProbeCollection
-      # @return [ProbeCollection] Returns list of probes.
-      def probes
-        @probes ||= ProbeCollection.new
-      end
-
-      # @api private
-      def start
-        stop
-        @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
-            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
-            sleep wait_time
-          end
-        end
-      end
-
-      # @api private
-      def stop
-        defined?(@thread) && @thread.kill
-        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
-        probe_instances[name] = instance
-      rescue => error
-        logger = Appsignal.internal_logger
-        logger.error "Error while initializing minutely probe '#{name}': #{error}"
-        logger.debug error.backtrace.join("\n")
-      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/deprecation_message.rb

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