class ADAL::Logger
Extended version of Ruby's base logger class to support VERBOSE
logging. This is consistent with ADAL
logging across platforms.
The format of a log message is described in the Ruby docs at ruby-doc.org/stdlib-2.2.2/libdoc/logger/rdoc/Logger.html as SeverityID, [DateTime pid] SeverityLabel – ProgName: message. SeverityID is the first letter of the severity. In the case of ADAL::Logger
that means one of {V, I, W, E, F}. The DateTime object uses the to_s method of DateTime from stdlib which is ISO-8601. The ProgName will be the correlation id if one is sent or absent otherwise.
Constants
- SEVS
- VERBOSE
Public Class Methods
new(logdev, correlation_id)
click to toggle source
Constructs a new Logger
.
@param String|IO logdev
A filename (String) or IO object (STDOUT, STDERR).
@param String correlation_id
The UUID of the request context.
Calls superclass method
# File lib/adal/logger.rb, line 47 def initialize(logdev, correlation_id) super(logdev) @correlation_id = correlation_id end
Public Instance Methods
error(message = nil, &block)
click to toggle source
:nocov:
# File lib/adal/logger.rb, line 69 def error(message = nil, &block) add(ERROR, message, @correlation_id, &block) end
fatal(message = nil, &block)
click to toggle source
# File lib/adal/logger.rb, line 73 def fatal(message = nil, &block) add(FATAL, message, @correlation_id, &block) end
format_severity(severity)
click to toggle source
# File lib/adal/logger.rb, line 52 def format_severity(severity) SEVS[severity] || 'ANY' end
info(message = nil, &block)
click to toggle source
# File lib/adal/logger.rb, line 77 def info(message = nil, &block) add(INFO, message, @correlation_id, &block) end
verbose(message = nil, &block)
click to toggle source
# File lib/adal/logger.rb, line 81 def verbose(message = nil, &block) add(VERBOSE, message, @correlation_id, &block) end
warn(message = nil, &block)
click to toggle source
# File lib/adal/logger.rb, line 85 def warn(message = nil, &block) add(WARN, message, @correlation_id, &block) end