Module: ActiveSupport::TaggedLogging

Relationships & Source Files
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.

Class Method Summary

.new(logger)

Instance Attribute Summary

#pop_tags readonly
#push_tags readonly

Class Method Details

.new(logger)

[ GitHub ]

# File 'activesupport/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

Instance Attribute Details

#pop_tags (readonly)

[ GitHub ]

# File 'activesupport/lib/active_support/tagged_logging.rb', line 65


delegate :push_tags, :pop_tags, :clear_tags!, to: :formatter

#push_tags (readonly)

[ GitHub ]

# File 'activesupport/lib/active_support/tagged_logging.rb', line 65


delegate :push_tags, :pop_tags, :clear_tags!, to: :formatter

Instance Method Details

#clear_tags!

[ GitHub ]

# File 'activesupport/lib/active_support/tagged_logging.rb', line 65


delegate :push_tags, :pop_tags, :clear_tags!, to: :formatter

#flush

[ GitHub ]

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


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

#tagged(*tags)

[ GitHub ]

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


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