A class that provides simple logging facilities for AutoHotkey

This log-Class supports

• Loglevel allows to define to a hierarchy of log messages and controls which messages are logged

• Layout of the logged message

• Appenders to the the channels to be logged to

Each message has to be logged on a certain loglevel. Consider the loglevel as the severity of the message you want to log: some logmessages are used for simple debug purposes, whereas other logmessages may indicate an Error. In some situations you want to see a very detailled logging - in other situations you just want to be notified about errors ... Both can be managed via loglevel.

Layouts allow to determine the format of the messages to be logged (see layout)

Appenders define the "channels" to be logged to. Currently following appenders can be used:

You might choose several appenders to be logged on simultaneously

log4ahk is implemented as singleton, so there is only one existing instance. Each change on loglevel, layout will be a global change and be valid from the time of change.

#include log4ahk.ahk

logger := new log4ahk()
; Enable logging to STDOUT
logger.appenders.push(new logger.appender.stdout())
; Set the loglevel to be filtered upon
logger.loglevel.required := logger.loglevel.TRACE
; Show loglevel, current function, computername and log message in log protocol
logger.layout.required := "[%-5.5V] {%-15.15M}{%H} %m"
logger.trace("TRACE - Test TRACE")
logger.debug("TRACE - Test DEBUG")
logger.info("TRACE - Test INFO")

f1()
return

;########################################################
f1() {
    logger := new log4ahk()
    ;Change the loglevel to be filtered upon
    logger.loglevel.required := logger.loglevel.INFO
    logger.trace("INFO - Test TRACE") ; shouldn't be logged due to required loglevel
    logger.debug("INFO - Test DEBUG") ; shouldn't be logged due to required loglevel
    logger.info("INFO - Test INFO")
}

; Output:
;[TRACE] {# }{XYZ-COMP} TRACE - Test TRACE
;[DEBUG] {# }{XYZ-COMP} TRACE - Test DEBUG
;[INFO ] {# }{XYZ-COMP} TRACE - Test INFO
;[INFO ] {f1}{XYZ-COMP} INFO - Test INFO

Helper class for log4ahk (Implementing appender via outputdebug)

Logs messages via OutputDebug

logger.appenders.push(new logger.appenderoutputdebug())

Helper class for log4ahk (Implementing appender via stdout)

Logs messages via StdOut

logger.appenders.push(new logger.appenderstdout())

Helper class for log4ahk (Implementing layout)

Creates a pattern layout according to log4j-layout and a couple of log4ahk-specific extensions.

The following placeholders can be used within the layout string:

Most placeholders can be extended with formatting instructions, just similar to format:

Fine tuning with curlies:

Some placeholders have special functions defined if you add curlies with content after them:

To set a layout use

logger.layout.required := "[%-5.5V] {%-15.15M}{%H} %m"

Helper class for log4ahk (Implementing loglevels)

Loglevels support the following needs

• prioritize your log messages due to importance of the log message (from TRACE to FATAL)

• control which level of log messages are currently to be logged

• Different priorities/hierarchical loglevels are supported

• The priorities are trace (1) <- debug (2) <- info (3) <- warn (4) <- error (5) <- fatal (6)

• to log with a certain priority, separate methods are available (trace, debug, info, warn, error, fatal)

• To filter messages due currently desired loglevel, set the property logger.loglevel.required to the required loglevel