mmstatd.conf.5

mmstatd包含一个 C库和服务器

.\" $Id: mmstatd.conf.5,v 1.2 2003/01/01 14:54:11 mmondor Exp $
.\"
.\" Copyright (C) 2002-2003, Matthew Mondor
.\" 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. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"      This product includes software written by Matthew Mondor.
.\" 4. The name of Matthew Mondor may not be used to endorse or promote
.\"    products derived from this software without specific prior written
.\"    permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY MATTHEW MONDOR ``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 MATTHEW MONDOR 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.
.\"
.Dd 11 Dec, 2002
.Dt MMSTATD.CONF 5
.Os
.Sh NAME
.Nm mmstatd.conf
.Nd
.Xr mmstatd.conf 5
configuration file for mmstatd and mmstat
.Sh DESCRIPTION
The
.Nm /etc/mmstatd.conf
file may contain one or more keyword/value pairs per line, empty lines or
comments.  A ';' or '#' character causes all other characters to be considered
as a comment, and to be ignored, until the end of the current line. It is
very important to enclose the value for a keyword in double quotes ('"'
characters) if the following characters are found in it: ';', '#', space and
tab. Here are documented the various possible keywords and their
allowed values, as well as their defaults, and mmstatd/mmstat relation.
.Pp
.Nm These are both used by mmstatd and mmstat:
.Pp
.Bl -tag -width XXXXXXXX -offset indent -compact
.It Nm LOG_SOCKET Ar "file"
Location of statistics update request socket, to which the logger process
of
.Nm mmstatd
listens to.
.Pp
.It Nm STAT_SOCKET Ar "file"
Location of statistics report request socket, to which the librarian process
of
.Nm mmstatd listens to.
.El
.Pp
.Nm These are only used by mmstatd:
.Pp
.Bl -tag -width XXXXXXXX -offset indent -compact
.It Nm USER Ar "user"
Unprivileged user service should run as.
.Pp
.It Nm GROUPS Ar "group ..."
Groups mmstatd should be part of, separated by spaces. The groups specified
for
.Ar LOG_GROUP
and
.Ar STAT_GROUP
should also be specified here. Do not forget to enclose the value of this
keyword in double quotes as more than one space separated entries may
exist.
.Pp
.It Nm LOG_FACILITY Ar "facility"
Syslog facility which should be used for error logging. Should normally be
one of
.Sy LOG_AUTH LOG_AUTHPRIV LOG_CRON LOG_DAEMON LOG_FTP LOG_KERN LOG_LPR
.Sy LOG_MAIL LOG_NEWS LOG_SYSLOG LOG_USER LOG_UUCP
, see
.Xr syslog 3
man page for more information.
.Pp
.It Nm PID_FILE Ar "file"
Location where mmstatd writes it's pid file. This consists of a small file
holding the process ID of
.Nm mmstatd
which can be used by scripts or the administrator to kill the daemon properly.
.Pp
.It Nm LOCK_FILE Ar "file"
Location of mmstatd lock file, this is only used to make sure that only
one copy of the service is running, otherwise this could lead to database
corruption.
.Pp
.It Nm ENV_DIR Ar "directory"
Location where database and recovery logs are internally, automatically stored
and managed by
.Nm mmstatd
daemon.
.Pp
.It Nm LOG_GROUP Ar "group"
.Ar LOG_SOCKET
is created with permission mode 220. This permits users of the specified
group to perform statistic update requests, using the
.Xr mmstat 3
library interface. Don't forget to also specify this group name into
.Ar GROUPS
variable.
.Pp
.It Nm STAT_GROUP Ar "group"
.Ar STAT_SOCKET
is created with permission mode 660. This permits users of the specified
group to obtain statistic reports or to rotate statistics using the
.Xr mmstat 3
library interface, or
.Xr mmstat 8
utility. Don't forget to also specify this group name into
.Ar GROUPS 
variable.
.Pp
.It Nm SYNC_INTERVAL Ar "seconds"
Specifies the interval in seconds at which the statistics db will be
synchronized to disk. This delay can be long enough, as a good log-based
recovery technique is used in case system crashed between two sync events.
.Pp
.It Nm SYNC_BYTES Ar "bytes"
Maximum number of bytes to write to recovery logs before forcing a sync
with physical media (using fdatasync()). 0 Can be specified to force a sync
after every new entry; Higher values may cause some of the last update
requests before a crash to be lost but will be more efficient.
.Pp
.It Nm MAX_LOGSIZE Ar "bytes"
Maximum size of a recovery log file, in bytes. When reaching that size
internal rotation to other files is performed. Logs are internally maintained
and cleaned up as necessary by mmstatd and are not user serviceable.
.Pp
.It Nm STATS_RATE Ar "times"
Maximum number of times Unix stream connections to
.Ar STAT_SOCKET
can be performed within
.Ar STATS_TIME
period. This prevents an application from requesting a large number of full
reports thus potentially preventing the librarian part of
.Nm mmstatd
to peform its vital tasks. As a general rule reports are not requested
frequently. If necessary, 0 can be specified for no limit, and care should be
taken to choose an adequate
.Ar STAT_GROUP
to restrict access.
.Pp
.It Nm STATS_TIME Ar "seconds"
Period in seconds during which a maximum of
.Ar STATS_RATE
connections are allowed to occur.
.El
.Sh DEFAULTS
The following defaults are used:
.Pp
.Bd -literal -offset indent -compact
USER            mmstatd
GROUPS          "mmstat staff"
LOG_FACILITY    LOG_AUTHPRIV
PID_FILE        "/var/mmstatd/mmstatd.pid"
LOCK_FILE       "/var/mmstatd/mmstatd.lock"
LOG_SOCKET      "/var/mmstatd/mmstatd_log.sock"
STAT_SOCKET     "/var/mmstatd/mmstatd_stat.sock"
ENV_DIR         "/var/mmstatd"
LOG_GROUP       mmstat
STAT_GROUP      staff
SYNC_INTERVAL   1800
SYNC_BYTES      4096
MAX_LOGSIZE     1048576
STATS_RATE      5
STATS_TIME      10
.Ed
.Sh AUTHOR
mmstat and related daemon and library were written by Matthew Mondor,
and are Copyright (c) 2002-2003, Matthew Mondor, All rights reserved.
It originally was written for the mmftpd and mmmail suite of daemons by the
same author.
.Sh FILES
.Bl -tag -width XXXXXXXXXXXXXXXXXXXX -compact
.It Pa <mmstat.h>
Headerfile used both by
.Nm mmstatd
daemon and
.Nm mmstat
utility, defining related
.Ar MAX_TRANSACT
variable.
.Pp
.It Pa /etc/mmstatd.conf
Configuration file for both
.Nm mmstatd
daemon and
.Nm mmstat
utility. (This file)
.El
.Sh SEE ALSO
.Xr mmstat 3 ,
.Xr mmstat 8 ,
.Xr mmstatd 8 ,
.Xr syslog 3 ,
.Xr fdatasync 2 ,
.Xr fsync 2 .
.Sh BUGS
Please report any bug to [e-mail]