syslog.conf.5

MSyslog是一个允许在Linux下运行的网络系统日志程序

.\"	$CoreSDI: syslog.conf.5,v 1.16 2001/11/14 19:27:27 alejo Exp $
.\"
.\" Copyright (c) 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     from: @(#)syslog.conf.5	8.1 (Berkeley) 6/9/93
.\"     $OpenBSD: syslog.conf.5,v 1.4 1997/11/09 09:45:04 todd Exp $
.\"	$NetBSD: syslog.conf.5,v 1.4 1996/01/02 17:41:46 perry Exp $
.\"
.Dd June 9, 1993
.Dt SYSLOG.CONF 5
.Os Core-SDI
.Sh NAME
.Nm syslog.conf
.Nd
.Xr syslogd 8
configuration file
.Sh DESCRIPTION
The
.Nm
file is the configuration file for the
.Xr syslogd 8
program.
It consists of blocks of lines separated by
.Em program
specifications, with each line containing two fields: the
.Em selector
field which specifies the types of messages and priorities to which the
line applies, and an
.Em action
field which specifies the action to be taken if a message
.Xr syslogd
receives matches the selection criteria.
The
.Em selector
field is separated from the
.Em action
field by one or more tab characters.
.Pp
The
.Em Selectors
function
are encoded as a
.Em facility ,
a period (``.''), and a
.Em level ,
with no intervening white-space.
Both the
.Em facility
and the
.Em level
are case insensitive.
.Pp
The
.Em facility
describes the part of the system generating the message, and is one of
the following keywords: auth, authpriv, cron, daemon, kern, lpr, mail,
mark, news, syslog, user, uucp and local0 through local7.
These keywords (with the exception of mark) correspond to the
similar
.Dq Dv LOG_
values specified to the
.Xr openlog 3
and
.Xr syslog 3
library routines.
.Pp
The
.Em level
describes the severity of the message, and is a keyword from the
following ordered list (higher to lower): emerg, alert, crit, err,
warning, notice, info and debug.
These keywords correspond to the
similar
.Pq Dv LOG_
values specified to the
.Xr syslog
library routine.
.Pp 
Each block of lines is separated from the previous block by a tag. The tag
is a line beginning with 
.Em #!prog
or
.Em !prog
(the former is for compatibility with the previous syslogd, if one is sharing
syslog.conf files, for example)
and each block will be associated with calls to syslog from that specific
program.
.Pp
See
.Xr syslog 3
for a further descriptions of both the
.Em facility
and
.Em level
keywords and their significance. It's preferred that selections be made on
.Em facility
rather than
.Em program ,
since the latter can easily vary in a networked environment. In some cases,
though, an appropriate
.Em facility
simply doesn't exist.
.Pp
If a received message matches the specified
.Em facility
and is of the specified
.Em level
.Em (or a higher level) ,
and the first word in the message after the date matches the
.Em program ,
the action specified in the
.Em action
field will be taken. Beware, all rules after it are assigned this program
name, to disable you may add a line with just
.Em #!
or
.Em !
to make it handle all programs.
.Pp
Multiple
.Em selectors
may be specified for a single
.Em action
by separating them with semicolon (``;'') characters.
It is important to note, however, that each
.Em selector
can modify the ones preceding it.
.Pp
Multiple
.Em facilities
may be specified for a single
.Em level
by separating them with comma (``,'') characters.
.Pp
An asterisk (``*'') can be used to specify all
.Em facilities ,
all
.Em levels
or all
.Em programs .
.Pp
The special
.Em facility
``mark'' receives a message at priority ``info'' every 20 minutes
(see
.Xr syslogd 8 ) .
This is not enabled by a
.Em facility
field containing an asterisk.
.Pp
The special
.Em level
``none'' disables a particular
.Em facility .
.Pp
The
.Em action
field of each line specifies the action to be taken when the
.Em selector
field selects a message.
There are four old forms:
.Bl -bullet
.It
A pathname (beginning with a leading slash).
Selected messages are appended to the file.
.It
A hostname (preceded by an at (``@'') sign).
Selected messages are forwarded to the
.Xr syslogd
program on the named host.
.It
A comma separated list of users.
Selected messages are written to those users
if they are logged in.
.It
An asterisk.
Selected messages are written to all logged-in users.
.El
.Pp
Because the new
.Xr syslogd 8
daemon is now modularized, the last
four forms are included into a ``classic'' module. The new
modular form is as follows:
.Bl -bullet
.It
%classic 
.Pa xxx,
where 
.Pa xxx
is one of the last four.
.El
.Pp
Blank lines and lines whose first non-blank character is a hash (``#'')
character are ignored with the exception of lines beginning with (``#!'').
These lines are treated as section headers in the same way as lines
beginning with (``!'').  This allows
.Nm
files to be shared with systems that don't recognise the (``!'') syntax.
.Sh EXAMPLES
.Bl -bullet
.It
A configuration file that doesn't include modules might appear as follows:
.Pp
.Bd -literal -offset indent
# Log all kernel messages, authentication messages of
# level notice or higher and anything of level err or
# higher to the console.
# Don't log private authentication messages!
.Pp
*.err;kern.*;auth.notice;authpriv.none	/dev/console
.Pp
# Log anything (except mail) of level info or higher.
# Don't log private authentication messages!
.Pp
*.info;mail.none;authpriv.none		/var/log/messages
.Pp
# The authpriv file has restricted access.
.Pp
authpriv.*				/var/log/secure
.Pp
# Log all the mail messages in one place.
.Pp
mail.*					/var/log/maillog
.Pp
# Everybody gets emergency messages, plus log them on another
# machine.
.Pp
*.emerg					*
*.emerg					@arpa.berkeley.edu
.Pp
# Root and Eric get alert and higher messages.
.Pp
*.alert					root,eric
.Pp
# Save mail and news errors of level err and higher in a
# special file.
.Pp
uucp,news.crit				/var/log/spoolerr
.Pp 
# Save ftpd transactions along with mail and news
.Pp
!ftpd
*.*					/var/log/spoolerr
.Ed
.Pp
.It
A configuration file using modules might appear as follows:
.Bd -literal -offset indent
# Log all kernel messages, authentication messages of
# level notice or higher and anything of level err or
# higher to the console.
# Don't log private authentication messages!
.Pp
*.err;kern.*;auth.notice;authpriv.none	%classic /dev/console
.Pp
# Log anything (except mail) of level info or higher.
# Don't log private authentication messages!
.Pp
*.info;mail.none;authpriv.none	%classic /var/log/messages
.Pp
# The authpriv file has restricted access.
.Pp
authpriv.*			%classic /var/log/secure
.Pp
# Log all the mail messages in one place.
.Pp
mail.*				%classic /var/log/maillog
.Pp
# Everybody gets emergency messages, plus log them on another
# machine.
.Pp
*.emerg				%classic *
*.emerg				%classic @arpa.berkeley.edu
.Pp
# Root and Eric get alert and higher messages.
.Pp
*.alert				%classic root,eric
.Pp
# Save mail and news errors of level err and higher in a
# special file.
.Pp
uucp,news.crit			%classic /var/log/spoolerr
.Pp
# Save ftpd transactions along with mail and news
.Pp
!ftpd
*.*				%classic /var/log/spoolerr
.Ed
.El
.Sh FILES
.Bl -tag -width /etc/syslog.conf -compact
.It Pa /etc/syslog.conf
The
.Xr syslogd 8
configuration file.
.El
.Sh SEE ALSO
.Xr syslog 3 ,
.Xr om_classic 8 ,
.Xr om_mysql 8 ,
.Xr om_peo 8 ,
.Xr om_pgsql 8 ,
.Xr om_regex 8 ,
.Xr om_tcp 8 ,
.Xr om_udp 8 ,
.Xr peochk 8 ,
.Xr syslogd 8
.Sh HISTORY
The
.Nm
file appeared in
.Bx 4.3 ,
along with
.Xr syslogd 8 .
.Sh BUGS
.Bl -bullet
.It
The effects of multiple selectors are sometimes not intuitive.
For example ``mail.crit,*.err'' will select ``mail'' facility messages at
the level of ``err'' or higher, not at the level of ``crit'' or higher.
.It
Even it works to mix configuration lines that uses the old and the
new modular method, avoid this. Future releases may not support mixing
old and new styles.
.It
On each line there should be only one classic module so,
the following is wrong:
.Pp
.Dl *.*	%classic /dev/console %classic /var/log/messages
.Pp
the correct lines are:
.Pp
.Dl *.*	%classic /dev/console
.Dl *.*	%classic /var/log/messages
.It
Submit bugs at this project's Sourceforge Bug reporting system at:
http://sourceforge.net/tracker/?func=add&group_id=25741&atid=385117
You may also report them directly to the authors; send an email to
[e-mail], describing the problem the most you can,
containing also machine description, hardware description, the
configuration file (/etc/syslog.conf), the OS description, and the
invoking command line.
The more you describe the bug, the faster we can fix it.
.El