Module: HrrRbSftp::Loggable

Included in:
Protocol, Protocol::Common::Packets::Packet, Protocol::Version1::Packets, Protocol::Version3::Extensions, Protocol::Version3::Extensions::Extension, Server
Defined in:
lib/hrr_rb_sftp/loggable.rb

Overview

This module is used to log message with useful logging key.

Examples:

class SomeClass
  include HrrRbSftp::Loggable
  def initialize logger
    self.logger = logger
  end
  def log_some_info
    log_info { "something" }
  end
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#logger ⇒ Object

A logger instance that has #fatal, #error, #warn, #info, and #debug methods.



22
23
24
 
# File 'lib/hrr_rb_sftp/loggable.rb', line 22

def logger
  @logger
end

Instance Method Details

#log_debug ⇒ Object

Outputs debug message when the logger’s log level debug or higher.



63
64
65
66
67
 
# File 'lib/hrr_rb_sftp/loggable.rb', line 63

def log_debug
  if logger
    logger.debug(log_key){ yield }
  end
end

#log_error ⇒ Object

Outputs error message when the logger’s log level error or higher.



36
37
38
39
40
 
# File 'lib/hrr_rb_sftp/loggable.rb', line 36

def log_error
  if logger
    logger.error(log_key){ yield }
  end
end

#log_fatal ⇒ Object

Outputs fatal message when the logger’s log level fatal or higher.



27
28
29
30
31
 
# File 'lib/hrr_rb_sftp/loggable.rb', line 27

def log_fatal
  if logger
    logger.fatal(log_key){ yield }
  end
end

#log_info ⇒ Object

Outputs info message when the logger’s log level info or higher.



54
55
56
57
58
 
# File 'lib/hrr_rb_sftp/loggable.rb', line 54

def log_info
  if logger
    logger.info(log_key){ yield }
  end
end

#log_warn ⇒ Object

Outputs warn message when the logger’s log level warn or higher.



45
46
47
48
49
 
# File 'lib/hrr_rb_sftp/loggable.rb', line 45

def log_warn
  if logger
    logger.warn(log_key){ yield }
  end
end