Enabling or disabling diagnostic logs
Active Roles administrators can enable diagnostic logging at the request of support personnel to assist them in finding root causes of issues that occur during Active Roles operations. The diagnostic information includes the Active Roles configuration statistics (referred to as Active Roles system summary), the Active Roles Administration Service diagnostic log and the Active Roles Console diagnostic log.
The Active Roles Administration Service’s diagnostic log (ds.log) contains tracing information, such as API calls, internal function calls and state transitions performed by the Administration Service. This information is stored in the ds.log file that you can send to the support team for issue diagnostic purposes. Two logging levels are available: Basic and Verbose. The Verbose option writes much more information to the log, which can aid in the process of isolating an issue. However, with the increase in verbosity comes a corresponding decrease in performance and increase in the size of the log file.
The Active Roles Console’s diagnostic log (EDMSnap.txt) contains debugging information specific to the Active Roles Console, this can be helpful in isolating Console-related issues.
You can use the Active Roles Console to perform the following tasks:
-
Export Active Roles system summary.
This option allows you to save the Active Roles configuration statistics to a file that you can later send to the support team for diagnosing the issue.
-
Turn the Administration Service’s diagnostic log on or off.
The Console shows the path to the log file located on the computer running the Administration Service.
-
Choose the level of verbosity for the Administration Service: Basic or Verbose.
The Verbose option results in a more detailed log, but considerably increases the size of the log file.
-
Turn the Console’s diagnostic log on or off.
The Console shows the path to the Console’s log file on the local computer.
It is also possible to enable or disable diagnostic logs by using Configuration Center (see Logging management tasks). The following instructions apply to the Active Roles Console.
To view or change the diagnostic settings
-
Log on as an Active Roles Admin, and open the Active Roles Console.
-
In the Active Roles Console tree, click the root node to display the Active Roles summary page in the details pane.
-
On the summary page, expand the Diagnostics area.
In the Diagnostics area, you can view whether the Active Roles Administration Service’s diagnostic logging is currently enabled (turned on) or disabled (turned off).
-
In the Diagnostics area, click View or change diagnostic settings.
This opens the Diagnostics page in the Properties dialog for the Administration Service instance to which the Console is currently connected. Another way to open that page is by directly opening the Properties dialog from the Administration Service object in the Configuration/Server Configuration/Administration Service container.
-
Use the Diagnostics page to perform the following tasks:
-
To turn the Administration Service’s log on or off, click the appropriate option. This option enables or disables the Administration Service diagnostic logging on the computer running the Administration Service instance to which the console is currently connected.
-
Choose the level of verbosity from the Logging level list, if you have selected the option to turn on the Administration Service’s log.
-
View the path and name of the Administration Service’s log file, along with the name of the computer that holds the log file.
-
Click the appropriate option to turn on or off the Console’s log. This option enables or disables the console diagnostic logging on the local computer.
-
View the path and name of the Console’s log file, along with the name of the computer that holds the log file.
-
Click Export Active Roles system summary to save the Active Roles configuration statistics to a file that you can later send to the support team for diagnosing the issue.
-
When finished, click OK or Apply for your changes to take effect.
Active Roles Log Viewer
The Log Viewer tool enables you to browse and analyze diagnostic log files created by the Active Roles Administration Service as well as event log files created by saving the Active Roles event log in Event Viewer on the computer running the Administration Service. Log Viewer can help you drill down through the sequence or hierarchy of requests processed by the Administration Service, identify error conditions that the Administration Service encountered during request processing, and find Knowledge Articles that apply to a given error condition.
With Log Viewer, you can open an Active Roles diagnostic log file (ds.log) or saved event log file (.evtx), and view a list of:
-
Errors encountered by the Administration Service and recorded in the log file.
-
Requests processed by the Administration Service and traced in the log file.
-
All trace records found in the diagnostic log file.
-
All events found in the event log file.
When you select an error in the list, you can choose a command to look for solution in Knowledge Base. The command performs a search in One Identity Software Knowledge Base to list the Knowledge Articles that can provide helpful information on how to troubleshoot the error you selected.
Log Viewer also enables you to:
-
Search the list for a particular text string, such as an error message.
-
Filter the list by various conditions, to narrow the set of list items to those you are interested in.
-
View detailed information about each list item, such as error details, request details or stack trace.
Using Log Viewer
To start Log Viewer, click Start Log Viewer in the Configuration Center main window.
Once you have started Log Viewer, open your Active Roles diagnostic log file or saved event log file by clicking Open on the Log Viewer toolbar, and supplying the path and name of the log file.
By default, Log Viewer displays a list of errors encountered by the Administration Service and recorded in the log file. You can use Log Viewer to look for information on how to troubleshoot a given error: Right-click the error in the list and then click Look for solution in Knowledge Base. Log Viewer performs a search in One Identity Software Knowledge Base to list the Knowledge Articles that apply to the error you selected.
Other tasks you can perform:
-
To view a list of requests processed by the Administration Service and traced in the log file, click Requests in the View area on the Log Viewer toolbar.
-
To view all trace records found in the diagnostic log file or all events found in the event log file, click Raw log records in the View area on the Log Viewer toolbar.
-
To search the list for a particular text string, such as an error message, type the text string in the Search box on the Log Viewer toolbar and press Enter.
-
To narrow the set of list items to those you are interested in, click Filter on the Log Viewer toolbar and specify the desired filter conditions.
-
To view detailed information about an error, request, trace record or event, right-click the corresponding list item, and click Details.
-
To view all trace records that apply to a given request, right-click the corresponding item in the Requests list and click Stack trace. This task is unavailable in case of an event log file.
-
To view the request that caused a given error, right-click the error in the Errors list and click Related request. This task is unavailable in case of an event log file.
-
To view all trace records that apply to the request that caused a given error, right-click the error in the Errors list and click Stack trace for related request. This task is unavailable in case of an event log file.
SQL Server replication
SQL Server database replication allows copying and distributing data between different nodes to maintain replicated data.
Active Roles uses the replication functionality of Microsoft SQL Server to copy and distribute configuration data from one Administration Service database to another, and to synchronize data among the databases for consistency.
For more information about replication terminology, the type of SQL Server Replication model that Active Roles uses, and the steps required to configure replication, see the following topics: