module ActiveSupport::TaggedLogging - activesupport-4.2.3 Documentation

# module ActiveSupport::TaggedLogging

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.

### Public Class Methods

new(logger) click to toggle source

    # File lib/active_support/tagged_logging.rb, line 58
    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

### Public Instance Methods

flush() click to toggle source
Calls superclass method

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

tagged(*tags) { |self| ... } click to toggle source

    # File lib/active_support/tagged_logging.rb, line 67
    def tagged(*tags)
      formatter.tagged(*tags) { yield self }
    end