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.

Best practice
We recommend that you use the Remedy Management Console to set the log files options. For more information, see Setting global and local level configurations using Remedy Management Console.

After being activated, logging starts immediately. You can activate logging at any time.

Important
  • 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.

  • This form shows the local level value of the configuration. If a local value does not exist, the form displays the global level configuration. If you modify the value on this form, the local level configuration value is modified.

    For example, if a configuration shows global level value and you modify the value by using this form, the local level value gets created for the configuration.

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

Description

Default file name

Default form name

API

Logs information about all API calls made by all clients.
This information is logged on entry and exit of every API call.

When the Always On Logging option is selected, this log is recorded automatically even when you do not select this log.

arapi.log

AR System Log: API

Escalation

Logs information about escalation activity.
This information includes the escalations that executed, whether the escalation qualification found any matches, and any escalation actions taken.

When the Always On Logging option is selected, this log is recorded automatically even when you do not select this log.

arescl.log

AR System Log: Escalation

Filter

Logs information about filter activity for each operation.
This information includes the filters that tried to execute and all filter actions performed.

When the Always On Logging option is selected, this log is recorded automatically even when you do not select this log.

arfilter.log

AR System Log: Filter

SQL

Logs SQL commands sent to the database.
This information is logged for each SQL command issued, including a time stamp and the user name of the user performing the operation.

When the Always On Logging option is selected, this log is recorded automatically even when you do not select this log.

arsql.log

AR System Log: SQL

Thread

Logs information about threads being started and restarted on the server.

When the Always On Logging option is selected, this log is recorded automatically even when you do not select this log.

arthread.log

AR System Log: Thread

User

Logs information about connection activity for each user.
This information includes whether the user can obtain a license and when each floating license is released. This enables you to keep an audit trail of user activity to help you determine whether you need more floating licenses.

When the Always On Logging option is selected, this log is recorded automatically even when you do not select this log.

aruser.log

AR System Log: User

Alert

Logs detailed information about user registration and about the generation and delivery of alerts.

aralert.log

AR System Log: Alert

Full Text Index

Logs information about full text search indexer activity.

arftindx.log

AR System Log: Full Text Index

Server Group

Logs information about server group activity.
Records information about the starting and stopping of operations, the evaluation of other servers, and the timing of each event.

When the Always On Logging option is selected, this log is recorded automatically even when you do not select this log.

arsrvgrp.log

AR System Log: Server Group

(For On-premises deployments only) DSO

If you are licensed for Distributed Server Option (DSO), logs information about DSO server activity. See BMC-Remedy-Distributed-Server-Option-logging.

ardist.log

No form is created for DSO.

Plug-In Server

Logs the events of plug-ins that AR System uses. For more information about plug-ins, see Enabling Plug-ins.

arplugin.log

No form is created for the plug-in server.

Archive Log

Logs information about scheduled or on-demand archive by any user. For more information about archiving, see Archiving-overview.

ararchive.log

AR System Log: Archive

For more information, see Analyzing-logs.

 To set log files or forms

  1. In a browser, open the AR System Administration Console, and click System > General > Server Information.
     The AR System Administration: Server Information form appears.
  2. Click the Log Files tab.
    AR System Administration: Server Information form — Log Files tab
    Server Info - Log files.png
  3. Select the check box next to each log that you want to create.

  4. Select the type of log to create: File or Form.

    Note

    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.

  5. In the Name field, specify the full path to the log file or the name of the form.

    Important

    When naming log files, do not use special characters such as a forward slash or a question mark. Use alphanumeric characters only.

  6. To view a log file or form for any selected log, click View.
     Log forms are opened in the Search mode.

  7. Edit the other options, as needed:

    Log Files tab fields

    Field Name

    Description

    Plugin Log Level

    Specifies the level of logging for the plug-in server. The options are

    • All — All log information. The default value is 100.
    • Finest — Code-level information. The default value is 400.
    • Finer — Logs tasks as they are executed within the system. The default value is 500.
    • Fine — Internal exceptions. The default value is 600.           
    • Config — Configuration, status, severe, and warning messages. The default value is 700.
    • Info — Status, severe, and warning messages. The default value is 800.
    • Warning — Severe and warning messages. The default value is 900.
    • Severe — Only severe messages. The default value is 1000.
    • Off — None. The default value is 10000.

    Log-File Creation

    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.

    Maximum Backups

    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.

    Reload Log Conf File

    Enables JMX logging and third party loggers log level in logback_server.xml file without restarting the server.The Reload Log Conf File check box is read-only. You must select the Reload Log Conf File check box every time when there a change in the logback_server.xml file.The changes are applied if you select the check box.

    When you select the Reload Log Conf File check box, the AR System Server updates the changes in the logback_server.xml file. This check box is automatically cleared when you reload the Server Information form.


    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.


  8. Click Apply.