Allow unsubscribing from events #39
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
Ref: rails#50452 This adds a Structured Event Reporter to Rails, accessible via `Rails.event`. It allows you to report events to a subscriber, and provides mechanisms for adding tags and context to events. Events encompass "structured logs", but also "business events", as well as telemetry events such as metrics and logs. The Event Reporter is designed to be a single interface for producing any kind of event in a Rails application. We separate the emission of events from how these events reach end consumers; applications are expected to define their own subscribers, and the Event Reporter is responsible for emitting events to these subscribers.
Add JSON and MessagePack encoders to ActiveSupport::EventReporter. This allows applications to serialize events to common formats without needing to implement their own serialization logic in subscribers.
adrianna-chang-shopify
force-pushed
the
ac-structured-events
branch
from
f5d9c02 to
a320b9f
Compare
adrianna-chang-shopify
force-pushed
the
ac-structured-events
branch
from
a320b9f to
a266aef
Compare
zzak
force-pushed
the
event-reporter-subscribers
branch
from
9dbd456 to
6a2a397
Compare
adrianna-chang-shopify
force-pushed
the
ac-structured-events
branch
3 times, most recently
from
ebd42e3 to
2e8ae57
Compare
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.
Some minor API changes around subscriptions, partly taken from ErrorReporter.
@subscribersor@raise_on_error.raise_on_error=with docssubscribe(already_included_subscriber)Some of these we didn't do with ErrorReporter (mainly
attr_*) but I think it's a cleaner API, for exampleErrorReporter#loggerdoesn't need a reader but now that it's public technically removing it should be deprecated. So just being stricter about what we publicize makes maintenance / change easier later.I also debated whether to add
EventReporter#disable(&block)for disabling subscriptions because I couldn't think of a use-case but it could always be added later./cc @adrianna-chang-shopify