This is the hu.dwim.logger Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri May 15 12:26:55 2026 GMT+0.
The main system appears first, followed by any subsystem dependency.
hu.dwim.loggerGeneric purpose logger utility.
Tamás Borbély <tomi.borbely@gmail.com>
Attila Lendvai <attila.lendvai@gmail.com>
Levente Mészáros <levente.meszaros@gmail.com>
BSD or Bugroff
hu.dwim.asdf (system).
bordeaux-threads (system).
hu.dwim.def/namespace (system).
hu.dwim.def+hu.dwim.common (system).
hu.dwim.defclass-star+hu.dwim.def (system).
hu.dwim.util (system).
hu.dwim.util/threads (system).
local-time (system).
source (module).
Modules are listed depth-first from the system components tree.
hu.dwim.logger/sourcehu.dwim.logger (system).
api.lisp (file).
appender.lisp (file).
formatter.lisp (file).
logger.lisp (file).
package.lisp (file).
root-logger.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
hu.dwim.logger/hu.dwim.logger.asdhu.dwim.logger/source/api.lisphu.dwim.logger/source/appender.lisphu.dwim.logger/source/formatter.lisphu.dwim.logger/source/logger.lisphu.dwim.logger/source/package.lisphu.dwim.logger/source/root-logger.lisphu.dwim.logger/hu.dwim.logger.asdhu.dwim.logger (system).
hu.dwim.logger/source/api.lisppackage.lisp (file).
source (module).
append-message (generic function).
appender (class).
format-message (generic function).
handle-log-message (generic function).
log-to-console (function).
appenderp (function).
formatter (class).
formatter-of (reader method).
(setf formatter-of) (writer method).
formatterp (function).
hu.dwim.logger/source/appender.lispapi.lisp (file).
formatter.lisp (file).
logger.lisp (file).
source (module).
*log-directory* (special variable).
append-message (method).
append-message (method).
append-message (method).
append-message (method).
append-message (method).
caching-appender (class).
file-appender (class).
flush-caching-appender (function).
flush-caching-appenders (function).
initialize-instance (method).
level-filtering-appender (class).
make-file-appender (function).
make-level-filtering-appender (function).
make-stream-appender (function).
make-thread-safe-file-appender (function).
make-thread-safe-stream-appender (function).
print-object (method).
print-object (method).
stream-appender (class).
thread-safe-file-appender (class).
thread-safe-stream-appender (class).
+caching-appender/maximum-cache-size+ (constant).
async-flushing? (reader method).
(setf async-flushing?) (writer method).
cache-of (reader method).
(setf cache-of) (writer method).
caching-appender-p (function).
call-with-lock-held-on-caching-appender (function).
call-with-output-to-file-appender-file (function).
chained-appenders-of (reader method).
(setf chained-appenders-of) (writer method).
file-appender-output-file (function).
file-appender-p (function).
find-caching-appender (function).
(setf find-caching-appender) (function).
flush-caching-appender-messages (generic function).
format-or-write-string (function).
last-flushed-at-of (reader method).
(setf last-flushed-at-of) (writer method).
lazy-flushing? (reader method).
(setf lazy-flushing?) (writer method).
level-filtering-appender-p (function).
lock-of (reader method).
(setf lock-of) (writer method).
log-file-of (reader method).
(setf log-file-of) (writer method).
logger-name-for-output (function).
minimum-level-of (reader method).
(setf minimum-level-of) (writer method).
stream-appender-p (function).
stream-of (method).
stream-of (reader method).
(setf stream-of) (writer method).
thread-safe-file-appender-p (function).
thread-safe-stream-appender-p (function).
with-lock-held-on-caching-appender (macro).
with-output-to-file-appender-file (macro).
hu.dwim.logger/source/formatter.lispapi.lisp (file).
logger.lisp (file).
source (module).
brief-formatter (class).
format-message (method).
format-message (method).
format-message (method).
parsable-formatter (class).
verbose-formatter (class).
+max-logger-name-length+ (constant).
brief-formatter-p (function).
last-message-day-of (reader method).
(setf last-message-day-of) (writer method).
last-message-month-of (reader method).
(setf last-message-month-of) (writer method).
last-message-year-of (reader method).
(setf last-message-year-of) (writer method).
parsable-formatter-p (function).
verbose-formatter-p (function).
hu.dwim.logger/source/logger.lispapi.lisp (file).
source (module).
+debug+ (constant).
+dribble+ (constant).
+error+ (constant).
+fatal+ (constant).
+info+ (constant).
+log-level-keywords+ (constant).
+log-level-names+ (constant).
+warn+ (constant).
deflogger (macro).
find-logger (compiler macro).
find-logger (function).
(setf find-logger) (function).
handle-log-message (method).
log-level (function).
(setf log-level) (function).
log-level (type).
log-level/compile-time (function).
(setf log-level/compile-time) (function).
log-level/runtime (function).
(setf log-level/runtime) (function).
logger (class).
make-load-form (method).
print-object (method).
set-log-level (function).
shared-initialize (method).
with-logger-level (macro).
%find-logger (function).
(setf %find-logger) (function).
*toplevel-logger* (special variable).
appenders-of (reader method).
(setf appenders-of) (writer method).
at-compile-time-enabled? (function).
at-runtime-enabled? (function).
call-handle-log-message (function).
call-with-logging-io (function).
children-of (reader method).
(setf children-of) (writer method).
collect-helper-names (function).
compile-time-level-of (reader method).
(setf compile-time-level-of) (writer method).
documentation-of (reader method).
(setf documentation-of) (writer method).
logger-name (type).
loggerp (function).
name-of (reader method).
(setf name-of) (writer method).
note-logging-error (function).
parents-of (reader method).
(setf parents-of) (writer method).
runtime-level-of (reader method).
(setf runtime-level-of) (writer method).
validate-log-level (function).
with-logging-io (macro).
hu.dwim.logger/source/root-logger.lisplogger.lisp (file).
api.lisp (file).
appender.lisp (file).
source (module).
root-logger.debug (macro).
root-logger.dribble (macro).
root-logger.error (macro).
root-logger.fatal (macro).
root-logger.info (macro).
root-logger.warn (macro).
setup-logging-for-production (function).
Packages are listed by definition order.
hu.dwim.loggerhu.dwim.asdf.
hu.dwim.common.
hu.dwim.def.
hu.dwim.util.
*log-directory* (special variable).
+debug+ (constant).
+dribble+ (constant).
+error+ (constant).
+fatal+ (constant).
+info+ (constant).
+log-level-keywords+ (constant).
+log-level-names+ (constant).
+warn+ (constant).
append-message (generic function).
appender (class).
brief-formatter (class).
caching-appender (class).
deflogger (macro).
file-appender (class).
find-logger (compiler macro).
find-logger (function).
(setf find-logger) (function).
flush-caching-appender (function).
flush-caching-appenders (function).
format-message (generic function).
handle-log-message (generic function).
level-filtering-appender (class).
log-level (function).
(setf log-level) (function).
log-level (type).
log-level/compile-time (function).
(setf log-level/compile-time) (function).
log-level/runtime (function).
(setf log-level/runtime) (function).
log-to-console (function).
logger (class).
make-file-appender (function).
make-level-filtering-appender (function).
make-stream-appender (function).
make-thread-safe-file-appender (function).
make-thread-safe-stream-appender (function).
parsable-formatter (class).
root-logger.debug (macro).
root-logger.dribble (macro).
root-logger.error (macro).
root-logger.fatal (macro).
root-logger.info (macro).
root-logger.warn (macro).
set-log-level (function).
setup-logging-for-production (function).
stream-appender (class).
thread-safe-file-appender (class).
thread-safe-stream-appender (class).
verbose-formatter (class).
with-logger-level (macro).
%find-logger (function).
(setf %find-logger) (function).
*toplevel-logger* (special variable).
+caching-appender/maximum-cache-size+ (constant).
+max-logger-name-length+ (constant).
appenderp (function).
appenders-of (generic reader).
(setf appenders-of) (generic writer).
async-flushing? (generic reader).
(setf async-flushing?) (generic writer).
at-compile-time-enabled? (function).
at-runtime-enabled? (function).
brief-formatter-p (function).
cache-of (generic reader).
(setf cache-of) (generic writer).
caching-appender-p (function).
call-handle-log-message (function).
call-with-lock-held-on-caching-appender (function).
call-with-logging-io (function).
call-with-output-to-file-appender-file (function).
chained-appenders-of (generic reader).
(setf chained-appenders-of) (generic writer).
children-of (generic reader).
(setf children-of) (generic writer).
collect-helper-names (function).
compile-time-level-of (generic reader).
(setf compile-time-level-of) (generic writer).
documentation-of (generic reader).
(setf documentation-of) (generic writer).
file-appender-output-file (function).
file-appender-p (function).
find-caching-appender (function).
(setf find-caching-appender) (function).
flush-caching-appender-messages (generic function).
format-or-write-string (function).
formatter (class).
formatter-of (generic reader).
(setf formatter-of) (generic writer).
formatterp (function).
last-flushed-at-of (generic reader).
(setf last-flushed-at-of) (generic writer).
last-message-day-of (generic reader).
(setf last-message-day-of) (generic writer).
last-message-month-of (generic reader).
(setf last-message-month-of) (generic writer).
last-message-year-of (generic reader).
(setf last-message-year-of) (generic writer).
lazy-flushing? (generic reader).
(setf lazy-flushing?) (generic writer).
level-filtering-appender-p (function).
lock-of (generic reader).
(setf lock-of) (generic writer).
log-file-of (generic reader).
(setf log-file-of) (generic writer).
logger-name (type).
logger-name-for-output (function).
loggerp (function).
minimum-level-of (generic reader).
(setf minimum-level-of) (generic writer).
name-of (generic reader).
(setf name-of) (generic writer).
note-logging-error (function).
parents-of (generic reader).
(setf parents-of) (generic writer).
parsable-formatter-p (function).
runtime-level-of (generic reader).
(setf runtime-level-of) (generic writer).
stream-appender-p (function).
stream-of (generic function).
(setf stream-of) (generic writer).
thread-safe-file-appender-p (function).
thread-safe-stream-appender-p (function).
validate-log-level (function).
verbose-formatter-p (function).
with-lock-held-on-caching-appender (macro).
with-logging-io (macro).
with-output-to-file-appender-file (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Set the runtime level of the listed logger(s) to NEW-LEVEL and restore the original value in an unwind-protect.
The second line of the log message handling. Called for each logger-appender pair that receives this log message.
logger) (appender caching-appender) level message-control message-arguments) ¶logger) (appender level-filtering-appender) level message-control message-arguments) ¶logger) (appender file-appender) level message-control message-arguments) ¶logger) (appender stream-appender) level message-control message-arguments) ¶stream-appender) level message-control message-arguments) ¶This method is a customization point where subclasses can customize how to format the log message. Subclasses of stream-appender call this method by default, but some other appenders may chose not to call it by customizing APPEND-MESSAGE.
logger) appender (formatter parsable-formatter) level stream message-control message-arguments) ¶logger) appender (formatter verbose-formatter) level stream message-control message-arguments) ¶logger) appender (formatter brief-formatter) level stream message-control message-arguments) ¶(eql nil)) message-control message-arguments) ¶The first line of the log message handling, called by the printer macros. The default implementation if this method delegates the call to all the parents of the logger.
caching-appender) &key) ¶file-appender) stream0) ¶stream-appender) stream0) ¶:formatter
Minimal overhead text in messages. This amounts to: not printing the package names of loggers and log levels and a more compact printing of the current time.
0
:last-message-year
0
:last-message-month
0
:last-message-day
(bordeaux-threads:make-lock "a caching-appender of hu.dwim.logger")
:lock
(hu.dwim.util:get-monotonic-time)
:last-flushed-at
(make-array hu.dwim.logger::+caching-appender/maximum-cache-size+ :adjustable nil :fill-pointer 0)
:cache
Is it ok to call FLUSH-CACHING-APPENDER-MESSAGES without holding the appender lock?
boolean
:async-flushing
If an external entity regularly call FLUSH-CACHING-APPENDER on us, then we may be lazy flushing.
boolean
t
:lazy-flushing
Logs to a file.
Name of the file to write log messages to.
:log-file
Drops messages below MINIMUM-LEVEL and forwards the others to CHAINED-APPENDERS.
append-message.
append-message.
append-message.
append-message.
(setf appenders-of).
appenders-of.
(setf children-of).
children-of.
(setf compile-time-level-of).
compile-time-level-of.
(setf documentation-of).
documentation-of.
format-message.
format-message.
format-message.
handle-log-message.
make-load-form.
(setf name-of).
name-of.
(setf parents-of).
parents-of.
print-object.
(setf runtime-level-of).
runtime-level-of.
shared-initialize.
The parent logger this logger inherits from.
:parents
The loggers which inherit from this logger.
:children
A list of appender objects this logger should send messages to.
:appenders
The runtime log level determines whether an actual log message shows up at runtime.
(or null integer)
:runtime-level
The compile time log level is a compile time filter. Log expressions below this level will macro-expand to NIL at compile time.
(or null integer)
:compile-time-level
:name
common-lisp.
:documentation
The output of the file logger is not meant to be read directly by a human.
Human readable logger.
common-lisp.
(quote *standard-output*)
:stream
Attempts to be as precise as possible, logger names and log level names are printed with a package prefix and the time is printed in long format.
While inside HANDLE-LOG-MESSAGE, this variable is bound to the logger on which HANDLE-LOG-MESSAGE was called first, ignoring logger inheritance and handler delegation.
caching-appender)) ¶caching-appender)) ¶Is it ok to call FLUSH-CACHING-APPENDER-MESSAGES without holding the appender lock?
caching-appender)) ¶automatically generated reader method
caching-appender)) ¶automatically generated writer method
level-filtering-appender)) ¶automatically generated reader method
level-filtering-appender)) ¶automatically generated writer method
thread-safe-file-appender) lines) ¶thread-safe-stream-appender) lines) ¶caching-appender) lines) ¶caching-appender)) ¶automatically generated reader method
caching-appender)) ¶automatically generated writer method
brief-formatter)) ¶automatically generated reader method
brief-formatter)) ¶automatically generated writer method
brief-formatter)) ¶automatically generated reader method
brief-formatter)) ¶automatically generated writer method
brief-formatter)) ¶automatically generated reader method
brief-formatter)) ¶automatically generated writer method
caching-appender)) ¶caching-appender)) ¶If an external entity regularly call FLUSH-CACHING-APPENDER on us, then we may be lazy flushing.
caching-appender)) ¶automatically generated reader method
lock.
caching-appender)) ¶automatically generated writer method
lock.
file-appender)) ¶file-appender)) ¶Name of the file to write log messages to.
level-filtering-appender)) ¶automatically generated reader method
level-filtering-appender)) ¶automatically generated writer method
stream-appender)) ¶automatically generated reader method
stream-appender)) ¶automatically generated writer method
| Jump to: | %
(
A B C D F G H I L M N P R S T V W |
|---|
| Jump to: | %
(
A B C D F G H I L M N P R S T V W |
|---|
| Jump to: | *
+
A C D F L M N P R S |
|---|
| Jump to: | *
+
A C D F L M N P R S |
|---|
| Jump to: | A B C F H L M P R S T V |
|---|
| Jump to: | A B C F H L M P R S T V |
|---|