Module: OverSIP::Logger
- Included in:
- Config, Config::Validators, Launcher, PosixMQ, ProxiesConfig, SIP::ClientTransaction, SIP::Launcher, SIP::Logic, SIP::Message, SIP::Modules::RegistrarWithoutPath, SIP::Modules::UserAssertion, SIP::Proxy, SIP::RFC3263::Query, SIP::Reactor, SIP::ServerTransaction, SIP::TransportManager, TLS, WebSocket::HttpRequest, WebSocket::Launcher, WebSocket::TcpServer, WebSocket::WsApp, WebSocket::WsFraming
- Defined in:
- lib/oversip/logger.rb
Overview
Logging client module. Any class desiring to log messages must include (or extend) this module. In order to identify itself in the logs, the class can define log_ig() method or set @log_id attribute.
Constant Summary collapse
- SYSLOG_POSIXMQ_MAPPING =
{ "debug" => 0, "info" => 1, "notice" => 2, "warn" => 3, "error" => 4, "crit" => 5, "alert" => 6, "emerg" => 7 }
Class Method Summary collapse
- .close ⇒ Object
- .fg_system_msg2str(level, msg, log_id) ⇒ Object
- .init_logger_mq(num_instances, group = nil) ⇒ Object
- .load_methods ⇒ Object
-
.syslog_system_msg2str(level_value, msg, log_id) ⇒ Object
Generate nice log messages.
- .syslog_user_msg2str(level_value, msg, log_id) ⇒ Object
Instance Method Summary collapse
-
#fatal(msg) ⇒ Object
A convenient method to ensure that fatal logs are properly logged and program exited with error status.
-
#log_id ⇒ Object
Default logging identifier is the class name.
Class Method Details
.close ⇒ Object
158 159 160 161 |
# File 'lib/oversip/logger.rb', line 158 def self.close @@logger_mq.close rescue nil @@logger_mq.unlink rescue nil end |
.fg_system_msg2str(level, msg, log_id) ⇒ Object
147 148 149 150 151 152 153 154 155 156 |
# File 'lib/oversip/logger.rb', line 147 def self.fg_system_msg2str(level, msg, log_id) case msg when ::String "#{level.upcase}: <#{log_id}> " << msg when ::Exception "#{level.upcase}: <#{log_id}> #{msg.message} (#{msg.class })\n#{(msg.backtrace || [])[0..3].join("\n")}" else "#{level.upcase}: <#{log_id}> " << msg.inspect end end |
.init_logger_mq(num_instances, group = nil) ⇒ Object
19 20 21 22 23 24 25 26 27 28 29 30 |
# File 'lib/oversip/logger.rb', line 19 def self.init_logger_mq num_instances, group=nil OverSIP.syslogger_mq_name = "/#{OverSIP.master_name}_syslogger" @@logger_mq = ::OverSIP::PosixMQ.create_queue({ :name => ::OverSIP.syslogger_mq_name, :mode => :write, :maxmsg => 1000, :msgsize => 2000, :num_instances => num_instances, :group => group }) end |
.load_methods ⇒ Object
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/oversip/logger.rb', line 33 def self.load_methods begin @@threshold = SYSLOG_POSIXMQ_MAPPING[::OverSIP.configuration[:core][:syslog_level]] rescue @@threshold = 0 # debug. end $oversip_debug = ( @@threshold == 0 ? true : false ) @@congested = false SYSLOG_POSIXMQ_MAPPING.each do |level, level_value| method_str = " def log_system_#{level}(msg) " if ::OverSIP.syslogger_ready? method_str << " return false if @@threshold > #{level_value} || @@congested begin unless @@logger_mq.trysend ::OverSIP::Logger.syslog_system_msg2str(#{level_value}, msg, log_id), 0 @@congested = true EM.add_timer(1) do @@logger_mq.trysend ::OverSIP::Logger.syslog_system_msg2str(4, \"logger message queue was full, some logs have been lost\", log_id), 1 @@congested = false end end rescue Errno::EMSGSIZE @@logger_mq.trysend ::OverSIP::Logger.syslog_system_msg2str(4, \"too long message could not be logged\", log_id), 1 rescue nil rescue => e @@logger_mq.trysend ::OverSIP::Logger.syslog_system_msg2str(4, \"unexpected logging error (\#{e.class}: \#{e.message})\", log_id), 1 rescue nil end " end unless ::OverSIP.daemonized? if %w{debug info notice}.include? level method_str << " puts ::OverSIP::Logger.fg_system_msg2str('#{level}', msg, log_id) " else method_str << " $stderr.puts ::OverSIP::Logger.fg_system_msg2str('#{level}', msg, log_id) " end end method_str << "end" self.module_eval method_str if ::OverSIP.syslogger_ready? # User/script logs. method_str = " def log_#{level}(msg) return false if @@threshold > #{level_value} || @@congested begin unless @@logger_mq.trysend ::OverSIP::Logger.syslog_user_msg2str(#{level_value}, msg, log_id), 0 @@congested = true EM.add_timer(1) do @@logger_mq.trysend ::OverSIP::Logger.syslog_user_msg2str(4, \"logger message queue was full, some logs have been lost\", log_id), 1 @@congested = false end end rescue Errno::EMSGSIZE @@logger_mq.trysend ::OverSIP::Logger.syslog_user_msg2str(4, \"too long message could not be logged\", log_id), 1 rescue nil rescue => e @@logger_mq.trysend ::OverSIP::Logger.syslog_user_msg2str(4, \"unexpected logging error (\#{e.class}: \#{e.message})\", log_id), 1 rescue nil end end " self.module_eval method_str end end # .each # A convenient method to ensure that fatal logs are properly logged and program # exited with error status. def fatal msg log_system_crit msg log_system_crit "exiting with error status" ::OverSIP::Launcher.terminate error=true end end |
.syslog_system_msg2str(level_value, msg, log_id) ⇒ Object
Generate nice log messages. It accepst three parameters:
-
level_value: Integer representing the log level.
-
msg: the String or Exception to be logged.
-
log_id: a String helping to identify the generator of this log message.
125 126 127 128 129 130 131 132 133 134 |
# File 'lib/oversip/logger.rb', line 125 def self.syslog_system_msg2str(level_value, msg, log_id) case msg when ::String level_value.to_s << "<" << log_id << "> " << msg when ::Exception "#{level_value}<#{log_id}> #{msg.message} (#{msg.class })\n#{(msg.backtrace || [])[0..3].join("\n")}" else level_value.to_s << "<" << log_id << "> " << msg.inspect end end |
.syslog_user_msg2str(level_value, msg, log_id) ⇒ Object
136 137 138 139 140 141 142 143 144 145 |
# File 'lib/oversip/logger.rb', line 136 def self.syslog_user_msg2str(level_value, msg, log_id) case msg when ::String level_value.to_s << "<" << log_id << "> script: " << msg when ::Exception "#{level_value}<#{log_id}> script: #{msg.message} (#{msg.class })\n#{(msg.backtrace || [])[0..3].join("\n")}" else level_value.to_s << "<" << log_id << "> script: " << msg.inspect end end |
Instance Method Details
#fatal(msg) ⇒ Object
A convenient method to ensure that fatal logs are properly logged and program exited with error status.
113 114 115 116 117 118 |
# File 'lib/oversip/logger.rb', line 113 def fatal msg log_system_crit msg log_system_crit "exiting with error status" ::OverSIP::Launcher.terminate error=true end |
#log_id ⇒ Object
Default logging identifier is the class name. If log_id() method is redefined by the class including this module, or it sets @log_id, then such a value takes preference.
165 166 167 |
# File 'lib/oversip/logger.rb', line 165 def log_id @log_id ||= self.class.name end |