octolog

octolog is a logging library built on top of std/logging for multi-threaded logging, it is used Channel to queue log message between different thread, then write to file or stdout.

start proc is required to initialize octolog, underneath it will spawn a single thread to listen for log message, then write it to file / stdout / stderr.

                                     
[ start log channel ] --> [ log ] --> [ queue in log channel ] ----> [ stdout / stderr ]
                                                                |
                                                                |--> [ file]

Install

octolog is published on nimble, you can install it via:

nimble install octolog

or from github

git clone https://github.com/jaar23/octolog.git

cd octolog && nimble install

Documentation: octolog

Getting started

A simple example on how to use library.

import octolog, os

# start octolog
octologStart()

info "hello octolog!"
debug "hello octolog!"
warn "hello octolog!"
error "hello octolog!"
notice "hello octolog!"
fatal "hello octolog!"

# stop octolog
octologStop()

you are allow to use info("some info") or info "some info".

In this example, a log file with current datetime will be created, for example, 202404052020.log, you can pass in different configuration to initialize octolog to achieve what you want.

example output

[2023-09-03T21:15:03] [INFO] test1:octolog started
[2023-09-03T21:15:03] [INFO] test1:hello octolog!
[2023-09-03T21:15:03] [DEBUG] test1:hello octolog!
[2023-09-03T21:15:03] [WARN] test1:hello octolog!
[2023-09-03T21:15:03] [ERROR] test1:hello octolog!
[2023-09-03T21:15:03] [NOTICE] test1:hello octolog! 
[2023-09-03T21:15:03] [FATAL] test1:hello octolog!
[2023-09-03T21:15:04] [INFO] test1:octolog stopped

Filelogger

octolog used std filelogger for file logging, as octolog only running in single thread, it is thread safe for using std/logging here. start proc have default FileLogger configure for all level. You can modify the behavior like below:

import octolog

var logLevel: seq[Level] = @[lvlInfo, lvlDebug, lvlError]
octologStart(fileName="octolog", fileloggerlvl=logLevel)

info "hello octolog!!"
debug "hello octolog!!"
error "hello octolog!!"

octologStop()

the example above will write log into 3 different files, info.log. debug.log, and error.log.

info.log consists of info level log.
debug.log consists of info, debug, warn, notice, fatal, error log.
error.log consists of error log.

More configuration on filelogger level, refer to the code example below:

# default start
octologStart()

# start logging with log file name "octolog.log"
octologStart(fileName="octolog")

# start logging with log file name "octolog.log" but disable file logger, it will not write log into file
octologStart(fileName="octolog", usefilelogger=false)

# start with log level defined and with log file name "octolog.info.log, octolog.xxx.log, ..."
var logLevel: seq[Level] = @[lvlInfo, lvlDebug, lvlError, lvlWarn, lvlFatal, lvlNotice]
octologStart(fileName="octolog", fileloggerlvl=logLevel)

RollingFileLogger

logging file is going to grow. octolog also used RollingFileLogger to automatic archive and continue logging on a new file.

import octolog

# start octolog with filerolling  enabled 
# and number of lines should kept before archive the log file
octolog_start(fileRolling=true, maxLines=4)

info("hello octolog~")
info "hello octolog!"

octolog_stop()