|
Packit |
1fb8d4 |
.\" Written by David Fort (contact@hardening-consulting.com)
|
|
Packit |
1fb8d4 |
.\" Process this file with
|
|
Packit |
1fb8d4 |
.\" groff -man -Tascii wlog.7
|
|
Packit |
1fb8d4 |
.\"
|
|
Packit |
1fb8d4 |
.TH wLog 7 "June 2016" Version "2.0"
|
|
Packit |
1fb8d4 |
.SH NAME
|
|
Packit |
1fb8d4 |
wLog \- WinPR logging facility
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.SH DESCRIPTION
|
|
Packit |
1fb8d4 |
wLog is a configurable and flexible logging system used throughout WinPR and
|
|
Packit |
1fb8d4 |
FreeRDP.
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
The primary concept is to have a hierarchy of loggers that can be be configured
|
|
Packit |
1fb8d4 |
independently.
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.SH Appenders
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
WLog uses different appenders that define where the log output should be written
|
|
Packit |
1fb8d4 |
to. If the application doesn't explicitly configure the appenders the below
|
|
Packit |
1fb8d4 |
described variable WLOG_APPENDER can be used to choose one appender.
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
The following kind of appenders are available:
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.IP Binary
|
|
Packit |
1fb8d4 |
Write the log data into a binary format file.
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.IP Console
|
|
Packit |
1fb8d4 |
The console appender writes to the console. Depending of the operating system
|
|
Packit |
1fb8d4 |
the application runs on, the output might be handled differently. For example
|
|
Packit |
1fb8d4 |
on android log print would be used.
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.IP File
|
|
Packit |
1fb8d4 |
The file appender writes the textual output to a file.
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.IP Udp
|
|
Packit |
1fb8d4 |
This appender sends the logging messages to a pre-defined remote host via UDP.
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
If no target is set the default one 127.0.0.1:20000 is used. To receive the
|
|
Packit |
1fb8d4 |
log messages one can use netcat. To receive the default target the following
|
|
Packit |
1fb8d4 |
command can be used:
|
|
Packit |
1fb8d4 |
nc -u 127.0.0.1 -p 20000 -l
|
|
Packit |
1fb8d4 |
.IP Syslog
|
|
Packit |
1fb8d4 |
Use syslog for outputting the debug messages.
|
|
Packit |
1fb8d4 |
.IP Journald
|
|
Packit |
1fb8d4 |
This appender outputs messages to journald.
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.SH Levels
|
|
Packit |
1fb8d4 |
The WLog are complementary, the higher level always includes the lower ones.
|
|
Packit |
1fb8d4 |
The level list below is top down. Top the highest level.
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.IP TRACE
|
|
Packit |
1fb8d4 |
print everything including packets dumps
|
|
Packit |
1fb8d4 |
.IP DEBUG
|
|
Packit |
1fb8d4 |
debug messages
|
|
Packit |
1fb8d4 |
.IP INFO
|
|
Packit |
1fb8d4 |
general information
|
|
Packit |
1fb8d4 |
.IP WARN
|
|
Packit |
1fb8d4 |
warnings
|
|
Packit |
1fb8d4 |
.IP ERROR
|
|
Packit |
1fb8d4 |
errors
|
|
Packit |
1fb8d4 |
.IP FATAL
|
|
Packit |
1fb8d4 |
fatal problems
|
|
Packit |
1fb8d4 |
.IP OFF
|
|
Packit |
1fb8d4 |
completely disable the wlog output
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.SH Formats
|
|
Packit |
1fb8d4 |
The format a logger prints has the following possible options:
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.IP lv
|
|
Packit |
1fb8d4 |
log level
|
|
Packit |
1fb8d4 |
.IP mn
|
|
Packit |
1fb8d4 |
module name
|
|
Packit |
1fb8d4 |
.IP fl
|
|
Packit |
1fb8d4 |
file name
|
|
Packit |
1fb8d4 |
.IP fn
|
|
Packit |
1fb8d4 |
function
|
|
Packit |
1fb8d4 |
.IP ln
|
|
Packit |
1fb8d4 |
line number
|
|
Packit |
1fb8d4 |
.IP pid
|
|
Packit |
1fb8d4 |
process id
|
|
Packit |
1fb8d4 |
.IP tid
|
|
Packit |
1fb8d4 |
thread id
|
|
Packit |
1fb8d4 |
.IP yr
|
|
Packit |
1fb8d4 |
year
|
|
Packit |
1fb8d4 |
.IP mo
|
|
Packit |
1fb8d4 |
month
|
|
Packit |
1fb8d4 |
.IP dw
|
|
Packit |
1fb8d4 |
day of week
|
|
Packit |
1fb8d4 |
.IP hr
|
|
Packit |
1fb8d4 |
hour
|
|
Packit |
1fb8d4 |
.IP mi
|
|
Packit |
1fb8d4 |
minute
|
|
Packit |
1fb8d4 |
.IP se
|
|
Packit |
1fb8d4 |
second
|
|
Packit |
1fb8d4 |
.IP ml
|
|
Packit |
1fb8d4 |
millisecond
|
|
Packit |
1fb8d4 |
.PP
|
|
Packit |
1fb8d4 |
A maximum of 16 options can be used per format string.
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
An example that generally sets the WLOG_PREFIX for xfreerdp would look like:
|
|
Packit |
1fb8d4 |
WLOG_PREFIX="pid=%pid:tid=%tid:fn=%fn -" xfreerdp /v:xxx
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.SH ENVIRONMENT
|
|
Packit |
1fb8d4 |
.IP WLOG_APPENDER
|
|
Packit |
1fb8d4 |
The kind of appender, the accepted values are: CONSOLE, FILE, BINARY, SYSLOG, JOURNALD or UDP
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.IP WLOG_PREFIX
|
|
Packit |
1fb8d4 |
configure the prefix used for outputting the message (see Format for more details and examples)
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.IP WLOG_LEVEL
|
|
Packit |
1fb8d4 |
the level to output messages for
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.IP WLOG_FILTER
|
|
Packit |
1fb8d4 |
sets a filter for WLog messages. Only the filtered messages are
|
|
Packit |
1fb8d4 |
printed. The format of the filter is a series of \<logger name\>:\<level\> separated by
|
|
Packit |
1fb8d4 |
comas
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
example: WLOG_FILTER=core.channel:DEBUG,dummy:TRACE
|
|
Packit |
1fb8d4 |
will display debug messages for the core.channel logger and trace level for the dummy logger
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.IP WLOG_FILEAPPENDER_OUTPUT_FILE_PATH
|
|
Packit |
1fb8d4 |
When using the file appender it may contains the output log file's path
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.IP WLOG_FILEAPPENDER_OUTPUT_FILE_NAME
|
|
Packit |
1fb8d4 |
When using the file appender it may contains the output log file's name
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.IP WLOG_JOURNALD_ID
|
|
Packit |
1fb8d4 |
When using the systemd journal appender, this variable contains the id used with
|
|
Packit |
1fb8d4 |
the journal (by default the executable's name)
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.IP WLOG_UDP_TARGET
|
|
Packit |
1fb8d4 |
target to use for the UDP appender in the format
|
|
Packit |
1fb8d4 |
.B host:port
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.SH BUGS
|
|
Packit |
1fb8d4 |
Please report any bugs using the bug reporting form on the
|
|
Packit |
1fb8d4 |
.B FreeRDP
|
|
Packit |
1fb8d4 |
web site
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.SH "SEE ALSO"
|
|
Packit |
1fb8d4 |
Additional information and the latest version is available
|
|
Packit |
1fb8d4 |
at the web site:
|
|
Packit |
1fb8d4 |
.B http://www.freerdp.com
|
|
Packit |
1fb8d4 |
|
|
Packit |
1fb8d4 |
.SH AUTHOR
|
|
Packit |
1fb8d4 |
David Fort <contact@hardening-consulting.com> wrote this manpage from materials written
|
|
Packit |
1fb8d4 |
by Bernhard Miklautz <bernhard.miklautz@thincast.com>.
|
|
Packit |
1fb8d4 |
|