класс ActiveSupport::LogSubscriber

Родитель:: Subscriber

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

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

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

И в конечном итоге он регистрируется следующим образом:

ActiveRecord::LogSubscriber.attach_to :active_record

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

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

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

Константы

BLACK: Цвета
BLUE
BOLD
CLEAR: Вставить в строку, чтобы очистить все предыдущие ANSI-последовательности.
CYAN
GREEN
MAGENTA
RED
WHITE
YELLOW

Атрибуты

logger[W]

Публичные методы класса

flush_all!() Показать исходный код

# File activesupport/lib/active_support/log_subscriber.rb, line 69
def flush_all!
  logger.flush if logger.respond_to?(:flush)
end

Очистить журнал всех ::log_subscribers.

log_subscribers() Показать исходный код

# File activesupport/lib/active_support/log_subscriber.rb, line 64
def log_subscribers
  subscribers
end

logger() Показать исходный код

# File activesupport/lib/active_support/log_subscriber.rb, line 56
def logger
  @logger ||= if defined?(Rails) && Rails.respond_to?(:logger)
    Rails.logger
  end
end

Публичные методы экземпляра

finish(name, id, payload) Показать исходный код

# File activesupport/lib/active_support/log_subscriber.rb, line 82
def finish(name, id, payload)
  super if logger
rescue Exception => e
  logger.error "Could not log #{name.inspect} event. #{e.class}: #{e.message} #{e.backtrace}"
end

Вызывает метод суперкласса

logger() Показать исходный код

# File activesupport/lib/active_support/log_subscriber.rb, line 74
def logger
  LogSubscriber.logger
end

start(name, id, payload) Показать исходный код

# File activesupport/lib/active_support/log_subscriber.rb, line 78
def start(name, id, payload)
  super if logger
end

Вызывает метод суперкласса

Защищенные методы экземпляра

color(text, color, bold=false) Показать исходный код

# File activesupport/lib/active_support/log_subscriber.rb, line 102
def color(text, color, bold=false)
  return text unless colorize_logging
  color = self.class.const_get(color.upcase) if color.is_a?(Symbol)
  bold  = bold ? BOLD : ""
  "#{bold}#{color}#{text}#{CLEAR}"
end

Устанавливает цвет, используя строку или одну из определенных констант. Если третий параметр установлен в true, к строке также добавляется полужирное начертание. Это основано на реализации Highline и автоматически добавляет CLEAR в конец возвращаемой строки.