| Module: mod_log_config |
| Syntax: FRCACustomLog file-or-pipe file format-or-nickname |
| Default: none |
| Context: server config |
| Override: none |
| Origin: iSeries™ |
| Usage Considerations: The directive can be specified
multiple times in the same configuration file. This is how one would generate
multiple log files for the same server instance. For example, if you want
an access log, agent log, and referer log, you could specify this directive
three separate times with a different file and format. Log files created with
FRCACustomLog will be created with a CCSID of UTF-8 (1208) for Integrated
File System. |
| Example: See below. |
The FRCACustomLog directive is used to log FRCA requests to the server.
- Parameter One: file-or-pipe file
- The file-or-pipe file value indicates the filename to which log
records should be written. It is either a full path or relative to the current
server root. If a pipe is specified, it would be the name of a program that
would receive the log file information on standard in. A pipe is specified
by using the pipe character "|" followed by a path to the program name (no
space between them). The program name can be either a path to a QSYS program
object or an IFS path to a symbolic link. The symbolic link would then link
to a QSYS program. Note that data written to the pipe from the server will
be in the FSCCSID that is in use by the server.
- Parameter Two: format-or-nickname
- The format-or-nickname argument specifies a format or nickname for each
line of the log file . If it is a format, it specifies a format for each line
of the log file. The options available for the format are exactly the same
as for the argument of the LogFormat directive. If the format includes any
spaces (which it will in almost all cases) they should be enclosed in double
quotes. If the argument is a nickname, that nickname will tie back to a LogFormat
directive with the same specified nickname.
If the nickname "DDS" is specified,
the server will create a DDS log file and each record will contain the format
described by file QHTTPSVR/QAZHBLOG. When the second argument is "DDS" a path
name to a file in the QSYS.LIB file system must also be specified. When "DDS"
is specified, it is not necessary to use the Logformat directive to define
the format. The nickname "DDS" is a special nickname that is pre-defined in
the server. See directive Logformat for additional considerations for the
DDS nickname.
Examples of FRCACustomLog:
# FRCACustomLog with format nickname
LogFormat "%h %l %u %t \"%r\" %>s %b" common
FRCACustomLog logs/FRCAaccess_log common
# FRCACustomLog in QSYS with format nickname
LogFormat "%h %l %u %t \"%r\" %>s %b" common
FRCACustomLog /QSYS.LIB/MYLIB.LIB/MYFRCALOG.FILE common
# CustomLog in QSYS with DDS format
FRCACustomLog /QSYS.LIB/MYLIB.LIB/FRCADDSLOG.FILE DDS
# FRCACustomLog with explicit format string
FRCACustomLog logs/FRCAaccess_log "%h %l %u %t \"%r\" %>s %b"
# FRCACustomLog defining a piped log
LogFormat "%h %l %u %t \"%r\" %>s %b" common
FRCACustomLog |/QSYS.LIB/MYLIB.LIB/PIPELOG.PGM common
For IFS log files and QSYS log files, the user must create the directories
that contain the log file and must grant the QTMHHTTP user write access to
the directory. For QSYS.LIB logs, the user must create the library that contains
the logs. The server will create the file and members in the specified library.
Note: It is recommended that HTTP Server create the QSYS.LIB log file. If
the QSYS.LIB log file is created with a record length that is too small, log
information may be truncated and lost. By default the server creates all QSYS.LIB
log files with a record size of 512 or greater.
If the filename does not begin with a slash (/) then it is assumed to be
relative to the ServerRoot. If LogCycle is
active and if the path ends without a (/) character, then the path is considered
to be the complete log file name. In this case, the server will add an extension
in the format QCYYMMDDHH, where these variables have the following values:
- Q is a default value that indicates to the server that this is
a log file.
- C is the century indicator (0 for pre-2000, 1 for post-2000).
- YY is the year indicator.
- MM is the month indicator.
- DD is the day indicator.
- HH is the hour indicator (00 = 00:00 (midnight), 23=23:00).
Note: this
variable will not be generated for filesystem QDLS
For example, a
path of "/logs/errorlog" results in a file such as "/logs/errorlog.Q100030300".
If LogCycle is active
and if the path ends with a (/) character, then the path is considered to
be the directory that will contain the log file. In this case, the server
will create log files named in the QCYYMMDDHH format. For example, a path
of "/logs/errorlog/" results in a file such as "/logs/errorlog/Q100030300".
If LogCycle is active
and the logfile is in the QSYS filesystem, the name must end in the file component
of the IFS path. Example:
# Config file directives
LogCycle Daily
LogFormat "%h %l %u %t \"%r\" %>s %b" common
FRCACustomLog /QSYS.LIB/MYLIB.LIB/MYLOGS.FILE common
The resulting daily log rollovers will be of the form /QSYS.LIB/MYLIB.LIB/MYLOGS.FILE/Qcyymmddhh.MBR.
LogCycle Hourly is
not valid if the logfile is in the QDLS filesystem as that filesystem only
supports 8 character file names and 3 character extensions. Also for QDLS,
the path given on the FRCACustomLog directive must be a directory. For example:
FRCACustomLog /QDLS/MYPATH/LOGS/ common
The resulting log files would be /QDLS/MYPATH/LOGS/Qcyymmdd.
If LogCycle is not
active, no special naming is used. The name of the log file given on the FRCACustomLog
directive is used as given for the name of the log file. If the name is a
directory, a default name of http.log will be concatenated to the directory
name to create the log file. For example:
# Config file directives
LogCycle Off
LogFormat "%h %l %u %t \"%r\" %>s %b" common
CustomLog /logs/path/ common
The resulting log file will be /logs/path/http.log.
If FRCACustomLog is in the configuration, FRCA requests will be logged
to the file specified on the FRCACustomLog directive. All non-FRCA related
requests will be logged to any other custom logs configured with the CustomLog
directive. Example:
LogFormat "%h %l %u %t \"%r\" %>s %b" common
CustomLog logs/access_log common
FRCACustomLog logs/FRCAaccess_log common
All FRCA requests will be logged to logs/FRCAaccess_log and all non-FRCA
requests will be logged to logs/access_log. If FRCACustomLog is not specified
in the configuration of the server instance, ALL requests are logged to any
custom logs configured with CustomLog including FRCA requests.
for more information.