Module: OpenSearch::Loggable

Included in:
Transport::Transport::Base
Defined in:
lib/opensearch/transport/transport/loggable.rb

Overview

Module to encapsulate all logging functionality.

Since:

  • 7.0.0

Instance Method Summary collapse

Instance Method Details

#log_debug(message) ⇒ Object

Log a debug message.

Examples:

Log a debug message.

log_debug('Message')

Parameters:

  • message (String) —

    The message to log.

Since:

  • 7.0.0



40
41
42
 
# File 'lib/opensearch/transport/transport/loggable.rb', line 40

def log_debug(message)
  logger.debug(message) if logger&.debug?
end

#log_error(message) ⇒ Object

Log an error message.

Examples:

Log an error message.

log_error('Message')

Parameters:

  • message (String) —

    The message to log.

Since:

  • 7.0.0



52
53
54
 
# File 'lib/opensearch/transport/transport/loggable.rb', line 52

def log_error(message)
  logger.error(message) if logger&.error?
end

#log_fatal(message) ⇒ Object

Log a fatal message.

Examples:

Log a fatal message.

log_fatal('Message')

Parameters:

  • message (String) —

    The message to log.

Since:

  • 7.0.0



64
65
66
 
# File 'lib/opensearch/transport/transport/loggable.rb', line 64

def log_fatal(message)
  logger.fatal(message) if logger&.fatal?
end

#log_info(message) ⇒ Object

Log an info message.

Examples:

Log an info message.

log_info('Message')

Parameters:

  • message (String) —

    The message to log.

Since:

  • 7.0.0



76
77
78
 
# File 'lib/opensearch/transport/transport/loggable.rb', line 76

def log_info(message)
  logger.info(message) if logger&.info?
end

#log_warn(message) ⇒ Object

Log a warn message.

Examples:

Log a warn message.

log_warn('Message')

Parameters:

  • message (String) —

    The message to log.

Since:

  • 7.0.0



88
89
90
 
# File 'lib/opensearch/transport/transport/loggable.rb', line 88

def log_warn(message)
  logger.warn(message) if logger&.warn?
end