Log Module
#log.getFilename string log.getFilename()

Returns the filename (including full path) of the file we are logging to.

 #log.add log.add(string msg)

Adds 'msg' into our log file. This includes timestamp prefix, and a trailing newline (\n).

@code() log.add("Testing");-- Adds the following (with correct date-time) to your log file: 2018-09-17 18:01:55 : Testing @endcode #log.addRaw log.addRaw(string msg)

Adds 'msg' into our log file. This differs from log.add() as it does not include the timestamp.

 #log.isOpen boolean log.isOpen()

If a log was successfully opened for writing, returns true. If some error prevented the log from being opened, returns false.

#log.setLevel log.setLevel(number level)

Sets the minimum "level" that a message must be in order to be logged by the system. Log levels follow RFC-5425.

@code() log.setLevel(log.level.notice); log.warning("This is a warning! It will be logged."); log.notice("This is a boring notice. It will also be logged."); log.notice("This is a debug message. It will be ignored, because it does not reach the set log level."); @endcode

Log levelInt value
log.level.emergency0
log.level.alert1
log.level.critical2
log.level.error3
log.level.warning4
log.level.notice5
log.level.info6
log.level.debug7
Any message at or below your log level will be logged. For example, if your log level is log.level.error (5), then only emergency, alert, critical, and error messages will be logged while warning, notice, info, and debug messages will be ignored.

Emergency messages will always be logged and cannot be ignored. By default, the log level is typically be log.level.info (6)

 #log.emergency log.emergency(string msg)

Log an emergency-level message.

@code() log.emergency("Emergency message goes here"); @endcode #log.alert log.alert(string msg)

Log an alert-level message.

@code() log.alert("Alert message goes here"); @endcode #log.critical log.critical(string msg)

Log an critical-level message.

@code() log.critical("Critical message goes here"); @endcode #log.error log.error(string msg)

Log an error-level message.

@code() log.error("Error message goes here"); @endcode #log.warning log.warning(string msg)

Log an warning-level message.

@code() log.warning("Warning message goes here"); @endcode #log.notice log.notice(string msg)

Log an notice-level message.

@code() log.notice("Notice message goes here"); @endcode #log.info log.info(string msg)

Log an info-level message.

@code() log.info("Info message goes here"); @endcode #log.debug log.debug(string msg)

Log an debug-level message.

@code() log.debug("Debug message goes here"); @endcode

Page last updated at 2024-03-27 00:14:11

Copyright 2026