Skip to main content

Logging

The root module object, which contains the root logger. Also exposes proxy methods which operate on the root logger, e.g. Logging:debug calls Logger:debug on the root logger.

Functions

getLogger

since 0.1.0
</>
Logging:getLogger(name: string) → ()

Calls Logger:getChild on the root logger with the given name

getRootLogger

since 0.1.0
</>
Logging:getRootLogger() → Logger

Returns the root logger, calling Logging:createRootLogger if it hasn't been created yet.

basicConfig

since 0.1.0
</>
Logging:basicConfig(options: table) → ()

Attaches an OutputHandler with a Formatter to the root logger. The following keys can be specified:

  • level Level: The level to set the root logger. Default: Level.Warning
  • format string: The Formatter.fmt of the OutputHandler. Default: %(message)s
  • force boolean: If true, adds the new handler even if the root logger already has one.

getLevelName

since 0.1.0
</>
Logging:getLevelName(level: Level) → string

Returns the string name of the given numeric level, or raises an error if no name matches.

setLevel

FilteringProxy
since 0.1.0
</>
Logging:setLevel(level: Level) → ()

Proxy for Logger:setLevel on the root logger.

addFilter

FilteringProxy
since 0.1.0
</>
Logging:addFilter(filter: Filter) → ()

Proxy for Logger:addFilter on the root logger.

removeFilter

FilteringProxy
since 0.1.0
</>
Logging:removeFilter(filter: Filter) → ()

Proxy for Logger:removeFilter on the root logger.

filter

FilteringProxy
since 0.1.0
</>
Logging:filter() → boolean

Proxy for Logger:filter on the root logger.

addHandler

HandlingProxy
since 0.1.0
</>
Logging:addHandler(handler: Handler) → ()

Proxy for Logger:addHandler on the root logger.

removeHandler

HandlingProxy
since 0.1.0
</>
Logging:removeHandler(handler: Handler) → ()

Proxy for Logger:removeHandler on the root logger.

log

LoggingProxy
since 0.1.0
</>
Logging:log(
level: Level,
message: RecordMessage,
...: any
) → Record

Proxy for Logger:log on the root logger.

debug

LoggingProxy
since 0.1.0
</>
Logging:debug(
message: RecordMessage,
...: any
) → Record

Proxy for Logger:debug on the root logger.

info

LoggingProxy
since 0.1.0
</>
Logging:info(
message: RecordMessage,
...: any
) → Record

Proxy for Logger:info on the root logger.

warning

LoggingProxy
since 0.1.0
</>
Logging:warning(
message: RecordMessage,
...: any
) → Record

Proxy for Logger:warning on the root logger.

error

LoggingProxy
since 0.1.0
</>
Logging:error(
message: RecordMessage,
...: any
) → Record

Proxy for Logger:error on the root logger.

critical

LoggingProxy
since 0.1.0
</>
Logging:critical(
message: RecordMessage,
...: any
) → Record

Proxy for Logger:critical on the root logger.

wrap

SugarProxy
since 0.1.0
</>
Logging:wrap(callOriginal: boolean) → function,function

Proxy for Logger:wrap on the root logger.

pcall

SugarProxy
since 0.1.0
</>
Logging:pcall(
func: function,
...: any
) → any

Proxy for Logger:pcall on the root logger.

xpcall

SugarProxy
since 0.1.0
</>
Logging:xpcall(
func: function,
errorHandler: function,
...: any
) → any

Proxy for Logger:xpcall on the root logger.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new Logging module. For normal use, this is done once by the module.\nWhen running tests, the Logging module is recreated for each test case.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Logging"
                }
            ],
            "function_type": "static",
            "since": "0.1.0",
            "private": true,
            "source": {
                "line": 55,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "getLogger",
            "desc": "Calls [Logger:getChild] on the root logger with the given name",
            "params": [
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "since": "0.1.0",
            "source": {
                "line": 67,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "createRootLogger",
            "desc": "Creates a new root logger at the default level.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Logger"
                }
            ],
            "function_type": "method",
            "since": "0.1.0",
            "private": true,
            "source": {
                "line": 78,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "getRootLogger",
            "desc": "Returns the root logger, calling [Logging:createRootLogger] if it hasn't been created yet.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Logger"
                }
            ],
            "function_type": "method",
            "since": "0.1.0",
            "source": {
                "line": 89,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "basicConfig",
            "desc": "Attaches an [OutputHandler] with a [Formatter] to the root logger. The following keys can be specified:\n\n* `level` [Level]: The level to set the root logger. Default: [Level.Warning]\n* `format` string: The [Formatter.fmt] of the [OutputHandler]. Default: `%(message)s`\n* `force` boolean: If true, adds the new handler even if the root logger already has one.",
            "params": [
                {
                    "name": "options",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [],
            "function_type": "method",
            "since": "0.1.0",
            "source": {
                "line": 108,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "getLevelName",
            "desc": "Returns the string name of the given numeric level, or raises an error if no name matches.",
            "params": [
                {
                    "name": "level",
                    "desc": "",
                    "lua_type": "Level"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "method",
            "since": "0.1.0",
            "source": {
                "line": 131,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "setLevel",
            "desc": "Proxy for [Logger:setLevel] on the root logger.",
            "params": [
                {
                    "name": "level",
                    "desc": "",
                    "lua_type": "Level"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Filtering",
                "Proxy"
            ],
            "since": "0.1.0",
            "source": {
                "line": 150,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "addFilter",
            "desc": "Proxy for [Logger:addFilter] on the root logger.",
            "params": [
                {
                    "name": "filter",
                    "desc": "",
                    "lua_type": "Filter"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Filtering",
                "Proxy"
            ],
            "since": "0.1.0",
            "source": {
                "line": 160,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "removeFilter",
            "desc": "Proxy for [Logger:removeFilter] on the root logger.",
            "params": [
                {
                    "name": "filter",
                    "desc": "",
                    "lua_type": "Filter"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Filtering",
                "Proxy"
            ],
            "since": "0.1.0",
            "source": {
                "line": 170,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "filter",
            "desc": "Proxy for [Logger:filter] on the root logger.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "tags": [
                "Filtering",
                "Proxy"
            ],
            "since": "0.1.0",
            "source": {
                "line": 180,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "addHandler",
            "desc": "Proxy for [Logger:addHandler] on the root logger.",
            "params": [
                {
                    "name": "handler",
                    "desc": "",
                    "lua_type": "Handler"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Handling",
                "Proxy"
            ],
            "since": "0.1.0",
            "source": {
                "line": 190,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "removeHandler",
            "desc": "Proxy for [Logger:removeHandler] on the root logger.",
            "params": [
                {
                    "name": "handler",
                    "desc": "",
                    "lua_type": "Handler"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Handling",
                "Proxy"
            ],
            "since": "0.1.0",
            "source": {
                "line": 200,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "log",
            "desc": "Proxy for [Logger:log] on the root logger.",
            "params": [
                {
                    "name": "level",
                    "desc": "",
                    "lua_type": "Level"
                },
                {
                    "name": "message",
                    "desc": "",
                    "lua_type": "RecordMessage"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Record"
                }
            ],
            "function_type": "method",
            "tags": [
                "Logging",
                "Proxy"
            ],
            "since": "0.1.0",
            "source": {
                "line": 213,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "debug",
            "desc": "Proxy for [Logger:debug] on the root logger.",
            "params": [
                {
                    "name": "message",
                    "desc": "",
                    "lua_type": "RecordMessage"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Record"
                }
            ],
            "function_type": "method",
            "tags": [
                "Logging",
                "Proxy"
            ],
            "since": "0.1.0",
            "source": {
                "line": 225,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "info",
            "desc": "Proxy for [Logger:info] on the root logger.",
            "params": [
                {
                    "name": "message",
                    "desc": "",
                    "lua_type": "RecordMessage"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Record"
                }
            ],
            "function_type": "method",
            "tags": [
                "Logging",
                "Proxy"
            ],
            "since": "0.1.0",
            "source": {
                "line": 237,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "warning",
            "desc": "Proxy for [Logger:warning] on the root logger.",
            "params": [
                {
                    "name": "message",
                    "desc": "",
                    "lua_type": "RecordMessage"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Record"
                }
            ],
            "function_type": "method",
            "tags": [
                "Logging",
                "Proxy"
            ],
            "since": "0.1.0",
            "source": {
                "line": 249,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "error",
            "desc": "Proxy for [Logger:error] on the root logger.",
            "params": [
                {
                    "name": "message",
                    "desc": "",
                    "lua_type": "RecordMessage"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Record"
                }
            ],
            "function_type": "method",
            "tags": [
                "Logging",
                "Proxy"
            ],
            "since": "0.1.0",
            "source": {
                "line": 261,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "critical",
            "desc": "Proxy for [Logger:critical] on the root logger.",
            "params": [
                {
                    "name": "message",
                    "desc": "",
                    "lua_type": "RecordMessage"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Record"
                }
            ],
            "function_type": "method",
            "tags": [
                "Logging",
                "Proxy"
            ],
            "since": "0.1.0",
            "source": {
                "line": 273,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "wrap",
            "desc": "Proxy for [Logger:wrap] on the root logger.",
            "params": [
                {
                    "name": "callOriginal",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "function, function"
                }
            ],
            "function_type": "method",
            "tags": [
                "Sugar",
                "Proxy"
            ],
            "since": "0.1.0",
            "source": {
                "line": 284,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "pcall",
            "desc": "Proxy for [Logger:pcall] on the root logger.",
            "params": [
                {
                    "name": "func",
                    "desc": "",
                    "lua_type": "function"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "function_type": "method",
            "tags": [
                "Sugar",
                "Proxy"
            ],
            "since": "0.1.0",
            "source": {
                "line": 296,
                "path": "Logging/init.lua"
            }
        },
        {
            "name": "xpcall",
            "desc": "Proxy for [Logger:xpcall] on the root logger.",
            "params": [
                {
                    "name": "func",
                    "desc": "",
                    "lua_type": "function"
                },
                {
                    "name": "errorHandler",
                    "desc": "",
                    "lua_type": "function"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "function_type": "method",
            "tags": [
                "Sugar",
                "Proxy"
            ],
            "since": "0.1.0",
            "source": {
                "line": 309,
                "path": "Logging/init.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Logging",
    "desc": "The root module object, which contains the root logger. \nAlso exposes proxy methods which operate on the root logger, e.g. [Logging:debug] calls [Logger:debug] on the root logger.",
    "source": {
        "line": 6,
        "path": "Logging/init.lua"
    }
}