Wizards of Lua

The Art of Spell Crafting

---

Logger - Logging Messages

The Logger class supports writing log messages into the server’s log file.

The log messages can be of the following severity: error, warn, info, debug, and trace.

The server’s log files are found inside the server’s logs folder. By default “error”, “warn”, and “info” messages go into the files “latest.log” and “debug.log”, while “debug” and “trace” messages only go into “debug.log”.

The Logger class is a subtype of the Object class and inherits all its properties and functions.

Here is an overview of the Logger functions:

Functions

Below you find short descriptions about each of the functions and some examples about how to use them in your spells.

debug (message, arg…) -> nil

The ‘debug’ function writes the given debug message into the server’s log file if the log level is at least ‘debug’, prefixed with this logger’s name.

Optionally you can provide some message arguments that will be formatted into the final message (see string.format()).

Example

Printing a debug message into the server’s log file, prefixed with the category label “my-logger”.

local logger = Loggers.get("my-logger")
logger:debug("Some debug message")

Example

Printing a formatted debug message into the server’s log file, prefixed with the category label “my-logger.

local logger = Loggers.get("my-logger")
logger:debug("Some debug message with some value %s", value)

error (message, arg…) -> nil

The ‘error’ function writes the given error message into the server’s log file if the log level is at least ‘error’, prefixed with this logger’s name.

Optionally you can provide some message arguments that will be formatted into the final message (see string.format()).

Example

Printing an error message into the server’s log file, prefixed with the category label “my-logger”.

local logger = Loggers.get("my-logger")
logger:error("Some error message")

Example

Printing a formatted error message into the server’s log file, prefixed with the category label “my-logger.

local logger = Loggers.get("my-logger")
logger:error("Some error message with some value %s", value)

info (message, arg…) -> nil

The ‘info’ function writes the given information message into the server’s log file if the log level is at least ‘info’, prefixed with this logger’s name.

Optionally you can provide some message arguments that will be formatted into the final message (see string.format()).

Example

Printing an info message into the server’s log file, prefixed with the category label “my-logger”.

local logger = Loggers.get("my-logger")
logger:info("Some info message")

Example

Printing a formatted info message into the server’s log file, prefixed with the category label “my-logger.

local logger = Loggers.get("my-logger")
logger:info("Some info message with some value %s", value)

trace (message, arg…) -> nil

The ‘trace’ function writes the given tracing message into the server’s log file if the log level is at least ‘trace’, prefixed with this logger’s name.

Optionally you can provide some message arguments that will be formatted into the final message (see string.format()).

Example

Printing a tracing message into the server’s log file, prefixed with the category label “my-logger”.

local logger = Loggers.get("my-logger")
logger:trace("Some tracing message")

Example

Printing a formatted traceing message into the server’s log file, prefixed with the category label “my-logger.

local logger = Loggers.get("my-logger")
logger:trace("Some traceing message with some value %s", value)

warn (message, arg…) -> nil

The ‘warn’ function writes the given warning message into the server’s log file if the log level is at least ‘warn’, prefixed with this logger’s name.

Optionally you can provide some message arguments that will be formatted into the final message (see string.format()).

Example

Printing a warning message into the server’s log file, prefixed with the category label “my-logger”.

local logger = Loggers.get("my-logger")
logger:warn("Some warning message")

Example

Printing a formatted warning message into the server’s log file, prefixed with the category label “my-logger.

local logger = Loggers.get("my-logger")
logger:warn("Some warning message with some value %s", value)