Module: Xolo::Server::Helpers::Log

Included in:
Title, Version
Defined in:
lib/xolo/server/helpers/log.rb

Overview

This is mixed in to Xolo::Server::App (as a helper, available in route processing) and in Xolo::Server::Title and Xolo::Server::Version, for simplified access to the main server logger, with access to session IDs

The Title and Version objects must be instantiated with the current session object in order for this to work.

See Xolo::Server::Helpers::Titles#instantiate_title for how this happens

All those things need have have #session set before calling the log_* methods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(includer) ⇒ Object

when this module is included



34
35
36
 
# File 'lib/xolo/server/helpers/log.rb', line 34

def self.included(includer)
  Xolo.verbose_include includer, self
end

Instance Method Details

#log_debug(msg, alert: false) ⇒ Object 



56
57
58
59
 
# File 'lib/xolo/server/helpers/log.rb', line 56

def log_debug(msg, alert: false)
  logger.debug(session_svr_obj_id) { msg }
  send_alert msg, :DEBUG if alert
end

#log_error(msg, alert: false) ⇒ Object 



74
75
76
77
 
# File 'lib/xolo/server/helpers/log.rb', line 74

def log_error(msg, alert: false)
  logger.error(session_svr_obj_id) { msg }
  send_alert msg, :ERROR if alert
end

#log_fatal(msg, alert: false) ⇒ Object 



80
81
82
83
 
# File 'lib/xolo/server/helpers/log.rb', line 80

def log_fatal(msg, alert: false)
  logger.fatal(session_svr_obj_id) { msg }
  send_alert msg, :FATAL if alert
end

#log_info(msg, alert: false) ⇒ Object 



62
63
64
65
 
# File 'lib/xolo/server/helpers/log.rb', line 62

def log_info(msg, alert: false)
  logger.info(session_svr_obj_id) { msg }
  send_alert msg, :INFO if alert
end

#log_unknown(msg, alert: false) ⇒ Object 



86
87
88
89
 
# File 'lib/xolo/server/helpers/log.rb', line 86

def log_unknown(msg, alert: false)
  logger.unknown(session_svr_obj_id) { msg }
  send_alert msg, :UNKNOWN if alert
end

#log_warn(msg, alert: false) ⇒ Object 



68
69
70
71
 
# File 'lib/xolo/server/helpers/log.rb', line 68

def log_warn(msg, alert: false)
  logger.warn(session_svr_obj_id) { msg }
  send_alert msg, :WARNING if alert
end

#logger ⇒ Object 



43
44
45
 
# File 'lib/xolo/server/helpers/log.rb', line 43

def logger
  Xolo::Server.logger
end

#session_svr_obj_id ⇒ Object 



48
49
50
51
52
53
 
# File 'lib/xolo/server/helpers/log.rb', line 48

def session_svr_obj_id
  return @session_svr_obj_id if @session_svr_obj_id

  @session_svr_obj_id =
    ("#{session[:xolo_id]}-#{object_id}" if session[:xolo_id])
end