класс 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 => e
  if logger
    logger.error "Could not log #{name.inspect} event. #{e.class}: #{e.message} #{e.backtrace}"
  end
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 104
def color(text, color, bold = false) # :doc:
  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 в конец возвращаемой строки.