Written by David Fort (firstname.lastname@example.org) Process this file with groff -man -Tascii wlog.7
NAMEwLog - WinPR logging facility
DESCRIPTIONwLog is a configurable and flexible logging system used throughout WinPR and FreeRDP.
The primary concept is to have a hierarchy of loggers that can be be configured independently.
WLog uses different appenders that define where the log output should be written to. If the application doesn't explicitly configure the appenders the below described variable WLOG_APPENDER can be used to choose one appender.
The following kind of appenders are available:
Write the log data into a binary format file.
The console appender writes to the console. Depending of the operating system
the application runs on, the output might be handled differently. For example
on android log print would be used.
The file appender writes the textual output to a file.
This appender sends the logging messages to a pre-defined remote host via UDP.
If no target is set the default one 127.0.0.1:20000 is used. To receive the log messages one can use netcat. To receive the default target the following command can be used: nc -u 127.0.0.1 -p 20000 -l
- Use syslog for outputting the debug messages.
This appender outputs messages to journald.
LevelsThe WLog are complementary, the higher level always includes the lower ones. The level list below is top down. Top the highest level.
- print everything including packets dumps
- debug messages
- general information
- fatal problems
completely disable the wlog output
FormatsThe format a logger prints has the following possible options:
- log level
- module name
- file name
- line number
- process id
- thread id
- day of week
A maximum of 16 options can be used per format string.
An example that generally sets the WLOG_PREFIX for xfreerdp would look like: WLOG_PREFIX="pid=%pid:tid=%tid:fn=%fn -" xfreerdp /v:xxx
The kind of appender, the accepted values are: CONSOLE, FILE, BINARY, SYSLOG, JOURNALD or UDP
configure the prefix used for outputting the message (see Format for more details and examples)
the level to output messages for
sets a filter for WLog messages. Only the filtered messages are
printed. The format of the filter is a series of <logger name>:<level> separated by
example: WLOG_FILTER=core.channel:DEBUG,dummy:TRACE will display debug messages for the core.channel logger and trace level for the dummy logger
When using the file appender it may contains the output log file's path
When using the file appender it may contains the output log file's name
When using the systemd journal appender, this variable contains the id used with
the journal (by default the executable's name)
target to use for the UDP appender in the format