Module: Kontena::Websocket::Logging

Included in:
Client, Client::Connection
Defined in:
lib/kontena/websocket/logging.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.initialize_logger(log_target = STDOUT, log_level = Logger::INFO) ⇒ Object 



5
6
7
8
9
 
# File 'lib/kontena/websocket/logging.rb', line 5

def self.initialize_logger(log_target = STDOUT, log_level = Logger::INFO)
  @logger = Logger.new(log_target)
  @logger.level = log_level
  @logger
end

.logger ⇒ Object 



11
12
13
 
# File 'lib/kontena/websocket/logging.rb', line 11

def self.logger
  defined?(@logger) ? @logger : initialize_logger
end

.logger=(log) ⇒ Object 



15
16
17
 
# File 'lib/kontena/websocket/logging.rb', line 15

def self.logger=(log)
  @logger = (log ? log : Logger.new('/dev/null'))
end

Instance Method Details

#debug(message = nil, &block) ⇒ Object

Send a debug message

Parameters:

  • message (String) (defaults to: nil) 


33
34
35
 
# File 'lib/kontena/websocket/logging.rb', line 33

def debug(message = nil, &block)
  logger.add(Logger::DEBUG, message, logging_prefix, &block)
end

#error(message = nil, &block) ⇒ Object

Send an error message

Parameters:

  • message (String) (defaults to: nil) 


51
52
53
 
# File 'lib/kontena/websocket/logging.rb', line 51

def error(message = nil, &block)
  logger.add(Logger::ERROR, message, logging_prefix, &block)
end

#info(message = nil, &block) ⇒ Object

Send a info message

Parameters:

  • message (String) (defaults to: nil) 


39
40
41
 
# File 'lib/kontena/websocket/logging.rb', line 39

def info(message = nil, &block)
  logger.add(Logger::INFO, message, logging_prefix, &block)
end

#logger ⇒ Logger

Returns:

  • (Logger) 


20
21
22
 
# File 'lib/kontena/websocket/logging.rb', line 20

def logger
  Kontena::Websocket::Logging.logger
end

#logging_prefix ⇒ String

Prefix for log messages, defaults to class name

Returns:

  • (String) 


27
28
29
 
# File 'lib/kontena/websocket/logging.rb', line 27

def logging_prefix
  self.class.name
end

#warn(message = nil, &block) ⇒ Object

Send a warning message

Parameters:

  • message (String) (defaults to: nil) 


45
46
47
 
# File 'lib/kontena/websocket/logging.rb', line 45

def warn(message = nil, &block)
  logger.add(Logger::WARN, message, logging_prefix, &block)
end