 |
» |
|
|
|
The set_log_file command manages a file that SNAplus2 uses to record log
messages. It enables you to do the following: Specify the file used to record log
messages and the backup file to which log information is copied Specify the maximum log file size (when the log
file reaches this size, SNAplus2 copies log information to the backup
file and resets the log file) Copy the current contents of the log file to the
backup file and optionally delete the current file
You can record audit log and error log messages in separate
files or record both types of messages in the same file. Supplied Parameters | |
Parameter name Type Length Default
[set_log_file]
log_file_type constant ERROR
action constant NO_FILE_ACTION
file_name character 80 (null string)
backup_file_name character 80 (null string)
file_size decimal 0
|
Supplied parameters are: - log_file_type
The type of log file to be used. Possible values
are: - AUDIT
Audit log file (record audit messages only) - ERROR
Error log file (record problem and exception messages)
To record both types of messages in the same file, issue two set_log_file commands for the same file name, specifying AUDIT for
the log_file_type of one command and ERROR for
the log_file_type of the other. - action
The action to be taken on the log file. Specify
one of the following values: - NO_FILE_ACTION
Use the file specified in the file_name parameter as the log file, and the file specified in
the backup_file_name parameter as the backup file. After this command completes
successfully, all log messages of the type defined by log_file_type are written to the new log file. If a log file was
used before this command is issued, the log file is left unchanged. - DELETE_FILE
Delete the contents of the current log file. - BACKUP_FILE
Copy the contents of the current log file to the
backup file, and then delete the contents of the current file.
- file_name
Name of the new log file. To create the file in the default directory for diagnostics files, /var/opt/sna, specify the file name with no path. To create the file
in a different directory, specify either a full path or the path
relative to the default directory. If you include the path, ensure
that it is a valid path (either a path relative to the application's
working directory or a full path) on any computer to which this command
is issued. This parameter is an ASCII string of 1-80 characters. To
continue logging to the file specified on a previous set_log_file command, do not specify this parameter. The initial default,
before any set_log_file command has been issued, is /var/opt/sna/sna.err for the error log file or /var/opt/sna/sna.aud for the audit log file. - backup_file_name
Name of the backup log file. When the log file reaches the
size specified by the file_size parameter, SNAplus2 copies the current contents to
the backup file and then clears the log file. You can also request
a backup at any time using the action parameter. To create the file in the default directory for diagnostics files, /var/opt/sna, specify the file name with no path. To create the file
in a different directory, specify either a full path or the path
relative to the default directory. If you include the path, ensure
that it is a valid path (either a path relative to the application's
working directory or a full path) on any computer to which this command
is issued. This parameter is an ASCII string of 1-80 characters, terminated
with a null character (binary zero). To continue using the backup
file specified on a previous set_log_file command, do not specify this parameter. The initial default,
before any set_log_file command has been issued, is /var/opt/sna/bak.err for the error log file or /var/opt/sna/bak.aud for the audit log file. - file_size
The maximum size of the log file specified by log_file_type. When a message written to the file causes the file
size to exceed this limit, SNAplus2 copies the current contents
of the log file to the backup log file and clears the log file.
The maximum amount of disk space taken up by log files is approximately
twice file_size. To continue using the file size specified on a previous set_log_file command, do not specify this parameter. The initial default
value, before any set_log_file command has been issued, is 1,000,000 bytes. A value
of 0 indicates “continue using the existing
file size” and not “no limit.” You may need to increase the size of the log filesaccording
to the size of the SNAplus2 client-server network, to allow for
the volume of log information generated in larger systems. In particular,
consider increasing the log file size to allow for the following: Accommodating large numbers of clients
or users (because a single communications link failure may result
in large numbers of logs on the server relating to session failures) Activating audit logging as well as exception logging Using central logging instead of distributed logging Using detailed logging instead of succinct logging
Returned Parameters | |
No parameters are returned by SNAplus2 when this command executes successfully. Error Return Codes | |
If the command cannot be executed, SNAplus2 returns a primary
return code to indicate the type of error and a secondary return
code to provide specific details about the reason for unsuccessful
execution. If the command does not execute because of a parameter error,
SNAplus2 returns the following parameters: - primary_rc
PARAMETER_CHECK - secondary_rc
- INVALID_FILE_ACTION
The action parameter was not set to a valid value. - INVALID_FILE_TYPE
The log_file_type parameter was not set to a valid value.
|
Printable version
