Class: PEROBS::ILogger

Inherits:
Monitor
  • Object
show all
Includes:
Singleton
Defined in:
lib/perobs/Log.rb

Overview

The ILogger class is a singleton that provides a common logging mechanism to all objects. It exposes essentially the same interface as the Logger class, just as a singleton and extends fatal to raise an FatalError exception.

Constant Summary collapse

@@options =

Default options to create a logger. Keep 4 log files, each 1MB max.

[ 4, 2**20 ]
@@level = 
Logger::INFO
@@formatter = 
proc do |severity, time, progname, msg|
  "#{time} #{severity} #{msg}\n"
end
@@logger = 
nil

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &block) ⇒ Object

Pass all calls to unknown methods to the @@logger object.



98
99
100
 
# File 'lib/perobs/Log.rb', line 98

def method_missing(method, *args, &block)
  @@logger.send(method, *args, &block)
end

Instance Method Details

#fatal(msg, &block) ⇒ Object

Print an error message via the Logger and raise a Fit4Ruby::Error. This method should be used to abort the program in case of program logic errors.

Raises:



110
111
112
113
 
# File 'lib/perobs/Log.rb', line 110

def fatal(msg, &block)
  @@logger.fatal(msg, &block)
  raise FatalError, msg
end

#formatter=(f) ⇒ Object

Set Logger formatter.

Parameters:

  • f (Proc) 


74
75
76
 
# File 'lib/perobs/Log.rb', line 74

def formatter=(f)
  @@formatter = f
end

#level=(l) ⇒ Object

Set log level.

Parameters:

  • l (Logger::WARN, Logger:INFO, etc) 


68
69
70
 
# File 'lib/perobs/Log.rb', line 68

def level=(l)
  @@level = l
end

#open(io) ⇒ Object

Redirect all log messages to the given IO.

Parameters:

  • io (IO) —

    Output file descriptor



86
87
88
89
90
91
92
93
94
95
 
# File 'lib/perobs/Log.rb', line 86

def open(io)
  begin
    @@logger = Logger.new(io, *@@options)
  rescue IOError => e
    @@logger = Logger.new($stderr)
    $stderr.puts "Cannot open log file: #{e.message}"
  end
  @@logger.level = @@level
  @@logger.formatter = @@formatter
end

#options=(o) ⇒ Object

Set Logger options

Parameters:

  • o (Array) —

    Optional parameters for Logger.new().



80
81
82
 
# File 'lib/perobs/Log.rb', line 80

def options=(o)
  @@options = o
end

#respond_to?(method, include_private = false) ⇒ Boolean

Make it properly introspectable.

Returns:

  • (Boolean) 


103
104
105
 
# File 'lib/perobs/Log.rb', line 103

def respond_to?(method, include_private = false)
  @@logger.respond_to?(method)
end