appsignal 4.7.5 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38a8a53409f019647d09800fe8aece6217c73805d07bb3165e65352c7e9a3ad1
-  data.tar.gz: a6a427ea9312fd4c1557e73682a79dd656c835255d162dd3bc600ae6c079695c
+  metadata.gz: 374973a9b6a7ecaaec8b95c1aabcf738d2426364f6102e3e625d03c649524f4d
+  data.tar.gz: 8b8c0e6483788d34adcbd3d0d824bd0622f422500e45b2731ff513ab2f0b0909
 SHA512:
-  metadata.gz: a61228427035353534e9a91cd2ec2f0e93bc4ffbe3d384b181f723763cef3ac94210af5235d65ba8e3e3cb93edfd9bedd334004341f064060ffd5cca1d75bd49
-  data.tar.gz: 3ed5dff0b9e0478a6382a9828787cdef22adf312e34ca9d3f56cb9fce001d7e3d68266d56fbd8ac13d36dad4adee148a48c1d7190ddfeaa261e3a1fa14f0670b
+  metadata.gz: cd4637984afd4ec3fce96f18b9418f07c5dc79eea2f416f90ec6b9b59d5b36612e4e308c8bc25f9451e154c30c49e55c28651758d1023bc2ed9bdda266e00f8e
+  data.tar.gz: 89dc007d4151e75900412840cf606e73ca2633c17b53221364c65ac903014a122fdf18498a84b63c2f525bafbc172bcbd47b7235884254d45bc56c389e424e50

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # AppSignal for Ruby gem Changelog
 
+## 4.8.0
+
+_Published on 2025-12-04._
+
+### Added
+
+- Report events from Rails 8.1's Structured Event Reporting (`ActiveSupport::EventReporter`) as logs. (minor [8c55fee2](https://github.com/appsignal/appsignal-ruby/commit/8c55fee2364b19515f66084a3553b978ef756d63))
+
+### Fixed
+
+- Fix ActiveSupport::Notifications event instrumentation on Rails 8.1 when no listeners are registered. (patch [71a9caae](https://github.com/appsignal/appsignal-ruby/commit/71a9caaecaee3043b33d49d4a295a1b28d4962e0))
+
 ## 4.7.5
 
 _Published on 2025-10-17._

data/build_matrix.yml

@@ -115,9 +115,10 @@ matrix:
       - "rails-7.1"
       - "rails-7.2"
       - "rails-8.0"
-      # - "rails-8.1"
+      - "rails-8.1"
 
   ruby:
+    - ruby: "4.0.0-preview2"
     - ruby: "3.5.0-preview1"
     - ruby: "3.4.1"
     - ruby: "3.3.4"
@@ -132,9 +133,19 @@ matrix:
     - gem: "capistrano2"
     - gem: "capistrano3"
     - gem: "code_ownership"
+      only:
+        ruby:
+          - "3.4.1"
+          # - "3.3.4"
+          - "3.2.5"
+          - "3.1.6"
+          - "3.0.7"
+          - "2.7.8"
+          - "jruby-9.4.7.0"
     - gem: "dry-monitor"
       only:
         ruby:
+          - "4.0.0-preview2"
           - "3.5.0-preview1"
           - "3.4.1"
           - "3.3.4"
@@ -171,9 +182,13 @@ matrix:
     - gem: "http5"
     - gem: "ownership"
     - gem: "padrino"
+      exclude:
+        ruby:
+          - "4.0.0-preview2"
     - gem: "psych-3"
       only:
         ruby:
+          - "4.0.0-preview2"
           - "3.5.0-preview1"
           - "3.4.1"
           - "3.3.4"
@@ -184,6 +199,7 @@ matrix:
     - gem: "psych-4"
       only:
         ruby:
+          - "4.0.0-preview2"
           - "3.5.0-preview1"
           - "3.4.1"
           - "3.3.4"
@@ -211,6 +227,7 @@ matrix:
     - gem: "rails-7.0"
       only:
         ruby:
+          - "4.0.0-preview2"
           - "3.5.0-preview1"
           - "3.4.1"
           - "3.3.4"
@@ -222,6 +239,7 @@ matrix:
     - gem: "rails-7.1"
       only:
         ruby:
+          - "4.0.0-preview2"
           - "3.5.0-preview1"
           - "3.4.1"
           - "3.3.4"
@@ -232,6 +250,7 @@ matrix:
     - gem: "rails-7.2"
       only:
         ruby:
+          - "4.0.0-preview2"
           - "3.5.0-preview1"
           - "3.4.1"
           - "3.3.4"
@@ -239,19 +258,20 @@ matrix:
           - "3.1.6"
           - "jruby-9.4.7.0"
     - gem: "rails-8.0"
+      only:
+        ruby:
+          - "4.0.0-preview2"
+          - "3.5.0-preview1"
+          - "3.4.1"
+          - "3.3.4"
+          - "3.2.5"
+    - gem: "rails-8.1"
       only:
         ruby:
           - "3.5.0-preview1"
           - "3.4.1"
           - "3.3.4"
           - "3.2.5"
-    # - gem: "rails-8.1"
-    #   only:
-    #     ruby:
-    #       - "3.5.0-preview1"
-    #       - "3.4.1"
-    #       - "3.3.4"
-    #       - "3.2.5"
     - gem: "sequel"
     - gem: "sinatra"
     - gem: "webmachine2"
@@ -260,10 +280,12 @@ matrix:
     - gem: "sidekiq-7"
       only:
         ruby:
+          - "4.0.0-preview2"
           - "3.5.0-preview1"
           - "3.4.1"
     - gem: "sidekiq-8"
       only:
         ruby:
+          - "4.0.0-preview2"
           - "3.5.0-preview1"
           - "3.4.1"

data/lib/appsignal/config.rb

@@ -102,6 +102,7 @@ module Appsignal
       :enable_gvl_global_timer => true,
       :enable_gvl_waiting_threads => true,
       :enable_rails_error_reporter => true,
+      :enable_active_support_event_log_reporter => true,
       :enable_rake_performance_instrumentation => false,
       :endpoint => "https://push.appsignal.com",
       :files_world_accessible => true,
@@ -184,6 +185,8 @@ module Appsignal
       :enable_gvl_global_timer => "APPSIGNAL_ENABLE_GVL_GLOBAL_TIMER",
       :enable_gvl_waiting_threads => "APPSIGNAL_ENABLE_GVL_WAITING_THREADS",
       :enable_rails_error_reporter => "APPSIGNAL_ENABLE_RAILS_ERROR_REPORTER",
+      :enable_active_support_event_log_reporter =>
+        "APPSIGNAL_ENABLE_ACTIVE_SUPPORT_EVENT_LOG_REPORTER",
       :enable_rake_performance_instrumentation =>
         "APPSIGNAL_ENABLE_RAKE_PERFORMANCE_INSTRUMENTATION",
       :files_world_accessible => "APPSIGNAL_FILES_WORLD_ACCESSIBLE",
@@ -802,6 +805,8 @@ module Appsignal
       #   @return [Boolean] Configure whether GVL waiting threads instrumentation is enabled
       # @!attribute [rw] enable_rails_error_reporter
       #   @return [Boolean] Configure whether Rails error reporter integration is enabled
+      # @!attribute [rw] enable_active_support_event_log_reporter
+      #   @return [Boolean] Configure whether ActiveSupport::EventReporter integration is enabled
       # @!attribute [rw] enable_rake_performance_instrumentation
       #   @return [Boolean] Configure whether Rake performance instrumentation is enabled
       # @!attribute [rw] files_world_accessible

data/lib/appsignal/hooks/active_support_event_reporter.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Appsignal
+  class Hooks
+    # @!visibility private
+    class ActiveSupportEventReporterHook < Appsignal::Hooks::Hook
+      register :active_support_event_reporter
+
+      def dependencies_present?
+        defined?(::Rails) &&
+          defined?(::ActiveSupport::EventReporter) &&
+          Appsignal.config &&
+          Appsignal.config[:enable_active_support_event_log_reporter]
+      end
+
+      def install
+        require "appsignal/integrations/active_support_event_reporter"
+        Rails.event.subscribe(Appsignal::Integrations::ActiveSupportEventReporter::Subscriber.new)
+      end
+    end
+  end
+end

data/lib/appsignal/hooks/active_support_notifications.rb

@@ -29,6 +29,13 @@ module Appsignal
             parent_integration_module::StartFinishHandlerIntegration,
             ::ActiveSupport::Notifications::Fanout::Handle
           )
+
+          if defined?(::ActiveSupport::Notifications::Fanout::NullHandle)
+            install_module(
+              parent_integration_module::BuildHandleFanoutIntegration,
+              ::ActiveSupport::Notifications::Fanout
+            )
+          end
         else
           instrumenter = ::ActiveSupport::Notifications::Instrumenter
 

data/lib/appsignal/hooks/code_ownership.rb

@@ -8,7 +8,6 @@ module Appsignal
 
       def dependencies_present?
         defined?(::CodeOwnership) &&
-          Gem::Specification.find_by_name("code_ownership").version < Gem::Version.new("2.0") &&
           Appsignal.config && Appsignal.config[:instrument_code_ownership]
       end
 

data/lib/appsignal/hooks.rb

@@ -79,6 +79,7 @@ require "appsignal/hooks/action_cable"
 require "appsignal/hooks/action_mailer"
 require "appsignal/hooks/active_job"
 require "appsignal/hooks/active_support_notifications"
+require "appsignal/hooks/active_support_event_reporter"
 require "appsignal/hooks/celluloid"
 require "appsignal/hooks/code_ownership"
 require "appsignal/hooks/delayed_job"

data/lib/appsignal/integrations/active_support_event_reporter.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Appsignal
+  module Integrations
+    # @!visibility private
+    module ActiveSupportEventReporter
+      class Subscriber
+        def initialize
+          @logger = Appsignal::Logger.new("rails_events")
+        end
+
+        def emit(event)
+          @logger.info(event[:name], event[:payload])
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/integrations/active_support_notifications.rb

@@ -4,98 +4,97 @@ module Appsignal
   module Integrations
     # @!visibility private
     module ActiveSupportNotificationsIntegration
-      BANG = "!"
+      class << self
+        BANG = "!"
 
-      module InstrumentIntegration
-        def instrument(name, payload = {}, &block)
+        def start_event(name)
           # Events that start with a bang are internal to Rails
-          instrument_this = name[0] != ActiveSupportNotificationsIntegration::BANG
-
+          instrument_this = name[0] != BANG
           Appsignal::Transaction.current.start_event if instrument_this
+        end
 
+        def finish_event(name, payload = {})
+          # Events that start with a bang are internal to Rails
+          instrument_this = name[0] != BANG
+          return unless instrument_this
+
+          title, body, body_format = Appsignal::EventFormatter.format(name, payload)
+          Appsignal::Transaction.current.finish_event(
+            name.to_s,
+            title,
+            body,
+            body_format
+          )
+        end
+      end
+
+      module InstrumentIntegration
+        def instrument(name, payload = {}, &block)
+          ActiveSupportNotificationsIntegration.start_event(name)
           super
         ensure
-          if instrument_this
-            title, body, body_format = Appsignal::EventFormatter.format(name, payload)
-            Appsignal::Transaction.current.finish_event(
-              name.to_s,
-              title,
-              body,
-              body_format
-            )
-          end
+          ActiveSupportNotificationsIntegration.finish_event(name, payload)
         end
       end
 
       module StartFinishIntegration
         def start(name, payload = {})
-          # Events that start with a bang are internal to Rails
-          instrument_this = name[0] != ActiveSupportNotificationsIntegration::BANG
-
-          Appsignal::Transaction.current.start_event if instrument_this
-
+          ActiveSupportNotificationsIntegration.start_event(name)
           super
         end
 
         def finish(name, payload = {})
-          # Events that start with a bang are internal to Rails
-          instrument_this = name[0] != ActiveSupportNotificationsIntegration::BANG
-
-          if instrument_this
-            title, body, body_format = Appsignal::EventFormatter.format(name, payload)
-            Appsignal::Transaction.current.finish_event(
-              name.to_s,
-              title,
-              body,
-              body_format
-            )
-          end
-
+          ActiveSupportNotificationsIntegration.finish_event(name, payload)
           super
         end
       end
 
       module StartFinishHandlerIntegration
         def start
-          instrument_this = @name[0] != ActiveSupportNotificationsIntegration::BANG
-
-          Appsignal::Transaction.current.start_event if instrument_this
+          ActiveSupportNotificationsIntegration.start_event(@name)
           super
         end
 
         def finish_with_values(name, id, payload = {})
-          # Events that start with a bang are internal to Rails
-          instrument_this = name[0] != ActiveSupportNotificationsIntegration::BANG
-
-          if instrument_this
-            title, body, body_format = Appsignal::EventFormatter.format(name, payload)
-            Appsignal::Transaction.current.finish_event(
-              name.to_s,
-              title,
-              body,
-              body_format
-            )
-          end
-
+          ActiveSupportNotificationsIntegration.finish_event(name, payload)
           super
         end
       end
 
-      module FinishStateIntegration
-        def finish_with_state(listeners_state, name, payload = {})
-          # Events that start with a bang are internal to Rails
-          instrument_this = name[0] != ActiveSupportNotificationsIntegration::BANG
-
-          if instrument_this
-            title, body, body_format = Appsignal::EventFormatter.format(name, payload)
-            Appsignal::Transaction.current.finish_event(
-              name.to_s,
-              title,
-              body,
-              body_format
-            )
+      class NullHandleIntegration
+        def initialize(name, _id, payload)
+          @name = name
+          @payload = payload
+        end
+
+        def start
+          ActiveSupportNotificationsIntegration.start_event(@name)
+        end
+
+        def finish
+          finish_with_values(@name, nil, @payload)
+        end
+
+        def finish_with_values(name, _id, payload)
+          ActiveSupportNotificationsIntegration.finish_event(name, payload)
+        end
+      end
+
+      module BuildHandleFanoutIntegration
+        def build_handle(name, id, payload)
+          handle = super
+
+          if handle == ::ActiveSupport::Notifications::Fanout::NullHandle
+            NullHandleIntegration.new(name, id, payload)
+          else
+            handle
           end
+        end
+      end
 
+      module FinishStateIntegration
+        def finish_with_state(listeners_state, name, payload = {})
+          ActiveSupportNotificationsIntegration.finish_event(name, payload)
           super
         end
       end

data/lib/appsignal/logger.rb

@@ -228,6 +228,58 @@ module Appsignal
     end
 
     # Adds a logger to broadcast log messages to.
+    #
+    # This implementation of the broadcasting logic exists here in the
+    # AppSignal Ruby gem, because it doesn't work in Rails using tagged logging.
+    # It would log a log line as many times as there are `Rails.logger.tagged`
+    # calls wrapping it.
+    #
+    # For example, this setup with one log line:
+    #
+    # ```ruby
+    # appsignal_logger = Appsignal::Logger.new("rails")
+    # Rails.logger.broadcast_to(appsignal_logger)
+    #
+    # Rails.logger.tagged("my tag") do
+    #   Rails.logger.tagged("my nested tag") do
+    #     Rails.logger.info("Nested log")
+    #   end
+    # end
+    # ```
+    #
+    # Is logged as the following to the AppSignal logger.
+    # Each combination of tags is sent separately.
+    #
+    # ```
+    # Nested log
+    # [my nested tag] Nested log
+    # [my tag] Nested log
+    # [my tag] [my nested tag] Nested log
+    # ```
+    #
+    # Once it's fixed in Rails, it can be removed here.
+    #
+    # Related issues and PRs:
+    #
+    # - https://github.com/rails/rails/issues/46084
+    # - https://github.com/rails/rails/issues/44668
+    # - https://github.com/rails/rails/pull/53105
+    # - https://github.com/rails/rails/pull/49771
+    #
+    # Another issue was that the Rails `.broadcast_to` implementation in
+    # `ActiveSupport::BroadcastLogger` will run the block passed to `.tagged`
+    # as many times as there are loggers.
+    # Very early in the Rails execution stack, a middleware runs
+    # `logger.tagged(...) { @app.call(env) }`.
+    # This would cause the request handler to run twice, and it also causes
+    # the Rack response to be an array of Rack responses instead,
+    # which breaks the app entirely.
+    #
+    # Related issues:
+    #
+    # - https://github.com/rails/rails/issues/49745
+    # - https://github.com/rails/rails/issues/49745#issuecomment-1775100622
+    #
     # @param logger [Logger] The logger to add to the broadcast list.
     # @return [Array<Logger>]
     def broadcast_to(logger)

data/lib/appsignal/version.rb

@@ -2,5 +2,5 @@
 
 module Appsignal
   # @return [String]
-  VERSION = "4.7.5"
+  VERSION = "4.8.0"
 end

data/sig/appsignal.rbi

@@ -1206,6 +1206,10 @@ module Appsignal
       sig { returns(T::Boolean) }
       attr_accessor :enable_rails_error_reporter
 
+      # _@return_ — Configure whether ActiveSupport::EventReporter integration is enabled
+      sig { returns(T::Boolean) }
+      attr_accessor :enable_active_support_event_log_reporter
+
       # _@return_ — Configure whether Rake performance instrumentation is enabled
       sig { returns(T::Boolean) }
       attr_accessor :enable_rake_performance_instrumentation
@@ -1392,6 +1396,57 @@ module Appsignal
 
     # Adds a logger to broadcast log messages to.
     # 
+    # This implementation of the broadcasting logic exists here in the
+    # AppSignal Ruby gem, because it doesn't work in Rails using tagged logging.
+    # It would log a log line as many times as there are `Rails.logger.tagged`
+    # calls wrapping it.
+    # 
+    # For example, this setup with one log line:
+    # 
+    # ```ruby
+    # appsignal_logger = Appsignal::Logger.new("rails")
+    # Rails.logger.broadcast_to(appsignal_logger)
+    # 
+    # Rails.logger.tagged("my tag") do
+    #   Rails.logger.tagged("my nested tag") do
+    #     Rails.logger.info("Nested log")
+    #   end
+    # end
+    # ```
+    # 
+    # Is logged as the following to the AppSignal logger.
+    # Each combination of tags is sent separately.
+    # 
+    # ```
+    # Nested log
+    # [my nested tag] Nested log
+    # [my tag] Nested log
+    # [my tag] [my nested tag] Nested log
+    # ```
+    # 
+    # Once it's fixed in Rails, it can be removed here.
+    # 
+    # Related issues and PRs:
+    # 
+    # - https://github.com/rails/rails/issues/46084
+    # - https://github.com/rails/rails/issues/44668
+    # - https://github.com/rails/rails/pull/53105
+    # - https://github.com/rails/rails/pull/49771
+    # 
+    # Another issue was that the Rails `.broadcast_to` implementation in
+    # `ActiveSupport::BroadcastLogger` will run the block passed to `.tagged`
+    # as many times as there are loggers.
+    # Very early in the Rails execution stack, a middleware runs
+    # `logger.tagged(...) { @app.call(env) }`.
+    # This would cause the request handler to run twice, and it also causes
+    # the Rack response to be an array of Rack responses instead,
+    # which breaks the app entirely.
+    # 
+    # Related issues:
+    # 
+    # - https://github.com/rails/rails/issues/49745
+    # - https://github.com/rails/rails/issues/49745#issuecomment-1775100622
+    # 
     # _@param_ `logger` — The logger to add to the broadcast list.
     sig { params(logger: Logger).returns(T::Array[Logger]) }
     def broadcast_to(logger); end

data/sig/appsignal.rbs

@@ -1123,6 +1123,9 @@ module Appsignal
       # _@return_ — Configure whether Rails error reporter integration is enabled
       attr_accessor enable_rails_error_reporter: bool
 
+      # _@return_ — Configure whether ActiveSupport::EventReporter integration is enabled
+      attr_accessor enable_active_support_event_log_reporter: bool
+
       # _@return_ — Configure whether Rake performance instrumentation is enabled
       attr_accessor enable_rake_performance_instrumentation: bool
 
@@ -1276,6 +1279,57 @@ module Appsignal
 
     # Adds a logger to broadcast log messages to.
     # 
+    # This implementation of the broadcasting logic exists here in the
+    # AppSignal Ruby gem, because it doesn't work in Rails using tagged logging.
+    # It would log a log line as many times as there are `Rails.logger.tagged`
+    # calls wrapping it.
+    # 
+    # For example, this setup with one log line:
+    # 
+    # ```ruby
+    # appsignal_logger = Appsignal::Logger.new("rails")
+    # Rails.logger.broadcast_to(appsignal_logger)
+    # 
+    # Rails.logger.tagged("my tag") do
+    #   Rails.logger.tagged("my nested tag") do
+    #     Rails.logger.info("Nested log")
+    #   end
+    # end
+    # ```
+    # 
+    # Is logged as the following to the AppSignal logger.
+    # Each combination of tags is sent separately.
+    # 
+    # ```
+    # Nested log
+    # [my nested tag] Nested log
+    # [my tag] Nested log
+    # [my tag] [my nested tag] Nested log
+    # ```
+    # 
+    # Once it's fixed in Rails, it can be removed here.
+    # 
+    # Related issues and PRs:
+    # 
+    # - https://github.com/rails/rails/issues/46084
+    # - https://github.com/rails/rails/issues/44668
+    # - https://github.com/rails/rails/pull/53105
+    # - https://github.com/rails/rails/pull/49771
+    # 
+    # Another issue was that the Rails `.broadcast_to` implementation in
+    # `ActiveSupport::BroadcastLogger` will run the block passed to `.tagged`
+    # as many times as there are loggers.
+    # Very early in the Rails execution stack, a middleware runs
+    # `logger.tagged(...) { @app.call(env) }`.
+    # This would cause the request handler to run twice, and it also causes
+    # the Rack response to be an array of Rack responses instead,
+    # which breaks the app entirely.
+    # 
+    # Related issues:
+    # 
+    # - https://github.com/rails/rails/issues/49745
+    # - https://github.com/rails/rails/issues/49745#issuecomment-1775100622
+    # 
     # _@param_ `logger` — The logger to add to the broadcast list.
     def broadcast_to: (Logger logger) -> ::Array[Logger]
 

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 4.7.5
+  version: 4.8.0
 platform: ruby
 authors:
 - Robert Beekman
 - Thijs Cadier
 - Tom de Bruijn
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -213,6 +214,7 @@ files:
 - lib/appsignal/hooks/action_cable.rb
 - lib/appsignal/hooks/action_mailer.rb
 - lib/appsignal/hooks/active_job.rb
+- lib/appsignal/hooks/active_support_event_reporter.rb
 - lib/appsignal/hooks/active_support_notifications.rb
 - lib/appsignal/hooks/at_exit.rb
 - lib/appsignal/hooks/celluloid.rb
@@ -240,6 +242,7 @@ files:
 - lib/appsignal/hooks/unicorn.rb
 - lib/appsignal/hooks/webmachine.rb
 - lib/appsignal/integrations/action_cable.rb
+- lib/appsignal/integrations/active_support_event_reporter.rb
 - lib/appsignal/integrations/active_support_notifications.rb
 - lib/appsignal/integrations/capistrano/appsignal.cap
 - lib/appsignal/integrations/capistrano/capistrano_2_tasks.rb
@@ -320,6 +323,7 @@ metadata:
   documentation_uri: https://docs.appsignal.com/ruby/
   homepage_uri: https://docs.appsignal.com/ruby/
   source_code_uri: https://github.com/appsignal/appsignal-ruby
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -335,7 +339,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.5.9
+signing_key:
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com
 test_files: []