Module: ActiveSupport::TaggedLogging

Defined in:
lib/active_support/tagged_logging.rb

Overview

Wraps any standard Logger object to provide tagging capabilities.

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

This is used by the default Rails.logger as configured by Railties to make it easy to stamp log lines with subdomains, request ids, and anything else to aid debugging of multi-user production applications.

Defined Under Namespace

Modules: Formatter

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.new(logger) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/active_support/tagged_logging.rb', line 63

def self.new(logger)
  logger = logger.dup

  if logger.formatter
    logger.formatter = logger.formatter.dup
  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

Instance Method Details

#flush ⇒ Object 



83
84
85
86
 
# File 'lib/active_support/tagged_logging.rb', line 83

def flush
  clear_tags!
  super if defined?(super)
end

#tagged(*tags) ⇒ Object 



79
80
81
 
# File 'lib/active_support/tagged_logging.rb', line 79

def tagged(*tags)
  formatter.tagged(*tags) { yield self }
end