module HrrRbSftp::Loggable

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

@example

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

Attributes

logger[RW]

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

Public Instance Methods

log_debug() { || ... } click to toggle source

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

# File lib/hrr_rb_sftp/loggable.rb, line 63
def log_debug
  if logger
    logger.debug(log_key){ yield }
  end
end
log_error() { || ... } click to toggle source

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

# File lib/hrr_rb_sftp/loggable.rb, line 36
def log_error
  if logger
    logger.error(log_key){ yield }
  end
end
log_fatal() { || ... } click to toggle source

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

# File lib/hrr_rb_sftp/loggable.rb, line 27
def log_fatal
  if logger
    logger.fatal(log_key){ yield }
  end
end
log_info() { || ... } click to toggle source

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

# File lib/hrr_rb_sftp/loggable.rb, line 54
def log_info
  if logger
    logger.info(log_key){ yield }
  end
end
log_warn() { || ... } click to toggle source

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

# File lib/hrr_rb_sftp/loggable.rb, line 45
def log_warn
  if logger
    logger.warn(log_key){ yield }
  end
end

Private Instance Methods

log_key() click to toggle source
# File lib/hrr_rb_sftp/loggable.rb, line 71
def log_key
  @log_key ||= self.class.to_s + "[%x]" % object_id
end