appsignal 2.9.16 → 2.9.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05276a7162dde5c58464ac4d6170837a4a71522f42024b77fb456f35773c74b3
-  data.tar.gz: 8005bfc2837f546de89a5703ab0fdbd5a340f53f86871dc64de6550c3f728c26
+  metadata.gz: 3d3694d0f2970749ad1d8951a3989c2f6ea77c10f3cb695c3992266962bba09e
+  data.tar.gz: b16b94135fc7f014ec2a3b5b6904696d6b262972bb229d908f3d0c7f2f6bb6ff
 SHA512:
-  metadata.gz: 8906bffe72c3e8cceb40f1eb6e32827c4389acb19706fcd992901dc00074779ad2121e3d1c7f45ba9f876929c4bb2cb357808c5bd81d01bf3c6dd40695441b31
-  data.tar.gz: d5582d45e830d06d291296136d8802bad1121227af7b6f82192112f991c48621b3fe55836343ff0d592d9770c7043fc4abce04e5626d0115ea491b94e9ab201c
+  metadata.gz: cb9e78c6e46f317ea3092e6045afd21abb7bea8ed3858021fbd4d2ef0d4d743a778becf69a3e2c4dc0dd64a00a353b2793601d22ed5163d99c9dfd779f748b8b
+  data.tar.gz: fc32dfdfb9beadac21752e730340306674948458a2cc260d66e5dca646efa4bfe7a6c44e01d62a17844f229a08562d55534651c7744d82a9da8c98a8e23e9869

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 2.9.18 (Beta)
+- Bump agent to v-c348132
+  - Improve transmitter logging on timeout
+  - Improve queued payloads transmitter. Should prevent payloads being sent
+    multiple times.
+  - Add transaction debug mode
+  - Wrap Option in Mutex in TransactionInProgess
+
+## 2.9.17
+- Handle missing file and load errors from `application.rb` in `appsignal
+  install` for Rails apps. PR #568
+- Support minutely probes for Puma in clustered mode. PR #570
+  See the installation instructions for the Puma plugin:
+  https://docs.appsignal.com/ruby/integrations/puma.html
+
 ## 2.9.16
 - Check set_error arguments for Exceptions. PR #565
 - Bump agent to v-1d8917f - commit 737d6b1b8fc9cd2c0564050bb04246d9267dceb7

data/ext/agent.yml

@@ -1,70 +1,70 @@
 ---
-version: 1d8917f
+version: c348132
 mirrors:
 - https://appsignal-agent-releases.global.ssl.fastly.net
 - https://d135dj0rjqvssy.cloudfront.net
 triples:
   x86_64-darwin:
     static:
-      checksum: 777cf5c54eeb32d9d0d6de48c61f14d977244351a4a9e70c9b30c4221e38012c
+      checksum: cb287c8e2072fe5b8cf14449bd6892989c392d0c651ce339895ae0302cb69785
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: 2741e747961dbac985f5740c3c747c7a76ce88452a37604ae8c8588343a08464
+      checksum: af1ed2e9d29859ffbfc8e6903e4c51764dee94d7b4877ca8d30270b6f133a10f
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   universal-darwin:
     static:
-      checksum: 777cf5c54eeb32d9d0d6de48c61f14d977244351a4a9e70c9b30c4221e38012c
+      checksum: cb287c8e2072fe5b8cf14449bd6892989c392d0c651ce339895ae0302cb69785
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: 2741e747961dbac985f5740c3c747c7a76ce88452a37604ae8c8588343a08464
+      checksum: af1ed2e9d29859ffbfc8e6903e4c51764dee94d7b4877ca8d30270b6f133a10f
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   i686-linux:
     static:
-      checksum: 483417f3afbc76b959d68137717b85d44e9dd14c56bad3a44fd370294dc86273
+      checksum: 2c3bcd102592bf38fbdb27e7c70502dccbe54a0dc2739a9d54aaa694fcfb41fb
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: b34d007f69eea87a197e5bc8b0cd22f512dc37b732c2ae8c49f053c70c291d2c
+      checksum: 1c037b8370b755d706340e25d3e4b2f4acb279dd03873cc53bcf0a6ec0832653
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   x86-linux:
     static:
-      checksum: 483417f3afbc76b959d68137717b85d44e9dd14c56bad3a44fd370294dc86273
+      checksum: 2c3bcd102592bf38fbdb27e7c70502dccbe54a0dc2739a9d54aaa694fcfb41fb
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: b34d007f69eea87a197e5bc8b0cd22f512dc37b732c2ae8c49f053c70c291d2c
+      checksum: 1c037b8370b755d706340e25d3e4b2f4acb279dd03873cc53bcf0a6ec0832653
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   i686-linux-musl:
     static:
-      checksum: ad58fec875496aae76c870e5a1abdf37af27e4d237fc791c4820ef8ccfa05586
+      checksum: 0add9eed4452feda7fc5e1bbd0acdff32c353e4ea0b5d527959df57deb1bdcb2
       filename: appsignal-i686-linux-musl-all-static.tar.gz
   x86-linux-musl:
     static:
-      checksum: ad58fec875496aae76c870e5a1abdf37af27e4d237fc791c4820ef8ccfa05586
+      checksum: 0add9eed4452feda7fc5e1bbd0acdff32c353e4ea0b5d527959df57deb1bdcb2
       filename: appsignal-i686-linux-musl-all-static.tar.gz
   x86_64-linux:
     static:
-      checksum: dcab7852e81cbacb0a187cb62ce2f583f3ff835fb7c49c09f4e41df64b4b81c5
+      checksum: d11221c127c00128da16b419c503281407e429c0ea6f5bfe1691640b8e995e4e
       filename: appsignal-x86_64-linux-all-static.tar.gz
     dynamic:
-      checksum: 33523662808254ae1e630e33a2466bf17acfb636e3726d98d11b375619ea2cdf
+      checksum: 6869ab461fde55487d55805c396d55f36cb881998556f44236035b949939b0af
       filename: appsignal-x86_64-linux-all-dynamic.tar.gz
   x86_64-linux-musl:
     static:
-      checksum: 63cb4ac3d8befaec47eb907b1ff4c6c4af93e39fd7696db783cb6e656dda297c
+      checksum: 7ce44dc23c578933ca37a79d244bc367fdc2438408c2a61558adb92bcfebb1fa
       filename: appsignal-x86_64-linux-musl-all-static.tar.gz
     dynamic:
-      checksum: 4116c2757c2be2b8eb259d787034ec4ab4123889735ded1ef584afbd68a8247a
+      checksum: 78d98f468e3a12cc09baff9e68bc4d9cd3b79f4a3bbe744036bff685415546a4
       filename: appsignal-x86_64-linux-musl-all-dynamic.tar.gz
   x86_64-freebsd:
     static:
-      checksum: 39c006dd131d1ca452ff79ec988688a69823e0abf26ee6966b1639cc42720416
+      checksum: df5f8b61e6ecca40f349cf5c83d5f37f031850d367793dee90dc56f13974431d
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: 937fb029f9f6a57aa818d46dcf8fbbfe06481c0765ad591859fbc6970a32a1df
+      checksum: 30d0303e97386014640c5b8194b777a5741e08ab5497ba58a7d8229bd4890fc5
       filename: appsignal-x86_64-freebsd-all-dynamic.tar.gz
   amd64-freebsd:
     static:
-      checksum: 39c006dd131d1ca452ff79ec988688a69823e0abf26ee6966b1639cc42720416
+      checksum: df5f8b61e6ecca40f349cf5c83d5f37f031850d367793dee90dc56f13974431d
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: 937fb029f9f6a57aa818d46dcf8fbbfe06481c0765ad591859fbc6970a32a1df
+      checksum: 30d0303e97386014640c5b8194b777a5741e08ab5497ba58a7d8229bd4890fc5
       filename: appsignal-x86_64-freebsd-all-dynamic.tar.gz

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/config.rb

@@ -39,7 +39,8 @@ module Appsignal
       :enable_minutely_probes         => true,
       :ca_file_path                   => File.expand_path(File.join("../../../resources/cacert.pem"), __FILE__),
       :dns_servers                    => [],
-      :files_world_accessible         => true
+      :files_world_accessible         => true,
+      :transaction_debug_mode         => false
     }.freeze
 
     ENV_TO_KEY_MAPPING = {
@@ -75,6 +76,7 @@ module Appsignal
       "APPSIGNAL_DNS_SERVERS"                    => :dns_servers,
       "APPSIGNAL_FILES_WORLD_ACCESSIBLE"         => :files_world_accessible,
       "APPSIGNAL_REQUEST_HEADERS"                => :request_headers,
+      "APPSIGNAL_TRANSACTION_DEBUG_MODE"         => :transaction_debug_mode,
       "APP_REVISION"                             => :revision
     }.freeze
 
@@ -219,6 +221,7 @@ module Appsignal
       ENV["_APPSIGNAL_CA_FILE_PATH"]                 = config_hash[:ca_file_path].to_s
       ENV["_APPSIGNAL_DNS_SERVERS"]                  = config_hash[:dns_servers].join(",")
       ENV["_APPSIGNAL_FILES_WORLD_ACCESSIBLE"]       = config_hash[:files_world_accessible].to_s
+      ENV["_APPSIGNAL_TRANSACTION_DEBUG_MODE"]       = config_hash[:transaction_debug_mode].to_s
       ENV["_APP_REVISION"]                           = config_hash[:revision].to_s
     end
 
@@ -324,7 +327,7 @@ module Appsignal
          APPSIGNAL_ENABLE_ALLOCATION_TRACKING APPSIGNAL_ENABLE_GC_INSTRUMENTATION
          APPSIGNAL_RUNNING_IN_CONTAINER APPSIGNAL_ENABLE_HOST_METRICS
          APPSIGNAL_SEND_PARAMS APPSIGNAL_ENABLE_MINUTELY_PROBES
-         APPSIGNAL_FILES_WORLD_ACCESSIBLE].each do |var|
+         APPSIGNAL_FILES_WORLD_ACCESSIBLE APPSIGNAL_TRANSACTION_DEBUG_MODE].each do |var|
         env_var = ENV[var]
         next unless env_var
         config[ENV_TO_KEY_MAPPING[var]] = env_var.casecmp("true").zero?

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/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.16".freeze
+  VERSION = "2.9.18".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/config_spec.rb

@@ -134,6 +134,7 @@ describe Appsignal::Config do
         :ca_file_path                   => File.join(resources_dir, "cacert.pem"),
         :dns_servers                    => [],
         :files_world_accessible         => true,
+        :transaction_debug_mode         => false,
         :revision                       => "v2.5.1",
         :request_headers                => []
       )
@@ -473,6 +474,7 @@ describe Appsignal::Config do
       config[:filter_parameters] = %w[password confirm_password]
       config[:running_in_container] = false
       config[:dns_servers] = ["8.8.8.8", "8.8.4.4"]
+      config[:transaction_debug_mode] = true
       config[:revision] = "v2.5.1"
       config.write_to_environment
     end
@@ -500,6 +502,7 @@ describe Appsignal::Config do
       expect(ENV["_APPSIGNAL_CA_FILE_PATH"]).to                 eq File.join(resources_dir, "cacert.pem")
       expect(ENV["_APPSIGNAL_DNS_SERVERS"]).to                  eq "8.8.8.8,8.8.4.4"
       expect(ENV["_APPSIGNAL_FILES_WORLD_ACCESSIBLE"]).to       eq "true"
+      expect(ENV["_APPSIGNAL_TRANSACTION_DEBUG_MODE"]).to       eq "true"
       expect(ENV["_APP_REVISION"]).to                           eq "v2.5.1"
       expect(ENV).to_not                                        have_key("_APPSIGNAL_WORKING_DIR_PATH")
       expect(ENV).to_not                                        have_key("_APPSIGNAL_WORKING_DIRECTORY_PATH")

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

data/spec/lib/appsignal/minutely_spec.rb

@@ -1,4 +1,6 @@
 describe Appsignal::Minutely do
+  include WaitForHelper
+
   before { Appsignal::Minutely.probes.clear }
 
   it "returns a ProbeCollection" do
@@ -7,38 +9,26 @@ describe Appsignal::Minutely do
   end
 
   describe ".start" do
-    class Probe
-      attr_reader :calls
-
-      def initialize
-        @calls = 0
-      end
-
-      def call
-        @calls += 1
-      end
-    end
-
-    class ProbeWithoutDependency < Probe
+    class ProbeWithoutDependency < MockProbe
       def self.dependencies_present?
         true
       end
     end
 
-    class ProbeWithMissingDependency < Probe
+    class ProbeWithMissingDependency < MockProbe
       def self.dependencies_present?
         false
       end
     end
 
-    class BrokenProbe < Probe
+    class BrokenProbe < MockProbe
       def call
         super
         raise "oh no!"
       end
     end
 
-    class BrokenProbeOnInitialize < Probe
+    class BrokenProbeOnInitialize < MockProbe
       def initialize
         super
         raise "oh no initialize!"
@@ -60,7 +50,7 @@ describe Appsignal::Minutely do
 
     context "with an instance of a class" do
       it "calls the probe every <wait_time>" do
-        probe = Probe.new
+        probe = MockProbe.new
         Appsignal::Minutely.probes.register :my_probe, probe
         Appsignal::Minutely.start
 
@@ -90,8 +80,8 @@ describe Appsignal::Minutely do
 
     context "with probe class" do
       it "creates an instance of the class and call that every <wait time>" do
-        probe = Probe
-        probe_instance = Probe.new
+        probe = MockProbe
+        probe_instance = MockProbe.new
         expect(probe).to receive(:new).and_return(probe_instance)
         Appsignal::Minutely.probes.register :my_probe, probe
         Appsignal::Minutely.start
@@ -163,7 +153,7 @@ describe Appsignal::Minutely do
 
     context "with a broken probe" do
       it "logs the error and continues calling the probes every <wait_time>" do
-        probe = Probe.new
+        probe = MockProbe.new
         broken_probe = BrokenProbe.new
         Appsignal::Minutely.probes.register :my_probe, probe
         Appsignal::Minutely.probes.register :broken_probe, broken_probe
@@ -183,7 +173,7 @@ describe Appsignal::Minutely do
 
     it "ensures only one minutely probes thread is active at a time" do
       alive_thread_counter = proc { Thread.list.reject { |t| t.status == "dead" }.length }
-      probe = Probe.new
+      probe = MockProbe.new
       Appsignal::Minutely.probes.register :my_probe, probe
       expect do
         Appsignal::Minutely.start
@@ -349,31 +339,4 @@ describe Appsignal::Minutely do
       end
     end
   end
-
-  # Wait for a condition to be met
-  #
-  # @example
-  #   # Perform threaded operation
-  #   wait_for("enough probe calls") { probe.calls >= 2 }
-  #   # Assert on result
-  #
-  # @param name [String] The name of the condition to check. Used in the
-  #   error when it fails.
-  # @yield Assertion to check.
-  # @yieldreturn [Boolean] True/False value that indicates if the condition
-  #   is met.
-  # @raise [StandardError] Raises error if the condition is not met after 5
-  #   seconds, 5_000 tries.
-  def wait_for(name)
-    max_wait = 5_000
-    i = 0
-    while i <= max_wait
-      break if yield
-      i += 1
-      sleep 0.001
-    end
-
-    return unless i == max_wait
-    raise "Waited 5 seconds for #{name} condition, but was not met."
-  end
 end

data/spec/lib/puma/appsignal_spec.rb

@@ -0,0 +1,91 @@
+RSpec.describe "Puma plugin" do
+  include WaitForHelper
+
+  class MockPumaLauncher
+    def events
+      return @events if defined?(@events)
+
+      @events = MockPumaEvents.new
+    end
+  end
+
+  class MockPumaEvents
+    def on_booted(&block)
+      @on_booted = block if block_given?
+      @on_booted if defined?(@on_booted)
+    end
+  end
+
+  let(:probe) { MockProbe.new }
+  let(:launcher) { MockPumaLauncher.new }
+  before do
+    module Puma
+      def self.stats
+      end
+
+      class Plugin
+        class << self
+          attr_reader :plugin
+
+          def create(&block)
+            @plugin = Class.new(::Puma::Plugin)
+            @plugin.class_eval(&block)
+          end
+        end
+      end
+    end
+
+    Appsignal::Minutely.probes.clear
+    ENV["APPSIGNAL_ENABLE_MINUTELY_PROBES"] = "true"
+    Appsignal.config = project_fixture_config
+    # Speed up test time
+    allow(Appsignal::Minutely).to receive(:initial_wait_time).and_return(0.001)
+    allow(Appsignal::Minutely).to receive(:wait_time).and_return(0.001)
+
+    Appsignal::Minutely.probes.register :my_probe, probe
+    load File.expand_path("../lib/puma/plugin/appsignal.rb", APPSIGNAL_SPEC_DIR)
+  end
+  after do
+    Appsignal.config = nil
+    Object.send :remove_const, :Puma
+    Object.send :remove_const, :APPSIGNAL_PUMA_PLUGIN_LOADED
+  end
+
+  it "registers the PumaProbe" do
+    expect(Appsignal::Minutely.probes[:my_probe]).to eql(probe)
+    expect(Appsignal::Minutely.probes[:puma]).to be_nil
+    plugin = Puma::Plugin.plugin.new
+    expect(launcher.events.on_booted).to be_nil
+
+    plugin.start(launcher)
+    expect(Appsignal::Minutely.probes[:puma]).to be_nil
+    expect(launcher.events.on_booted).to_not be_nil
+
+    launcher.events.on_booted.call
+    expect(Appsignal::Minutely.probes[:puma]).to eql(Appsignal::Hooks::PumaProbe)
+
+    # Minutely probes started and called
+    wait_for("enough probe calls") { probe.calls >= 2 }
+  end
+
+  context "without Puma.stats" do
+    before { Puma.singleton_class.send(:remove_method, :stats) }
+
+    it "does not register the PumaProbe" do
+      expect(Appsignal::Minutely.probes[:my_probe]).to eql(probe)
+      expect(Appsignal::Minutely.probes[:puma]).to be_nil
+      plugin = Puma::Plugin.plugin.new
+      expect(launcher.events.on_booted).to be_nil
+
+      plugin.start(launcher)
+      expect(Appsignal::Minutely.probes[:puma]).to be_nil
+      expect(launcher.events.on_booted).to_not be_nil
+
+      launcher.events.on_booted.call
+      expect(Appsignal::Minutely.probes[:puma]).to be_nil
+
+      # Minutely probes started and called
+      wait_for("enough probe calls") { probe.calls >= 2 }
+    end
+  end
+end

data/spec/support/helpers/wait_for_helper.rb

@@ -0,0 +1,28 @@
+module WaitForHelper
+  # Wait for a condition to be met
+  #
+  # @example
+  #   # Perform threaded operation
+  #   wait_for("enough probe calls") { probe.calls >= 2 }
+  #   # Assert on result
+  #
+  # @param name [String] The name of the condition to check. Used in the
+  #   error when it fails.
+  # @yield Assertion to check.
+  # @yieldreturn [Boolean] True/False value that indicates if the condition
+  #   is met.
+  # @raise [StandardError] Raises error if the condition is not met after 5
+  #   seconds, 5_000 tries.
+  def wait_for(name)
+    max_wait = 5_000
+    i = 0
+    while i <= max_wait
+      break if yield
+      i += 1
+      sleep 0.001
+    end
+
+    return unless i == max_wait
+    raise "Waited 5 seconds for #{name} condition, but was not met."
+  end
+end

data/spec/support/mocks/mock_probe.rb

@@ -0,0 +1,11 @@
+class MockProbe
+  attr_reader :calls
+
+  def initialize
+    @calls = 0
+  end
+
+  def call
+    @calls += 1
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.9.16
+  version: 2.9.18
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-30 00:00:00.000000000 Z
+date: 2019-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -255,6 +255,7 @@ files:
 - lib/appsignal/utils/query_params_sanitizer.rb
 - lib/appsignal/utils/rails_helper.rb
 - lib/appsignal/version.rb
+- lib/puma/plugin/appsignal.rb
 - lib/sequel/extensions/appsignal_integration.rb
 - resources/appsignal.yml.erb
 - resources/cacert.pem
@@ -328,6 +329,7 @@ files:
 - spec/lib/appsignal/utils/json_spec.rb
 - spec/lib/appsignal/utils/query_params_sanitizer_spec.rb
 - spec/lib/appsignal_spec.rb
+- spec/lib/puma/appsignal_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures/generated_config.yml
 - spec/support/fixtures/projects/valid/config/application.rb
@@ -350,9 +352,11 @@ files:
 - spec/support/helpers/system_helpers.rb
 - spec/support/helpers/time_helpers.rb
 - spec/support/helpers/transaction_helpers.rb
+- spec/support/helpers/wait_for_helper.rb
 - spec/support/matchers/contains_log.rb
 - spec/support/mocks/fake_gc_profiler.rb
 - spec/support/mocks/mock_extension.rb
+- spec/support/mocks/mock_probe.rb
 - spec/support/rails/my_app.rb
 - spec/support/shared_examples/instrument.rb
 - spec/support/stubs/delayed_job.rb
@@ -384,7 +388,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com
@@ -459,6 +463,7 @@ test_files:
 - spec/lib/appsignal/utils/json_spec.rb
 - spec/lib/appsignal/utils/query_params_sanitizer_spec.rb
 - spec/lib/appsignal_spec.rb
+- spec/lib/puma/appsignal_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures/generated_config.yml
 - spec/support/fixtures/projects/valid/config/application.rb
@@ -481,9 +486,11 @@ test_files:
 - spec/support/helpers/system_helpers.rb
 - spec/support/helpers/time_helpers.rb
 - spec/support/helpers/transaction_helpers.rb
+- spec/support/helpers/wait_for_helper.rb
 - spec/support/matchers/contains_log.rb
 - spec/support/mocks/fake_gc_profiler.rb
 - spec/support/mocks/mock_extension.rb
+- spec/support/mocks/mock_probe.rb
 - spec/support/rails/my_app.rb
 - spec/support/shared_examples/instrument.rb
 - spec/support/stubs/delayed_job.rb