Module: BasicLogging
- Included in:
- Body, Configuration, Configuration, Headers, Newsgroups, OverrideDlg, PostProcessor
- Defined in:
- lib/basic_logging.rb
Overview
Simplified logging. See example code at the bottom of this file. Execute this file to see the output.
Constant Summary collapse
- DEBUG =
0
- INFO =
1
- WARN =
2
- ERROR =
3
- FATAL =
4
- UNKNOWN =
nil
- Levels =
this is mainly for the translation of method calls into log levels
{:debug => DEBUG, :info => INFO, :warn => WARN, :error => ERROR, :fatal => FATAL, :unknown => UNKNOWN}
- @@log_level =
UNKNOWN
- @@target =
STDOUT
- @@muted =
[]
Instance Attribute Summary collapse
-
#log_level ⇒ Object
readonly
Returns the value of attribute log_level.
-
#target ⇒ Object
readonly
Returns the value of attribute target.
Class Method Summary collapse
- .is_muted?(obj) ⇒ Boolean
-
.mute(obj) ⇒ Object
do not log, if caller is obj (class or instance).
Instance Method Summary collapse
-
#log(message) ⇒ Object
(also: #debug, #info, #warn, #error, #fatal)
Output of log messages, depending on the log level set for the calling class and the name of the alias method which is actually called.
-
#set_level(lv) ⇒ Object
set the log level.
-
#set_target(tg) ⇒ Object
set the log target.
Instance Attribute Details
#log_level ⇒ Object (readonly)
Returns the value of attribute log_level.
100 101 102 |
# File 'lib/basic_logging.rb', line 100 def log_level @log_level end |
#target ⇒ Object (readonly)
Returns the value of attribute target.
100 101 102 |
# File 'lib/basic_logging.rb', line 100 def target @target end |
Class Method Details
.is_muted?(obj) ⇒ Boolean
44 45 46 47 |
# File 'lib/basic_logging.rb', line 44 def self.is_muted?(obj) name = obj.class == Class ? obj.name.dup : obj.class.name @@muted.include?(name) end |
.mute(obj) ⇒ Object
do not log, if caller is obj (class or instance)
39 40 41 42 |
# File 'lib/basic_logging.rb', line 39 def self.mute(obj) name = obj.class == Class ? obj.name.dup : obj.class.name @@muted << name end |
Instance Method Details
#log(message) ⇒ Object Also known as: debug, info, warn, error, fatal
Output of log messages, depending on the log level set for the calling class and the name of the alias method which is actually called.
80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/basic_logging.rb', line 80 def log() if !BasicLogging.is_muted?(self) # how has this method been called? mlevel = __callee__ if Levels.has_key?(mlevel) && Levels[mlevel] <= FATAL # output only for levels equal or above the value that corresponds to # the calling alias. format_log( , mlevel) if @@log_level && Levels[mlevel] >= @@log_level else STDERR.puts __FILE__.dup << ": ERROR : invalid log level \"" << mlevel.to_s << "\"" end end end |
#set_level(lv) ⇒ Object
set the log level
50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/basic_logging.rb', line 50 def set_level(lv) if lv.respond_to?(:to_str) lv = Levels[lv.to_sym] end if(!lv || (lv.respond_to?(:to_int) && lv >= DEBUG && lv <= FATAL) ) @@log_level = lv else STDERR.puts __FILE__.dup << ": ERROR : invalid log level \"" << lv.to_s << "\"" STDERR.puts "Keepinng old log level " << Levels.keys.detect {| k| Levels[k] == @@log_level}.to_s end end |
#set_target(tg) ⇒ Object
set the log target
64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/basic_logging.rb', line 64 def set_target(tg) if !tg || tg.strip.empty? @@target = nil elsif tg.respond_to?(:to_io) @@target = tg elsif(!File::exist?(tg) || ( File.file?(tg) && File.writable?(tg) ) ) @@target = File.open(tg, 'w+') else STDERR.puts __FILE__.dup << ': ERROR : target ' << tg << ' cannot be set' STDERR.puts "Keeping old target " << @@target.inspect return end end |