class RemiLib::Logger

• RemiLib::Logger
• Reference
• Object

Overview

The base Logger class provides basic logging facilities.

The format of each message is:

[Header]: your message

Direct Known Subclasses

• RemiLib::ConcurrentLogger

Defined in:

remilib/logging.cr

Constant Summary

ANSI_REGEX = Regex.new("\e\\[[0-9;]*m")

Constructors

• .new(*, ensureNewline : Bool = true, defaultHeader : String = "", verboseHeader : String = "Note", debugHeader : String = "Debug", warnHeader : String = "Warning", errorHeader : String = "Error", fatalHeader : String = "Fatal", showHeaders : Bool = true)

Instance Method Summary

• #<<(text)

  Prints a message to #defaultStream by calling block, which must return a string.

• #debugColor : Symbol

  The color of the debug log header

• #debugColor=(debugColor : Symbol)

  The color of the debug log header

• #debugHeader : String

  The header printed before each debug log message.

• #debugHeader=(debugHeader : String)

  The header printed before each debug log message.

• #debugLevel : UInt8

  The debugging level.

• #debugLevel=(debugLevel : UInt8)

  The debugging level.

• #debugStream : IO

  The stream that debug messages are printed to

• #debugStream=(debugStream : IO)

  The stream that debug messages are printed to

• #defaultColor : Symbol

  The color of the default log header

• #defaultColor=(defaultColor : Symbol)

  The color of the default log header

• #defaultHeader : String

  The default log header.

• #defaultHeader=(defaultHeader : String)

  The default log header.

• #defaultStream : IO

  The stream that #log/#vlog/#<< messages are printed to.

• #defaultStream=(defaultStream : IO)

  The stream that #log/#vlog/#<< messages are printed to.

• #dlog(minLevel : UInt8, msg : String)

  Prints a message to #debugStream if #debugLevel is greater than or equal to minLevel.

• #dlog(minLevel : UInt8, &block : Proc(String)) : Bool

  Prints a message to #debugStream if #debugLevel is greater than or equal to minLevel by calling block, which must return a string.

• #dlog(msg : String) : Bool

  Prints a message to #debugStream if #debugLevel is greater than or equal to 1.

• #dlog(&block : Proc(String)) : Bool

  Prints a message to #debugStream if #debugLevel is greater than or equal to 1 by calling block, which must return a string.

• #dlog!(msg : String) : Bool

  Prints a message to #debugStream regardless of #debugLevel.

• #dlog!(&block : Proc(String)) : Bool

  Prints a message to #debugStream regardless of #debugLevel.

• #ensureNewline=(ensureNewline : Bool)

  When true, all logging calls will ensure that a newline is printed after their message is printed.

• #ensureNewline? : Bool

  When true, all logging calls will ensure that a newline is printed after their message is printed.

• #error(msg : String)

  Prints a message to #errorStream.

• #error(&block : Proc(String))

  Prints a message to #errorStream by calling block, which must return a string.

• #error(err : Exception)

  Prints an exception and its backtrace to #errorStream.

• #errorColor : Symbol

  The color of the error log header

• #errorColor=(errorColor : Symbol)

  The color of the error log header

• #errorHeader : String

  The header printed before each error log message.

• #errorHeader=(errorHeader : String)

  The header printed before each error log message.

• #errorStream : IO

  The stream that error messages are printed to

• #errorStream=(errorStream : IO)

  The stream that error messages are printed to

• #fatal(msg : String, exitCode = 1) : NoReturn

  Prints an error message to #errorStream, then calls exit with exitCode.

• #fatal(&block : Proc(Tuple(String, Int32))) : NoReturn

  Prints an error message to #errorStream by calling block.

• #fatal(err : Exception, exitCode = 1) : NoReturn

  Prints an exception and its backtrace to #errorStream, then calls exit with exitCode.

• #fatalHeader : String

  The header printed before a fatal log message.

• #fatalHeader=(fatalHeader : String)

  The header printed before a fatal log message.

• #forceFlush=(forceFlush : Bool)

  When true, IO#flush will be called after every log message.

• #forceFlush? : Bool

  When true, IO#flush will be called after every log message.

• #log(msg : String)

  Prints a message to #defaultStream.

• #log(&block : Proc(String))

  Prints a message to #defaultStream by calling block, which must return a string.

• #noColors=(noColors : Bool)

  When true, color output is completely disabled.

• #noColors? : Bool

  When true, color output is completely disabled.

• #otherStreams : Array(IO)

  Additional streams to log messages to.

• #otherStreams=(otherStreams : Array(IO))

  Additional streams to log messages to.

• #sanitizeOutput=(sanitizeOutput : Bool)

  When true, then all output will have meta characters (ESC, SUB, BEL, etc.) stripped from the output and replaced with textual representations.

• #sanitizeOutput? : Bool

  When true, then all output will have meta characters (ESC, SUB, BEL, etc.) stripped from the output and replaced with textual representations.

• #showHeaders=(showHeaders : Bool)

  When true, headers are shown for all of the logging messages.

• #showHeaders? : Bool

  When true, headers are shown for all of the logging messages.

• #timestamp : String

  When not String#empty?, use this as a Time::Format string to append a timestamp to each header.

• #timestamp=(timestamp : String)

  When not String#empty?, use this as a Time::Format string to append a timestamp to each header.

• #trace(msg : String) : Bool

  Prints a message to #debugStream only if #debugLevel is equal to 255.

• #trace(&block : Proc(String)) : Bool

  Prints a message to #debugStream by calling block (which must return a string), but only if #debugLevel is equal to 255.

• #verboseColor : Symbol

  The color of the verbose log header

• #verboseColor=(verboseColor : Symbol)

  The color of the verbose log header

• #verboseHeader : String

  The verbose log header.

• #verboseHeader=(verboseHeader : String)

  The verbose log header.

• #verbosityLevel : UInt8

  The verbosity level.

• #verbosityLevel=(verbosityLevel : UInt8)

  The verbosity level.

• #vlog(minLevel : UInt8, msg : String) : Bool

  Prints a message to #defaultStream if #verbosityLevel is greater than or equal to minLevel.

• #vlog(minLevel : UInt8, &block : Proc(String)) : Bool

  Prints a message to #defaultStream if #verbosityLevel is greater than or equal to minLevel by calling block, which must return a string.

• #vlog(msg : String) : Bool

  Convenience function that just calls #vlog with a minimum level of 1.

• #vlog(&block : Proc(String)) : Bool

  Convenience function that just calls #vlog with a minimum level of 1.

• #warn(msg : String)

  Prints a message to #warnStream.

• #warn(&block : Proc(String))

  Prints a message to #warnStream by calling block, which must return a string.

• #warn(err : Exception)

  Prints an exception and its backtrace to #warnStream.

• #warnColor : Symbol

  The color of the warning log header

• #warnColor=(warnColor : Symbol)

  The color of the warning log header

• #warnHeader : String

  The header printed before each warrning log message.

• #warnHeader=(warnHeader : String)

  The header printed before each warrning log message.

• #warnStream : IO

  The stream that warning messages are printed to

• #warnStream=(warnStream : IO)

  The stream that warning messages are printed to

Constructor Detail

Instance Method Detail