This documentation supports the 21.05 version of Action Request System.
To view an earlier version, select the version from the Product version menu.

Configuring the Log Settings page by using Mid Tier Configuration Tool

Use the Log settings page to update logging of configuration settings. A bold label with an asterisk (*) indicates a mandatory field. 

The following screenshot displays  Mid Tier Configuration Tool – Log Settings page:

Logging

The following table lists the log settings:

SettingDescription
Log Categories

The type of information to be stored in the log file. By default, all categories except Flashboards are selected.

  • Reporting – Messages related to reporting.
  • Cache – Messages related to definitions, such as forms and active links in the cache.
  • Session Management – Messages related to user session construction and expiration, such as login, logout, or timeout.
  • Configuration – Messages related to the config.properties file, such as when it is loaded and modified.
  • Flashboards – Messages related to Flashboards.
  • Web Services – Messages related to web services.
  • Field – Messages related to fields.
  • Workflow – Messages related to compilation of workflow, primarily active link actions, such as invalid active links.
  • Performance – Messages related to performance, including duration of operations.
  • Qualifications and Expressions – Messages related to parsing and compilation of expressions, for example, in active links.
  • Servlet – Messages related to servlet handling of http requests, primarily for reporting results of back-channel requests.
  • Internal – Internal logging messages.
  • ARServer (API/Filter/Database) – Messages related to APIs, filters, and databases. Selecting the ARServer (API/Filter/Database) option, overrides the API logging option and all API logging is redirected to the Mid Tier log file.
  • Data Visualization Module – Messages related to the data visualization module.
  • Progressive Web App Logs related to PWA REST calls and PWA-specific code path execution.

Important: You cannot disable all log categories. If you try to disable all log categories, the previous settings are restored.

Filter Log by User Name

The user names of those users whose activity is logged.

You can restrict the logging for one user or multiple users. To restrict logs for multiple users, specify each user name separated by a semicolon, for example, Alan;Jonnie.

If you leave the field blank, logs for all users in the current session are recorded.

When you enter one or more user names and save changes, a new log file is started. For log messages displayed on the screen, the filter applies only to new entries. Any existing entries for earlier users are still displayed on the screen until the limit set in the View Logs setting is reached.

Log Directory

The directory in which log files are stored. For example, ARSystemInstallDir/Logs.

To change the log directory, enter the absolute (complete) path for the new directory. You cannot change the log file name.

Maximum Log File Size (kb)

The maximum size (in kilobytes) a file can reach before a backup copy is automatically made. The default size is 1024 KB.

The default file name is armidtier.log. The backup copy is made with the same file name and an incremental number (for example, armidtierN.log).

Maximum Number of Log Files

The maximum number of backup files that the system will generate when the log file size exceeds the limit specified in the Maximum Log File Size.

The default value is 100 backups.

Log Level

The level of detail for logging information:

  • Fine – The highest level of detail.
  • Info – Less detail than Fine.
  • Warning – A moderate level of detail. Warnings plus those errors included in the Severe level are logged.
  • Severe – The lowest level of detail; only server start time and error messages are logged.

You can see the pre-load start and end timestamp when you set the log level to Info or Warning. Irrespective of the logging level, Mid Tier logs the pre-load start and end time.

The default value is Severe.

Log Viewer

The method by which you want to view log files:

  • Console – The log entries are directed to the stderr (System.err) of your servlet engine.
  • File – Data is saved to a file in the specified log directory.

The default value is File.

Log Format

The log output is generated using the standard Java 1.8 logging API, including Simple and XML formatting:

  • Simple Text (the default) – A basic text file for faster performance. It does not include stack trace information except in the case of Severe log messages.
  • Detailed Text (includes class name and methods) – A text file containing details such as Java class names and methods.
  • XML – A file in XML format.

Mid Tier Thread Dumps

Enables you to collect logs of all the Java activities in your environment.

The Launch button displays the Get Mid-Tier JVM Thread Dumps page. You can perform the following steps on the Get Mid-Tier JVM Thread Dumps page:

  1. In the Elapsed Time (Seconds) field, enter the number of seconds you want to monitor the Mid Tier . For example, 600
  2. In the Storage field, select from the following options:
    • Midtier/ Webserver
      The logs are stored in the Mid Tier installation directory. < Mid Tier installation directory>\logs
    • Client
      The logs are stored in the browser you are using. By default, the logs are stored in the browser's Download folder.
  3. Click Start.

Mid-Tier Profiler

To activate the Mid-Tier Profiler, set the value of Mid-Tier profiling to True. Mid-Tier Profiler provides the performance information about the client side (JavaScript) code on the Mid Tier . The profiler shows how much time was spent on a particular method (such as a table refresh). When the profiler is turned on, Show Profile and Clear Profile buttons appear in the Mid Tier  toolbar (if enabled) when forms are viewed in the browser. 

The Mid-Tier Profiling option is normally used during development of an application because when you turn on the profiler, all users have access to the profile.


The following table describes the setting in the Mid Tier  profiler: 

SettingDescription
Show ProfileDisplays all the profiled data in a new window.
Clear ProfileClear all the profiled data from memory.



Important

You must restart the web server if you change the Mid Tier profiler value.

You can view the log files that record the activity of the Mid Tier . If you have no log files generated, it might be because the Log Viewer setting is set to Console. Change this setting to Files to generate Mid Tier  log files.

The following table lists the log file view settings:

SettingDescription
Display LastThe number of lines that you want to view from the most recent entries in the log. The default is 25.
View Log FileClick to view the log file.

Use the View Log File button on the Log Settings page to view logs.

Mid Tier  Log file format

Following is a sample Mid Tier  log file entry:

<MTIER><TID: 0000000093> <CATEGORY:com.remedy.log.PERFORMANCE    > /* Tue Apr 09 2019 03:52:17.034  */  <LEVEL: FINE> <Class: com.remedy.arsys.stubs.GoatServlet><Method:postInternal><TENANT: null> <USER: null                                          >  GoatServlet: url=http://<midtier>/arsys/forms/<arserver>/User
<MTIER><TID: 0000000093> <CATEGORY:com.remedy.log.PERFORMANCE    > /* Tue Apr 09 2019 03:52:17.065  */  <LEVEL: FINE> <Class: com.remedy.arsys.stubs.FormServlet><Method: doRequest><TENANT: null> <USER: Demo> server:<arserver>||app:null||form:User||view:null||file:null||appResource:null||size:2

Restricting Mid Tier  logs for multiple users

Mid Tier  logging provides the functionality to restrict the logs based on multiple users at the same time. By restricting the logging to one or more users, you can generate log files containing details of the activity performed only by the specified users.

To restrict Mid Tier  logs for multiple users

  1. Open the  Mid Tier  Configuration Tool.
  2. Go to the Log Settings page. 

  3. In the Filter Log by User Name field, enter the names of the user for restricting the logging.

    To restrict the the log for multiple users, specify the user names as semicolon (;) separated values; for example, Allen;John.
  4. Click Save.

The log file records the activity performed only by the specified users.

Related topic

Mid Tier logging


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

Comments