класс ActiveSupport::LogSubscriber

ActiveSupport::LogSubscriber — это объект, предназначенный для обработки ActiveSupport::Notifications с единственной целью — их протоколирование. Подписчик логов рассылает уведомления зарегистрированному объекту на основе заданного имённого пространства.

Например, подписчик логов Active Record отвечает за протоколирование запросов:

module ActiveRecord
  class LogSubscriber < ActiveSupport::LogSubscriber
    def sql(event)
      info "#{event.payload[:name]} (#{event.duration}) #{event.payload[:sql]}"
    end
  end
end

И, наконец, он зарегистрирован как:

ActiveRecord::LogSubscriber.attach_to :active_record

Поскольку нам необходимо знать все методы экземпляров до подключения подписчика логов, строка выше должна вызываться после определения вашего ActiveRecord::LogSubscriber.

Также необходимо установить логгер с помощью ActiveRecord::LogSubscriber.logger=. Это происходит автоматически в среде Rails.

После настройки, всякий раз, когда публикуется уведомление "sql.active_record", оно должным образом отправит событие (ActiveSupport::Notifications::Event) в метод sql.

Как потребитель ActiveSupport::Notifications, ActiveSupport::LogSubscriber предоставляет простой интерфейс для проверки, вызывает ли инструментированный код исключение. Часто бывает необходимо протоколировать другое сообщение в случае ошибки, и это можно сделать, расширив предыдущий пример:

module ActiveRecord
  class LogSubscriber < ActiveSupport::LogSubscriber
    def sql(event)
      exception = event.payload[:exception]

      if exception
        exception_object = event.payload[:exception_object]

        error "[ERROR] #{event.payload[:name]}: #{exception.join(', ')} " \
              "(#{exception_object.backtrace.first})"
      else
        # standard logger code
      end
    end
  end
end

Подписчик логов также имеет некоторые вспомогательные функции для обработки протоколирования и автоматически очищает все логи при завершении запроса (через уведомление action_dispatch.callback в среде Rails).