Supplied parameters

The application supplies the following parameters:

opcode
AP_SET_LOG_FILE
log_file_type
The type of log file being managed. Possible values are:
AP_AUDIT_FILE
Audit log file (audit messages only).
AP_ERROR_FILE
Error log file (problem and exception messages).
AP_USAGE_FILE
Usage log file (information on current and peak usage of CS Linux resources).

To record both audit and error messages in the same file, issue two SET_LOG_FILE verbs for the same file name, specifying AP_AUDIT_FILE on one verb and AP_ERROR_FILE on the other.

action
The action to be taken on the log file. Specify one of the following values:
AP_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 verb completes successfully, all log messages of the type defined by log_file_type are written to the new log file. The log file that was used before this verb is issued, if any, is left unchanged.
AP_DELETE_FILE
Delete the contents of the current log file.
AP_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/ibm/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 relative to the application's working directory or a full path) on any computer to which this verb is issued.

This parameter is an ASCII string of 1-80 characters, followed by a NULL character (binary zero). To continue logging to the file specified on a previous SET_LOG_FILE verb, specify a null string.

backup_file_name
Name of the backup log file. When the log file reaches the size specified by file_size below, CS Linux 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 above.

To create the file in the default directory for diagnostics files, /var/opt/ibm/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 relative to the application's working directory or a full path) on any computer to which this verb is issued.

This parameter is an ASCII string of 1-80 characters, followed by a NULL character (binary zero). To continue using the backup file specified on a previous SET_LOG_FILE verb, specify a null string.

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, CS Linux copies the current contents of the log file to the backup log file and clears the log file. This means that 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 verb, set this parameter to zero. The initial default value, before any SET_LOG_FILE verb has been issued, is 10,000,000 bytes. A value of zero indicates continue using the existing file size and not no limit.

You may need to increase the size of the audit and error log files according to the size of the CS Linux 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:

  • Large numbers of clients or users (since 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 full logging instead of succinct logging.