1wLog(7) 2.0 wLog(7)
2
6 wLog - WinPR logging facility
7
10 wLog is a configurable and flexible logging system used throughout
11 WinPR and FreeRDP.
12 The primary concept is to have a hierarchy of loggers that can be be
14 configured independently.
15
18 WLog uses different appenders that define where the log output should
19 be written to. If the application doesn't explicitly configure the
20 appenders the below described variable WLOG_APPENDER can be used to
21 choose one appender.
22 The following kind of appenders are available:
24 Binary Write the log data into a binary format file.
27 Console
30 The console appender writes to the console. Depending of the
31 operating system the application runs on, the output might be
32 handled differently. For example on android log print would be
33 used.
34 File The file appender writes the textual output to a file.
37 Udp This appender sends the logging messages to a pre-defined remote
40 host via UDP.
41 If no target is set the default one 127.0.0.1:20000 is used. To
43 receive the log messages one can use netcat. To receive the
44 default target the following command can be used: nc -u
45 127.0.0.1 -p 20000 -l
46 Syslog Use syslog for outputting the debug messages.
48 Journald
50 This appender outputs messages to journald.
51
54 The WLog are complementary, the higher level always includes the lower
55 ones. The level list below is top down. Top the highest level.
56 TRACE print everything including packets dumps
59 DEBUG debug messages
61 INFO general information
63 WARN warnings
65 ERROR errors
67 FATAL fatal problems
69 OFF completely disable the wlog output
71
74 The format a logger prints has the following possible options:
75 lv log level
78 mn module name
80 fl file name
82 fn function
84 ln line number
86 pid process id
88 tid thread id
90 yr year
92 mo month
94 dw day of week
96 hr hour
98 mi minute
100 se second
102 ml millisecond
104 A maximum of 16 options can be used per format string.
106 An example that generally sets the WLOG_PREFIX for xfreerdp would look
108 like: WLOG_PREFIX="pid=%pid:tid=%tid:fn=%fn -" xfreerdp /v:xxx
109
113 WLOG_APPENDER
114 The kind of appender, the accepted values are: CONSOLE, FILE,
115 BINARY, SYSLOG, JOURNALD or UDP
116 WLOG_PREFIX
119 configure the prefix used for outputting the message (see Format
120 for more details and examples)
121 WLOG_LEVEL
124 the level to output messages for
125 WLOG_FILTER
128 sets a filter for WLog messages. Only the filtered messages are
129 printed. The format of the filter is a series of <logger
130 name>:<level> separated by comas
131 example: WLOG_FILTER=core.channel:DEBUG,dummy:TRACE will display
133 debug messages for the core.channel logger and trace level for
134 the dummy logger
135 WLOG_FILEAPPENDER_OUTPUT_FILE_PATH
138 When using the file appender it may contains the output log
139 file's path
140 WLOG_FILEAPPENDER_OUTPUT_FILE_NAME
143 When using the file appender it may contains the output log
144 file's name
145 WLOG_JOURNALD_ID
148 When using the systemd journal appender, this variable contains
149 the id used with the journal (by default the executable's name)
150 WLOG_UDP_TARGET
153 target to use for the UDP appender in the format host:port
154
157 Please report any bugs using the bug reporting form on the FreeRDP web
158 site
159
162 Additional information and the latest version is available at the web
163 site: http://www.freerdp.com
164
167 David Fort <contact@hardening-consulting.com> wrote this manpage from
168 materials written by Bernhard Miklautz <bernhard.miklautz@thin‐
169 cast.com>.
170Version June 2016 wLog(7)