File appenders define logs that capture messages in a text file as they are generated by the system. The log file is stored in the location that was specified when TeamConnect was installed.
Whether you are defining a file appender for system logging or audit logging, the settings that are specific to file appenders are the same.
For general instructions on defining appenders, see one of the following sections:
•For system logging, see Defining System Appenders.
•For audit logging, see Defining Audit Appenders.
File Appender Information Section
The following table describes the file appender settings.
Field or Button
|
Description
|
Application Logs Folder
|
Indicates the location of the log files on the application server as a hyperlink. This location is specified when TeamConnect is first installed.
Note: You can click the hyperlink to view the contents of the folder if you are using the same machine where TeamConnect is installed. Otherwise, navigate to the folder on the application server.
|
File Name
|
Type the name that you want to use as the name of the log file, including its file extension.
If you are using HTML or XML layout for the log file, use the corresponding extension.
If you want to specify a subdirectory of the logs folder on the application server, you can type the directory location in this field, relative to the logs folder indicated in the Application Logs Folder field. For example, if you want the RulesLog.log file to be stored in a subdirectory called Custom_Rule_Logging, then you would type Custom_Rule_Logging\RulesLog.log as the file name.
Important: To organize your log files, you must manually create the corresponding subdirectories directly on the application server.
|
Rollover Policy
|
Determines when you want the system to stop writing to a file, add a timestamp to the file name, and begin writing to a new file. Select one of the following:
•Rollover on Schedule—Allows the log file to be rolled over daily, weekly, or monthly, as specified by the value of the Backup Schedule setting. Important: If you select Rollover on Schedule, previously rolled log files are not automatically replaced by new files. You have to periodically clean up your logs directory to delete old log files.
•Rollover on Size—Allows you specify a file size at which the log file is rolled over and how many backup files to store before replacing them. This is the default rollover policy. |
Max. Backup Index
|
The maximum number of backup files to be stored before backup files are replaced by new files. The oldest file is replaced each time a new file is rolled over. By default, the maximum backup index is 5.
Important: Specifying a larger number, such as 10, may negatively impact performance.
This field is only displayed if Rollover on Size is selected as the rollover policy.
|
Max. File Size (MB)
|
The maximum file size, in megabytes, that the log file should reach before rolling over and starting a new file. By default, the maximum file size is 10 MB.
This field is only displayed if Rollover on Size is selected as the rollover policy.
|
Backup Schedule
|
Select how often the log file should be rolled over and timestamped and a new file should be created—Daily, Weekly, or Monthly.
This field is only displayed if Rollover on Schedule is selected for the rollover policy.
|
Immediate Flush
|
Select this check-box to have each write of a logging event followed by a flush operation. This helps prevent all or part of a log message from being lost should the application exit abruptly. This check-box is selected by default.
If this check-box is not selected, logging throughput is improved by about 15%, but it is more likely that if the application exits abruptly, a logging message that was written might not be completely captured in the log.
|
Layout
|
Select whether you want to use a Pattern, HTML, or XML layout for the contents being written to the log file. Pattern Layout is selected by default.
For more details, see File Appender Layouts.
|
Pattern
|
This field becomes available when Pattern Layout is selected in the Layout field.
Type the pattern you want to use to display the logging messages in the log file. For more details, see Pattern Layout.
|
|
