dcsext.env.Logger
Logger.
Contents
Description
A simple leveled logger that writes to the DCS mission environment log functions. Loggers are created by name and shared through getByName.
Methods
logger:getByName(name)
Get the logger associated with name. Creates the logger on first use so callers sharing a name share a single instance.
Parameters
- name
- facility name
Returns
- the Logger instance for name
logger:setDebug(debug)
Enable or disable debug level as the default for new loggers. Existing loggers keep their current level.
Parameters
- debug
- value converted with dcsext.math.toBoolean
logger:setDefaultLogLevel(lvl)
Set the default logging level that new loggers with use unless not specified in the logger table.
Parameters
- lvl
- log level from Logger.level
logger:setAllLogLevels(lvltbl)
Set specifically named loggers to have a specified default log level. This might be useful when you have a known set of named loggers and some need to log at debug vs. error.
Parameters
- lvltbl
- a table where each key is the name of a logger and the value is the log level.
logger:setPrefix(prefix)
Set the log line prefix prepended to every log message generated. This should be called first and set to something unique.
Parameters
- prefix
- the string prefix added to all log messages
logger:setLevel(lvl)
Sets the logging level of the logger object.
Parameters
- lvl
- numeric log level from Logger.level
logger:error(userfmt, …)
Log an error message.
Parameters
- userfmt
- format string same as string.format
- …
- values to format
logger:warn(userfmt, …)
Log a warning message.
Parameters
- userfmt
- format string same as string.format
- …
- values to format
logger:info(userfmt, …)
Log an info message.
Parameters
- userfmt
- format string same as string.format
- …
- values to format
logger:debug(userfmt, …)
Log a debug message.
Parameters
- userfmt
- format string same as string.format
- …
- values to format
Metamethods
logger:__init(name)
Constructor.
Parameters
- name
- unique facility name for this logger, shown in every message it logs
Tables
logger.level
Logger logging levels. Numeric levels passed to setLevel and setDefaultLogLevel, lower values are more severe.
Parameters
- [error]
- [warn]
- [info]
- [debug]