Class: TinyLog

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

Overview

This class provides a simple logging utility with some metadata attached:

  • timestamp to the microsecond

  • the process ID

  • logger level

  • the log message

Ex:

l = Log.new
l.erro('hi there')
l.erro('hi there')
2022-11-18T01:26:37.086295Z  92967 ERRO hi there
^timestamp to microsecond    ^pid  ^lvl ^log message

Instance Method Summary collapse

Constructor Details

#initialize(filename = nil, buffering = true) ⇒ TinyLog

filename: the I/O stream to send log messages to

if unspecified, will default to $stdout
if specified, attempts to open a file with the specified name to append to

buffered: whether or not to buffer log output

true, or not specified: log buffering is enabled
false: log buffering is disabled - most useful for dev/test environments
  where you want to watch output in realtime



23
24
25
26
 
# File 'lib/tiny_log.rb', line 23

def initialize(filename=nil, buffering=true)
  @buffering = !!buffering
  @io = filename.is_a?(String) ? File.open(filename, 'a') : $stdout
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(prefix, *msgs) ⇒ Object

the clever bit that annotates the log message with a log level and UTC timestamp



30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/tiny_log.rb', line 30

def method_missing(prefix, *msgs)
  msgs.each do |m|
    m.to_s.lines.each do |l|
      @io.puts "#{Time.now.utc.iso8601(6)} #{Process.pid.to_s.rjust(6)} #{prefix.to_s.upcase} #{l}"
    end
  end

  @io.flush unless @buffering

  nil
end