appsignal 4.5.6 → 4.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c26526a57b19a4680e8d3b7293eb1f46c9e32b8bf4fc47e9ea9aa74c96a3b64
-  data.tar.gz: 91ef88fce1c7fdf231ce23bbe6047338b34100f4610bbadea6f8b6fcbb79cacf
+  metadata.gz: cb6b257bdb500ffff85f0aaf2c4a63c85ef1d454df501973b99c3871869564fd
+  data.tar.gz: 9f62ae7ee6fd67935b079ece3d8c5ef827396b654b675754bcaa9a323ca8141e
 SHA512:
-  metadata.gz: 18fbaec4092861cebc794fbeabdcb4ea189a5c38faabf99fe25cdd1b07d1d0d778de73c5d7f55977b8abfa69d2d77b924dcb4a6ec4a0c97beeab88770ea06115
-  data.tar.gz: 43d538d0d1cd4571704abed7116f40819569d78cfe54b00bf0b888f3e5ca6b4f46d40e4100c1a7953cb63e66c904fa6ab2f3f3297eeef4ee1b34face4af63c39
+  metadata.gz: 2a58b34251fd0eef84bf5cfb0f275f4e974d3e48eccdfb10426acda5ec6ba39c6f33377b3f77bdfb7c0772f2bdc510ce0a2f5e829649c67b203f105ae1360c41
+  data.tar.gz: d96563953abcb4614df3325b486ba23b6e25458d1649661a977e45ea06e24bec7bfa79f21295ed901d466313b3d8753f1d91d3585f20c166388b6006cef000cf

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # AppSignal for Ruby gem Changelog
 
+## 4.5.7
+
+_Published on 2025-03-20._
+
+### Added
+
+- Add the `Appsignal.config_error` and `Appsignal.config_error?` methods. This method contains any error that may have occurred while loading the `config/appsignal.rb` file. If it is `nil` no error occurred or `Appsignal.start` hasn't been called yet. The `Appsignal.config_error?` method is an alias for syntax sugar. (patch [0f3a7372](https://github.com/appsignal/appsignal-ruby/commit/0f3a73729306d96b630339ccf6e218318d1e2870))
+- Add the `check_if_started!` method. This method will raise an error if the AppSignal Ruby gem failed to start.
+
+  Call this method in your CI or on app boot if you wish to verify that AppSignal has started when your application does, and want the application to fail to start if AppSignal hasn't started.
+
+  For example, in this Rails initializer:
+
+  ```
+  # config/initializers/appsignal.rb
+
+  Appsignal.check_if_started!
+  ```
+
+  (patch [b41c9c99](https://github.com/appsignal/appsignal-ruby/commit/b41c9c991bdbcd64b7a04e9832b15ddacda7ae20))
+
 ## 4.5.6
 
 _Published on 2025-03-20._

data/lib/appsignal/internal_errors.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Appsignal
+  # @api private
+  class InternalError < StandardError; end
+
+  # @api private
+  class NotStartedError < InternalError
+    MESSAGE = <<~MESSAGE
+      The AppSignal Ruby gem was not started!
+
+      This error was raised by calling `Appsignal.check_if_started!`
+    MESSAGE
+
+    def message
+      MESSAGE
+    end
+  end
+end

data/lib/appsignal/version.rb

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

data/lib/appsignal.rb

@@ -62,6 +62,19 @@ module Appsignal
     #   @see start
     attr_writer :internal_logger
 
+    # Returns the error that was encountered while loading the `appsignal.rb`
+    # config file.
+    #
+    # It does not include any error that occurred while loading the
+    # `appsignal.yml` file.
+    #
+    # If the value is `nil`, no error was encountered or AppSignal wasn't
+    # started yet.
+    #
+    # @return [NilClass/Exception]
+    attr_reader :config_error
+    alias config_error? config_error
+
     # @api private
     def testing?
       false
@@ -483,6 +496,31 @@ module Appsignal
       defined?(@dsl_config_file_loaded) ? true : false
     end
 
+    # Check if the AppSignal Ruby gem has started successfully.
+    #
+    # If it has not (yet) started or encountered an error in the
+    # `config/appsignal.rb` config file during start up that prevented it from
+    # starting, it will raise a {Appsignal::NotStartedError}.
+    #
+    # If there an error raised from the config file, it will include it as the
+    # error cause of the raised error.
+    #
+    # @raise [Appsignal::NotStartedError]
+    # @return [void]
+    def check_if_started!
+      return if started?
+
+      begin
+        raise config_error if config_error?
+      rescue
+        # Raise the NotStartedError and make the config error the error cause
+        raise NotStartedError, config_error
+      end
+
+      # Raise the NotStartedError as normal
+      raise NotStartedError
+    end
+
     private
 
     def params_match_loaded_config?(env_param, root_path_param)
@@ -508,7 +546,7 @@ module Appsignal
         @dsl_config_file_loaded = true
         require path
       rescue => error
-        @config_file_error = error
+        @config_error = error
         message = "Not starting AppSignal because an error occurred while " \
           "loading the AppSignal config file.\n" \
           "File: #{path.inspect}\n" \
@@ -527,7 +565,7 @@ module Appsignal
         end
 
         # Disable on config file error
-        config[:active] = false if defined?(@config_file_error)
+        config[:active] = false if defined?(@config_error)
 
         ENV.delete("_APPSIGNAL_CONFIG_FILE_CONTEXT")
         ENV.delete("_APPSIGNAL_CONFIG_FILE_ENV")
@@ -569,6 +607,7 @@ module Appsignal
   end
 end
 
+require "appsignal/internal_errors"
 require "appsignal/loaders"
 require "appsignal/sample_data"
 require "appsignal/environment"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 4.5.6
+  version: 4.5.7
 platform: ruby
 authors:
 - Robert Beekman
@@ -248,6 +248,7 @@ files:
 - lib/appsignal/integrations/sidekiq.rb
 - lib/appsignal/integrations/unicorn.rb
 - lib/appsignal/integrations/webmachine.rb
+- lib/appsignal/internal_errors.rb
 - lib/appsignal/loaders.rb
 - lib/appsignal/loaders/grape.rb
 - lib/appsignal/loaders/hanami.rb