module Mongo::Loggable

Allows objects to easily log operations.

@since 2.0.0

Constants

PREFIX

The standard MongoDB log prefix.

@since 2.0.0

Public Instance Methods

log_debug(message) click to toggle source

Convenience method to log debug messages with the standard prefix.

@example Log a debug message.

log_debug('Message')

@param [ String ] message The message to log.

@since 2.0.0

# File lib/mongo/loggable.rb, line 35
def log_debug(message)
  logger.debug(format_message(message)) if logger.debug?
end
log_error(message) click to toggle source

Convenience method to log error messages with the standard prefix.

@example Log a error message.

log_error('Message')

@param [ String ] message The message to log.

@since 2.0.0

# File lib/mongo/loggable.rb, line 47
def log_error(message)
  logger.error(format_message(message)) if logger.error?
end
log_fatal(message) click to toggle source

Convenience method to log fatal messages with the standard prefix.

@example Log a fatal message.

log_fatal('Message')

@param [ String ] message The message to log.

@since 2.0.0

# File lib/mongo/loggable.rb, line 59
def log_fatal(message)
  logger.fatal(format_message(message)) if logger.fatal?
end
log_info(message) click to toggle source

Convenience method to log info messages with the standard prefix.

@example Log a info message.

log_info('Message')

@param [ String ] message The message to log.

@since 2.0.0

# File lib/mongo/loggable.rb, line 71
def log_info(message)
  logger.info(format_message(message)) if logger.info?
end
log_warn(message) click to toggle source

Convenience method to log warn messages with the standard prefix.

@example Log a warn message.

log_warn('Message')

@param [ String ] message The message to log.

@since 2.0.0

# File lib/mongo/loggable.rb, line 83
def log_warn(message)
  logger.warn(format_message(message)) if logger.warn?
end
logger() click to toggle source

Get the logger instance.

@example Get the logger instance.

loggable.logger

@return [ Logger ] The logger.

@since 2.1.0

# File lib/mongo/loggable.rb, line 95
def logger
  ((options && options[:logger]) || Logger.logger)
end

Private Instance Methods

_mongo_log_prefix() click to toggle source
# File lib/mongo/loggable.rb, line 105
def _mongo_log_prefix
  (options && options[:log_prefix]) || PREFIX
end
format_message(message) click to toggle source
# File lib/mongo/loggable.rb, line 101
def format_message(message)
  format("%s | %s".freeze, _mongo_log_prefix, message)
end