Enabling logging in the web client for the RM application

Edit online

You can enable logging in the web client for the Requirements Management (RM) application to capture information about events, processes, and other activities, which you can use for debugging purposes. To access the log messages in the web client, you specify a log level in the URL for the application.

To enable logging in the web client, include the clientlog parameter in the RM application URL. This parameter specifies the level and type of logging that occurs when the RM application is used. By default, the log level is set to 4 (ERROR). For example, the following URL captures debugging-related information and log messages about processes, events, and important decision points:

https://<host>:<port>/rdm/web?debug=true&clientlog=1

All log messages are written to the browser console.

The following table describes the different logging levels that you can set.

Table 1. Web client logging levels
Level	Description
5 (SILENT)	Nothing is logged.
4 (ERROR)	Use this level to log only errors that break the normal workflow. Typically, his type of error affects the user experience and requires human intervention.
3 (WARN)	Use this level to capture details about unexpected inputs or situations that are not typical, but that do not break the normal work flow. For example, the following situations might generate messages at this level: the use of deprecated APIs, the incorrect use of APIs, and other runtime situations that are undesirable or unexpected, but not necessarily incorrect.
2 (INFO)	Use this level to capture information about high-level events such as session lifecycle calls, database calls, or remote API calls. Information at this level is an abstract of an event: it does not include specific details that are covered by the debug level.
1 (DEBUG)	Use this level to capture details that can help you troubleshoot problems, for example, relevant information about processes, events, and important decision points.
0 (TRACE)	Use this level to generate more detailed output about objects, data structures, and environment compared to the DEBUG level.

Note: The logging levels for the web client are inclusive. For example, if you specify clientlog=3, all warnings and errors are logged. To work with the RM application in debug mode, you can use the clientlog parameter and set debug to true. If you do not work in debug mode, only the log messages that are part of the RM application are included in the web client log.

Examples

If you include clientlog=1 in the RM application URL, and then open a project that includes link constraint rules, you might see log entries like these:

LinkingConstraintsCache: Getting constraints for project <projectURL>
LinkingConstraintsCache: Get constraints for project finished in <#>ms.
LinkTypeUtils: Processing <#> link types for project.

If you include clientlog=1 in the RM application URL, and then open the audit history page for an artifact, you might see log entries like these:

AuditHistoryRetriever: Getting artifact history.
AuditHistoryRetriever: Get artifact history finished in <#>ms.
AuditHistoryViewer: Populating <#> audit history change entries for detail pane.