class method
self.subscribe
Ruby on Rails 6.0.6
Since v3.0.20Signature
self.subscribe(*args, &block)
Subscribe to a given event name with the passed block.
You can subscribe to events by passing a String to match exact event names, or by passing a Regexp to match all events that match a pattern.
ActiveSupport::Notifications.subscribe(/render/) do |*args| @event = ActiveSupport::Notifications::Event.new(*args) end
The block will receive five parameters with information about the event:
ActiveSupport::Notifications.subscribe('render') do |name, start, finish, id, payload| name # => String, name of the event (such as 'render' from above) start # => Time, when the instrumented block started execution finish # => Time, when the instrumented block ended execution id # => String, unique ID for the instrumenter that fired the event payload # => Hash, the payload end
If the block passed to the method only takes one parameter, it will yield an event object to the block:
ActiveSupport::Notifications.subscribe(/render/) do |event| @event = event end
Parameters
-
argsrest -
blockblock
Source
# File activesupport/lib/active_support/notifications.rb, line 211
def subscribe(*args, &block)
notifier.subscribe(*args, &block)
end
Defined in activesupport/lib/active_support/notifications.rb line 211
· View on GitHub
· Improve this page
· Find usages on GitHub
Defined in ActiveSupport::Notifications