Class Index [+]

Quicksearch

Net::SSH::Loggable

A simple module to make logging easier to deal with. It assumes that the logger instance (if not nil) quacks like a Logger object (in Ruby’s standard library). Although used primarily internally by Net::SSH, it can easily be used to add Net::SSH-like logging to your own programs.

  class MyClass
    include Net::SSH::Loggable
  end

  Net::SSH.start(...) do |ssh|
    obj = MyClass.new
    obj.logger = ssh.logger
    ...
  end

Attributes

logger[RW]

The logger instance that will be used to log messages. If nil, nothing will be logged.

Public Instance Methods

debug() click to toggle source

Displays the result of yielding if the log level is Logger::DEBUG or greater.

    # File lib/net/ssh/loggable.rb, line 24
24:     def debug
25:       logger.add(Logger::DEBUG, nil, facility) { yield } if logger && logger.debug?
26:     end
error() click to toggle source

Displays the result of yielding if the log level is Logger:ERROR or greater.

    # File lib/net/ssh/loggable.rb, line 42
42:     def error
43:       logger.add(Logger::ERROR, nil, facility) { yield } if logger && logger.error?
44:     end
fatal() click to toggle source

Displays the result of yielding if the log level is Logger::FATAL or greater.

    # File lib/net/ssh/loggable.rb, line 48
48:     def fatal
49:       logger.add(Logger::FATAL, nil, facility) { yield } if logger && logger.fatal?
50:     end
info() click to toggle source

Displays the result of yielding if the log level is Logger::INFO or greater.

    # File lib/net/ssh/loggable.rb, line 30
30:     def info
31:       logger.add(Logger::INFO, nil, facility) { yield } if logger && logger.info?
32:     end
lwarn() click to toggle source

Displays the result of yielding if the log level is Logger::WARN or greater. (Called lwarn to avoid shadowing with Kernel#warn.)

    # File lib/net/ssh/loggable.rb, line 36
36:     def lwarn
37:       logger.add(Logger::WARN, nil, facility) { yield } if logger && logger.warn?
38:     end

Private Instance Methods

facility() click to toggle source

Sets the “facility” value, used for reporting where a log message originates. It defaults to the name of class with the object_id appended.

    # File lib/net/ssh/loggable.rb, line 57
57:       def facility
58:         @facility ||= self.class.name.gsub(/::/, ".").gsub(/([a-z])([A-Z])/, "\\1_\\2").downcase + "[%x]" % object_id
59:       end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.