appsignal 4.5.5 → 4.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41e086d2d7476bbb4d6a885bcd12d1d7355cef5ee121441e920a9d36d84030c2
-  data.tar.gz: 2b94e8d395a231edc08b5c5865731c31f5a1f4cb7d112394ab50df843ddd6f0a
+  metadata.gz: cb6b257bdb500ffff85f0aaf2c4a63c85ef1d454df501973b99c3871869564fd
+  data.tar.gz: 9f62ae7ee6fd67935b079ece3d8c5ef827396b654b675754bcaa9a323ca8141e
 SHA512:
-  metadata.gz: 052e339a0d8ee03f4f363573569c3abebeedb70a62dfc212c3c92b82212e50d07c9c302b550114d2368cb5daf51e2d6119a2b6e059e8d3ab8ba2aabf2e6e4ae8
-  data.tar.gz: '0178e5a44687ee7c497e4c5a464cb6524645d4eade5b0b21150519749273c2602227a8a16f3c4109a96e22c95f607240b216e5665bede1b6cdcf08a9a16b4ac5'
+  metadata.gz: 2a58b34251fd0eef84bf5cfb0f275f4e974d3e48eccdfb10426acda5ec6ba39c6f33377b3f77bdfb7c0772f2bdc510ce0a2f5e829649c67b203f105ae1360c41
+  data.tar.gz: d96563953abcb4614df3325b486ba23b6e25458d1649661a977e45ea06e24bec7bfa79f21295ed901d466313b3d8753f1d91d3585f20c166388b6006cef000cf

data/CHANGELOG.md

@@ -1,5 +1,50 @@
 # 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._
+
+### Added
+
+- Add the Logger `<<` method. This improves our compatibility with Ruby's Logger class implementation, making it usable in more scenarios. (patch [e09a78a4](https://github.com/appsignal/appsignal-ruby/commit/e09a78a425607852b5e12adf5c9ddb718811b09f))
+
+### Changed
+
+- Explicitly return `nil` from public methods with no usable return value. We want to avoid the situation where `Appsignal.start` happens to return `true` and it is thought to mean that the gem started successfully.
+
+  Methods updated:
+
+  - `Appsignal.start`
+  - `Appsignal.stop`
+  - `Appsignal.configure`
+  - `Appsignal.forked`
+  - `Appsignal.load`
+
+  (patch [93c304ee](https://github.com/appsignal/appsignal-ruby/commit/93c304eecd80992648d9e836a52e28c4e78958ee))
+- Differentiate between `process_request.rack` events. Add the callback that triggered the event in the event title for debugging purposes. (patch [4393b2fa](https://github.com/appsignal/appsignal-ruby/commit/4393b2faeac6d8be6390eef158b3cda133b99915))
+- Improve the log message for the uneven timestack error. This will help the AppSignal team debug issues where events get closed when all events are already closed. (patch [d2d4863f](https://github.com/appsignal/appsignal-ruby/commit/d2d4863fc8421eabb4c88e945bb24243a56535d3))
+
 ## 4.5.5
 
 _Published on 2025-03-14._

data/ext/agent.rb

@@ -6,7 +6,7 @@
 # Modifications to this file will be overwritten with the next agent release.
 
 APPSIGNAL_AGENT_CONFIG = {
-  "version" => "0.36.2",
+  "version" => "0.36.3",
   "mirrors" => [
     "https://d135dj0rjqvssy.cloudfront.net",
     "https://appsignal-agent-releases.global.ssl.fastly.net"
@@ -14,131 +14,131 @@ APPSIGNAL_AGENT_CONFIG = {
   "triples" => {
     "x86_64-darwin" => {
       "static" => {
-        "checksum" => "838d9a9e3f90933dcd1a7764e8d65bc3510915fcf987bebacfa97700b38fde72",
+        "checksum" => "ed3454688e7cd976aec81a7826900027ce6508f790e7f53c97484e40c128bd36",
         "filename" => "appsignal-x86_64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "0bf762d2a4ccaa89320f6139d8bbe8c5e99340ad2eee1db7253a78c195f02381",
+        "checksum" => "b559c97425ffef908258a5d2ea67477e364be90dc8e28b5747776c340c7b8c65",
         "filename" => "appsignal-x86_64-darwin-all-dynamic.tar.gz"
       }
     },
     "universal-darwin" => {
       "static" => {
-        "checksum" => "838d9a9e3f90933dcd1a7764e8d65bc3510915fcf987bebacfa97700b38fde72",
+        "checksum" => "ed3454688e7cd976aec81a7826900027ce6508f790e7f53c97484e40c128bd36",
         "filename" => "appsignal-x86_64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "0bf762d2a4ccaa89320f6139d8bbe8c5e99340ad2eee1db7253a78c195f02381",
+        "checksum" => "b559c97425ffef908258a5d2ea67477e364be90dc8e28b5747776c340c7b8c65",
         "filename" => "appsignal-x86_64-darwin-all-dynamic.tar.gz"
       }
     },
     "aarch64-darwin" => {
       "static" => {
-        "checksum" => "c18a2e088c059a105a7f74a598a71f2916fea52a24eaf70693badf45f5f50c17",
+        "checksum" => "43f66e1da26e9b15050392105868f8c99e28e89d7831a0e09d8d8b54abaa24d2",
         "filename" => "appsignal-aarch64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "ea1dec0168b0344c30a8a018c20aced197f7a52c1e68a4d78f4a143d976c5f72",
+        "checksum" => "f6d9d48fa91873ffd7f54af94bb463c266bbca9d86f2ec4253b43b7290f6f479",
         "filename" => "appsignal-aarch64-darwin-all-dynamic.tar.gz"
       }
     },
     "arm64-darwin" => {
       "static" => {
-        "checksum" => "c18a2e088c059a105a7f74a598a71f2916fea52a24eaf70693badf45f5f50c17",
+        "checksum" => "43f66e1da26e9b15050392105868f8c99e28e89d7831a0e09d8d8b54abaa24d2",
         "filename" => "appsignal-aarch64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "ea1dec0168b0344c30a8a018c20aced197f7a52c1e68a4d78f4a143d976c5f72",
+        "checksum" => "f6d9d48fa91873ffd7f54af94bb463c266bbca9d86f2ec4253b43b7290f6f479",
         "filename" => "appsignal-aarch64-darwin-all-dynamic.tar.gz"
       }
     },
     "arm-darwin" => {
       "static" => {
-        "checksum" => "c18a2e088c059a105a7f74a598a71f2916fea52a24eaf70693badf45f5f50c17",
+        "checksum" => "43f66e1da26e9b15050392105868f8c99e28e89d7831a0e09d8d8b54abaa24d2",
         "filename" => "appsignal-aarch64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "ea1dec0168b0344c30a8a018c20aced197f7a52c1e68a4d78f4a143d976c5f72",
+        "checksum" => "f6d9d48fa91873ffd7f54af94bb463c266bbca9d86f2ec4253b43b7290f6f479",
         "filename" => "appsignal-aarch64-darwin-all-dynamic.tar.gz"
       }
     },
     "aarch64-linux" => {
       "static" => {
-        "checksum" => "8008e7ca60e301e6dd4a7ec18ce68f1dedff4e40c6029af368a9f35ac95c4e70",
+        "checksum" => "287caad6b86b5d2bfe36ae87179d8f587e0cb76c80cdf4f3300b32e37553d9cb",
         "filename" => "appsignal-aarch64-linux-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "c191e248892cbd8854cc9c2a41cf66495e430de1f734d2cf1c28ef9753978dc6",
+        "checksum" => "6db055791a2b588edb4394afc2978309e4fea8ac5c3b14cd3b25913b6fc183c3",
         "filename" => "appsignal-aarch64-linux-all-dynamic.tar.gz"
       }
     },
     "i686-linux" => {
       "static" => {
-        "checksum" => "cc52418f2e828ce9d5ab908e5691fdd4e5ad20264af19a7f00de1678bea57711",
+        "checksum" => "816ca2ec568680ec8e44ee8dfa1a014062c4a8969883ddb4533610489eb689b0",
         "filename" => "appsignal-i686-linux-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "61cd5c686cf1de3c547ab043773ed1fc11c2cb7386f0767f6c8c6b88dd682266",
+        "checksum" => "a2f5e885812510a77a36c0044150e321a3cca1354310d4b9be6f0ef7971c93e2",
         "filename" => "appsignal-i686-linux-all-dynamic.tar.gz"
       }
     },
     "x86-linux" => {
       "static" => {
-        "checksum" => "cc52418f2e828ce9d5ab908e5691fdd4e5ad20264af19a7f00de1678bea57711",
+        "checksum" => "816ca2ec568680ec8e44ee8dfa1a014062c4a8969883ddb4533610489eb689b0",
         "filename" => "appsignal-i686-linux-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "61cd5c686cf1de3c547ab043773ed1fc11c2cb7386f0767f6c8c6b88dd682266",
+        "checksum" => "a2f5e885812510a77a36c0044150e321a3cca1354310d4b9be6f0ef7971c93e2",
         "filename" => "appsignal-i686-linux-all-dynamic.tar.gz"
       }
     },
     "x86_64-linux" => {
       "static" => {
-        "checksum" => "93465fd24205f2d1576d7318d6cc8da06e5f474236bc6ac3038468d3c5146c9c",
+        "checksum" => "6b48d90f89a3e687e440147d18717913857409fff66022b29a4107379f1d0903",
         "filename" => "appsignal-x86_64-linux-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "e02842c8f92dca81449b13165aece5cb7a35b8945903715d80768524aedfdf4f",
+        "checksum" => "141cc47e66c18782a9c6c7d175b54e681034f6f39b6e871d5e60160f5d1a1f3e",
         "filename" => "appsignal-x86_64-linux-all-dynamic.tar.gz"
       }
     },
     "x86_64-linux-musl" => {
       "static" => {
-        "checksum" => "21478e01005635987df8bc35375d6f363d03ea46feda0fa88da714de9282d71b",
+        "checksum" => "9c74fbfa5bdef7df3d4fc6f8da73635b351c71b8d6e4c1ca9916b2f3dae0d7e7",
         "filename" => "appsignal-x86_64-linux-musl-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "a8ff342cf20763298070276eda4fbc6fb3fe9ac0ffd7ef8de5e2791ebaae9aaa",
+        "checksum" => "576853c59aab8f7542e9bb9a612df626f6b56e78d1ce7c6fc8c725db4417a4a1",
         "filename" => "appsignal-x86_64-linux-musl-all-dynamic.tar.gz"
       }
     },
     "aarch64-linux-musl" => {
       "static" => {
-        "checksum" => "bf85fe3dd65a6a85e8004eee8269af6f62c4dafa2c39ef4fe50958e3dc7c4d0e",
+        "checksum" => "7bbbbbf58db496cce04f68d40e3077cf382196e77e1b6a2ad58dd0e32442a828",
         "filename" => "appsignal-aarch64-linux-musl-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "85ccfbcf75c64c320b9466c8c67fcc774566a839579f33d9c51780357b730468",
+        "checksum" => "6f12971462b0dbd4a4f6d8987a96fd25538e35e0c783b3afbe2317a866073d7a",
         "filename" => "appsignal-aarch64-linux-musl-all-dynamic.tar.gz"
       }
     },
     "x86_64-freebsd" => {
       "static" => {
-        "checksum" => "7355fcf72d6141f7e411351ff0c7c4beffc3c2a3bfaee70732ad301ce24b4bfa",
+        "checksum" => "a3f0c1e66e1e37a5f153a6dcb4c8eae63a038d54f838a358eabcd5db5c11b02f",
         "filename" => "appsignal-x86_64-freebsd-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "0a286f1f5c534e570589874f82b2c70c2374ecdddfeafcbdae8eafe789ec8c61",
+        "checksum" => "a141eaa327e77e3b1b9fb34798aff103f9098b1b4aed20e68e9c505aae645129",
         "filename" => "appsignal-x86_64-freebsd-all-dynamic.tar.gz"
       }
     },
     "amd64-freebsd" => {
       "static" => {
-        "checksum" => "7355fcf72d6141f7e411351ff0c7c4beffc3c2a3bfaee70732ad301ce24b4bfa",
+        "checksum" => "a3f0c1e66e1e37a5f153a6dcb4c8eae63a038d54f838a358eabcd5db5c11b02f",
         "filename" => "appsignal-x86_64-freebsd-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "0a286f1f5c534e570589874f82b2c70c2374ecdddfeafcbdae8eafe789ec8c61",
+        "checksum" => "a141eaa327e77e3b1b9fb34798aff103f9098b1b4aed20e68e9c505aae645129",
         "filename" => "appsignal-x86_64-freebsd-all-dynamic.tar.gz"
       }
     }

data/lib/appsignal/config.rb

@@ -442,6 +442,7 @@ module Appsignal
       merge(options)
     end
 
+    # @return [void]
     # @api private
     def validate
       # Apply any overrides for invalid settings.
@@ -472,6 +473,7 @@ module Appsignal
     # of the Ruby app.
     #
     # @api private
+    # @return [void]
     # @since 4.0.0
     def freeze
       super

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

@@ -159,6 +159,17 @@ module Appsignal
       add_with_attributes(FATAL, message, @group, attributes)
     end
 
+    # Log an info level message
+    #
+    # Returns the number of characters written.
+    #
+    # @param message Message to log
+    # @return [Integer]
+    def <<(message)
+      add(Logger::INFO, message)
+      message.length
+    end
+
     # When using ActiveSupport::TaggedLogging without the broadcast feature,
     # the passed logger is required to respond to the `silence` method.
     #

data/lib/appsignal/rack/event_handler.rb

@@ -68,7 +68,7 @@ module Appsignal
 
             Appsignal::Rack::EventHandler
               .safe_execution("Appsignal::Rack::EventHandler's after_reply") do
-              transaction.finish_event("process_request.rack", "", "")
+              transaction.finish_event("process_request.rack", "callback: after_reply", "")
               queue_start = Appsignal::Rack::Utils.queue_start_from(request.env)
               transaction.set_queue_start(queue_start) if queue_start
             end
@@ -111,7 +111,7 @@ module Appsignal
         return unless transaction
 
         self.class.safe_execution("Appsignal::Rack::EventHandler#on_finish") do
-          transaction.finish_event("process_request.rack", "", "")
+          transaction.finish_event("process_request.rack", "callback: on_finish", "")
           transaction.add_params_if_nil { request.params }
           transaction.add_headers_if_nil { request.env }
           transaction.add_session_data_if_nil do

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "4.5.5"
+  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
@@ -145,11 +158,12 @@ module Appsignal
       else
         internal_logger.error("Not starting, no valid config for this environment")
       end
+      nil
     end
 
     # PRIVATE METHOD. DO NOT USE.
     #
-    # @param env_var [String, NilClass] Used by diagnose CLI to pass through
+    # @param env_param [String, NilClass] Used by diagnose CLI to pass through
     #   the environment CLI option value.
     # @api private
     def _load_config!(env_param = nil, &block)
@@ -224,6 +238,7 @@ module Appsignal
         Appsignal::Probes.stop
         Appsignal::CheckIn.stop
       end.join
+      nil
     end
 
     # Configure the AppSignal Ruby gem using a DSL.
@@ -328,14 +343,17 @@ module Appsignal
 
       yield config_dsl
       config.merge_dsl_options(config_dsl.dsl_options)
+      nil
     end
 
+    # @return [void]
     def forked
       return unless active?
 
       Appsignal._start_logger
       internal_logger.debug("Forked process, resubscribing and restarting extension")
       Appsignal::Extension.start
+      nil
     end
 
     # Load an AppSignal integration.
@@ -368,6 +386,7 @@ module Appsignal
     # @since 3.12.0
     def load(integration_name)
       Loaders.load(integration_name)
+      nil
     end
 
     # @api private
@@ -477,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)
@@ -502,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" \
@@ -521,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")
@@ -563,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.5
+  version: 4.5.7
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-14 00:00:00.000000000 Z
+date: 2025-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -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
@@ -316,7 +317,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com