type

Log

src const class Log : Obj

Log provides a simple, but standardized mechanism for logging.

See Logging for details and examples.

constructors

make

Create a new log by name.

fields

level

The log level field defines which log entries are reported versus ignored.

methods

addHandler

Install a handler to receive callbacks on logging events.

debug

Generate a LogLevel.debug log entry.

err

Generate a LogLevel.err log entry.

find

Find a registered log by name.

get

Find an existing registered log by name or if not found then create a new registered Log instance with the given name.

handlers

List all the handler functions installed to process log events.

info

Generate a LogLevel.info log entry.

isDebug

Return if debug level is enabled.

isEnabled

Return if this log is enabled for the specified level.

isErr

Return if error level is enabled.

isInfo

Return if info level is enabled.

isWarn

Return if warn level is enabled.

list

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

log

Publish a log entry.

name

Return name of the log.

removeHandler

Uninstall a log handler.

toStr

Return name.

warn

Generate a LogLevel.warn log entry.

Slot Details

addHandler

src static Void addHandler(|LogRec| handler)

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

debug

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

Generate a LogLevel.debug log entry.

err

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

Generate a LogLevel.err log entry.

find

src 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.

get

src 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.

handlers

src static |LogRec|[] handlers()

List all the handler functions installed to process log events.

info

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

Generate a LogLevel.info log entry.

isDebug

src Bool isDebug()

Return if debug level is enabled.

isEnabled

src Bool isEnabled(LogLevel level)

Return if this log is enabled for the specified level.

isErr

src Bool isErr()

Return if error level is enabled.

isInfo

src Bool isInfo()

Return if info level is enabled.

isWarn

src Bool isWarn()

Return if warn level is enabled.

level

src 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.

list

src static Log[] list()

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

log

src 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.

make

src 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.

name

src Str name()

Return name of the log.

removeHandler

src static Void removeHandler(|LogRec| handler)

Uninstall a log handler.

toStr

src virtual override Str toStr()

Return name.

warn

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

Generate a LogLevel.warn log entry.