Уведомления

ActiveSupport::Notifications предоставляет API для инструментирования Ruby.

Инструментаторы

Для инструментирования события необходимо выполнить следующее:

ActiveSupport::Notifications.instrument('render', extra: :information) do
  render text: 'Foo'
end

Это сначала выполняет блок, а затем уведомляет всех подписчиков по завершении.

В примере выше render — имя события, а всё остальное — данные. Данные — это механизм, позволяющий инструментаторам передавать дополнительную информацию подписчикам. Данные представляют собой хэш, содержимое которого произвольно и обычно зависит от события.

Подписчики

Вы можете получать эти события и предоставляемую ими информацию, зарегистрировав подписчика.

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 this notification
  payload # => Hash, the payload
end

Например, сохраним все события «render» в массиве:

events = []

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

Этот код возвращается сразу же, вы просто подписываетесь на события «render». Блок сохраняется и вызывается каждый раз, когда кто-то инструментирует «render»:

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 }

Блок в вызове subscribe получает имя события, начальную отметку времени, конечную отметку времени, строку с уникальным идентификатором этого события (что-то вроде «535801666f04d0298cd6») и хэш с данными в указанном порядке.

Если во время конкретного инструментирования произойдёт исключение, данные будут содержать ключ :exception со значением массивом из двух элементов: строкой с именем класса исключения и сообщением об исключении.

Как показывает предыдущий пример, класс ActiveSupport::Notifications::Event может принять аргументы как они есть и предоставить объектно-ориентированный интерфейс к этим данным.

Также можно передать объект, который отвечает на метод call в качестве второго параметра методу subscribe вместо блока:

module ActionController
  class PageRequest
    def call(name, started, finished, unique_id, payload)
      Rails.logger.debug ['notification:', name, started, finished, unique_id, payload].join(' ')
    end
  end
end

ActiveSupport::Notifications.subscribe('process_action.action_controller', ActionController::PageRequest.new)

что приведёт к следующему выводу в логах, включая хэш с данными:

notification: process_action.action_controller 2012-04-13 01:08:35 +0300 2012-04-13 01:08:35 +0300 af358ed7fab884532ec7 {
   controller: "Devise::SessionsController",
   action: "new",
   params: {"action"=>"new", "controller"=>"devise/sessions"},
   format: :html,
   method: "GET",
   path: "/login/sign_in",
   status: 200,
   view_runtime: 279.3080806732178,
   db_runtime: 40.053
 }

Также можно подписаться на все события, имя которых соответствует определённому регулярному выражению:

ActiveSupport::Notifications.subscribe(/render/) do |*args|
  ...
end

и даже не передавать аргумент методу subscribe, в этом случае вы подписываетесь на все события.

Временные подписки

Иногда вы не хотите подписываться на событие на протяжении всего жизненного цикла приложения. Есть два способа отписаться.

ПРЕДУПРЕЖДЕНИЕ: Фреймворк инструментирования предназначен для долгоживущих подписчиков, используйте эту функцию с осторожностью, поскольку она очищает некоторые внутренние кэши, что негативно сказывается на производительности.

Подписка во время выполнения блока

Вы можете временно подписаться на событие во время выполнения какого-либо блока. Например, в

callback = lambda {|*args| ... }
ActiveSupport::Notifications.subscribed(callback, "sql.active_record") do
  ...
end

обработчик будет вызываться для всех событий «sql.active_record», инструментированных во время выполнения блока. Обработчик отписывается автоматически после этого.

Ручная отписка

Метод subscribe возвращает объект подписчика:

subscriber = ActiveSupport::Notifications.subscribe("render") do |*args|
  ...
end

Чтобы предотвратить вызов этого блока, просто отпишитесь, передав эту ссылку:

ActiveSupport::Notifications.unsubscribe(subscriber)

Также можно отписаться, передав имя объекта подписчика. Обратите внимание, что это отпишет все подписки с данным именем:

ActiveSupport::Notifications.unsubscribe("render")

Очередь по умолчанию

Уведомления поставляются с реализацией очереди, которая потребляет и публикует события для всех подписчиков журнала. Вы можете использовать любую реализацию очереди, которую хотите.