class Berkshelf::Logger

Public Class Methods

new(device = STDOUT) click to toggle source
Calls superclass method
# File lib/berkshelf/logger.rb, line 3
def initialize(device = STDOUT)
  super
  self.level = Logger::WARN
  @filter_params = []
end

Public Instance Methods

add(severity, message = nil, progname = nil) { || ... } click to toggle source

Reimplements Logger#add adding message filtering. The info, warn, debug, error, and fatal methods all call add.

@param [Fixnum] severity

an integer measuing the severity - Logger::INFO, etc.

@param [String] message = nil

the message to log

@param [String] progname = nil

the program name performing the logging

@param &block

a block that will be evaluated (for complicated logging)

@example

log.filter_param("hello")
log.info("hello world!") => "FILTERED world!"

@return [Boolean]

# File lib/berkshelf/logger.rb, line 26
def add(severity, message = nil, progname = nil, &block)
  severity ||= Logger::UNKNOWN
  if @logdev.nil? || severity < (@level)
    return true
  end

  progname ||= @progname
  if message.nil?
    if block_given?
      message = yield
    else
      message = progname
      progname = @progname
    end
  end
  @logdev.write(
    format_message(format_severity(severity), Time.now, progname, filter(message))
  )
  true
end
clear_filter_params() click to toggle source
# File lib/berkshelf/logger.rb, line 55
def clear_filter_params
  @filter_params.clear
end
deprecate(message) click to toggle source
# File lib/berkshelf/logger.rb, line 68
def deprecate(message)
  trace = caller.join("\n\t")
  warn "DEPRECATION WARNING: #{message}\n\t#{trace}"
end
exception(ex) click to toggle source

Log an exception and its backtrace to FATAL

@param [Exception] ex

# File lib/berkshelf/logger.rb, line 76
def exception(ex)
  fatal("#{ex.class}: #{ex}")
  fatal(ex.backtrace.join("\n")) unless ex.backtrace.nil?
end
filter(message) click to toggle source
# File lib/berkshelf/logger.rb, line 59
def filter(message)
  filter_params.each do |param|
    message.gsub!(param.to_s, "FILTERED")
  end
  message
end
filter_param(param) click to toggle source
# File lib/berkshelf/logger.rb, line 51
def filter_param(param)
  @filter_params << param unless filter_params.include?(param)
end
filter_params() click to toggle source
# File lib/berkshelf/logger.rb, line 47
def filter_params
  @filter_params.dup
end