Working with logs

To debug an issue in BMC Helix Single Sign-On, you can investigate log files. Logs give information about various events on the BMC Helix SSO server, BMC Helix SSO agent, and BMC Helix SSO AR System External Authentication (AREA) plugin.

BMC Helix SSO server logs

By default, the BMC Helix SSO server log level is set to INFO. To modify the log level on the BMC Helix SSO server, use one of the options:

Configure the log level in the BMC Helix SSO Admin Console. For more information, see Configuring settings for the Remedy SSO server.
(On-prem deployment only) Configure the logback.xml file in $TOMCAT$/webapps/rsso/WEB-INF/classes. For more information, seeLogback configuration in the Logback Project documentation.

The BMC Helix SSO server logs are recorded to the rsso.log file available in the logs directory of Tomcat on the BMC Helix SSO server. BMC recommends that you preserve the default log parameters for the BMC Helix SSO server. If you need to reconfigure these logs, see theSimple Logging Facade for Java documentation.

BMC Helix SSO agent logs

BMC Helix SSOagent logs can be confugured by using the rsso-log.cfg file.

To set the log level for the BMC Helix SSO agent

By default, the BMC Helix SSO agent log level is set to INFO. To modify the log level on the BMC Helix SSO agent, use one of the options:

Update the rsso-log.cfg file available in the class path of an integrated application. For information about the location of the file, seethe documentationof the integrated BMC Helix application.
Specify the configuration path to the rsso-log.cfg file through the following system property: -Drsso.log.cfg.file=<path_to_rsso-log.cfg>

To configure logging for the BMC Helix SSO agent

To configure the BMC Helix SSO agent logging, modify the following parameters in the rsso-log.cfg file:

Name	Default value	Description
rsso.log.name.format	rsso.%g.log	Logging file name. The %g pattern is replaced by the number corresponding to the current logging file output.
rsso.log.level	INFO	Log level. Supported log levels are SEVERE, WARNING, INFO, FINER, and FINEST.
rsso.log.roll	1	General number of logging files.
rsso.log.limit	10485760	The maximum size (in bytes) of one logging output file. The default value is 10 MB.
rsso.log.dir	NA	Directory of the log files.
rsso.io.tmpdir	NA	Temporary directory. This directory is used if rsso.log.dir and catalina.home directories are empty. If this parameter is not specified, the java.io.tmpdir directory is returned.

BMC Helix SSO agent logs configuration example

For example, you need to apply the following configuration to the BMC Helix SSO agent:

The logs should be stored in the logger directory and the log file name should be rs_Try.%g.log.
The maximum number of log files should be 2, and the maximum size of each log file should be 5 MB.
The logging level should be set to FINEST.

The following sample shows how to configure the BMC Helix SSO agent to meet these requirements:

rsso.log.name.format=rs_Try.%g.log
rsso.log.level=FINEST
rsso.log.roll=2
rsso.log.limit=5242880
rsso.log.dir=logger

BMC Helix SSO AREA plugin logs

BMC Helix SSOAREA plugin log files are stored in \ARserver\DB\arjavaplugin.log.

For more information about the BMC Helix SSO AREA plugin logs, seeTroubleshooting issues with plug-in servers in the BMC Helix Innovation Suite official documentation.