https://github.com/rxi/log.lua

A tiny logging module for Lua
https://github.com/rxi/log.lua

Last synced: 14 days ago
JSON representation

A tiny logging module for Lua

• Host: GitHub
• URL: https://github.com/rxi/log.lua
• Owner: rxi
• License: mit
• Created: 2014-07-03T20:02:28.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-08-23T03:10:40.000Z (about 1 year ago)
• Last Synced: 2024-07-31T20:48:16.440Z (3 months ago)
• Language: Lua
• Size: 15.6 KB
• Stars: 303
• Watchers: 12
• Forks: 86
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-love2d - log.lua - Library for configurable log output. (Utilities)

README

        
# log.lua

A tiny logging module for Lua. 

![screenshot from 2014-07-04 19 55 55](https://cloud.githubusercontent.com/assets/3920290/3484524/2ea2a9c6-03ad-11e4-9ed5-a9744c6fd75d.png)

## Installation

The [log.lua](log.lua?raw=1) file should be dropped into an existing project

and required by it.

```lua

log = require "log"

``` 

## Usage

log.lua provides 6 functions, each function takes all its arguments,

concatenates them into a string then outputs the string to the console and --

if one is set -- the log file:

* **log.trace(...)**

* **log.debug(...)**

* **log.info(...)**

* **log.warn(...)**

* **log.error(...)**

* **log.fatal(...)**

### Additional options

log.lua provides variables for setting additional options:

#### log.usecolor

Whether colors should be used when outputting to the console, this is `true` by

default. If you're using a console which does not support ANSI color escape

codes then this should be disabled.

#### log.outfile

The name of the file where the log should be written, log files do not contain

ANSI colors and always use the full date rather than just the time. By default

`log.outfile` is `nil` (no log file is used). If a file which does not exist is

set as the `log.outfile` then it is created on the first message logged. If the

file already exists it is appended to.

#### log.level

The minimum level to log, any logging function called with a lower level than

the `log.level` is ignored and no text is outputted or written. By default this

value is set to `"trace"`, the lowest log level, such that no log messages are

ignored.

The level of each log mode, starting with the lowest log level is as follows:

`"trace"` `"debug"` `"info"` `"warn"` `"error"` `"fatal"`

## License

This library is free software; you can redistribute it and/or modify it under

the terms of the MIT license. See [LICENSE](LICENSE) for details.