ActiveSupport::TaggedLogging (original) (raw)

Active Support Tagged Logging

Wraps any standard Logger object to provide tagging capabilities.

May be called with a block:

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

If called without a block, a new logger will be returned with applied tags:

logger = ActiveSupport::TaggedLogging.new(Logger.new(STDOUT))
logger.tagged("BCX").info "Stuff"                 # Logs "[BCX] Stuff"
logger.tagged("BCX", "Jason").info "Stuff"        # Logs "[BCX] [Jason] Stuff"
logger.tagged("BCX").tagged("Jason").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.

Methods

F

• flush

L

• logger

N

• new

T

• tagged

Class Public methods

logger(*args, **kwargs)Link

Returns an ‘ActiveSupport::Logger` that has already been wrapped with tagged logging concern.

Source: show | on GitHub

def self.logger(*args, **kwargs) new ActiveSupport::Logger.new(*args, **kwargs) end

new(logger)Link

Source: show | on GitHub

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

if logger.formatter logger.formatter = logger.formatter.clone

logger.formatter.object_id if logger.formatter.is_a?(Proc)

else

logger.formatter = ActiveSupport::Logger::SimpleFormatter.new

end

logger.formatter.extend Formatter logger.extend(self) end

Instance Public methods

flush()Link

Source: show | on GitHub

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

tagged(*tags)Link

Source: show | on GitHub

def tagged(*tags) if block_given? formatter.tagged(*tags) { yield self } else logger = ActiveSupport::TaggedLogging.new(self) logger.formatter.extend LocalTagStorage logger.push_tags(*formatter.current_tags, *tags) logger end end