path: root/activesupport/lib/active_support/tagged_logging.rb

module ActiveSupport
  # 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.
  class TaggedLogging
    def initialize(logger)
      @logger = logger
      @tags   = []
    end

    def tagged(*tags)
      new_tags = Array.wrap(tags).flatten
      @tags += new_tags
      yield
    ensure
      new_tags.size.times { @tags.pop }
    end


    def add(severity, message = nil, progname = nil, &block)
      @logger.add(severity, "#{tags}#{message}", progname, &block)
    end


    def fatal(progname = nil, &block)
      add(@logger.class::FATAL, progname, &block)
    end

    def error(progname = nil, &block)
      add(@logger.class::ERROR, progname, &block)
    end

    def warn(progname = nil, &block)
      add(@logger.class::WARN, progname, &block)
    end

    def info(progname = nil, &block)
      add(@logger.class::INFO, progname, &block)
    end

    def debug(progname = nil, &block)
      add(@logger.class::DEBUG, progname, &block)
    end

    def unknown(progname = nil, &block)
      add(@logger.class::UNKNOWN, progname, &block)
    end


    def method_missing(method, *args)
      @logger.send(method, *args)
    end
    

    private
      def tags
        if @tags.any?
          @tags.collect { |tag| "[#{tag}]" }.join(" ") + " "
        end
      end
  end
end