ActiveSupport::Subscriber is an object set to consume ActiveSupport::Notifications. The subscriber dispatches notifications to a registered object based on its given namespace.
An example would be Active Record subscriber responsible for collecting statistics about queries:
module ActiveRecord
class StatsSubscriber < ActiveSupport::Subscriber
def sql(event)
Statsd.timing("sql.#{event.payload[:name]}", event.duration)
end
end
end
And it's finally registered as:
ActiveRecord::StatsSubscriber.attach_to :active_record
Since we need to know all instance methods before attaching the log subscriber, the line above should be called after your subscriber definition.
After configured, whenever a “sql.active_record” notification is published,
it will properly dispatch the event (ActiveSupport::Notifications::Event)
to the sql
method.
Methods
- A
- F
- N
- S
Class Public methods
attach_to(namespace, subscriber=new, notifier=ActiveSupport::Notifications)
Link
Attach the subscriber to a namespace.
# File activesupport/lib/active_support/subscriber.rb, line 33 def attach_to(namespace, subscriber=new, notifier=ActiveSupport::Notifications) subscribers << subscriber subscriber.public_methods(false).each do |event| next if %w{ start finish }.include?(event.to_s) notifier.subscribe("#{event}.#{namespace}", subscriber) end end
new()
Link
subscribers()
Link
Instance Public methods
finish(name, id, payload)
Link