appsignal 2.9.12.beta.0 → 2.9.18.beta.1

data/lib/appsignal/cli/install.rb

@@ -75,18 +75,39 @@ module Appsignal
         def install_for_rails(config)
           puts "Installing for Ruby on Rails"
 
-          require File.expand_path(File.join(Dir.pwd, "config/application.rb"))
+          name_overwritten = configure_rails_app_name(config)
+          configure(config, rails_environments, name_overwritten)
+          done_notice
+        end
 
-          config[:name] = Appsignal::Utils::RailsHelper.detected_rails_app_name
-          name_overwritten = yes_or_no("  Your app's name is: '#{config[:name]}' \n  Do you want to change how this is displayed in AppSignal? (y/n): ")
-          puts
-          if name_overwritten
-            config[:name] = required_input("  Choose app's display name: ")
+        def configure_rails_app_name(config)
+          loaded =
+            begin
+              load Appsignal::Utils::RailsHelper.application_config_path
+              true
+            rescue LoadError, StandardError
+              false
+            end
+
+          name_overwritten = false
+          if loaded
+            config[:name] = Appsignal::Utils::RailsHelper.detected_rails_app_name
+            puts
+            name_overwritten = yes_or_no(
+              "  Your app's name is: '#{config[:name]}' \n  " \
+                "Do you want to change how this is displayed in AppSignal? " \
+                "(y/n): "
+            )
+            if name_overwritten
+              config[:name] = required_input("  Choose app's display name: ")
+              puts
+            end
+          else
+            puts "  Unable to automatically detect your Rails app's name."
+            config[:name] = required_input("  Choose your app's display name for AppSignal.com: ")
             puts
           end
-
-          configure(config, rails_environments, name_overwritten)
-          done_notice
+          name_overwritten
         end
 
         def install_for_sinatra(config)
@@ -227,7 +248,10 @@ module Appsignal
 
         def installed_frameworks
           [].tap do |out|
-            out << :rails if framework_available? "rails"
+            if framework_available?("rails") &&
+                File.exist?(Appsignal::Utils::RailsHelper.application_config_path)
+              out << :rails
+            end
             out << :sinatra if framework_available? "sinatra"
             out << :padrino if framework_available? "padrino"
             out << :grape if framework_available? "grape"

data/lib/appsignal/helpers/instrumentation.rb

@@ -2,7 +2,6 @@
 
 module Appsignal
   module Helpers
-    # @api private
     module Instrumentation # rubocop:disable Metrics/ModuleLength
       # Creates an AppSignal transaction for the given block.
       #
@@ -202,7 +201,8 @@ module Appsignal
       )
         return unless active?
         unless error.is_a?(Exception)
-          logger.error("Can't send error, given value is not an exception")
+          logger.error "Appsignal.send_error: Cannot send error. The given " \
+            "value is not an exception: #{error.inspect}"
           return
         end
         transaction = Appsignal::Transaction.new(
@@ -257,9 +257,12 @@ module Appsignal
       #   Exception handling guide
       # @since 0.6.6
       def set_error(exception, tags = nil, namespace = nil)
-        return if !active? ||
-            Appsignal::Transaction.current.nil? ||
-            exception.nil?
+        unless exception.is_a?(Exception)
+          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.nil?
         transaction = Appsignal::Transaction.current
         transaction.set_error(exception)
         transaction.set_tags(tags) if tags

data/lib/appsignal/helpers/metrics.rb

@@ -2,7 +2,6 @@
 
 module Appsignal
   module Helpers
-    # @api private
     module Metrics
       def set_gauge(key, value, tags = {})
         Appsignal::Extension.set_gauge(

data/lib/appsignal/hooks/puma.rb

@@ -11,27 +11,22 @@ module Appsignal
       end
 
       def install
-        if ::Puma.respond_to?(:stats)
+        if ::Puma.respond_to?(:stats) && !defined?(APPSIGNAL_PUMA_PLUGIN_LOADED)
+          # Only install the minutely probe if a user isn't using our Puma
+          # plugin, which lives in `lib/puma/appsignal.rb`. This plugin defines
+          # the {APPSIGNAL_PUMA_PLUGIN_LOADED} constant.
+          #
+          # We prefer people use the AppSignal Puma plugin. This fallback is
+          # only there when users relied on our *magic* integration.
+          #
+          # Using the Puma plugin, the minutely probe thread will still run in
+          # Puma workers, for other non-Puma probes, but the Puma probe only
+          # runs in the Puma main process.
+          # For more information:
+          # https://docs.appsignal.com/ruby/integrations/puma.html
           Appsignal::Minutely.probes.register :puma, PumaProbe
         end
 
-        if ::Puma.respond_to?(:cli_config) && ::Puma.cli_config
-          ::Puma.cli_config.options[:before_fork] ||= []
-          ::Puma.cli_config.options[:before_fork] << proc do |_id|
-            Appsignal::Minutely.start
-          end
-
-          ::Puma.cli_config.options[:before_worker_boot] ||= []
-          ::Puma.cli_config.options[:before_worker_boot] << proc do |_id|
-            Appsignal.forked
-          end
-
-          ::Puma.cli_config.options[:before_worker_shutdown] ||= []
-          ::Puma.cli_config.options[:before_worker_shutdown] << proc do |_id|
-            Appsignal.stop("puma before_worker_shutdown")
-          end
-        end
-
         return unless defined?(::Puma::Cluster)
         # For clustered mode with multiple workers
         ::Puma::Cluster.class_eval do

data/lib/appsignal/hooks/sequel.rb

@@ -42,7 +42,7 @@ module Appsignal
 
       def install
         # Register the extension...
-        if ::Sequel::MAJOR >= 4 && ::Sequel::MINOR >= 35
+        if (::Sequel::MAJOR >= 4 && ::Sequel::MINOR >= 35) || ::Sequel::MAJOR >= 5
           ::Sequel::Database.register_extension(
             :appsignal_integration,
             Appsignal::Hooks::SequelLogConnectionExtension

data/lib/appsignal/hooks/sidekiq.rb

@@ -38,13 +38,29 @@ module Appsignal
       end
 
       def call
-        stats = ::Sidekiq::Stats.new
+        track_redis_info
+        track_stats
+        track_queues
+      end
+
+      private
+
+      attr_reader :cache
+
+      def track_redis_info
+        return unless ::Sidekiq.respond_to?(:redis_info)
         redis_info = ::Sidekiq.redis_info
-        gauge "worker_count", stats.workers_size
-        gauge "process_count", stats.processes_size
+
         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")
+      end
+
+      def track_stats
+        stats = ::Sidekiq::Stats.new
+
+        gauge "worker_count", stats.workers_size
+        gauge "process_count", stats.processes_size
         gauge_delta :jobs_processed, "job_count", stats.processed,
           :status => :processed
         gauge_delta :jobs_failed, "job_count", stats.failed, :status => :failed
@@ -52,7 +68,9 @@ module Appsignal
         gauge_delta :jobs_dead, "job_count", stats.dead_size, :status => :died
         gauge "job_count", stats.scheduled_size, :status => :scheduled
         gauge "job_count", stats.enqueued, :status => :enqueued
+      end
 
+      def track_queues
         ::Sidekiq::Queue.all.each do |queue|
           gauge "queue_length", queue.size, :queue => queue.name
           # Convert latency from seconds to milliseconds
@@ -60,10 +78,6 @@ module Appsignal
         end
       end
 
-      private
-
-      attr_reader :cache
-
       # Track a gauge metric with the `sidekiq_` prefix
       def gauge(key, value, tags = {})
         tags[:hostname] = hostname if hostname

data/lib/appsignal/integrations/que.rb

@@ -5,16 +5,17 @@ module Appsignal
     module QuePlugin
       def self.included(base)
         base.class_eval do
-          def _run_with_appsignal
+          def _run_with_appsignal(*)
+            local_attrs = respond_to?(:que_attrs) ? que_attrs : attrs
             env = {
               :metadata    => {
-                :id        => attrs[:job_id],
-                :queue     => attrs[:queue],
-                :run_at    => attrs[:run_at].to_s,
-                :priority  => attrs[:priority],
-                :attempts  => attrs[:error_count].to_i
+                :id        => local_attrs[:job_id] || local_attrs[:id],
+                :queue     => local_attrs[:queue],
+                :run_at    => local_attrs[:run_at].to_s,
+                :priority  => local_attrs[:priority],
+                :attempts  => local_attrs[:error_count].to_i
               },
-              :params => attrs[:args]
+              :params => local_attrs[:args]
             }
 
             request = Appsignal::Transaction::GenericRequest.new(env)
@@ -31,7 +32,7 @@ module Appsignal
               transaction.set_error(error)
               raise error
             ensure
-              transaction.set_action "#{attrs[:job_class]}#run"
+              transaction.set_action "#{local_attrs[:job_class]}#run"
               Appsignal::Transaction.complete_current!
             end
           end

data/lib/appsignal/transaction.rb

@@ -264,6 +264,11 @@ module Appsignal
     end
 
     def set_error(error)
+      unless error.is_a?(Exception)
+        Appsignal.logger.error "Appsignal::Transaction#set_error: Cannot set error. " \
+          "The given value is not an exception: #{error.inspect}"
+        return
+      end
       return unless error
       return unless Appsignal.active?
 

data/lib/appsignal/utils/rails_helper.rb

@@ -11,6 +11,10 @@ module Appsignal
           rails_class.parent_name
         end
       end
+
+      def self.application_config_path
+        File.expand_path(File.join(Dir.pwd, "config/application.rb"))
+      end
     end
   end
 end

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "2.9.12.beta.0".freeze
+  VERSION = "2.9.18.beta.1".freeze
 end

data/lib/puma/plugin/appsignal.rb

@@ -0,0 +1,26 @@
+APPSIGNAL_PUMA_PLUGIN_LOADED = true
+
+# AppSignal Puma plugin
+#
+# This plugin ensures the minutely probe thread is started with the Puma
+# minutely probe in the Puma master process.
+#
+# The constant {APPSIGNAL_PUMA_PLUGIN_LOADED} is here to mark the Plugin as
+# loaded by the rest of the AppSignal gem. This ensures that the Puma minutely
+# probe is not also started in every Puma workers, which was the old behavior.
+# See {Appsignal::Hooks::PumaHook#install} for more information.
+#
+# For even more information:
+# https://docs.appsignal.com/ruby/integrations/puma.html
+Puma::Plugin.create do
+  def start(launcher = nil)
+    launcher.events.on_booted do
+      require "appsignal"
+      if ::Puma.respond_to?(:stats)
+        Appsignal::Minutely.probes.register :puma, Appsignal::Hooks::PumaProbe
+      end
+      Appsignal.start
+      Appsignal.start_logger
+    end
+  end
+end

data/spec/lib/appsignal/cli/install_spec.rb

@@ -16,6 +16,10 @@ describe Appsignal::CLI::Install do
     allow(described_class).to receive(:press_any_key)
     allow(Appsignal::Demo).to receive(:transmit).and_return(true)
   end
+  after do
+    FileUtils.rm_rf(tmp_dir)
+    FileUtils.mkdir_p(tmp_dir)
+  end
   around do |example|
     original_stdin = $stdin
     $stdin = StringIO.new
@@ -157,16 +161,10 @@ describe Appsignal::CLI::Install do
   shared_examples "capistrano install" do
     let(:capfile) { File.join(tmp_dir, "Capfile") }
     before do
-      FileUtils.mkdir_p(tmp_dir)
-
       enter_app_name "foo"
       add_cli_input "n"
       choose_environment_config
     end
-    after do
-      FileUtils.rm_rf(tmp_dir)
-      FileUtils.mkdir_p(tmp_dir)
-    end
 
     context "without Capfile" do
       it "does nothing" do
@@ -260,7 +258,6 @@ describe Appsignal::CLI::Install do
         FileUtils.touch(File.join(environments_dir, "development.rb"))
         FileUtils.touch(File.join(environments_dir, "staging.rb"))
         FileUtils.touch(File.join(environments_dir, "production.rb"))
-        enter_app_name app_name
       end
 
       describe "environments" do
@@ -410,6 +407,53 @@ describe Appsignal::CLI::Install do
           end
         end
       end
+
+      context "when there is no Rails application.rb file" do
+        before do
+          # Do not detect it as another framework for testing
+          allow(described_class).to receive(:framework_available?).and_call_original
+          allow(described_class).to receive(:framework_available?).with("sinatra").and_return(false)
+
+          File.delete(File.join(config_dir, "application.rb"))
+          expect(File.exist?(File.join(config_dir, "application.rb"))).to eql(false)
+        end
+
+        it "fails the installation" do
+          run
+
+          expect(output).to include("We could not detect which framework you are using.")
+          expect(output).to_not include("Installing for Ruby on Rails")
+          expect(output).to include_complete_install
+
+          expect(File.exist?(config_file_path)).to be(false)
+        end
+      end
+
+      context "when failed to load the Rails application.rb file" do
+        before do
+          File.open(File.join(config_dir, "application.rb"), "w") do |file|
+            file.write("I am invalid code")
+          end
+        end
+
+        it "prompts the user to fill in an app name" do
+          enter_app_name app_name
+          choose_config_file
+          run
+
+          expect(output).to include("Installing for Ruby on Rails")
+          expect(output).to include("Unable to automatically detect your Rails app's name.")
+          expect(output).to include("Choose your app's display name for AppSignal.com:")
+          expect(output).to include_file_config
+          expect(output).to include_complete_install
+
+          expect(config_file).to configure_app_name(app_name)
+          expect(config_file).to configure_push_api_key(push_api_key)
+          expect(config_file).to configure_environment("development")
+          expect(config_file).to configure_environment("staging")
+          expect(config_file).to configure_environment("production")
+        end
+      end
     end
   end
 

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

@@ -27,6 +27,8 @@ describe Appsignal::Hooks::PumaHook do
     end
 
     describe "installation" do
+      before { Appsignal::Minutely.probes.clear }
+
       context "when not clustered mode" do
         it "does not add AppSignal stop behavior Puma::Cluster" do
           expect(defined?(::Puma::Cluster)).to be_falsy
@@ -34,9 +36,27 @@ describe Appsignal::Hooks::PumaHook do
           Appsignal::Hooks::PumaHook.new.install
         end
 
-        it "adds the Puma minutely probe" do
-          probe = Appsignal::Minutely.probes[:puma]
-          expect(probe).to eql(Appsignal::Hooks::PumaProbe)
+        context "with APPSIGNAL_PUMA_PLUGIN_LOADED defined" do
+          before do
+            # Set in lib/puma/appsignal.rb
+            APPSIGNAL_PUMA_PLUGIN_LOADED = true
+          end
+          after { Object.send :remove_const, :APPSIGNAL_PUMA_PLUGIN_LOADED }
+
+          it "does not add the Puma minutely probe" do
+            Appsignal::Hooks::PumaHook.new.install
+            expect(Appsignal::Minutely.probes[:puma]).to be_nil
+          end
+        end
+
+        context "without APPSIGNAL_PUMA_PLUGIN_LOADED defined" do
+          it "adds the Puma minutely probe" do
+            expect(defined?(APPSIGNAL_PUMA_PLUGIN_LOADED)).to be_nil
+
+            Appsignal::Hooks::PumaHook.new.install
+            probe = Appsignal::Minutely.probes[:puma]
+            expect(probe).to eql(Appsignal::Hooks::PumaProbe)
+          end
         end
       end
 
@@ -49,11 +69,11 @@ describe Appsignal::Hooks::PumaHook do
               end
             end
           end
-          Appsignal::Hooks::PumaHook.new.install
         end
         after { Puma.send(:remove_const, :Cluster) }
 
         it "adds behavior to Puma::Cluster.stop_workers" do
+          Appsignal::Hooks::PumaHook.new.install
           cluster = Puma::Cluster.new
 
           expect(cluster.instance_variable_defined?(:@called)).to be_falsy
@@ -62,40 +82,28 @@ describe Appsignal::Hooks::PumaHook do
           expect(cluster.instance_variable_get(:@called)).to be(true)
         end
 
-        it "adds the Puma minutely probe" do
-          probe = Appsignal::Minutely.probes[:puma]
-          expect(probe).to eql(Appsignal::Hooks::PumaProbe)
-        end
-      end
-    end
-
-    context "with nil hooks" do
-      before do
-        Puma.cli_config.options.delete(:before_fork)
-        Puma.cli_config.options.delete(:before_worker_boot)
-        Puma.cli_config.options.delete(:before_worker_shutdown)
-        Appsignal::Hooks::PumaHook.new.install
-      end
+        context "with APPSIGNAL_PUMA_PLUGIN_LOADED defined" do
+          before do
+            # Set in lib/puma/appsignal.rb
+            APPSIGNAL_PUMA_PLUGIN_LOADED = true
+          end
+          after { Object.send :remove_const, :APPSIGNAL_PUMA_PLUGIN_LOADED }
 
-      it "should add a before shutdown worker callback" do
-        expect(Puma.cli_config.options[:before_fork].first).to be_a(Proc)
-        expect(Puma.cli_config.options[:before_worker_boot].first).to be_a(Proc)
-        expect(Puma.cli_config.options[:before_worker_shutdown].first).to be_a(Proc)
-      end
-    end
+          it "does not add the Puma minutely probe" do
+            Appsignal::Hooks::PumaHook.new.install
+            expect(Appsignal::Minutely.probes[:puma]).to be_nil
+          end
+        end
 
-    context "with existing hooks" do
-      before do
-        Puma.cli_config.options[:before_fork] = []
-        Puma.cli_config.options[:before_worker_boot] = []
-        Puma.cli_config.options[:before_worker_shutdown] = []
-        Appsignal::Hooks::PumaHook.new.install
-      end
+        context "without APPSIGNAL_PUMA_PLUGIN_LOADED defined" do
+          it "adds the Puma minutely probe" do
+            expect(defined?(APPSIGNAL_PUMA_PLUGIN_LOADED)).to be_nil
 
-      it "should add a before shutdown worker callback" do
-        expect(Puma.cli_config.options[:before_fork].first).to be_a(Proc)
-        expect(Puma.cli_config.options[:before_worker_boot].first).to be_a(Proc)
-        expect(Puma.cli_config.options[:before_worker_shutdown].first).to be_a(Proc)
+            Appsignal::Hooks::PumaHook.new.install
+            probe = Appsignal::Minutely.probes[:puma]
+            expect(probe).to eql(Appsignal::Hooks::PumaProbe)
+          end
+        end
       end
     end
   end