Module: ActiveSupport::Notifications

Defined in:
activesupport/lib/active_support/notifications.rb,
activesupport/lib/active_support/notifications/fanout.rb,
activesupport/lib/active_support/notifications/instrumenter.rb

Overview

Notifications provides an instrumentation API for Ruby. To instrument an action in Ruby you just need to do:

ActiveSupport::Notifications.instrument(:render, :extra => :information) do
  render :text => "Foo"
end

You can consume those events and the information they provide by registering a log subscriber. For instance, let's store all instrumented events in an array:

@events = []

ActiveSupport::Notifications.subscribe do |*args|
  @events << ActiveSupport::Notifications::Event.new(*args)
end

ActiveSupport::Notifications.instrument(:render, :extra => :information) do
  render :text => "Foo"
end

event = @events.first
event.name      # => :render
event.duration  # => 10 (in milliseconds)
event.payload   # => { :extra => :information }

When subscribing to Notifications, you can pass a pattern, to only consume events that match the pattern:

ActiveSupport::Notifications.subscribe(/render/) do |event|
  @render_events << event
end

Notifications ships with a queue implementation that consumes and publish events to log subscribers in a thread. You can use any queue implementation you want.

Defined Under Namespace

Classes: Event, Fanout, Instrumenter

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.notifierObject

Returns the value of attribute notifier



45
46
47
# File 'activesupport/lib/active_support/notifications.rb', line 45

def notifier
  @notifier
end

Class Method Details

.instrument(name, payload = {}) ⇒ Object



51
52
53
54
55
56
57
# File 'activesupport/lib/active_support/notifications.rb', line 51

def instrument(name, payload = {})
  if @instrumenters[name]
    instrumenter.instrument(name, payload) { yield payload if block_given? }
  else
    yield payload if block_given?
  end
end

.instrumenterObject



70
71
72
# File 'activesupport/lib/active_support/notifications.rb', line 70

def instrumenter
  Thread.current[:instrumentation_#{notifier.object_id}"] ||= Instrumenter.new(notifier)
end

.publish(name, *args) ⇒ Object



47
48
49
# File 'activesupport/lib/active_support/notifications.rb', line 47

def publish(name, *args)
  notifier.publish(name, *args)
end

.subscribe(*args, &block) ⇒ Object



59
60
61
62
63
# File 'activesupport/lib/active_support/notifications.rb', line 59

def subscribe(*args, &block)
  notifier.subscribe(*args, &block).tap do
    @instrumenters.clear
  end
end

.unsubscribe(args) ⇒ Object



65
66
67
68
# File 'activesupport/lib/active_support/notifications.rb', line 65

def unsubscribe(args)
  notifier.unsubscribe(args)
  @instrumenters.clear
end