appsignal 4.0.4 → 4.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91e5aad04da2524d3d2f4bd983ecd76cf1a33380a1bc2a6bf8aab1bd4d91db5b
-  data.tar.gz: c7d0582debd5c6d9ed29f2239a4baeed92ebdad46606c423e7537495b4dea3ab
+  metadata.gz: 51a7aea13c765d90524be570df11734a859538a18e2934fbf24e2631d9668817
+  data.tar.gz: 702e3e82530b79db9d8b26519d14cb9664d728a12f3d6c5999b63bfbda022fd1
 SHA512:
-  metadata.gz: a482b32ffa5d9ddc805a65507ab4d526f9c299969c86123743e8f0c4830af6f8abd3eecd805cb7c4eec6abcd474a2f97704ac9f5129825b7958245cc973ff6db
-  data.tar.gz: c0bf6a6ba6454fee105c6890db3154e03c0ad64c6b5ab325fb0186edf99066e923d7b6b4043ea4d77428155fbc58371ece1309517109437edc8cc265ffda554a
+  metadata.gz: 0a290f8c380748ff3ddaca671191d75277f592a296299fc2a21035ebab6afcd58dc2e8796ec197e155e5118b07bccaf2ae1d13c94253f1919388428e83fecd46
+  data.tar.gz: bf73768bfbbc2db0c042cb84ddc185362707f7b0b622d0565ce7a5142ddd0479daea6e76d7d87d9b7542ff01929b7a24cf566ca9036e3bd66a5fb0f2de1e622a

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 # AppSignal for Ruby gem Changelog
 
+## 4.0.5
+
+_Published on 2024-09-02._
+
+### Added
+
+- Report Puma low-level errors using the `lowlevel_error` reporter. This will report errors previously not caught by our instrumentation middleware. (patch [70cc21f4](https://github.com/appsignal/appsignal-ruby/commit/70cc21f49e19faa9fd2d12a051620cd48e036dcb))
+
+### Changed
+
+- Log a warning when loader defaults are added after AppSignal has already been configured.
+
+  ```ruby
+  # Bad
+  Appsignal.configure # or Appsignal.start
+  Appsignal.load(:sinatra)
+
+  # Good
+  Appsignal.load(:sinatra)
+  Appsignal.configure # or Appsignal.start
+  ```
+
+  (patch [0997dd9c](https://github.com/appsignal/appsignal-ruby/commit/0997dd9c0430123a697b8100785f5676163e20ef))
+- Rename the `path` and `method` transaction metadata to `request_path` and `request_method` to make it more clear what context this metadata is from. The `path` and `method` metadata will continue to be reported until the next major/minor version. (patch [fa314b5f](https://github.com/appsignal/appsignal-ruby/commit/fa314b5fb6fdfbf3e9746df377b0145cde0cfa36))
+- Internal change to how OpenTelemetry metrics are sent. (patch [e66d1d70](https://github.com/appsignal/appsignal-ruby/commit/e66d1d702d5010cb5b8084ba790b24d9e70a9e08))
+
+### Removed
+
+- Drop support for Puma version 2 and lower. (patch [4fab861c](https://github.com/appsignal/appsignal-ruby/commit/4fab861cae74b08aa71bf64e1b134ae4b1df1dff))
+
+### Fixed
+
+- Fix the error log message about our `at_exit` hook reporting no error on process exit when the process exits without an error. (patch [b71f3966](https://github.com/appsignal/appsignal-ruby/commit/b71f39661e9b05c10fa78b821ba0e45bde0c941b))
+
 ## 4.0.4
 
 _Published on 2024-08-29._

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.35.21",
+  "version" => "0.35.22",
   "mirrors" => [
     "https://appsignal-agent-releases.global.ssl.fastly.net",
     "https://d135dj0rjqvssy.cloudfront.net"
@@ -14,131 +14,131 @@ APPSIGNAL_AGENT_CONFIG = {
   "triples" => {
     "x86_64-darwin" => {
       "static" => {
-        "checksum" => "0e7b5bc5bf1e9903276b9fbe105af1128011613f9dc7ac7cedd4d230d92011bd",
+        "checksum" => "024cef88b24032d7187488c00682f92095da406d80ae642ac858e6318b840ad6",
         "filename" => "appsignal-x86_64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "56cc9aed70014b4fda2b30ff34819370cab2eb2bda588f59d7d86816d60a458f",
+        "checksum" => "ddddf86a951fe57f50e351a449df65d2c6428d703581b8ef5922fad23a688f1d",
         "filename" => "appsignal-x86_64-darwin-all-dynamic.tar.gz"
       }
     },
     "universal-darwin" => {
       "static" => {
-        "checksum" => "0e7b5bc5bf1e9903276b9fbe105af1128011613f9dc7ac7cedd4d230d92011bd",
+        "checksum" => "024cef88b24032d7187488c00682f92095da406d80ae642ac858e6318b840ad6",
         "filename" => "appsignal-x86_64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "56cc9aed70014b4fda2b30ff34819370cab2eb2bda588f59d7d86816d60a458f",
+        "checksum" => "ddddf86a951fe57f50e351a449df65d2c6428d703581b8ef5922fad23a688f1d",
         "filename" => "appsignal-x86_64-darwin-all-dynamic.tar.gz"
       }
     },
     "aarch64-darwin" => {
       "static" => {
-        "checksum" => "423178f0178f15d7f663451e45a318ca92d8f7cca136b5e985e753520b4ad3e4",
+        "checksum" => "b8dfebd77322a1f66e0f0acf1717c2583189016e9749286f61956a3ebbc1a16a",
         "filename" => "appsignal-aarch64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "c2c0aeba5ddb38584c8b1cc8b2ad2407431c71b944cd4dee47d45828b93619ae",
+        "checksum" => "d94ae45a9fa69566a30aaacf9f65bdf21b5d0d2a5990e4ba8f98dedc5956f62f",
         "filename" => "appsignal-aarch64-darwin-all-dynamic.tar.gz"
       }
     },
     "arm64-darwin" => {
       "static" => {
-        "checksum" => "423178f0178f15d7f663451e45a318ca92d8f7cca136b5e985e753520b4ad3e4",
+        "checksum" => "b8dfebd77322a1f66e0f0acf1717c2583189016e9749286f61956a3ebbc1a16a",
         "filename" => "appsignal-aarch64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "c2c0aeba5ddb38584c8b1cc8b2ad2407431c71b944cd4dee47d45828b93619ae",
+        "checksum" => "d94ae45a9fa69566a30aaacf9f65bdf21b5d0d2a5990e4ba8f98dedc5956f62f",
         "filename" => "appsignal-aarch64-darwin-all-dynamic.tar.gz"
       }
     },
     "arm-darwin" => {
       "static" => {
-        "checksum" => "423178f0178f15d7f663451e45a318ca92d8f7cca136b5e985e753520b4ad3e4",
+        "checksum" => "b8dfebd77322a1f66e0f0acf1717c2583189016e9749286f61956a3ebbc1a16a",
         "filename" => "appsignal-aarch64-darwin-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "c2c0aeba5ddb38584c8b1cc8b2ad2407431c71b944cd4dee47d45828b93619ae",
+        "checksum" => "d94ae45a9fa69566a30aaacf9f65bdf21b5d0d2a5990e4ba8f98dedc5956f62f",
         "filename" => "appsignal-aarch64-darwin-all-dynamic.tar.gz"
       }
     },
     "aarch64-linux" => {
       "static" => {
-        "checksum" => "bf94592c9640f89d0321acd5a0a9bd6951154c37f97f4778ddc2fc536203dc4f",
+        "checksum" => "1f21e14f31b9b91f5ce3da0dcb91224bc9f4a0d834ada75e87f396ca9838cf59",
         "filename" => "appsignal-aarch64-linux-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "8f8e60daae9ac10bae66fcf9ea33984046b5c92d911eae71ac1a8bdbaa7fa3eb",
+        "checksum" => "cf81cabcd216cf41d55ad2ad50f5eccfc1b3edc0dc78159973f3c0687f5ad86d",
         "filename" => "appsignal-aarch64-linux-all-dynamic.tar.gz"
       }
     },
     "i686-linux" => {
       "static" => {
-        "checksum" => "1553674c377a3e6fa56e31754d2af175e734531a44a76c680ff14cc49d4f0031",
+        "checksum" => "6111532d1958f9bbbdbea9104c509636d7b6d311090c609a0c134b68e6ef0dd6",
         "filename" => "appsignal-i686-linux-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "93e53b3cb2e2fb89cc3dff690da910fccb46503c3d58e4d3fb1a525fb222eea7",
+        "checksum" => "705fd88f0e2a4370766f64c93d123476d37f169190550cc3a2c85d34ce1b1893",
         "filename" => "appsignal-i686-linux-all-dynamic.tar.gz"
       }
     },
     "x86-linux" => {
       "static" => {
-        "checksum" => "1553674c377a3e6fa56e31754d2af175e734531a44a76c680ff14cc49d4f0031",
+        "checksum" => "6111532d1958f9bbbdbea9104c509636d7b6d311090c609a0c134b68e6ef0dd6",
         "filename" => "appsignal-i686-linux-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "93e53b3cb2e2fb89cc3dff690da910fccb46503c3d58e4d3fb1a525fb222eea7",
+        "checksum" => "705fd88f0e2a4370766f64c93d123476d37f169190550cc3a2c85d34ce1b1893",
         "filename" => "appsignal-i686-linux-all-dynamic.tar.gz"
       }
     },
     "x86_64-linux" => {
       "static" => {
-        "checksum" => "497d280dff46f7e72875af69f7b3756f3925bcad9e1922f030f818c8c5fa5d67",
+        "checksum" => "9e325faf63b7fe9b9804b4e8ce4bac7deefa6c47aec47faf47d90133d44dbaa5",
         "filename" => "appsignal-x86_64-linux-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "1b230cc3e80ef4013defc9d6e80713d1d318ed7f673121433d864b47e239ff73",
+        "checksum" => "11bac70bee7e620b31a26a01093a0c9ef01f7eb7508ac0c0a0eae27973cc643f",
         "filename" => "appsignal-x86_64-linux-all-dynamic.tar.gz"
       }
     },
     "x86_64-linux-musl" => {
       "static" => {
-        "checksum" => "2bcbc6b57a0298a97e6549e025ec092f8b3bd2b4e8f430fe7b040f7a2e274527",
+        "checksum" => "a76de00904eb40a61a7e68082cb06379aa13f61ec0d25ead828fd2ba022f9be9",
         "filename" => "appsignal-x86_64-linux-musl-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "7e89c78e9375d55b035f0e75e13d8dd278c2ddf4618fbe005c26f13d249b303f",
+        "checksum" => "b7b34ed9243059259a5fa10daa65adb6c4748e8b9715f64e6e559f88aa7aec03",
         "filename" => "appsignal-x86_64-linux-musl-all-dynamic.tar.gz"
       }
     },
     "aarch64-linux-musl" => {
       "static" => {
-        "checksum" => "f9bfd06e0107f3a491ff6009a1e8c0d6d2598c128e8ee84bd852a2f8d3e8e16b",
+        "checksum" => "2e197b99b7052357e466a7d93450d87cbdc07d0e5749630e98adcf7c7fad8936",
         "filename" => "appsignal-aarch64-linux-musl-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "187a9a8e58617a0f78077b412dee18351cc975af41500443d7450fc44f2f65d3",
+        "checksum" => "ace9ab040e4c412f9d6c0b7d2209388e81f40882f8719a67cc30c60e0bdc50ed",
         "filename" => "appsignal-aarch64-linux-musl-all-dynamic.tar.gz"
       }
     },
     "x86_64-freebsd" => {
       "static" => {
-        "checksum" => "cf8043c78e0e628cf0747dd57327d6c0ffd4147d3bff7b2426110fd2fada0960",
+        "checksum" => "0c263f693ba5c06373b9fb4062f14d2b6bf1ff33bc0d737abcccc77bab66a634",
         "filename" => "appsignal-x86_64-freebsd-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "072c2312aadf961c3f851552ee255db77f0c4050e47d438dd9f82e536b68bcd6",
+        "checksum" => "7545a50f4d127da466e87d9504df4911ed9f8b0ec67b86023e08f8a58ea2b8c2",
         "filename" => "appsignal-x86_64-freebsd-all-dynamic.tar.gz"
       }
     },
     "amd64-freebsd" => {
       "static" => {
-        "checksum" => "cf8043c78e0e628cf0747dd57327d6c0ffd4147d3bff7b2426110fd2fada0960",
+        "checksum" => "0c263f693ba5c06373b9fb4062f14d2b6bf1ff33bc0d737abcccc77bab66a634",
         "filename" => "appsignal-x86_64-freebsd-all-static.tar.gz"
       },
       "dynamic" => {
-        "checksum" => "072c2312aadf961c3f851552ee255db77f0c4050e47d438dd9f82e536b68bcd6",
+        "checksum" => "7545a50f4d127da466e87d9504df4911ed9f8b0ec67b86023e08f8a58ea2b8c2",
         "filename" => "appsignal-x86_64-freebsd-all-dynamic.tar.gz"
       }
     }

data/lib/appsignal/config.rb

@@ -15,6 +15,13 @@ module Appsignal
 
     # @api private
     def self.add_loader_defaults(name, env: nil, root_path: nil, **options)
+      if Appsignal.config
+        Appsignal.internal_logger.warn(
+          "The config defaults from the '#{name}' loader are ignored since " \
+            "the AppSignal config has already been initialized."
+        )
+      end
+
       loader_defaults << {
         :name => name,
         :env => env,

data/lib/appsignal/hooks/at_exit.rb

@@ -24,6 +24,7 @@ module Appsignal
       class AtExitCallback
         def self.call
           error = $! # rubocop:disable Style/SpecialGlobalVars
+          return unless error
           return if ignored_error?(error)
           return if Appsignal::Transaction.last_errors.include?(error)
 

data/lib/appsignal/hooks/puma.rb

@@ -7,10 +7,14 @@ module Appsignal
       register :puma
 
       def dependencies_present?
-        defined?(::Puma)
+        defined?(::Puma) &&
+          Gem::Version.new(Puma::Const::VERSION) >= Gem::Version.new("3.0.0")
       end
 
       def install
+        require "appsignal/integrations/puma"
+        ::Puma::Server.prepend(Appsignal::Integrations::PumaServer)
+
         return unless defined?(::Puma::Cluster)
 
         # For clustered mode with multiple workers

data/lib/appsignal/integrations/puma.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Appsignal
+  module Integrations
+    # @api private
+    module PumaServer
+      def lowlevel_error(error, env, response_status = 500)
+        response =
+          if method(:lowlevel_error).super_method.arity.abs == 3 # Puma >= 5
+            super
+          else # Puma <= 4
+            super(error, env)
+          end
+
+        unless PumaServerHelper.ignored_error?(error)
+          Appsignal.report_error(error) do |transaction|
+            Appsignal::Rack::ApplyRackRequest
+              .new(::Rack::Request.new(env))
+              .apply_to(transaction)
+            transaction.add_tags(
+              :reported_by => :puma_lowlevel_error,
+              :response_status => response_status
+            )
+          end
+        end
+
+        response
+      end
+    end
+
+    module PumaServerHelper
+      IGNORED_ERRORS = [
+        # Ignore internal Puma Client IO errors
+        # https://github.com/puma/puma/blob/9ee922d28e1fffd02c1d5480a9e13376f92f46a3/lib/puma/server.rb#L536-L544
+        "Puma::MiniSSL::SSLError",
+        "Puma::HttpParserError",
+        "Puma::HttpParserError501"
+      ].freeze
+
+      def self.ignored_error?(error)
+        IGNORED_ERRORS.include?(error.class.to_s)
+      end
+    end
+  end
+end

data/lib/appsignal/rack/abstract_middleware.rb

@@ -19,7 +19,6 @@ module Appsignal
         @app = app
         @options = options
         @request_class = options.fetch(:request_class, ::Rack::Request)
-        @params_method = options.fetch(:params_method, :params)
         @instrument_event_name = options.fetch(:instrument_event_name, nil)
         @report_errors = options.fetch(:report_errors, DEFAULT_ERROR_REPORTING)
       end
@@ -136,52 +135,9 @@ module Appsignal
       # Override this method to set metadata after the app is called.
       # Call `super` to also include the default set metadata.
       def add_transaction_metadata_after(transaction, request)
-        transaction.set_metadata("path", request.path)
-
-        request_method = request_method_for(request)
-        transaction.set_metadata("method", request_method) if request_method
-
-        transaction.add_params { params_for(request) }
-        transaction.add_session_data { session_data_for(request) }
-        transaction.add_headers do
-          request.env if request.respond_to?(:env)
-        end
-
-        queue_start = Appsignal::Rack::Utils.queue_start_from(request.env)
-        transaction.set_queue_start(queue_start) if queue_start
-      end
-
-      def params_for(request)
-        return unless request.respond_to?(@params_method)
-
-        request.send(@params_method)
-      rescue => error
-        Appsignal.internal_logger.error(
-          "Exception while fetching params from '#{@request_class}##{@params_method}': " \
-            "#{error.class} #{error}"
-        )
-        nil
-      end
-
-      def request_method_for(request)
-        request.request_method
-      rescue => error
-        Appsignal.internal_logger.error(
-          "Exception while fetching the HTTP request method: #{error.class}: #{error}"
-        )
-        nil
-      end
-
-      def session_data_for(request)
-        return unless request.respond_to?(:session)
-
-        request.session.to_h
-      rescue => error
-        Appsignal.internal_logger.error(
-          "Exception while fetching session data from '#{@request_class}': " \
-            "#{error.class} #{error}"
-        )
-        nil
+        Appsignal::Rack::ApplyRackRequest
+          .new(request, @options)
+          .apply_to(transaction)
       end
 
       def request_for(env)

data/lib/appsignal/rack/event_handler.rb

@@ -79,6 +79,8 @@ module Appsignal
             #
             # The EventHandler.on_finish callback should be called first, this is
             # just a fallback if that doesn't get called.
+            #
+            # One such scenario is when a Puma "lowlevel_error" occurs.
             Appsignal::Transaction.complete_current!
           end
           transaction.start_event

data/lib/appsignal/rack/hanami_middleware.rb

@@ -5,13 +5,17 @@ module Appsignal
     # @api private
     class HanamiMiddleware < AbstractMiddleware
       def initialize(app, options = {})
-        options[:params_method] ||= :params
+        options[:params_method] = nil
         options[:instrument_event_name] ||= "process_action.hanami"
         super
       end
 
       private
 
+      def add_transaction_metadata_after(transaction, request)
+        transaction.add_params { params_for(request) }
+      end
+
       def params_for(request)
         ::Hanami::Action.params_class.new(request.env).to_h
       end

data/lib/appsignal/rack.rb

@@ -37,5 +37,73 @@ module Appsignal
         end
       end
     end
+
+    class ApplyRackRequest
+      attr_reader :request, :options
+
+      def initialize(request, options = {})
+        @request = request
+        @options = options
+        @params_method = options.fetch(:params_method, :params)
+      end
+
+      def apply_to(transaction)
+        request_path = request.path
+        transaction.set_metadata("request_path", request_path)
+        # TODO: Remove in next major/minor version
+        transaction.set_metadata("path", request_path)
+
+        request_method = request_method_for(request)
+        if request_method
+          transaction.set_metadata("request_method", request_method)
+          # TODO: Remove in next major/minor version
+          transaction.set_metadata("method", request_method)
+        end
+
+        transaction.add_params { params_for(request) }
+        transaction.add_session_data { session_data_for(request) }
+        transaction.add_headers do
+          request.env if request.respond_to?(:env)
+        end
+
+        queue_start = Appsignal::Rack::Utils.queue_start_from(request.env)
+        transaction.set_queue_start(queue_start) if queue_start
+      end
+
+      private
+
+      def params_for(request)
+        return if !@params_method || !request.respond_to?(@params_method)
+
+        request.send(@params_method)
+      rescue => error
+        Appsignal.internal_logger.error(
+          "Exception while fetching params from '#{request.class}##{@params_method}': " \
+            "#{error.class} #{error}"
+        )
+        nil
+      end
+
+      def request_method_for(request)
+        request.request_method
+      rescue => error
+        Appsignal.internal_logger.error(
+          "Exception while fetching the HTTP request method: #{error.class}: #{error}"
+        )
+        nil
+      end
+
+      def session_data_for(request)
+        return unless request.respond_to?(:session)
+
+        request.session.to_h
+      rescue => error
+        Appsignal.internal_logger.error(
+          "Exception while fetching session data from '#{request.class}': " \
+            "#{error.class} #{error}"
+        )
+        nil
+      end
+    end
   end
 end

data/lib/appsignal/version.rb

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