KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

lua-log

★ 114 Open GitHub ↗

Asynchronous logging library for Lua

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Logging library for Lua 5.1/5.2

[![Build Status](https://buildhive.cloudbees.com/job/moteus/job/lua-log/badge/icon)](https://buildhive.cloudbees.com/job/moteus/job/lua-log/)
[![Build Status](https://travis-ci.org/moteus/lua-log.svg?branch=master)](https://travis-ci.org/moteus/lua-log)
[![Licence](http://img.shields.io/badge/Licence-MIT-brightgreen.svg)](https://raw.githubusercontent.com/moteus/lua-log/master/LICENCE.txt)

***

## Usage ##

### Write to roll file and to console ###

```lua
local LOG = require "log".new(
  -- maximum log level
  "trace",

-- Writer
  require 'log.writer.list'.new(               -- multi writers:
    require 'log.writer.console.color'.new(),  -- * console color
    require 'log.writer.file.roll'.new(        -- * roll files
      './logs',                                --   log dir
      'events.log',                            --   current log name
      10,                                      --   count files
      10*1024*1024                             --   max file size in bytes
    )
  ),

-- Formatter
  require "log.formatter.concat".new()
)

LOG.error("some", "error")
```

### Write to file from separate thread ###

```lua
local LOG = require "log".new(
  require "log.writer.async.zmq".new(
    'inproc://async.logger',
    function() -- calls from separate thread/Lua state
      return require 'log.writer.file.by_day'.new(
        './logs', 'events.log', 5000
      )
    end
  )
)

LOG.error("some error")
```

### More complex example ###

```lua
local host = arg[1] or '127.0.0.1'
local port = arg[2] or 514

-- this code run in separate thread.
local InitWriter = [[
  return require 'log.writer.list'.new(                  -- multi writers:
    require 'log.writer.console.color'.new(),            -- * console color
    require 'log.writer.net.zmq'.new('%{zmq_cnn_host}'), -- * zmq pub socket
    require "log.writer.format".new(                     -- * syslog over udp
      require "log.logformat.syslog".new("user"),
      require 'log.writer.net.udp'.new('%{udp_cnn_host}', %{udp_cnn_port})
    )
  )
]]

-- create async writer and run new work thread.
-- communicate with work thread using zmq library
local writer = require "log.writer.async.zmq".new(
  'inproc://async.logger', 
  InitWriter:gsub('%%{(.-)}', {
    zmq_cnn_host = 'tcp://' .. host .. ':' .. port;
    udp_cnn_host = host;
    udp_cnn_port = port;
  })
)

-- create new logger
local LOG = require"log".new(writer)

require "socket".sleep(0.5) -- net.zmq need time to connect

LOG.fatal("can not allocate memory")
LOG.error("file not found")
LOG.warning("cache server is not started")
LOG.info("new message is received")
LOG.notice("message has 2 file")

print("Press enter ...") io.flush() io.read()
```

### Sendout logs to separate process/host

This example show how to send logs in 2 separate destination
with 2 formats. Write to stdout as whell as to remote syslog
server. In fact here no async on Lua side. Application write
to network directly from main thread. But it is possible use
one or more work threads that will do this.

```Lua
-- Buld writer with 2 destinations
local writer = require "log.writer.list".new(
  require "log.writer.format".new(
    -- explicit set logformat to stdout writer
    require "log.logformat.default".new(), 
    require "log.writer.stdout".new()
  ),
  -- define network writer.
  -- This writer has no explicit format so it will
  -- use one defined for logger.
  require "log.writer.net.udp".new('127.0.0.1', 514)
)

local function SYSLOG_NEW(level, ...)
  return require "log".new(level, writer,
    require "log.formatter.mix".new(),
    require "log.logformat.syslog".new(...)
  )
end

local SYSLOG = {
  -- Define first syslog logger with some settings
  KERN = SYSLOG_NEW('trace', 'kern'),
  
  -- Define second syslog logger with other settings
  USER = SYSLOG_NEW('trace', 'USER'),
}

SYSLOG.KERN.emerg ('emergency message')
SYSLOG.USER.alert ('alert message')
```

## Dependences ##

### core ###
* [LuaDate](https://github.com/Tieske/date)

### writer.async.udp ###
* [llthreads2](http://github.com/moteus/lua-llthreads2)
* or [llthreads](http://github.com/Neopallium/lua-llthreads)
* writer.net.udp

### writer.async.zmq ###
* [llthreads2](http://github.com/moteus/lua-llthreads2)
* or [llthreads](http://github.com/Neopallium/lua-llthreads)
* writer.net.zmq

### writer.async.lane ###
* [LuaLanes](https://github.com/LuaLanes/lanes) - This is experemental writer

### writer.console.color ###
* ansicolors
* or lua-conio
* or cio (Windows only)

### writer.file.by_day ###
* [lfs](http://keplerproject.github.com/luafilesystem)

### writer.net.udp ###
* [LuaSocket](http://www.impa.br/~diego/software/luasocket)

### writer.net.zmq ###
* [lzmq](http://github.com/moteus/lzmq)
* or [lua-zmq](http://github.com/Neopallium/lua-zmq)

### writer.net.smtp ###
* [LuaSocket](http://www.impa.br/~diego/software/luasocket)
* [lua-sendmail](http://github.com/moteus/lua-sendmail)

lua-log

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README