appsignal 4.5.7 → 4.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb6b257bdb500ffff85f0aaf2c4a63c85ef1d454df501973b99c3871869564fd
-  data.tar.gz: 9f62ae7ee6fd67935b079ece3d8c5ef827396b654b675754bcaa9a323ca8141e
+  metadata.gz: f023b8343540c92b7c106f7c9853d7ec08c64f0138fa1904be7b606aadf6691b
+  data.tar.gz: eb18c6e7c352ab0e5e44f739190df8a2c671212b97133311070633944597b63f
 SHA512:
-  metadata.gz: 2a58b34251fd0eef84bf5cfb0f275f4e974d3e48eccdfb10426acda5ec6ba39c6f33377b3f77bdfb7c0772f2bdc510ce0a2f5e829649c67b203f105ae1360c41
-  data.tar.gz: d96563953abcb4614df3325b486ba23b6e25458d1649661a977e45ea06e24bec7bfa79f21295ed901d466313b3d8753f1d91d3585f20c166388b6006cef000cf
+  metadata.gz: 678d39b904447512f7222a7c3f82bd251d507e745d9b1402f7c3a3784fabd691f1a1538421ff4dd7fb158cdc74d02e925cbea10eff59581c2d661d3d1ad9c03a
+  data.tar.gz: 18efa45cf4d42fd8faacaf5cec5ec93e76d41773d83e9e077a6d4528aeb5019a05ce41b35b1e88e3449ccd8635ce27045c8cca49d46077327d6490e3e6dc31d4

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # AppSignal for Ruby gem Changelog
 
+## 4.5.8
+
+_Published on 2025-04-04._
+
+### Added
+
+- Add the `enable_at_exit_hook` option to configure if `Appsignal.stop` is called when the Ruby application exits. Calling `Appsignal.stop` will stop the application for a moment to flush all the data to our agent before shutting down.
+
+  This option has three possible values:
+
+  - `always`: Always call `Appsignal.stop` when the program exits. On (Docker) containers it's automatically set to this value.
+  - `never`: Never call `Appsignal.stop` when the program exits. The default value when the program doesn't run on a (Docker) container.
+  - `on_error`: Call `Appsignal.stop` when the program exits with an error.
+
+  (patch [d0a5875c](https://github.com/appsignal/appsignal-ruby/commit/d0a5875cef5101680f1cab4649d71440212f9ea8), [043a6c74](https://github.com/appsignal/appsignal-ruby/commit/043a6c740b708e1182ed7161e3c9ad38bd3314de), [b680fe6f](https://github.com/appsignal/appsignal-ruby/commit/b680fe6f6b283205a13ca61bd4a26167f541dbca))
+
+### Deprecated
+
+- Deprecate the `Appsignal.monitor_and_stop` helper.
+
+  We instead recommend using the `Appsignal.monitor` helper and configuring the `enable_at_exit_hook` config option to `always`.
+
+  (patch [84969aea](https://github.com/appsignal/appsignal-ruby/commit/84969aeaca8f3737921e9adf1efdad55b52e1206))
+
 ## 4.5.7
 
 _Published on 2025-03-20._

data/lib/appsignal/config.rb

@@ -93,6 +93,7 @@ module Appsignal
       :ca_file_path => File.expand_path(File.join("../../../resources/cacert.pem"), __FILE__),
       :dns_servers => [],
       :enable_allocation_tracking => true,
+      :enable_at_exit_hook => "on_error",
       :enable_at_exit_reporter => true,
       :enable_host_metrics => true,
       :enable_minutely_probes => true,
@@ -153,6 +154,7 @@ module Appsignal
       :name => "APPSIGNAL_APP_NAME",
       :bind_address => "APPSIGNAL_BIND_ADDRESS",
       :ca_file_path => "APPSIGNAL_CA_FILE_PATH",
+      :enable_at_exit_hook => "APPSIGNAL_ENABLE_AT_EXIT_HOOK",
       :hostname => "APPSIGNAL_HOSTNAME",
       :host_role => "APPSIGNAL_HOST_ROLE",
       :http_proxy => "APPSIGNAL_HTTP_PROXY",
@@ -507,6 +509,8 @@ module Appsignal
         # environment variable is present and not empty.
         env_push_api_key = ENV["APPSIGNAL_PUSH_API_KEY"] || ""
         hash[:active] = true unless env_push_api_key.strip.empty?
+
+        hash[:enable_at_exit_hook] = "always" if Appsignal::Extension.running_in_container?
       end
     end
 

data/lib/appsignal/helpers/instrumentation.rb

@@ -154,6 +154,11 @@ module Appsignal
       #
       # @see monitor
       def monitor_and_stop(action:, namespace: nil, &block)
+        Appsignal::Utils::StdoutAndLoggerMessage.warning \
+          "The `Appsignal.monitor_and_stop` helper is deprecated. " \
+            "Use the `Appsignal.monitor` along with our `enable_at_exit_hook` " \
+            "option instead."
+
         monitor(:namespace => namespace, :action => action, &block)
       ensure
         Appsignal.stop("monitor_and_stop")

data/lib/appsignal/hooks/at_exit.rb

@@ -11,27 +11,41 @@ module Appsignal
       end
 
       def install
-        return unless Appsignal.config[:enable_at_exit_reporter]
-
         Kernel.at_exit(&AtExitCallback.method(:call))
       end
 
-      # Report any unhandled errors and will crash the Ruby process.
+      # Stop AppSignal before the app exists.
+      #
+      # This is the default behavior and can be customized with the
+      # `enable_at_exit_hook` option.
+      #
+      # When the `enable_at_exit_reporter` option is set to `true` (the
+      # default), it will report any unhandled errors that will crash the Ruby
+      # process.
       #
       # If this error was previously reported by any of our instrumentation,
       # the error will not also be reported here. This way we don't report an
       # error from a Rake task or instrumented script twice.
       class AtExitCallback
         def self.call
+          report_error = false
+          return unless Appsignal.config&.[](:enable_at_exit_reporter)
+
           error = $! # rubocop:disable Style/SpecialGlobalVars
           return unless error
           return if ignored_error?(error)
           return if Appsignal::Transaction.last_errors.include?(error)
 
+          report_error = true
+
           Appsignal.report_error(error) do |transaction|
             transaction.set_namespace("unhandled")
           end
-          Appsignal.stop("at_exit")
+        ensure
+          at_exit_hook = Appsignal.config&.[](:enable_at_exit_hook)
+          if at_exit_hook == "always" || (at_exit_hook == "on_error" && report_error)
+            Appsignal.stop("at_exit")
+          end
         end
 
         IGNORED_ERRORS = [

data/lib/appsignal/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 4.5.7
+  version: 4.5.8
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-20 00:00:00.000000000 Z
+date: 2025-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger