класс 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.