Module: ActiveSupport::TaggedLogging

Defined in:
activesupport/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


57
58
59
60
61
62
# File 'activesupport/lib/active_support/tagged_logging.rb', line 57

def self.new(logger)
  # Ensure we set a default formatter so we aren't extending nil!
  logger.formatter ||= ActiveSupport::Logger::SimpleFormatter.new
  logger.formatter.extend Formatter
  logger.extend(self)
end

Instance Method Details

#flushObject


70
71
72
73
# File 'activesupport/lib/active_support/tagged_logging.rb', line 70

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

#tagged(*tags) ⇒ Object


66
67
68
# File 'activesupport/lib/active_support/tagged_logging.rb', line 66

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