Managing logs for server groups

You can use the AR System Server Group Administration Console to manage logs for multiple components that belong to a server group. All these components are part of Centralized Configuration and AR System Configuration Generic UI. 

How logs are enabled across servers and server groups

When you enable or disable logging for any component from one of the following forms, the changes are immediately reflected in the remaining two forms:

• Server Information> Log Files tab
• AR System Server Group Administration> Server Group Logs Management

• Centralized Configuration > AR System Configuration Generic UI

For example, if you change the setting for AR Filter Log from the Centralized Configuration > AR System Configuration Generic UI, you can view the changed setting either from the Server Information > Log Files or from the AR System Server Group Administration > Server Group Logs Management.

The Server Group Logs Management form uses only the relative paths to enable the logs. 

By default, all logs (except Flashboard logs and Email Engine logs) are stored in the <installDir>/db folder. You can change it 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.

For example, if you want to enable api log, provide the relative path as api.log. The api.log is stored in the default directory at <installDir>\db\api.log location. 
If you have set the Common-Logging-Root-Path parameter, the log file is stored at <common_logging_root_path>\api.log location. For example, C:\test\api.log. Here, C:\test is the common logging root path.

Process for enabling logs for the components of a server group

You can perform the following activities on the AR System Server Group Administration Console:

Before you begin

You must be an AR System Administrator to use the Server Group Logs Management form. 

(Optional) To create a server name list for applying log settings

To apply the same log settings to a group of servers, define a Server Name List that contains the list of servers. For example, if you create a server name list for a type of server, such as user-facing servers or reporting servers, you can apply log settings to those specific servers in that group.
After you create a server name list, you select this list from the Server List field on the Server Group Logs Management form. The following screenshot illustrates the AR System Server Name List form.

Perform the following steps to create a server name list:

1. Navigate to AR System Server Group Administration > AR System Server Name List. 
2. Enter a new name or select an option from the Server Name List field.
3. Select a server from the list of available servers.
4. Click Apply. Repeat step 3 to add more servers.
5. Close the AR System Server Name List form.

To delete a server, from the Server Name List, expand the Server Name table, select a server from the Server Name List, and click Delete.

(Optional) To configure a template for server group log settings

If you want to preconfigure common log settings, use the Manage Logging Templates form to create, modify or delete a template. You will specify the template when you enable the logs for a server group. 

Perform the following steps to create a new template or modify an existing template:

1. Navigate to Applications > AR System Server Group Administration > Server Group Logs Management.
2. On the Server Group Logs Management form, click the Manage Template link. 
   The Manage Logging Templates form opens.

1. (Optional) On the Manage Logging Templates form, select either Server or Template.
2. Select an option from the Template Name to modify the existing template or to enter a new template name. 
3. To enable logs for a specific component, select Enable Log and switch the Apply Setting toggle to green. 
4. Enter either the file name or the file name with the relative path where the logs are recorded. 
   You must enter the file name with extension.
5. Click Save Template and then click Close.

To delete a template, select the template from the Template Name field and click Delete.

To enable logs for server group

1. Navigate to Applications > AR System Server Group Administration > Server Group Logs Management.
   
   The Server Group Logs Management form opens.
2. (Optional) Select either Server or Template to load the required settings.
3. Select either of the following options for Apply to: 
   • All Servers
   • Server
   • Server List
4. To enable the log for a specific component, select Enable Log and switch the Apply Setting toggle to green. 

5. Enter either the file name or the file name with the relative path where the logs are recorded.
   You must enter the file name with extension. 
   When you enter the relative path along with the log file name (for example, test/api.log), the log file is generated in the default log location in the folder you specified (test). However, if you enter only the log file name (api.log), the log file is created directly in the default log location.

   Note

   Follow these guidelines for specifying the relative path:

   • The folder name cannot start with single dot (.) or double dots (..).
   • (Microsoft Windows) For a folder name, use only the characters that are supported by Microsoft Windows. 
   • (Microsoft Windows) The relative path cannot start with forward slash (/).
   • (Linux) The relative path cannot start with a backslash (\).

   For Plug-in log, you must provide a file name with an absolute file path, because a relative file path does not work.

6. (Optional) Click the Advanced Settings link. For more information, see Advanced settings.
7. Click Apply.
   

Server Group Logs Management form fields

This section describes the fields available on the Server Group Logs Management form. The following table describes how to set the fields in the Server Group Logs Management form:

Server Group Logs Management form— Advanced Settings

The Advanced Settings Panel allows you to enable additional log settings. The following screenshot illustrates the Advanced Settings panel:

The following table describes how to set the fields in the Advanced Settings Panel:

Related topics

Setting-log-files-options

Using-log-files

Analyzing-logs