Package: rsyslog
Version: 8.36.0-1
Severity: minor
Tags: patch
The patch is in the attachment.
Summary:
Remove space at end of lines.
Fix warnings from test-groff.
Change \\ to \e to print the escape character.
Change a HYPHEN-MINUS (code 0x55, 2D) to a dash
(minus) if it matches " -[:alpha:]" or \(aq-[:alpha:] (for options).
Delete a repeated word.
Shorten (split) long strings.
Add a comma (or \&) after "e.g." and "i.e.", or use English words.
Begin a sentence on a new line (for long lines).
Split long lines (> 80).
Use \(en for a dash where appropriate.
Details:
Input file is rsyslog.conf.5
mandoc: rsyslog.conf.5:3:4: STYLE: whitespace at end of input line
and so on for about 130 lines
mandoc: rsyslog.conf.5:92:2: WARNING: line scope broken: TP breaks TP
mandoc: rsyslog.conf.5:357:2: ERROR: skipping end of block that is not open: RE
#######
Test nr. 2:
Enable and fix warnings from 'test-groff'.
troff: <rsyslog.conf.5>:517: warning [p 8, 6.3i]: can't break line
Output is from: test-groff -b -e -mandoc -T utf8 -rF0 -t -w w -z
[ "test-groff" is a developmental version of "groff" ]
####
Test nr. 20:
Use "\e" to print the escape character instead of "\\" (which gets
interpreted in copy mode).
423:contains a template. The backslash is an escape character. For example, \\7
rings the
424:bell (this is an ASCII value), \\n is a new line. The set in rsyslog is a
bit restricted
435: % = \\%
437: \\ = \\\\ --> '\\' is used to escape (as in C)
439:$template TraditionalFormat,"%timegenerated% %HOSTNAME% %syslogtag%%msg%\\n"
467:("\'" and "\\") inside each field. Please note that in MySQL configuration,
the NO_BACKSLASH_ESCAPES
511:%syslogtag%%msg:::drop-last-lf%\\n"
519:%syslogtag%,%msg%\\n"
531:$template usermsg," XXXX%syslogtag%%msg%\\n\\r"
537:$template wallmsg,"\\r\\n\\7Message from syslogd@%HOSTNAME% at
%timegenerated%"
546:into systemevents\\r\\n", SQL
708:expression is: "%msg:R:.*Sev:. \\(.*\\) \\[.*--end%"
#####
Test nr. 25:
Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.
78:Input plugin for UDP syslog. Replaces the deprecated -r option. Can be
86:Input plugin for plain TCP syslog. Replaces the deprecated -t
#####
Test nr. 27:
Find a repeated word
! 334 --> all
#####
Test nr. 40:
Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7) [package "manpages"]).
175:specifies the subsystem that produced the message, i.e. all mail programs
log
333:must start with a $-sign, e.g. if you would like to bind your output
channel definition "mychannel"
587:or manipulate the value, e.g. by converting all characters to lower case.
626:the PRI part of the message in a textual form (e.g. "syslog.info")
696:(e.g. %msg:10:$%, which will extract from position 10 to the end of the
string).
#####
Test nr. 41:
Wrong distance between sentences or protect the indicator.
1) Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) [package "manpages"] and "info groff".
Or
2) Adjust space between sentences (two spaces),
3) or protect the indicator by adding "\&" after it.
The "indicator" is an "end-of-sentence character" (.!?).
About 137 lines with only one space character between sentences.
NOT FIXED.
Test nr. 42:
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks
Many long lines, only some of them are split into two or more lines.
-- System Information:
Debian Release: buster/sid
APT prefers stable-updates
APT policy: (500, 'stable-updates'), (500, 'proposed-updates'), (500,
'testing'), (500, 'stable')
Architecture: amd64 (x86_64)
Kernel: Linux 4.9.110-3 (SMP w/2 CPU cores)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE=is_IS.iso88591 (charmap=ISO-8859-1)
Shell: /bin/sh linked to /bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages rsyslog depends on:
ii libc6 2.27-5
ii libestr0 0.1.10-2.1
ii libfastjson4 0.99.8-2
ii liblognorm5 2.0.5-1
ii libsystemd0 239-6
ii libuuid1 2.32-0.1
ii lsb-base 9.20170808
ii zlib1g 1:1.2.11.dfsg-1
Versions of packages rsyslog recommends:
ii logrotate 3.11.0-0.1
Versions of packages rsyslog suggests:
pn rsyslog-doc <none>
pn rsyslog-gnutls <none>
pn rsyslog-gssapi <none>
pn rsyslog-mongodb <none>
pn rsyslog-mysql | rsyslog-pgsql <none>
pn rsyslog-relp <none>
-- no debconf information
--
Bjarni I. Gislason
--- rsyslog.conf.5 2018-06-26 17:29:08.000000000 +0000
+++ rsyslog.conf.5.new 2018-07-22 14:38:16.000000000 +0000
@@ -1,18 +1,18 @@
.\" rsyslog.conf - rsyslogd(8) configuration file
.\" Copyright 2003-2008 Rainer Gerhards and Adiscon GmbH.
-.\"
+.\"
.\" This file is part of the rsyslog package, an enhanced system log daemon.
-.\"
+.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
-.\"
+.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
-.\"
+.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
@@ -28,10 +28,12 @@ file is the main configuration file for
which logs system messages on *nix systems. This file specifies rules
for logging. For special features see the
.BR rsyslogd (8)
-manpage. Rsyslog.conf is backward-compatible with sysklogd's syslog.conf file.
So if you migrate
-from sysklogd you can rename it and it should work.
+manpage.
+Rsyslog.conf is backward-compatible with sysklogd's syslog.conf file.
+So if you migrate from sysklogd you can rename it and it should work.
-.B Note that this version of rsyslog ships with extensive documentation in
html format.
+.B Note that this version of rsyslog ships with extensive documentation \
+in html format.
This is provided in the ./doc subdirectory and probably
in a separate package if you installed rsyslog via a packaging system.
To use rsyslog's advanced features, you
@@ -56,7 +58,7 @@ Output module for GSS-enabled syslog
Output module for MySQL
.TP
.I omrelp
-Output module for the reliable RELP protocol (prevents message loss).
+Output module for the reliable RELP protocol (prevents message loss).
For details, see below at imrelp and the html documentation.
It can be used like this:
.IP
@@ -75,7 +77,7 @@ SQLite, Ingres, Oracle, mSQL)
Input module for text files
.TP
.I imudp
-Input plugin for UDP syslog. Replaces the deprecated -r option. Can be
+Input plugin for UDP syslog. Replaces the deprecated \-r option. Can be
used like this:
.IP
$ModLoad imudp
@@ -83,14 +85,13 @@ $ModLoad imudp
$UDPServerRun 514
.TP
.I imtcp
-Input plugin for plain TCP syslog. Replaces the deprecated -t
+Input plugin for plain TCP syslog. Replaces the deprecated \-t
option. Can be used like this:
.IP
$ModLoad imtcp
.IP
$InputTCPServerRun 514
.TP
-.TP
.I imrelp
Input plugin for the RELP protocol. RELP can be used instead
of UDP or plain TCP syslog to provide reliable delivery of
@@ -130,34 +131,41 @@ are doing.
.SH BASIC STRUCTURE
-Lines starting with a hash mark ('#') and empty lines are ignored.
-Rsyslog.conf should contain following sections (sorted by recommended order in
file):
+Lines starting with a hash mark ('#') and empty lines are ignored.
+Rsyslog.conf should contain following sections
+(sorted by recommended order in file):
.TP
Global directives
-Global directives set some global properties of whole rsyslog daemon, for
example size of main
-message queue ($MainMessageQueueSize), loading external modules ($ModLoad) and
so on.
-All global directives need to be specified on a line by their own and must
start with
-a dollar-sign. The complete list of global directives can be found in html
documentation in doc
-directory or online on web pages.
+Global directives set some global properties of whole rsyslog daemon,
+for example size of main message queue ($MainMessageQueueSize),
+loading external modules ($ModLoad) and so on.
+All global directives need to be specified on a line by their own and
+must start with a dollar-sign.
+The complete list of global directives can be found in html
+documentation in doc directory or online on web pages.
.TP
Templates
-Templates allow you to specify format of the logged message. They are also
used for dynamic
-file name generation. They have to be defined before they are used in rules.
For more info
-about templates see TEMPLATES section of this manpage.
+Templates allow you to specify format of the logged message.
+They are also used for dynamic file name generation.
+They have to be defined before they are used in rules.
+For more info about templates see TEMPLATES section of this manpage.
.TP
Output channels
-Output channels provide an umbrella for any type of output that the user might
want.
-They have to be defined before they are used in rules. For more info about
output channels
+Output channels provide an umbrella for any type of output that the
+user might want.
+They have to be defined before they are used in rules.
+For more info about output channels
see OUTPUT CHANNELS section of this manpage.
.TP
Rules (selector + action)
-Every rule line consists of two fields, a selector field and an action field.
These
-two fields are separated by one or more spaces or tabs. The selector field
specifies
-a pattern of facilities and priorities belonging to the specified action.
+Every rule line consists of two fields, a selector field and an action field.
+These two fields are separated by one or more spaces or tabs.
+The selector field specifies a pattern of facilities and
+priorities belonging to the specified action.
.SH SELECTORS
@@ -172,7 +180,7 @@ kern, lpr, mail, mark, news, security (s
local0 through local7. The keyword security should not be used anymore and mark
is only for internal use and therefore should not be used in applications.
Anyway, you may want to specify and redirect these messages here. The facility
-specifies the subsystem that produced the message, i.e. all mail programs log
+specifies the subsystem that produced the message, i.e., all mail programs log
with the mail facility (LOG_MAIL) if they log using syslog.
The priority is one of the following keywords, in ascending order: debug, info,
@@ -208,12 +216,12 @@ you use both extensions than the exclama
sign, just use it intuitively.
.SH ACTIONS
-The action field of a rule describes what to do with the message. In general,
message content
-is written to a kind of "logfile". But also other actions might be done, like
writing to a
+The action field of a rule describes what to do with the message. In general,
message content
+is written to a kind of "logfile". But also other actions might be done, like
writing to a
database table or forwarding to another host.
.SS Regular file
-Typically messages are logged to real files. The file has to be specified with
full pathname,
+Typically messages are logged to real files. The file has to be specified with
full pathname,
beginning with a slash ('/').
.B Example:
@@ -239,9 +247,9 @@ To selectively disable syncing for certa
file path with a minus sign ("-").
.SS Named pipes
-This version of rsyslogd(8) has support for logging output to named pipes
(fifos). A fifo or
-named pipe can be used as a destination for log messages by prepending a pipe
symbol ('|')
-to the name of the file. This is handy for debugging. Note that the fifo must
be created with
+This version of rsyslogd(8) has support for logging output to named pipes
(fifos). A fifo or
+named pipe can be used as a destination for log messages by prepending a pipe
symbol ('|')
+to the name of the file. This is handy for debugging. Note that the fifo must
be created with
the mkfifo(1) command before rsyslogd(8) is started.
.SS Terminal and console
@@ -262,7 +270,7 @@ string ":omrelp:" in front of the hostna
*.* @192.168.0.1
.RE
.sp
-In the example above, messages are forwarded via UDP to the machine
192.168.0.1, the destination
+In the example above, messages are forwarded via UDP to the machine
192.168.0.1, the destination
port defaults to 514. Due to the nature of UDP, you will probably lose some
messages in transit.
If you expect high traffic volume, you can expect to lose a quite noticeable
number of messages
(the higher the traffic, the more likely and severe is message loss).
@@ -294,30 +302,30 @@ forwarding. For full details, please see
.SS List of users
Usually critical messages are also directed to ``root'' on that machine. You
-can specify a list
+can specify a list
of users that shall get the message by simply writing ":omusrmsg:" followed
-by the login name. You may specify more than one
+by the login name. You may specify more than one
user by separating them with commas (','). If they're logged in they
get the message (for example: ":omusrmsg:root,user1,user2").
.SS Everyone logged on
-Emergency messages often go to all users currently online to notify them that
something strange
+Emergency messages often go to all users currently online to notify them that
something strange
is happening with the system. To specify this wall(1)-feature use an
":omusrmsg:*".
.SS Database table
This allows logging of the message to a database table.
-By default, a MonitorWare-compatible schema is required for this to work. You
can
+By default, a MonitorWare-compatible schema is required for this to work. You
can
create that schema with the createDB.SQL file that came with the rsyslog
package. You can also
-use any other schema of your liking - you just need to define a proper
template and assign this
+use any other schema of your liking \(en you just need to define a proper
template and assign this
template to the action.
See the html documentation for further details on database logging.
.SS Discard
-If the discard action is carried out, the received message is immediately
discarded. Discard
-can be highly effective if you want to filter out some annoying messages that
otherwise would
-fill your log files. To do that, place the discard actions early in your log
files.
-This often plays well with property-based filters, giving you great freedom in
specifying
+If the discard action is carried out, the received message is immediately
discarded. Discard
+can be highly effective if you want to filter out some annoying messages that
otherwise would
+fill your log files. To do that, place the discard actions early in your log
files.
+This often plays well with property-based filters, giving you great freedom in
specifying
what you do not want.
Discard is just the single 'stop' command with no further parameters.
@@ -329,13 +337,13 @@ Discard is just the single 'stop' comman
.SS Output channel
-Binds an output channel definition (see there for details) to this action.
Output channel actions
-must start with a $-sign, e.g. if you would like to bind your output channel
definition "mychannel"
-to the action, use "$mychannel". Output channels support template definitions
like all all other
+Binds an output channel definition (see there for details) to this action.
Output channel actions
+must start with a $-sign, e.g., if you would like to bind your output channel
definition "mychannel"
+to the action, use "$mychannel". Output channels support template definitions
like all other
actions.
.SS Shell execute
-This executes a program in a subshell. The program is passed the
template-generated message as the
+This executes a program in a subshell. The program is passed the
template-generated message as the
only command line parameter. Rsyslog waits until the program terminates and
only then continues to run.
.B Example:
@@ -343,7 +351,7 @@ only command line parameter. Rsyslog wai
^program-to-execute;template
.RE
-The program-to-execute can be any valid executable. It receives the template
string as a single parameter
+The program-to-execute can be any valid executable. It receives the template
string as a single parameter
(argv[1]).
.SH FILTER CONDITIONS
@@ -354,23 +362,21 @@ Rsyslog offers three different types "fi
* property-based filters
.sp 0
* expression-based filters
-.RE
-
.SS Selectors
-.B Selectors are the traditional way of filtering syslog messages.
-They have been kept in rsyslog with their original syntax, because it is
well-known, highly
-effective and also needed for compatibility with stock syslogd configuration
files. If you just
-need to filter based on priority and facility, you should do this with
selector lines. They are
+.B Selectors are the traditional way of filtering syslog messages.
+They have been kept in rsyslog with their original syntax, because it is
well-known, highly
+effective and also needed for compatibility with stock syslogd configuration
files. If you just
+need to filter based on priority and facility, you should do this with
selector lines. They are
not second-class citizens in rsyslog and offer the best performance for this
job.
.SS Property-Based Filters
-Property-based filters are unique to rsyslogd. They allow to filter on any
property, like HOSTNAME,
-syslogtag and msg.
+Property-based filters are unique to rsyslogd. They allow to filter on any
property, like HOSTNAME,
+syslogtag and msg.
-A property-based filter must start with a colon in column 0. This tells
rsyslogd that it is the new
-filter type. The colon must be followed by the property name, a comma, the
name of the compare
-operation to carry out, another comma and then the value to compare against.
This value must be quoted.
-There can be spaces and tabs between the commas. Property names and compare
operations are
+A property-based filter must start with a colon in column 0. This tells
rsyslogd that it is the new
+filter type. The colon must be followed by the property name, a comma, the
name of the compare
+operation to carry out, another comma and then the value to compare against.
This value must be quoted.
+There can be spaces and tabs between the commas. Property names and compare
operations are
case-sensitive, so "msg" works, while "MSG" is an invalid property name. In
brief, the syntax is as follows:
.sp
.RS
@@ -387,7 +393,7 @@ Checks if the string provided in value i
.sp
.B isequal
.RS
-Compares the "value" string provided and the property contents. These two
values must be exactly equal to match.
+Compares the "value" string provided and the property contents. These two
values must be exactly equal to match.
.RE
.sp
.B startswith
@@ -396,7 +402,7 @@ Checks if the value is found exactly at
.RE
.sp
.B regex
-.RS
+.RS
Compares the property against the provided regular expression.
.RE
@@ -406,101 +412,101 @@ See the html documentation for this feat
.SH TEMPLATES
-Every output in rsyslog uses templates - this holds true for files, user
-messages and so on. Templates compatible with the stock syslogd
-formats are hardcoded into rsyslogd. If no template is specified, we use
-one of these hardcoded templates. Search for "template_" in syslogd.c and
+Every output in rsyslog uses templates \(en this holds true for files, user
+messages and so on. Templates compatible with the stock syslogd
+formats are hardcoded into rsyslogd. If no template is specified, we use
+one of these hardcoded templates. Search for "template_" in syslogd.c and
you will find the hardcoded ones.
-A template consists of a template directive, a name, the actual template text
+A template consists of a template directive, a name, the actual template text
and optional options. A sample is:
.RS
-.B $template MyTemplateName,"\\\\7Text %property% some more
text\\\\n",<options>
+.B $template MyTemplateName,"\e7Text %property% some more text\en",<options>
.RE
-The "$template" is the template directive. It tells rsyslog that this line
-contains a template. The backslash is an escape character. For example, \\7
rings the
-bell (this is an ASCII value), \\n is a new line. The set in rsyslog is a bit
restricted
-currently.
+The "$template" is the template directive. It tells rsyslog that this line
+contains a template. The backslash is an escape character.
+For example, \e7 rings the bell (this is an ASCII value), \en is a new line.
+The set in rsyslog is a bit restricted currently.
-All text in the template is used literally, except for things within percent
-signs. These are properties and allow you access to the contents of the syslog
+All text in the template is used literally, except for things within percent
+signs. These are properties and allow you access to the contents of the syslog
message. Properties are accessed via the property replacer and it can for
example
pick a substring or do date-specific formatting. More on this is the PROPERTY
REPLACER
section of this manpage.
To escape:
.sp 0
- % = \\%
+ % = \e%
.sp 0
- \\ = \\\\ --> '\\' is used to escape (as in C)
+ \e = \e\e --> '\e' is used to escape (as in C)
.sp 0
-$template TraditionalFormat,"%timegenerated% %HOSTNAME% %syslogtag%%msg%\\n"
+$template TraditionalFormat,"%timegenerated% %HOSTNAME% %syslogtag%%msg%\en"
Properties can be accessed by the property replacer (see there for details).
.B Please note that templates can also by used to generate selector lines with
dynamic file names.
-For example, if you would like to split syslog messages from different hosts
+For example, if you would like to split syslog messages from different hosts
to different files (one per host), you can define the following template:
.RS
.B $template DynFile,"/var/log/system-%HOSTNAME%.log"
.RE
-
-This template can then be used when defining an output selector line. It will
+
+This template can then be used when defining an output selector line. It will
result in something like "/var/log/system-localhost.log"
.SS Template options
-The <options> part is optional. It carries options influencing the template as
whole.
-See details below. Be sure NOT to mistake template options with property
options - the
-later ones are processed by the property replacer and apply to a SINGLE
property, only
+The <options> part is optional. It carries options influencing the template as
whole.
+See details below. Be sure NOT to mistake template options with property
options \(en the
+later ones are processed by the property replacer and apply to a SINGLE
property, only
(and not the whole template).
Template options are case-insensitive. Currently defined are:
.RS
-.TP
+.TP
sql
-format the string suitable for a SQL statement in MySQL format. This will
replace single
-quotes ("'") and the backslash character by their backslash-escaped
counterpart
-("\'" and "\\") inside each field. Please note that in MySQL configuration,
the NO_BACKSLASH_ESCAPES
+format the string suitable for a SQL statement in MySQL format. This will
replace single
+quotes ("'") and the backslash character by their backslash-escaped counterpart
+("\e'" and "\e\e") inside each field. Please note that in MySQL configuration,
the NO_BACKSLASH_ESCAPES
mode must be turned off for this format to work (this is the default).
-.TP
+.TP
stdsql
-format the string suitable for a SQL statement that is to be sent to a
standards-compliant
-sql server. This will replace single quotes ("'") by two single quotes ("''")
inside each field.
-You must use stdsql together with MySQL if in MySQL configuration the
NO_BACKSLASH_ESCAPES
+format the string suitable for a SQL statement that is to be sent to a
standards-compliant
+sql server. This will replace single quotes ("'") by two single quotes ("''")
inside each field.
+You must use stdsql together with MySQL if in MySQL configuration the
NO_BACKSLASH_ESCAPES
is turned on.
.RE
Either the
.B sql
-or
-.B stdsql
-option
-.B MUST
-be specified when a template is used for writing to a database,
-otherwise injection might occur. Please note that due to the unfortunate fact
-that several vendors have violated the sql standard and introduced their own
-escape methods, it is impossible to have a single option doing all the work.
+or
+.B stdsql
+option
+.B MUST
+be specified when a template is used for writing to a database,
+otherwise injection might occur. Please note that due to the unfortunate fact
+that several vendors have violated the sql standard and introduced their own
+escape methods, it is impossible to have a single option doing all the work.
So you yourself must make sure you are using the right format.
.B If you choose the wrong one, you are still vulnerable to sql injection.
-Please note that the database writer *checks* that the sql option is present
-in the template. If it is not present, the write database action is disabled.
-This is to guard you against accidental forgetting it and then becoming
-vulnerable to SQL injection. The sql option can also be useful with files -
-especially if you want to import them into a database on another machine for
-performance reasons. However, do NOT use it if you do not have a real need for
-it - among others, it takes some toll on the processing time. Not much, but on
+Please note that the database writer *checks* that the sql option is present
+in the template. If it is not present, the write database action is disabled.
+This is to guard you against accidental forgetting it and then becoming
+vulnerable to SQL injection. The sql option can also be useful with files \(en
+especially if you want to import them into a database on another machine for
+performance reasons. However, do NOT use it if you do not have a real need for
+it \(en among others, it takes some toll on the processing time. Not much, but
on
a really busy system you might notice it ;)
-The default template for the write to database action has the sql option set.
+The default template for the write to database action has the sql option set.
.SS Template examples
-Please note that the samples are split across multiple lines. A template MUST
+Please note that the samples are split across multiple lines. A template MUST
NOT actually be split across multiple lines.
A template that resembles traditional syslogd file output:
@@ -508,15 +514,15 @@ A template that resembles traditional sy
.RS
$template TraditionalFormat,"%timegenerated% %HOSTNAME%
.sp 0
-%syslogtag%%msg:::drop-last-lf%\\n"
+%syslogtag%%msg:::drop-last-lf%\en"
.RE
A template that tells you a little more about the message:
.sp
.RS
-$template
precise,"%syslogpriority%,%syslogfacility%,%timegenerated%,%HOSTNAME%,
+$template precise,"%syslogpriority%,%syslogfacility%,
.sp 0
-%syslogtag%,%msg%\\n"
+%timegenerated%,%HOSTNAME%,%syslogtag%,%msg%\en"
.RE
A template for RFC 3164 format:
@@ -528,13 +534,13 @@ $template RFC3164fmt,"<%PRI%>%TIMESTAMP%
A template for the format traditionally used for user messages:
.sp
.RS
-$template usermsg," XXXX%syslogtag%%msg%\\n\\r"
+$template usermsg," XXXX%syslogtag%%msg%\en\er"
.RE
And a template with the traditional wall-message format:
.sp
.RS
-$template wallmsg,"\\r\\n\\7Message from syslogd@%HOSTNAME% at %timegenerated%"
+$template wallmsg,"\er\en\e7Message from syslogd@%HOSTNAME% at %timegenerated%"
.RE
.B A template that can be used for writing to a database (please note the SQL
template option)
@@ -543,9 +549,9 @@ $template wallmsg,"\\r\\n\\7Message from
.ad l
$template MySQLInsert,"insert iut, message, receivedat values
('%iut%', '%msg:::UPPERCASE%', '%timegenerated:::date-mysql%')
-into systemevents\\r\\n", SQL
+into systemevents\er\en", SQL
-NOTE 1: This template is embedded into core application under name
+NOTE 1: This template is embedded into core application under name
.B StdDBFmt
, so you don't need to define it.
.sp
@@ -555,9 +561,9 @@ NOTE 2: You have to have MySQL module in
.SH OUTPUT CHANNELS
-Output Channels are a new concept first introduced in rsyslog 0.9.0. As of
this writing,
+Output Channels are a new concept first introduced in rsyslog 0.9.0. As of
this writing,
it is most likely that they will be replaced by something different in the
future.
-So if you use them, be prepared to change you configuration file syntax when
you upgrade
+So if you use them, be prepared to change you configuration file syntax when
you upgrade
to a later release.
Output channels are defined via an $outchannel directive. It's syntax is as
follows:
@@ -566,14 +572,14 @@ Output channels are defined via an $outc
.B $outchannel name,file-name,max-size,action-on-max-size
.RE
-name is the name of the output channel (not the file), file-name is the file
name to be
-written to, max-size the maximum allowed size and action-on-max-size a command
to be issued
-when the max size is reached. This command always has exactly one parameter.
The binary is
-that part of action-on-max-size before the first space, its parameter is
everything behind
+name is the name of the output channel (not the file), file-name is the file
name to be
+written to, max-size the maximum allowed size and action-on-max-size a command
to be issued
+when the max size is reached. This command always has exactly one parameter.
The binary is
+that part of action-on-max-size before the first space, its parameter is
everything behind
that space.
-Keep in mind that $outchannel just defines a channel with "name". It does not
activate it.
-To do so, you must use a selector line (see below). That selector line
includes the channel
+Keep in mind that $outchannel just defines a channel with "name". It does not
activate it.
+To do so, you must use a selector line (see below). That selector line
includes the channel
name plus ":omfile:$" in front of it. A sample might be:
.sp
.RS
@@ -581,20 +587,20 @@ name plus ":omfile:$" in front of it. A
.RE
.SH PROPERTY REPLACER
-The property replacer is a core component in rsyslogd's output system. A
syslog message has
-a number of well-defined properties (see below). Each of this properties can
be accessed and
-manipulated by the property replacer. With it, it is easy to use only part of
a property value
-or manipulate the value, e.g. by converting all characters to lower case.
+The property replacer is a core component in rsyslogd's output system. A
syslog message has
+a number of well-defined properties (see below). Each of this properties can
be accessed and
+manipulated by the property replacer. With it, it is easy to use only part of
a property value
+or manipulate the value, e.g., by converting all characters to lower case.
.SS Accessing Properties
-Syslog message properties are used inside templates. They are accessed by
putting them between
+Syslog message properties are used inside templates. They are accessed by
putting them between
percent signs. Properties can be modified by the property replacer. The full
syntax is as follows:
.sp
.RS
.B %propname:fromChar:toChar:options%
.RE
-propname is the name of the property to access.
+propname is the name of the property to access.
.B It is case-sensitive.
.SS Available Properties
@@ -609,36 +615,36 @@ the message exactly as it was received f
hostname from the message
.TP
.B FROMHOST
-hostname of the system the message was received from (in a relay chain, this
is the system immediately
+hostname of the system the message was received from (in a relay chain, this
is the system immediately
in front of us and not necessarily the original sender)
.TP
.B syslogtag
TAG from the message
.TP
.B programname
-the "static" part of the tag, as defined by BSD syslogd. For example, when TAG
is "named[12345]",
+the "static" part of the tag, as defined by BSD syslogd. For example, when TAG
is "named[12345]",
programname is "named".
.TP
.B PRI
-PRI part of the message - undecoded (single value)
+PRI part of the message \(en undecoded (single value)
.TP
.B PRI-text
-the PRI part of the message in a textual form (e.g. "syslog.info")
+the PRI part of the message in a textual form (e.g.\& "syslog.info")
.TP
.B IUT
-the monitorware InfoUnitType - used when talking to a MonitorWare backend
(also for phpLogCon)
+the monitorware InfoUnitType \(en used when talking to a MonitorWare backend
(also for phpLogCon)
.TP
.B syslogfacility
-the facility from the message - in numerical form
+the facility from the message \(en in numerical form
.TP
.B syslogfacility-text
-the facility from the message - in text form
+the facility from the message \(en in text form
.TP
.B syslogseverity
-severity from the message - in numerical form
+severity from the message \(en in numerical form
.TP
.B syslogseverity-text
-severity from the message - in text form
+severity from the message \(en in text form
.TP
.B timegenerated
timestamp when the message was RECEIVED. Always in high resolution
@@ -683,44 +689,44 @@ The current hour in military (24 hour) t
The current minute (2-digit)
.P
-Properties starting with a $-sign are so-called system properties. These do
NOT stem from the
+Properties starting with a $-sign are so-called system properties. These do
NOT stem from the
message but are rather internally-generated.
.SS Character Positions
-FromChar and toChar are used to build substrings. They specify the offset
within the string that
-should be copied. Offset counting starts at 1, so if you need to obtain the
first 2 characters of
-the message text, you can use this syntax: "%msg:1:2%". If you do not wish to
specify from and to,
-but you want to specify options, you still need to include the colons. For
example, if you would
-like to convert the full message text to lower case, use "%msg:::lowercase%".
If you would like to
-extract from a position until the end of the string, you can place a
dollar-sign ("$") in toChar
-(e.g. %msg:10:$%, which will extract from position 10 to the end of the
string).
+FromChar and toChar are used to build substrings. They specify the offset
within the string that
+should be copied. Offset counting starts at 1, so if you need to obtain the
first 2 characters of
+the message text, you can use this syntax: "%msg:1:2%". If you do not wish to
specify from and to,
+but you want to specify options, you still need to include the colons. For
example, if you would
+like to convert the full message text to lower case, use "%msg:::lowercase%".
If you would like to
+extract from a position until the end of the string, you can place a
dollar-sign ("$") in toChar
+(e.g., %msg:10:$%, which will extract from position 10 to the end of the
string).
-There is also support for
+There is also support for
.B regular expressions.
-To use them, you need to place a "R" into FromChar.
-This tells rsyslog that a regular expression instead of position-based
extraction is desired. The
-actual regular expression
-.B must
-then be provided in toChar. The regular expression must be followed
-by the string "--end". It denotes the end of the regular expression and will
not become part of it.
-If you are using regular expressions, the property replacer will return the
part of the property text
-that matches the regular expression. An example for a property replacer
sequence with a regular
-expression is: "%msg:R:.*Sev:. \\(.*\\) \\[.*--end%"
+To use them, you need to place a "R" into FromChar.
+This tells rsyslog that a regular expression instead of position-based
extraction is desired. The
+actual regular expression
+.B must
+then be provided in toChar. The regular expression must be followed
+by the string "--end". It denotes the end of the regular expression and will
not become part of it.
+If you are using regular expressions, the property replacer will return the
part of the property text
+that matches the regular expression. An example for a property replacer
sequence with a regular
+expression is: "%msg:R:.*Sev:. \e(.*\e) \e[.*--end%"
-Also, extraction can be done based on so-called "fields". To do so, place a
"F" into FromChar. A field
-in its current definition is anything that is delimited by a delimiter
character. The delimiter by
-default is TAB (US-ASCII value 9). However, if can be changed to any other
US-ASCII character by
-specifying a comma and the decimal US-ASCII value of the delimiter immediately
after the "F". For example,
-to use comma (",") as a delimiter, use this field specifier: "F,44". If your
syslog data is delimited,
-this is a quicker way to extract than via regular expressions (actually, a
*much* quicker way). Field
-counting starts at 1. Field zero is accepted, but will always lead to a "field
not found" error. The same
-happens if a field number higher than the number of fields in the property is
requested. The field number
-must be placed in the "ToChar" parameter. An example where the 3rd field
(delimited by TAB) from the msg
-property is extracted is as follows: "%msg:F:3%". The same example with
semicolon as delimiter is
+Also, extraction can be done based on so-called "fields". To do so, place a
"F" into FromChar. A field
+in its current definition is anything that is delimited by a delimiter
character. The delimiter by
+default is TAB (US-ASCII value 9). However, if can be changed to any other
US-ASCII character by
+specifying a comma and the decimal US-ASCII value of the delimiter immediately
after the "F". For example,
+to use comma (",") as a delimiter, use this field specifier: "F,44". If your
syslog data is delimited,
+this is a quicker way to extract than via regular expressions (actually, a
*much* quicker way). Field
+counting starts at 1. Field zero is accepted, but will always lead to a "field
not found" error. The same
+happens if a field number higher than the number of fields in the property is
requested. The field number
+must be placed in the "ToChar" parameter. An example where the 3rd field
(delimited by TAB) from the msg
+property is extracted is as follows: "%msg:F:3%". The same example with
semicolon as delimiter is
"%msg:F,59:3%".
-Please note that the special characters "F" and "R" are case-sensitive. Only
upper case works, lower case
-will return an error. There are no white spaces permitted inside the sequence
(that will lead to error
+Please note that the special characters "F" and "R" are case-sensitive. Only
upper case works, lower case
+will return an error. There are no white spaces permitted inside the sequence
(that will lead to error
messages and will NOT provide the intended result).
.SS Property Options
@@ -745,13 +751,19 @@ date-rfc3339
format as RFC 3339 date
.TP
escape-cc
-replace control characters (ASCII value 127 and values less then 32) with an
escape sequence. The sequence is "#<charval>" where charval is the 3-digit
decimal value of the control character. For example, a tabulator would be
replaced by "#009".
+replace control characters (ASCII value 127 and values less then 32)
+with an escape sequence.
+The sequence is "#<charval>" where charval is
+the 3-digit decimal value of the control character.
+For example, a tabulator would be replaced by "#009".
.TP
space-cc
replace control characters by spaces
.TP
drop-cc
-drop control characters - the resulting string will neither contain control
characters, escape sequences nor any other replacement character like space.
+drop control characters \(en the resulting string will neither contain
+control characters, escape sequences nor any other replacement
+character like space.
.SH QUEUED OPERATIONS
Rsyslogd supports queued operations to handle offline outputs
