In Files

  • logger.rb

Parent

Included Modules

Logger::Application

Description

Application --- Add logging support to your application.

Usage

  1. Define your application class as a sub-class of this class.

  2. Override the run method in your class to do many things.

  3. Instantiate it and invoke start.

Example

class FooApp < Application
  def initialize(foo_app, application_specific, arguments)
    super('FooApp') # Name of the application.
  end

  def run
    ...
    log(WARN, 'warning', 'my_method1')
    ...
    @log.error('my_method2') { 'Error!' }
    ...
  end
end

status = FooApp.new(....).start

Attributes

appname[R]

Name of the application given at initialize.

Public Class Methods

new(appname = '') click to toggle source

Args

appname

Name of the application.

Description

Create an instance. Log device is STDERR by default. This can be changed with set_log.

 
               # File logger.rb, line 728
def initialize(appname = nil)
  @appname = appname
  @log = Logger.new(STDERR)
  @log.progname = @appname
  @level = @log.level
end
            

Public Instance Methods

level=(level) click to toggle source

Set the logging threshold, just like Logger#level=.

 
               # File logger.rb, line 783
def level=(level)
  @level = level
  @log.level = @level
end
            
log(severity, message = nil, &block) click to toggle source

See Logger#add. This application’s appname is used.

 
               # File logger.rb, line 791
def log(severity, message = nil, &block)
  @log.add(severity, message, @appname, &block) if @log
end
            
log=(logdev) click to toggle source
 
               # File logger.rb, line 776
def log=(logdev)
  set_log(logdev)
end
            
logger() click to toggle source

Logger for this application. See the class Logger for an explanation.

 
               # File logger.rb, line 752
def logger
  @log
end
            
logger=(logger) click to toggle source

Sets the logger for this application. See the class Logger for an explanation.

 
               # File logger.rb, line 760
def logger=(logger)
  @log = logger
  @log.progname = @appname
  @log.level = @level
end
            
set_log(logdev, shift_age = 0, shift_size = 1024000) click to toggle source

Sets the log device for this application. See Logger.new for an explanation of the arguments.

 
               # File logger.rb, line 770
def set_log(logdev, shift_age = 0, shift_size = 1024000)
  @log = Logger.new(logdev, shift_age, shift_size)
  @log.progname = @appname
  @log.level = @level
end
            
start() click to toggle source

Start the application. Return the status code.

 
               # File logger.rb, line 738
def start
  status = -1
  begin
    log(INFO, "Start of #{ @appname }.")
    status = run
  rescue
    log(FATAL, "Detected an exception. Stopping ... #{$!} (#{$!.class})\n" << $@.join("\n"))
  ensure
    log(INFO, "End of #{ @appname }. (status: #{ status.to_s })")
  end
  status
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus