class ActiveSupport::TaggedLogging

Wraps any standard Logger class to provide tagging capabilities. Examples:

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 16
def initialize(logger)
  @logger = logger
end

Public Instance Methods

add(severity, message = nil, progname = nil, &block) click to toggle source
# File lib/active_support/tagged_logging.rb, line 46
def add(severity, message = nil, progname = nil, &block)
  message = (block_given? ? block.call : progname) if message.nil?
  @logger.add(severity, "#{tags_text}#{message}", progname)
end
clear_tags!() click to toggle source
# File lib/active_support/tagged_logging.rb, line 37
def clear_tags!
  current_tags.clear
end
flush() click to toggle source
# File lib/active_support/tagged_logging.rb, line 59
def flush
  clear_tags!
  @logger.flush if @logger.respond_to?(:flush)
end
method_missing(method, *args) click to toggle source
# File lib/active_support/tagged_logging.rb, line 64
def method_missing(method, *args)
  @logger.send(method, *args)
end
pop_tags(size = 1) click to toggle source
# File lib/active_support/tagged_logging.rb, line 33
def pop_tags(size = 1)
  current_tags.pop size
end
push_tags(*tags) click to toggle source
# File lib/active_support/tagged_logging.rb, line 27
def push_tags(*tags)
  tags.flatten.reject(&:blank?).tap do |new_tags|
    current_tags.concat new_tags
  end
end
silence(temporary_level = Logger::ERROR, &block) click to toggle source
# File lib/active_support/tagged_logging.rb, line 41
def silence(temporary_level = Logger::ERROR, &block)
  @logger.silence(temporary_level, &block)
end
tagged(*tags) { |self| ... } click to toggle source
# File lib/active_support/tagged_logging.rb, line 20
def tagged(*tags)
  new_tags = push_tags(*tags)
  yield self
ensure
  pop_tags(new_tags.size)
end

Private Instance Methods

current_tags() click to toggle source
# File lib/active_support/tagged_logging.rb, line 76
def current_tags
  Thread.current[:activesupport_tagged_logging_tags] ||= []
end
tags_text() click to toggle source
# File lib/active_support/tagged_logging.rb, line 69
def tags_text
  tags = current_tags
  if tags.any?
    tags.collect { |tag| "[#{tag}] " }.join
  end
end