This documentation supports the 22.1 version of BMC Helix Single Sign-On, which is available only to BMC Helix customers (SaaS). 

To view an earlier version, select the version from the Product version menu.

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, BMC Helix SSO AREA plugin, Java SDK, and installation.

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 logback.xml file in $TOMCAT$/webapps/rsso/WEB-INF/classes
    For more information about the logback.xml file, see Logback configuration Open link .

The BMC Helix SSO server log example is as follows:

$TOMCAT_HOME$\logs\rsso.0.loginternal BMC Helix SSO logger

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 Simple Logging Facade for Java (SLF4J) Open link .

BMC Helix SSO agent logs

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, see the documentation Open link of the integrated 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>

BMC Helix SSO agent log examples are as follows:

  • $TOMCAT_HOME$\logs\rsso.0.loginternal BMC Helix SSO logger
  • $TOMCAT_HOME$\logs\rsso-agent.0.loginternal BMC Helix SSO logger used in the BMC Helix SSO agent

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: 

NameDefault ValueDescription
rsso.log.name.formatrsso.%g.log

Logging file name. The %g pattern is replaced by the number corresponding to the current logging file output.

rsso.log.levelINFO

Log level. Supported log levels are SEVERE, WARNING, INFO, FINER, and FINEST.

rsso.log.roll1General number of logging files.
rsso.log.limit10485760

The maximum size (in bytes) of one logging output file. The default value is 10 MB.

rsso.log.dir
Directory of the log files.
rsso.io.tmpdir

Temporary directory. This directory is used if rsso.log.dir and catalina.home are empty. If this parameter is not specified, java.io.tmpdir 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 folder 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 SSO AREA plugin log files are as follows:

  • %TEMP%/rsso.0.log—logs recorded on the BMC Helix SSO server
  • \ARserver\DB\arjavaplugin.loglogs recorded on the Remedy AR System server

For more information about the BMC Helix SSO AREA plugin logs, see Troubleshooting plug-in issues Open link .

BMC Helix SSO installation logs 

The log files are created in the temp folder at the time of installation, and are preserved during the next installation. BMC Helix SSO copies the log files in the temp folder and zips the following log files:

  • remedysso_configuration_log
  • remedysso_install_log

The zipped file is called log_timestamp and saved to the RSSOInstallFolder/logs folder, which enables viewing the previous installation logs to troubleshoot installation issues.

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

Comments