Skip to content

install.md

Latest commit

 

History

History
44 lines (28 loc) · 1.46 KB

install.md

File metadata and controls

44 lines (28 loc) · 1.46 KB
Raw

Logging kdb-x installation

log.q is written as a module, under KDB-X's module framework. Though modules can be loaded from anywhere if added to your $QPATH, we recommend installing under a kx folder within your $QPATH. This is to avoid name clashes with other user defined modules, as well as providing a name for other KX modules to cross reference each other.

.log.q depends on the printf library from KX and assumes it is a sibling of log.q

Installing a Release

It is recommended that a user install this module through a release.

Download a release and then unzip to your module directory. The following example assumes the default install location for KDB-X.

unzip logging.zip -d ~/.kx/mod

Installing from Source

git clone https://github.com/KxSystems/logging.git
cd logging

Move log.q into your module directory, under kx. The following example assumes the default install location for KDB-X.

mkdir -p ~/.kx/mod/kx
cp test.q ~/.kx/mod/kx/

Next Steps

Now from anywhere you can import the logging library.

q).logger:use`kx.log;
q).log:.logger.createLog[];
q).log.info "Hello World!";
2025.10.30D11:23:36.826956689 info PID[78061] HOST[a-lptp-p2myzzg4] Hello World!

You're ready to check out some of the tests we've provided here and the reference to get started