Module: Log

Included in:
ScClient
Defined in:
lib/socketclusterclient/log.rb

Overview

Module Logger provides an interface to log events

Author:

Instance Method Summary collapse

Instance Method Details

#disable_logging ⇒ Object

Method to disable logging



36
37
38
 
# File 'lib/socketclusterclient/log.rb', line 36

def disable_logging
  @logger = nil
end

#enable_logging ⇒ Object

Method to enable logging



46
47
48
 
# File 'lib/socketclusterclient/log.rb', line 46

def enable_logging
  initialize_logger
end

#initialize_logger ⇒ Object

Initializes logger instance and sets logger level



15
16
17
 
# File 'lib/socketclusterclient/log.rb', line 15

def initialize_logger
  @logger = Logger.new(STDOUT)
end

#logger ⇒ Logger

Method to get the logger instance

Returns:

  • (Logger) —

    An instance of logger



25
26
27
28
 
# File 'lib/socketclusterclient/log.rb', line 25

def logger
  initialize_logger unless @logger
  @logger
end

#set_logging_level(level) ⇒ Object

Method to set logging level :debug < :info < :warn < :error < :fatal < :unknown



56
57
58
59
60
61
62
63
 
# File 'lib/socketclusterclient/log.rb', line 56

def set_logging_level(level)
  level = level.to_s.downcase
  if %w[debug info warn error fatal unknown].include?(level)
    @logger.level = level.to_sym
  else
    @logger.warn('Invalid logger level')
  end
end