跳到內容 跳到搜尋

Active Support 記錄標示

封裝任何標準的 Logger 物件以提供標示功能。

可以使用區塊呼叫

logger = ActiveSupport::TaggedLogging.new(Logger.new(STDOUT))
logger.tagged('BCX') { logger.info 'Stuff' }                                  # Logs "[BCX] Stuff"
logger.tagged('BCX', "Jason") { |tagged_logger| tagged_logger.info 'Stuff' }  # Logs "[BCX] [Jason] Stuff"
logger.tagged('BCX') { logger.tagged('Jason') { logger.info 'Stuff' } }       # Logs "[BCX] [Jason] Stuff"

如果在沒有區塊的情況下呼叫，將會傳回一個套用標籤的新記錄器

logger = ActiveSupport::TaggedLogging.new(Logger.new(STDOUT))
logger.tagged("BCX").info "Stuff"                 # Logs "[BCX] Stuff"
logger.tagged("BCX", "Jason").info "Stuff"        # Logs "[BCX] [Jason] Stuff"
logger.tagged("BCX").tagged("Jason").info "Stuff" # Logs "[BCX] [Jason] Stuff"

預設 Rails.logger 由 Railties 設定，會使用此功能標示記錄行，以便適當地使用子網域、要求 ID 以及其他任何有助於偵錯多使用者製作應用程式的資訊。

方法
F
L
N
T

類別公開方法

logger(*args, **kwargs)

傳回一個已經使用標示記錄設定封裝的「ActiveSupport::Logger`。

來源： 顯示 | GitHub

# File activesupport/lib/active_support/tagged_logging.rb, line 117
def self.logger(*args, **kwargs)
  new ActiveSupport::Logger.new(*args, **kwargs)
end

new(logger)

來源： 顯示 | GitHub

# File activesupport/lib/active_support/tagged_logging.rb, line 121
def self.new(logger)
  logger = logger.clone

  if logger.formatter
    logger.formatter = logger.formatter.clone

    # Workaround for https://bugs.ruby-lang.org/issues/20250
    # Can be removed when Ruby 3.4 is the least supported version.
    logger.formatter.object_id if logger.formatter.is_a?(Proc)
  else
    # Ensure we set a default formatter so we aren't extending nil!
    logger.formatter = ActiveSupport::Logger::SimpleFormatter.new
  end

  logger.formatter.extend Formatter
  logger.extend(self)
end

執行個體公開方法

flush()

來源： 顯示 | GitHub

# File activesupport/lib/active_support/tagged_logging.rb, line 152
def flush
  clear_tags!
  super if defined?(super)
end

tagged(*tags)

來源： 顯示 | GitHub

# File activesupport/lib/active_support/tagged_logging.rb, line 141
def tagged(*tags)
  if block_given?
    formatter.tagged(*tags) { yield self }
  else
    logger = ActiveSupport::TaggedLogging.new(self)
    logger.formatter.extend LocalTagStorage
    logger.push_tags(*formatter.current_tags, *tags)
    logger
  end
end