NAME
nfslog.conf — NFS server logging configuration file
DESCRIPTION
The
nfslog.conf
file specifies the location of the NFS server logs, as well as
the location of the private work files used by the NFS server and
nfslogd(1M)
daemon during logging.
Each entry in the file consists of a mandatory tag identifier and one or
more parameter identifiers.
The parameter identifier specifies the value
or location of the specific parameter.
For instance, the parameter identifier
log=/var/nfs/logs/serverLog
specifies the location
of the NFS server activity log.
The mandatory tag identifier
serves as an index into the
/etc/nfs/nfslog.conf
file to identify the various parameters to be used.
At export time, the
share_nfs(1M)
command specifies the NFS server logging parameters
to use by associating a tag from the
/etc/nfs/nfslog.conf
file to the exported file system.
It is legal for more than one file system
to be exported using the same logging tag identifier.
A "global" tag identifier is included in
/etc/nfs/nfslog.conf.
It specifies the default set of values to be used during
logging.
If no tag identifier is specified at export time, then the values
in the "global" entry are used.
The "global" values can be modified by updating this entry in
/etc/nfs/nfslog.conf.
Each entry in the file must contain a mandatory tag identifier and
at least one parameter/value pair.
If a parameter is not specified in a
given entry, the global value of the parameter will be used.
The exact entry syntax follows:
tag [defaultdir=path] [log=path file]
[fhtable=path file] \
[buffer=path file]
[logformat=basic|extended]
The entries are described here.
- defaultdir=path
Specifies the directory where the log and work files will be placed.
This path is prepended to all relative paths specified in other parameters.
- log=path file
Specifies the location of the user-readable log file.
The log will be located in the
defaultdir,
unless
path
is an absolute path.
- fhtable=path file
Specifies the location of the private file handle to path
mapping database files.
These database files are for the private use of the NFS
server kernel module and the
nfslogd
daemon.
These files will be located in the
defaultdir,
unless
path
is an absolute path.
These
database files are permanently stored in the file system.
Consult
nfslogd(1M)
for information on pruning the database files.
- buffer=path file
Specifies the location of the private work buffer file
used by the NFS server kernel module to record raw
RPC information.
This file is later processed by the
nfslog
daemon, which in turn generates the user-readable log file.
This work buffer file will be located in the
defaultdir,
unless
path
is an absolute path.
- logformat=basic|extended
Sets the format of the user-readable log file.
If not specified,
the
basic
format is used. The
basic
format is compatible with log files generated by the Washington University
FTPd.
The
extended
format provides a more detailed log, which includes directory modification
operations not included in the basic format, such as
mkdir,
rmdir,
and
remove.
Note that the
extended
format is not compatible with Washington University's
FTPd
log format.
WARNINGS
Log files, work files, and file handle to path mapping database can become
very large.
Be aware of appropriate placement within the file system
name space.
See
nfslogd(1M)
for information on pruning the database files and cycling logs.
EXAMPLES
Example 1: Using the global Tag
The
global
tag may be modified so that all exported file systems
that enabled logging use a common set of parameters that conform to the
specific needs of the user.
These values are used until a specific tag
identifier overrides them.
global defaultdir=/var/nfs log=logs/nfslog fhtable=tables/fhtable \
buffer=buffers/nfslog_workbuffer logformat=basic
Example 2: Overriding the Global defaultdir and logformat
Because log files can become very large, it may be desirable to store
the log and work files in separate file systems.
This can be easily accomplished by simply specifying a different
defaultdir
for every file system exported by means of a unique tag:
engineering defaultdir=/engineering/logging logformat=extended
accounting defaultdir=/accounting/logging
marketing defaultdir=/marketing/logging
File systems shared
with the engineering identifier will have their log and work files located
in
/engineering/logging.
For instance, the log file
will be located at
/engineering/logging/logs/nfslog.
Note that the engineering log file will be stored in the extended format,
while the rest of the log files will remain in the basic format.
Any of the parameters can be updated in a tag identifier, which overrides
the global settings.
Printable version
