Fantom

 

const class

sys::Log

sys::Obj
  sys::Log

Log provides a simple, but standardized mechanism for logging.

See docLang::Logging for details and examples.

Slots

addHandlerSource

static Void addHandler(|LogRec| handler)

Install a handler to receive callbacks on logging events. If the handler func is not immutable, then throw NotImmutableErr.

debugSource

Void debug(Str msg, Err? err := null)

Generate a LogLevel.debug log entry.

errSource

Void err(Str msg, Err? err := null)

Generate a LogLevel.err log entry.

findSource

static Log? find(Str name, Bool checked := true)

Find a registered log by name. If the log doesn't exist and checked is false then return null, otherwise throw Err.

getSource

static Log get(Str name)

Find an existing registered log by name or if not found then create a new registered Log instance with the given name. Name must be valid according to Uri.isName otherwise NameErr is thrown.

handlersSource

static |LogRec|[] handlers()

List all the handler functions installed to process log events.

infoSource

Void info(Str msg, Err? err := null)

Generate a LogLevel.info log entry.

isDebugSource

Bool isDebug()

Return if debug level is enabled.

isEnabledSource

Bool isEnabled(LogLevel level)

Return if this log is enabled for the specified level.

isErrSource

Bool isErr()

Return if error level is enabled.

isInfoSource

Bool isInfo()

Return if info level is enabled.

isWarnSource

Bool isWarn()

Return if warn level is enabled.

levelSource

LogLevel level

The log level field defines which log entries are reported versus ignored. Anything which equals or is more severe than the log level is logged. Anything less severe is ignored. If the level is set to silent, then logging is disabled.

listSource

static Log[] list()

Return a list of all the active logs which have been registered since system startup.

logSource

virtual Void log(LogRec rec)

Publish a log entry. The convenience methods err, warn info, and debug all route to this method for centralized handling. The standard implementation is to call each of the installed handlers if the specified level is enabled.

makeSource

new make(Str name, Bool register)

Create a new log by name. The log is added to the VM log registry only if register is true. If register is true and a log has already been created for the specified name then throw ArgErr. Name must be valid according to Uri.isName otherwise NameErr is thrown.

nameSource

Str name()

Return name of the log.

removeHandlerSource

static Void removeHandler(|LogRec| handler)

Uninstall a log handler.

toStrSource

override Str toStr()

Overrides sys::Obj.toStr

Return name.

warnSource

Void warn(Str msg, Err? err := null)

Generate a LogLevel.warn log entry.