Подписчик журнала Active Support

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

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

module ActiveRecord
  class LogSubscriber < ActiveSupport::LogSubscriber
    attach_to :active_record

    def sql(event)
      info "#{event.payload[:name]} (#{event.duration}) #{event.payload[:sql]}"
    end
  end
end

Также необходимо задать 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

ActiveSupport::LogSubscriber также предоставляет вспомогательные методы для работы с журналами. Например, ActiveSupport::LogSubscriber.flush_all! гарантирует, что все журналы будут сброшены; этот метод вызывается в Rails::Rack::Logger после завершения запроса.