Module: Log
- Extended by:
- Term::ANSIColor
- Defined in:
- lib/rbbt/util/log.rb,
lib/rbbt/util/log/progress.rb,
lib/rbbt/util/log/progress/util.rb,
lib/rbbt/util/log/progress/report.rb
Defined Under Namespace
Classes: ProgressBar
Constant Summary collapse
- LOG_MUTEX =
ToDo: Iām not sure if using a Mutex here really gives troubles in CPU concurrency
MockMutex.new
- SEVERITY_COLOR =
.collect{|e| ā033[#{e}ā}
[reset, cyan, green, magenta, blue, yellow, red]
- HIGHLIGHT =
"\033[1m"
- LAST =
"log"
Class Attribute Summary collapse
-
.logfile(file = nil) ⇒ Object
Returns the value of attribute logfile.
-
.nocolor ⇒ Object
Returns the value of attribute nocolor.
-
.severity ⇒ Object
Returns the value of attribute severity.
-
.tty_size ⇒ Object
Returns the value of attribute tty_size.
Class Method Summary collapse
- ._ignore_stderr ⇒ Object
- .clear_line(out = STDOUT) ⇒ Object
- .color(severity, str = nil, reset = false) ⇒ Object
- .color_stack(stack) ⇒ Object
- .compact ⇒ Object
- .count_stack ⇒ Object
- .debug(message = nil, &block) ⇒ Object
- .deprecated(m) ⇒ Object
- .down_lines(num = 1) ⇒ Object
- .error(message = nil, &block) ⇒ Object
- .exception(e) ⇒ Object
- .get_level(level) ⇒ Object
- .high(message = nil, &block) ⇒ Object
- .highlight(str = nil) ⇒ Object
- .ignore_stderr(&block) ⇒ Object
- .info(message = nil, &block) ⇒ Object
- .last_caller(stack) ⇒ Object
- .log(message = nil, severity = MEDIUM, &block) ⇒ Object
- .log_obj_fingerprint(obj, level, file = $stdout) ⇒ Object
- .log_obj_inspect(obj, level, file = $stdout) ⇒ Object
- .logn(message = nil, severity = MEDIUM, &block) ⇒ Object
- .low(message = nil, &block) ⇒ Object
- .medium(message = nil, &block) ⇒ Object
- .no_bar ⇒ Object
- .no_bar=(value) ⇒ Object
- .reset_color ⇒ Object
- .return_line ⇒ Object
- .stack(stack) ⇒ Object
- .terminal_width ⇒ Object
- .trap_std(msg = "STDOUT", msge = "STDERR", severity = 0, severity_err = nil) ⇒ Object
- .trap_stderr(msg = "STDERR", severity = 0) ⇒ Object
- .tsv(tsv) ⇒ Object
- .uncolor(str) ⇒ Object
- .up_lines(num = 1) ⇒ Object
- .warn(message = nil, &block) ⇒ Object
- .with_severity(level) ⇒ Object
- .with_stack_counts(head = 10, total = 100) ⇒ Object
Class Attribute Details
.logfile(file = nil) ⇒ Object
Returns the value of attribute logfile.
146 147 148 |
# File 'lib/rbbt/util/log.rb', line 146 def logfile @logfile end |
.nocolor ⇒ Object
Returns the value of attribute nocolor.
146 147 148 |
# File 'lib/rbbt/util/log.rb', line 146 def nocolor @nocolor end |
.severity ⇒ Object
Returns the value of attribute severity.
146 147 148 |
# File 'lib/rbbt/util/log.rb', line 146 def severity @severity end |
.tty_size ⇒ Object
Returns the value of attribute tty_size.
146 147 148 |
# File 'lib/rbbt/util/log.rb', line 146 def tty_size @tty_size end |
Class Method Details
._ignore_stderr ⇒ Object
110 111 112 113 114 115 116 117 118 119 120 121 |
# File 'lib/rbbt/util/log.rb', line 110 def self._ignore_stderr backup_stderr = STDERR.dup File.open('/dev/null', 'w') do |f| STDERR.reopen(f) begin yield ensure STDERR.reopen backup_stderr backup_stderr.close end end end |
.clear_line(out = STDOUT) ⇒ Object
222 223 224 |
# File 'lib/rbbt/util/log.rb', line 222 def self.clear_line(out = STDOUT) out.puts Log.return_line << " " * (Log.tty_size || 80) << Log.return_line unless nocolor end |
.color(severity, str = nil, reset = false) ⇒ Object
198 199 200 201 202 203 204 205 206 207 208 |
# File 'lib/rbbt/util/log.rb', line 198 def self.color(severity, str = nil, reset = false) return str.dup || "" if nocolor color = reset ? Term::ANSIColor.reset : "" color << SEVERITY_COLOR[severity] if Integer === severity color << Term::ANSIColor.send(severity) if Symbol === severity and Term::ANSIColor.respond_to? severity if str.nil? color else color + str.to_s + self.color(0) end end |
.color_stack(stack) ⇒ Object
335 336 337 338 339 340 341 342 |
# File 'lib/rbbt/util/log.rb', line 335 def self.color_stack(stack) stack.collect do |line| line = line.sub('`',"'") color = :green if line =~ /workflow/ color = :blue if line =~ /rbbt-/ Log.color color, line end unless stack.nil? end |
.compact ⇒ Object
31 32 33 |
# File 'lib/rbbt/util/log.rb', line 31 def self.compact true end |
.count_stack ⇒ Object
360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'lib/rbbt/util/log.rb', line 360 def self.count_stack if ! $count_stacks Log.debug "Counting stacks at: " << caller.first return end $stack_counts ||= {} head = $count_stacks_head stack = caller[1..head+1] stack.reverse.each do |line,i| $stack_counts[line] ||= 0 $stack_counts[line] += 1 end end |
.debug(message = nil, &block) ⇒ Object
295 296 297 |
# File 'lib/rbbt/util/log.rb', line 295 def self.debug( = nil, &block) log(, DEBUG, &block) end |
.deprecated(m) ⇒ Object
329 330 331 332 333 |
# File 'lib/rbbt/util/log.rb', line 329 def self.deprecated(m) stack = caller warn("DEPRECATED: " << Log.last_caller(stack)) warn("* " << (m || "").to_s) end |
.down_lines(num = 1) ⇒ Object
214 215 216 |
# File 'lib/rbbt/util/log.rb', line 214 def self.down_lines(num = 1) nocolor ? "" : "\033[#{num+1}E" end |
.error(message = nil, &block) ⇒ Object
319 320 321 |
# File 'lib/rbbt/util/log.rb', line 319 def self.error( = nil, &block) log(, ERROR, &block) end |
.exception(e) ⇒ Object
323 324 325 326 327 |
# File 'lib/rbbt/util/log.rb', line 323 def self.exception(e) stack = caller error([e.class.to_s, e.].compact * ": " ) error("BACKTRACE [#{Process.pid}]: " << Log.last_caller(stack) << "\n" + color_stack(e.backtrace)*"\n") end |
.get_level(level) ⇒ Object
130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/rbbt/util/log.rb', line 130 def self.get_level(level) case level when Numeric level.to_i when String begin Log.const_get(level.upcase) rescue Log.exception $! end when Symbol get_level(level.to_s) end || 0 end |
.high(message = nil, &block) ⇒ Object
307 308 309 |
# File 'lib/rbbt/util/log.rb', line 307 def self.high( = nil, &block) log(, HIGH, &block) end |
.highlight(str = nil) ⇒ Object
226 227 228 229 230 231 232 233 234 |
# File 'lib/rbbt/util/log.rb', line 226 def self.highlight(str = nil) if str.nil? return "" if nocolor HIGHLIGHT else return str if nocolor HIGHLIGHT + str + color(0) end end |
.ignore_stderr(&block) ⇒ Object
124 125 126 127 128 |
# File 'lib/rbbt/util/log.rb', line 124 def self.ignore_stderr(&block) LOG_MUTEX.synchronize do _ignore_stderr &block end end |
.info(message = nil, &block) ⇒ Object
311 312 313 |
# File 'lib/rbbt/util/log.rb', line 311 def self.info( = nil, &block) log(, INFO, &block) end |
.last_caller(stack) ⇒ Object
36 37 38 39 40 41 42 43 44 |
# File 'lib/rbbt/util/log.rb', line 36 def self.last_caller(stack) line = nil pos ||= 0 while line.nil? or line =~ /util\/log\.rb/ and stack.any? line = stack.shift end line ||= caller.first line.gsub('`', "'") end |
.log(message = nil, severity = MEDIUM, &block) ⇒ Object
261 262 263 264 265 266 267 |
# File 'lib/rbbt/util/log.rb', line 261 def self.log( = nil, severity = MEDIUM, &block) return if severity < self.severity ||= block.call if block_given? return if .nil? = + "\n" unless [-1] == "\n" self.logn , severity, &block end |
.log_obj_fingerprint(obj, level, file = $stdout) ⇒ Object
282 283 284 285 286 287 288 289 290 291 292 293 |
# File 'lib/rbbt/util/log.rb', line 282 def self.log_obj_fingerprint(obj, level, file = $stdout) stack = caller line = Log.last_caller stack level = Log.get_level level name = Log::SEVERITY_NAMES[level] + ": " Log.log Log.color(level, name, true) << line, level Log.log "", level Log.log Log.color(level, "=> ", true) << Misc.fingerprint(obj), level Log.log "", level end |
.log_obj_inspect(obj, level, file = $stdout) ⇒ Object
269 270 271 272 273 274 275 276 277 278 279 280 |
# File 'lib/rbbt/util/log.rb', line 269 def self.log_obj_inspect(obj, level, file = $stdout) stack = caller line = Log.last_caller stack level = Log.get_level level name = Log::SEVERITY_NAMES[level] + ": " Log.log Log.color(level, name, true) << line, level Log.log "", level Log.log Log.color(level, "=> ", true) << obj.inspect, level Log.log "", level end |
.logn(message = nil, severity = MEDIUM, &block) ⇒ Object
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 |
# File 'lib/rbbt/util/log.rb', line 237 def self.logn( = nil, severity = MEDIUM, &block) return if severity < self.severity ||= block.call if block_given? return if .nil? time = Time.now.strftime("%m/%d/%y-%H:%M:%S.%L") sev_str = severity.to_s prefix = time << color(severity) << "[" << sev_str << "]" << color(0) = "" << highlight << << color(0) if severity >= INFO str = prefix << " " << .to_s LOG_MUTEX.synchronize do if logfile.nil? STDERR.write str else logfile.write str end Log::LAST.replace "log" nil end end |
.low(message = nil, &block) ⇒ Object
299 300 301 |
# File 'lib/rbbt/util/log.rb', line 299 def self.low( = nil, &block) log(, LOW, &block) end |
.medium(message = nil, &block) ⇒ Object
303 304 305 |
# File 'lib/rbbt/util/log.rb', line 303 def self.medium( = nil, &block) log(, MEDIUM, &block) end |
.no_bar ⇒ Object
10 11 12 13 |
# File 'lib/rbbt/util/log/progress.rb', line 10 def self. @@no_bar = false unless defined?(@@no_bar) @@no_bar || ENV["RBBT_NO_PROGRESS"] == "true" end |
.no_bar=(value) ⇒ Object
6 7 8 |
# File 'lib/rbbt/util/log/progress.rb', line 6 def self.(value) @@no_bar = value end |
.reset_color ⇒ Object
194 195 196 |
# File 'lib/rbbt/util/log.rb', line 194 def self.reset_color reset end |
.return_line ⇒ Object
218 219 220 |
# File 'lib/rbbt/util/log.rb', line 218 def self.return_line nocolor ? "" : "\033[1A" end |
.stack(stack) ⇒ Object
350 351 352 353 354 355 356 357 358 |
# File 'lib/rbbt/util/log.rb', line 350 def self.stack(stack) LOG_MUTEX.synchronize do STDERR.puts Log.color :magenta, "Stack trace [#{Process.pid}]: " << Log.last_caller(caller) color_stack(stack).each do |line| STDERR.puts line end end end |
.terminal_width ⇒ Object
27 28 29 |
# File 'lib/rbbt/util/log.rb', line 27 def self.terminal_width 80 end |
.trap_std(msg = "STDOUT", msge = "STDERR", severity = 0, severity_err = nil) ⇒ Object
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/rbbt/util/log.rb', line 47 def self.trap_std(msg = "STDOUT", msge = "STDERR", severity = 0, severity_err = nil) sout, sin = Misc.pipe soute, sine = Misc.pipe backup_stderr = STDERR.dup backup_stdout = STDOUT.dup old_logfile = Log.logfile Log.logfile(backup_stderr) severity_err ||= severity th_log = Thread.new do while line = sout.gets Log.logn "#{msg}: " + line, severity end end th_loge = Thread.new do while line = soute.gets Log.logn "#{msge}: " + line, severity_err end end begin STDOUT.reopen(sin) STDERR.reopen(sine) yield ensure STDERR.reopen backup_stderr STDOUT.reopen backup_stdout sin.close sine.close th_log.join th_loge.join backup_stdout.close backup_stderr.close Log.logfile = old_logfile end end |
.trap_stderr(msg = "STDERR", severity = 0) ⇒ Object
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/rbbt/util/log.rb', line 85 def self.trap_stderr(msg = "STDERR", severity = 0) sout, sin = Misc.pipe backup_stderr = STDERR.dup old_logfile = Log.logfile Log.logfile(backup_stderr) th_log = Thread.new do while line = sout.gets Log.logn "#{msg}: " + line, severity end end begin STDERR.reopen(sin) yield sin.close ensure STDERR.reopen backup_stderr th_log.join backup_stderr.close Log.logfile = old_logfile end end |
.tsv(tsv) ⇒ Object
344 345 346 347 348 |
# File 'lib/rbbt/util/log.rb', line 344 def self.tsv(tsv) STDERR.puts Log.color :magenta, "TSV log: " << Log.last_caller(caller).gsub('`',"'") STDERR.puts Log.color(:blue, "=> "<< Misc.fingerprint(tsv), true) STDERR.puts Log.color(:cyan, "=> " << tsv.summary) end |
.uncolor(str) ⇒ Object
190 191 192 |
# File 'lib/rbbt/util/log.rb', line 190 def self.uncolor(str) "" << Term::ANSIColor.uncolor(str) end |
.up_lines(num = 1) ⇒ Object
210 211 212 |
# File 'lib/rbbt/util/log.rb', line 210 def self.up_lines(num = 1) nocolor ? "" : "\033[#{num+1}F\033[2K" end |
.warn(message = nil, &block) ⇒ Object
315 316 317 |
# File 'lib/rbbt/util/log.rb', line 315 def self.warn( = nil, &block) log(, WARN, &block) end |
.with_severity(level) ⇒ Object
160 161 162 163 164 165 166 167 168 |
# File 'lib/rbbt/util/log.rb', line 160 def self.with_severity(level) orig = Log.severity begin Log.severity = level yield ensure Log.severity = orig end end |
.with_stack_counts(head = 10, total = 100) ⇒ Object
374 375 376 377 378 379 380 381 382 383 |
# File 'lib/rbbt/util/log.rb', line 374 def self.with_stack_counts(head = 10, total = 100) $count_stacks_head = head $count_stacks = true $stack_counts = {} res = yield $count_stacks = false Log.debug "STACK_COUNTS:\n" + $stack_counts.sort_by{|line,c| c}.reverse.collect{|line,c| [c, line] * " - "}[0..total] * "\n" $stack_counts = {} res end |