This documentation supports the 20.02 version of Remedy Action Request (AR) System.

To view an earlier version, select the version from the Product version menu.


Managing the server group logs


The Logs screen enables you to perform different server group logs related operations such as configuring logs, viewing server group logs, and monitoring the longest command configuration.

You can perform the following log management activities:

Required permissions

You must have either of the following permissions to access the logs:

  • AR System Administrator
  • AR System Configuration Administrator
  • Integration Administrator
  • Email Administrator

Configuring logs for the server group

Use the Logs Management screen to efficiently configure the server logs. This screen provides a single location to configure logs. You can configure logs across a single server, a list of servers, or all servers in the server group.

For more information about using this screen, see Managing logs for a server group.

Viewing and saving the log files

Use the View Logs screen to retrieve log files from any server in the group. You can retrieve any system logs or any log under the configured log file root directory.


Security considerations

  • In ar.cfg, if you enable thDisable-View-Log property, you can configure the maximum log file size by using the Max-Get-Log-File-Size property.
  • The default size of the Max-Get-Log-File-Size property is 500 MB.
  • The value you set for AR-Max-Attach-Size property determines the size of the log file. For example, If you set the AR-Max-Attach-Size property to 200 MB and Max-Get-Log-File-Size property to 500 MB, then you cannot view a log file of 500 MB. 
  • Based on your environment settings a performance issue might occur if you exceed the default size of the Max-Get-Log-File-Size property.

To retrieve a log file from the server

  1. In the Server Name field, select a server name.
    When you select the server name, Root Log Dir and DB Dir fields are automatically populated with the root directories on that server from where files are retrieved.
    1. Root Log Dir
      Displays the configured root log directory on the selected server. 
      By default, all logs (except Flashboard logs and Email Engine logs) are stored in the <installDir>/db folder. You can change the root path to a different location by setting the Common-Logging-Root-Path parameter in Centralized Configuration. The default value for this parameter is NULL.
      For more information about the Common-Logging-Root-Path parameter, see Configuration settings C-D
    2. DB DirDisplays the database directory along with the product installation path on the selected server. 
  2. In the File To Retrieve field, select a log file from the following options. These files are the system log files with fixed names and are retreived from the specified database directory.
    1. arerror
    2. ardebug
    3. arexception
    4. armonitor
    5. arhgroup
    6. Relative Path—In the File Name field, specify a file name to retrieve a file from the root log Directory.
  3. Click the Get File button to retrieve the file from the specified server.
    The file loads in the attachment field.
  4. Click Display to view the file.

Gathering statistics about the longest running API and SQL commands

The AR System server continously collects a list of the longest running APIs and SQL commands. Use the Longest Running API/SQL screen to perform the following tasks:

  • View the details of longest running API / SQL. 
  • Record the list of the longest API and SQL commands and view the list of recent commands.
  • Use this data as a debugging tool to identify an operation that takes excessive time.

You can perform these operations on a single server or across all servers in the server group. 

To gather statistics about the longest running SQL and API commands

  1. From the Applicable To field, select either Server or All.
  2. Perform the following optional steps:
    1. In the Number of Saved Operations field, specify the number of API or SQL commands that are running on a server.
      The server retains the specified number of operations.
      Maximum Value—100
      Default value—20
      Recommended value—20
    2. In the Auto Save and Purge Interval (min) field, specify the time interval (minutes) to automatically record the list of commands. 
      The command list is not saved automatically.
      Default value—20 
    3. In the Minimum Elapsed Time (mSec) field, set the minimum duration of the longest API and SQL events saved in the memory buffer in milliseconds.
      Any event shorter than this value is discarded.
    4. Select Enable Console Display.
      Displays API and SQL events in the console when an automatic save is triggered by the time specified in the Auto Save and Purge Interval (min) field.
    5. Select Enable Exceptional Logging.
      Enables exception logging, where all API and SQL calls that exceed the value specified in the Minimum Elapsed Time (mSec) field are immediately written to the arexception.log file.
      Default  value5000 ms (5 seconds)

  3. Click Apply Configuration to save the preferences.
  4. In the Save Current Options In Memory field, select from the following options:

    OptionDescription
    Completed APIList of the longest API commands that are complete.
    Completed SQLList of the longest SQL commands that are complete.
    Pending APIList of API commands that are currently in progress.
    Pending SQLList of SQL commands that are currently in progress.
  5. Click Save Now to list the longest API and SQL commands.
  6. In the Show field, select an option to view the data. The following options are available:
    1. API
    2. SQL
    3. ALL (Default)
  7. In the For field, select the time interval to view the data.
  8. Click Refresh to reload the table with specified preferences.

The Open Longest APIs and Open Longest SQLs links open the corresponding forms showing more details of the server statistics. For more information, see Setting server statistics options.

Related topics

Setting log files options

Using log files

Analyzing logs

Was this page helpful? Yes No Submitting... Thank you

Comments