Module: Logging

Included in:
FMail, IPRange, TClass, TClass
Defined in:
lib/logging.rb

Overview

of the object. Example for a class-level logger: # ——————– class TClass

self.extend(Logging)
@@log = init_logger(STDOUT)
def test_log
        @@log.info('class-level logger called from instance: ' << @@log.to_s)
        @log = @@log
        @log.info('AGAIN: class-level logger called from instance: ' << @log.to_s)
end
def self::test_log
        @log.info('class-level logger called from class: ' << @log.to_s)
        @@log.info('AGAIN: class-level logger called from class: ' << @@log.to_s)
end

end #——————— Example for a object-level logger: ATTN! This means 1 logger per object. # ——————– class TClass

include Logging
def initialize
        init_logger(STDOUT, Logger::DEBUG)
end
def test_log
        @log.debug('called test_log() ')
end

end

Constant Summary collapse

@@have_log = 
false
@@LOG_CONF = 
File.dirname(File.absolute_path(__FILE__)) << File::Separator << 'log.conf'

Instance Method Summary collapse

Instance Method Details

#init_logger(target = STDOUT, level = Logger::INFO) ⇒ Object

Call this method in an instance-method (e.g. initialize() ) to define the object-level logger; i.e. an object-specific member @log. Call this method within the class-definition for a class-level logger; i.e. a member @log for class-level acces. The method returns the logger, so you can actually do what you want with it.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/logging.rb', line 65

def init_logger(target = STDOUT, level = Logger::INFO)
  # Prepare for a class-level logger. This is actually quite cool.

  # ---> Ingeniuous code starts here
  cn = (self.class == Class ? name : self.class.name)
  # <--- Ingeniuous code ends here

  # 11/2019
  if (cn == 'Object')
    cn = 'Top Level'
  end

  # allow to override the set log-levels with an
  # external configuration (log.conf).
  log_conf(cn)
  # Or use the defaults as set here or elsewhere...

  @level ||= level 
  @target ||= target

  @log = Logger.new(@target)
  @log.level = @level

  @log.formatter = proc do |severity, datetime, progname, msg|
    t = Time.now
    "#{cn}: #{severity} #{t.hour}-#{t.min}-#{t.sec}: #{msg}\n"
  end
  if ! @@have_log
    @log.debug cn.dup << ' reading logging-configuration from ' << @@LOG_CONF	
    @@have_log = true
    @log.debug('level is ' << level.to_s)
  end
  return @log
end

#log_level=(level) ⇒ Object

set the log-level



108
109
110
111
 
# File 'lib/logging.rb', line 108

def log_level=(level)
  @level = level
  @log.level = @level
end

#log_target=(target) ⇒ Object

Set the log-target to an IO object.



101
102
103
104
105
 
# File 'lib/logging.rb', line 101

def log_target=(target)
  @target = target
  @log = Logger.new(@@target)
  @log.level = @level
end