Подписчик 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 после завершения запроса.