Skip to content

Latest commit

 

History

History
93 lines (81 loc) · 3.86 KB

README.md

File metadata and controls

93 lines (81 loc) · 3.86 KB
Raw

Logd Build Status

Logd is a log scanner daemon that exposes a Lua API to run arbitrary logic on structured logs.

Logd module API

Builtin Description
function logd.log_get (logptr, key) value Get a property from the log
function logd.log_set (logptr, key, value) Set a property to the log
function logd.log_remove (logptr, key) Remove a property from a log
function logd.log_reset (logptr) Reset all log properties
function logd.log_clone (logptr) logptr Make a safe clone of logptr which will be managed by lua's GC.
function logd.to_str (logptr) str Serialize a log into a string
function logd.to_logptr (table) logptr Convert a table into a logptr
function logd.to_table (logptr) table Convert a logptr into a table
function logd.print (string|table|logptr) Serialize message or table into a log string and print it to the standard output
Hook Description
function logd.on_log (logptr) Logs are scanned and supplied to this handler. Use logd.log_* set of functions to manipulate them.
function logd.on_exit (code, reason) Called when collector is gracefully terminating.
function logd.on_error (error, logptr, at) Called when collector failed to scan a log line. Scanning will resume after this function returns.

Preloaded Lua modules

Optionally Preloaded Lua modules

Depending on the build, the following modules are preloaded:

Build instructions

Run configure script and then make:

$ ./configure
$ make
$ make install

If you have problems linking with a system dependency, you can configure the project to build the dependency from source:

$ ./configure --enable-build-luajit --enable-build-openssl
$ make

Alternatively, you can provide your own CFLAGS or LDFLAGS:

$ ./configure CFLAGS='-DOPENSSL_NO_STDIO -DOPENSSL_NO_SM2'
$ make

Finally, you can also disable some of the modules:

$ ./configure --without-openssl --without-lpeg
$ make

For a full list of options run ./configure --help.

Please refer to the Docker images in utils to see some of the common options and CFLAGS used by the different Linux distros.

MacOS Build instructions

Assuming you have Homebrew installed:

$ brew update && brew bundle --file=utils/Brewfile
$ export LIBTOOL=glibtool
$ export LIBTOOLIZE=glibtoolize
$ ./configure --enable-build-all
$ make && make install

Please refer to MacOS section in .travis.yml to see the latest build options.

Scanning

The builtin scanner expects logs to be in the following format:

YYYY-MM-dd hh:mm:ss	LEVEL	[Thread]	Class	key: value...

If you need to scan logs in a different format, you can load a dynamic shared object that implements src/scanner.h via the --scanner flag. For static builds (if dlopen is disabled) or if you simply want to build the project with a different builtin scanner, you can configure so with:

$ ./configure --with-builtin-scanner=my_scanner.c

For a list of available scanners look for the source files in src that end in _scanner.c.

Running tests

Configure and enable the development build:

$ ./configure --enable-develop
$ make
$ make test

Luvit

Logd uses Libuv under the hood and is compatible with Luvit modules. The Luvit runtime and standard modules are not preloaded by default but you can do so by running lit install luvit/luvit in your script's directory and then supplying your script to the logd executable.