Add support for ActiveSupport::EventReporter #1481
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Rails 8.1 adds ActiveSupport::EventReporter, an interface for reporting structured events. To catch these, report them as info-level logs in the rails_events category through the newly added Appsignal::Integrations::ActiveSupportEventReporter.
jeffkreeftmeijer
force-pushed
the
event-subscriber
branch
from
e5c6880 to
051180b
Compare
jeffkreeftmeijer
requested review from
lipskis,
matsimitsu,
tombruijn and
unflxw
tombruijn
reviewed
Nov 24, 2025
| type: add | ||
| --- | ||
|
|
||
| Report events from Rails 8.1's ActiveSupport::EventReporter as logs |
Member
There was a problem hiding this comment.
Suggested change
| Report events from Rails 8.1's ActiveSupport::EventReporter as logs | |
| Report events from Rails 8.1's Structured Event Reporting (`ActiveSupport::EventReporter`) as logs. |
Comment on lines
+24
to
+37
| # Mock Rails.event | ||
| stub_const("MockEventReporter", Class.new do | ||
| attr_reader :subscribers | ||
|
|
||
| def initialize | ||
| @subscribers = [] | ||
| end | ||
|
|
||
| def subscribe(subscriber) | ||
| @subscribers << subscriber | ||
| end | ||
| end) | ||
|
|
||
| mock_event_reporter = MockEventReporter.new |
Member
There was a problem hiding this comment.
I recommend using an instance double for this, so that if the Rails API for this ever changes, our tests fail too, and it doesn't silently keep passing the test. Keeping us unaware anything is broken.
https://rspec.info/features/3-12/rspec-mocks/verifying-doubles/instance-doubles/
Suggested change
| # Mock Rails.event | |
| stub_const("MockEventReporter", Class.new do | |
| attr_reader :subscribers | |
| def initialize | |
| @subscribers = [] | |
| end | |
| def subscribe(subscriber) | |
| @subscribers << subscriber | |
| end | |
| end) | |
| mock_event_reporter = MockEventReporter.new | |
| # Mock Rails.event | |
| subscribers = [] | |
| mock_event_reporter = instance_double( | |
| "ActiveSupport::EventReporter", | |
| :subscribe => nil, | |
| :subscribers => subscribers | |
| ) | |
| allow(mock_event_reporter).to receive(:subscribe) do |subscriber| | |
| subscribers << subscriber | |
| end |
| describe Appsignal::Hooks::ActiveSupportEventReporterHook do | ||
| begin | ||
| require "active_support/event_reporter" | ||
| rescue LoadError |
Member
There was a problem hiding this comment.
Suggested change
| rescue LoadError | |
| rescue LoadError # rubocop:disable Lint/SuppressedException |
Ignore RuboCop violation.
This is a message from the daily scheduled checks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rails 8.1 adds
ActiveSupport::EventReporter, an interface for reporting structured events. To catch these, report them as info-level logs in therails_events categorythrough the newly addedAppsignal::Integrations::ActiveSupportEventReporter.