Class: KineticRuby::Logger

Inherits:
Object
  • Object
show all
Defined in:
lib/kinetic_logger.rb

Constant Summary collapse

LOG_LEVELS = 
[
  LOG_LEVEL_NONE = 0,
  LOG_LEVEL_ERROR = 1,
  LOG_LEVEL_INFO = 2,
  LOG_LEVEL_VERBOSE = 3,
]

Instance Method Summary collapse

Constructor Details

#initialize(log_level = LOG_LEVEL_INFO, stream = $stdout, enable_timestamp = true) ⇒ Logger

Returns a new instance of Logger.



14
15
16
17
18
19
 
# File 'lib/kinetic_logger.rb', line 14

def initialize(log_level=LOG_LEVEL_INFO, stream=$stdout, enable_timestamp=true)
  set_level log_level
  @stream = stream
  @prefix = ''
  @timestamp_enabled = enable_timestamp
end

Instance Method Details

#enable_timestamp(enable = true) ⇒ Object 



29
30
31
 
# File 'lib/kinetic_logger.rb', line 29

def enable_timestamp(enable=true)
  @timestamp_enabled = enable
end

#level ⇒ Object 



25
26
27
 
# File 'lib/kinetic_logger.rb', line 25

def level
  @level.dup
end

#level=(log_level) ⇒ Object 



21
22
23
 
# File 'lib/kinetic_logger.rb', line 21

def level=(log_level)
  set_level(log_level)
end

#log_err(msg = '', banner = nil) ⇒ Object Also known as: loge 



51
52
53
 
# File 'lib/kinetic_logger.rb', line 51

def log_err(msg='', banner=nil)
  log_message(msg, banner) if @level >= LOG_LEVEL_ERROR
end

#log_exception(exception, desc = nil, level = LOG_LEVEL_ERROR) ⇒ Object 



61
62
63
64
65
66
67
 
# File 'lib/kinetic_logger.rb', line 61

def log_exception(exception, desc=nil, level=LOG_LEVEL_ERROR)
  log_err(desc) if (desc && !desc.empty?)
  log_err "Exception #{exception.class} '#{exception.message}' occured at:"
  exception.backtrace.each do |l|
    log_err "  #{l}"
  end
end

#log_info(msg = '', banner = nil) ⇒ Object Also known as: logi, log 



45
46
47
 
# File 'lib/kinetic_logger.rb', line 45

def log_info(msg='', banner=nil)
  log_message(msg, banner) if @level >= LOG_LEVEL_INFO
end

#log_verbose(msg = '', banner = nil) ⇒ Object Also known as: logv 



56
57
58
 
# File 'lib/kinetic_logger.rb', line 56

def log_verbose(msg='', banner=nil)
  log_message(msg, banner) if @level >= LOG_LEVEL_VERBOSE
end

#prefix ⇒ Object 



41
42
43
 
# File 'lib/kinetic_logger.rb', line 41

def prefix
  @prefix.dup if @prefix
end

#prefix=(msg) ⇒ Object 



37
38
39
 
# File 'lib/kinetic_logger.rb', line 37

def prefix=(msg)
  @prefix = msg if msg
end

#timestamp_enabled ⇒ Object 



33
34
35
 
# File 'lib/kinetic_logger.rb', line 33

def timestamp_enabled
  @timestamp_enabled
end