Setting log files options
Use the Log Files tab to set one or more of the log files shown in the AR System Administration: Server Information form--Log Files tab figure. BMC Remedy AR System creates log files or forms containing information about system activity.
After being activated, logging starts immediately. You can activate logging at any time.
Do not keep logging turned on continuously. Log files can consume increasing amounts of disk space as messages accumulate unless you limit the log file size. Monitor your disk resources carefully while logging is active. After you activate logging for workflow objects, logs are created for only those workflow objects that are processed after that activation.
Log files location
On the Log Files tab, the default location for log files is
- (Windows) ARSystemInstallDir\Arserver\Db
- (UNIX) ARSystemInstallDir/db
You can enter a different location. You can also specify the same location and file for multiple types of logging so that all data is logged to a single file.
Log forms considerations
If you choose to log activity to a form, users can query the log form like any other BMC Remedy AR System form.
During server installation, all the predefined log forms are imported into ARSystemInstallDir\AR SystemserverName\ARServer\SystemForms\en. The definition file names begin with LogForm. They are treated as system forms and are recovered from this definition file whenever the AR System server restarts.
Each supported log type has a separate form, and a common form (AR System Log: ALL) accommodates all types of logging information. You can specify whether the information should be logged to a specific form or the common form.
The log forms are identified with their reserved fields. This enables administrators to rename the forms at any time using BMC Remedy Developer Studio. Request IDs can be used to sort the log entries when troubleshooting.
The following options in the AR System server configuration file help identify the forms to which information is being logged:
Types of logs
The following table lists the types of logs you can create.
Types of logs
Type of log
Default file name
Default form name
Logs information about all API calls made by all clients.
AR System Log: API
Logs information about escalation activity.
AR System Log: Escalation
Logs information about filter activity for each operation.
AR System Log: Filter
Logs SQL commands sent to the database.
AR System Log: SQL
Logs information about threads being started and restarted on the server.
AR System Log: Thread
Logs information about connection activity for each user.
AR System Log: User
Logs detailed information about user registration and about the generation and delivery of alerts.
AR System Log: Alert
Full Text Index
Logs information about full text search indexer activity.
AR System Log: Full Text Index
Logs information about server group activity.
AR System Log: Server Group
ARFORK (UNIX only)
On UNIX systems, logs all arforkd activity (a process that reduces the amount of memory an AR System server uses when forking new processes).
No form is created for arforkd.
If you are licensed for Distributed Server Option (DSO), logs information about DSO server activity. See BMC Remedy Distributed Server Option logging.
No form is created for DSO.
Logs the events of plug-ins that AR System uses. For more information about plug-ins, see Enabling Plug-ins.
No form is created for the plug-in server.
For more information, see Analyzing logs.
To set log files or forms
- In a browser, open the AR System Administration Console, and click System > General > Server Information.
The AR System Administration: Server Information form appears.
- Click the Log Files tab.
AR System Administration: Server Information form — Log Files tab
(Click the image to expand it.)
- Select the check box next to each log that you want to create.
Select the type of log to create: File or Form.
When the Form option is selected, various LogFiles.txt are created under the ar_install_dir/bin directory on UNIX. Because this behavior is as designed, you must provide read-write access to the ar_install_dir/bin directory to make sure that this functionality works correctly.
In the Namefield, specify the full path to the log file or the name of the form.
When naming log files, do not use special characters such as a forward slash or a question mark . Use alphanumeric characters only.
- To view a log file or form for any selected log, click View.
Log forms are opened in the Search mode.
Edit the other options, as needed:
Log Files tab fields
Plugin Log Level
Specifies the level of logging for the plug-in server. The options are
- All — All log information
- Finest — Code-level information
- Finer — Logs tasks as they are executed within the system
- Fine — Internal exceptions
- Config — Configuration, status, severe, and warning messages
- Info — Status, severe, and warning messages
- Warning — Severe and warning messages
- Severe — Only severe messages
- Off — None
Defines how logs are created. The options are
- Create Backup — Creates new log files, and the contents of the previous log files are written to logName.bak files.
- Append to Existing — Log files and their contents are preserved, and new information is appended to them.
Client-Side Logging Group
Defines the group that can use logging options in AR System clients. Logging options are disabled for users who are not members of this group. For more information about client logging, see Enabling logs.
Maximum Log-File Size (byte)
Defines the maximum size (in bytes) for the log file. A value of 0 (the default) specifies no limit. Except for 0, the log file size cannot be set to less than 4096. When the log file reaches the maximum, new information wraps to the top of the file, overwriting the old information. If you do not specify a maximum size limit, you run the risk of running out of disk space on your system. This setting does not apply to the arforkd.log file.
Defines the maximum number of backup (.bak) log files to be allowed when the log file reaches the Maximum Log-File Size value and a new log file is created. By default, the number of backup log files allowed is 1, and the maximum number of backup log files allowed is 999.
Buffer Logged Lines
Buffers logged lines instead of having them immediately written to disk. Selecting this option decreases the impact to AR System performance when logging is enabled. See Buffering log output.
Log Per Thread
Creates per-thread log files. Selecting this option decreases the impact to AR System performance when logging is enabled. See Thread log.
- Click Apply.