share/man/man4/nfslog.conf.4

   1 '\" te
   2 .\" Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH NFSLOG.CONF 4 "Dec 2, 2004"
   7 .SH NAME
   8 nfslog.conf \- NFS server logging configuration file
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/etc/nfs/nfslog.conf\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBnfslog.conf\fR file specifies the location of the \fBNFS\fR server logs,
  19 as well as the location of the private work files used by the \fBNFS\fR server
  20 and \fBnfslogd\fR(8) daemon during logging. Each entry in the file consists of
  21 a mandatory tag identifier and one or more parameter identifiers. The parameter
  22 identifier specifies the value or location of the specific parameter. For
  23 instance, the parameter identifier "\fBlog=/var/nfs/logs/serverLog\fR"
  24 specifies the location of the \fBNFS\fR server activity log. The mandatory tag
  25 identifier serves as an index into the \fB/etc/nfs/nfslog.conf\fR file to
  26 identify the various parameters to be used. At export time, the
  27 \fBshare_nfs\fR(8) command specifies the \fBNFS\fR server logging parameters
  28 to use by associating a tag from the \fB/etc/nfs/nfslog.conf\fR file to the
  29 exported file system. It is legal for more than one file system to be exported
  30 using the same logging tag identifier.
  31 .sp
  32 .LP
  33 NFS server logging is not supported on Solaris machines that are  using NFS
  34 Version 4.
  35 .sp
  36 .LP
  37 A "global" tag identifier is included in \fB/etc/nfs/nfslog.conf\fR. It
  38 specifies the default set of values to be used during logging. If no tag
  39 identifier is specified at export time, then the values in the "global" entry
  40 are used. The "global" values can be modified by updating this entry in
  41 \fB/etc/nfs/nfslog.conf\fR.
  42 .sp
  43 .LP
  44 Each entry in the file must contain a mandatory tag identifier and at least one
  45 parameter/value pair. If a parameter is not specified in a given entry, the
  46 global value of the parameter will be used. The exact entry syntax follows:
  47 .sp
  48 .in +2
  49 .nf
  50 <tag>   [defaultdir=<path>] [log=<path><file>] \e
  51 [fhtable=<path><file>] [buffer=<path><file>] [logformat=basic|extended]
  52 .fi
  53 .in -2
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBdefaultdir=\fI<path>\fR\fR\fR
  59 .ad
  60 .RS 28n
  61 Specifies the directory where the logging files and working files will be
  62 placed. This path is prepended to all relative paths specified in other
  63 parameters.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBlog=\fI<path>\fR\fI<file>\fR\fR\fR
  70 .ad
  71 .RS 28n
  72 Specifies the location of the user-readable log file. The log will be located
  73 in the \fBdefaultdir\fR, unless \fB<path>\fR is an absolute path.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBfhtable=\fI<path>\fR\fI<file>\fR\fR\fR
  80 .ad
  81 .RS 28n
  82 Specifies the location of the private file handle to path mapping database
  83 files. These database files are for the private use of the \fBNFS\fR server
  84 kernel module and the \fBnfslog\fRd daemon. These files will be located in the
  85 \fBdefaultdir\fR, unless \fB<path>\fR is an absolute path. These database files
  86 are permanently stored in the file system. Consult \fBnfslogd\fR(8) for
  87 information on pruning the database files.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBbuffer=\fI<path>\fR\fI<file>\fR\fR\fR
  94 .ad
  95 .RS 28n
  96 Specifies the location of the private work buffer file  used by the \fBNFS\fR
  97 server kernel module to record raw \fBRPC\fR information. This file is later
  98 processed by the \fBnfslog\fR daemon, which in turn generates the user-readable
  99 log file. This work buffer file will be located in the \fBdefaultdir\fR, unless
 100 \fB<path>\fR is an absolute path.
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBlogformat=basic|extended\fR\fR
 107 .ad
 108 .RS 28n
 109 Sets the format of the user-readable log file. If not specified, the basic
 110 format is used. The basic format is compatible with log files generated by the
 111 Washington University \fBFTPd\fR. The extended format provides a more detailed
 112 log, which includes directory modification operations not included in the basic
 113 format, such as \fBmkdir\fR, \fBrmdir\fR and \fBremove\fR. Note that the
 114 extended format is not compatible with Washington University's \fBFTPd\fR log
 115 format.
 116 .RE
 117
 118 .SH EXAMPLES
 119 .LP
 120 \fBExample 1 \fRUsing the \fBglobal\fR Tag
 121 .sp
 122 .LP
 123 The "global" tag may be modified so that all exported file systems that enabled
 124 logging use a common set of parameters that conform to the specific needs of
 125 the user. These values are used until a specific tag identifier overrides them.
 126
 127 .sp
 128 .in +2
 129 .nf
 130 global  defaultdir=/var/nfs log=logs/nfslog \e
 131                 fhtable=tables/fhtable buffer=buffers/nfslog_workbuffer \e
 132                 logformat=basic
 133 .fi
 134 .in -2
 135
 136 .LP
 137 \fBExample 2 \fROverriding the Global \fBdefaultdir\fR and \fBlogformat\fR
 138 .sp
 139 .LP
 140 Because log files can become very large, it may be desirable to store the logs
 141 and working files in separate file systems. This can be easily accomplished by
 142 simply specifying a different \fBdefaultdir\fR for every file system exported
 143 by means of a unique tag:
 144
 145 .sp
 146 .in +2
 147 .nf
 148 engineering     defaultdir=/engineering/logging \e
 149                     logformat=extended
 150 accounting defaultdir=/accounting/logging
 151 marketing  defaultdir=/marketing/logging
 152 .fi
 153 .in -2
 154
 155 .sp
 156 .LP
 157 File systems shared with the engineering identifier will have their logs and
 158 workfiles located in \fB/engineering/logging\fR. For instance, the log file
 159 will be located at \fB/engineering/logging/logs/nfslog\fR. Note that the
 160 engineering log file will be stored in the extended format, while the rest of
 161 the log files will remain in the basic format.
 162
 163 .sp
 164 .LP
 165 Any of the parameters can be updated in a tag identifier, which overrides the
 166 global settings.
 167
 168 .SH SEE ALSO
 169 .sp
 170 .LP
 171 \fBnfslogd\fR(8), \fBshare_nfs\fR(8), \fBattributes\fR(5)
 172 .SH NOTES
 173 .sp
 174 .LP
 175 Logs, work files, and file handle to path mapping database can become very
 176 large. Be aware of appropriate placement within the file system name space. See
 177 \fBnfslogd\fR(8)) for information on pruning the database files and cycling
 178 logs.