12.5 Configuring Logging

Self Service Password Reset provides logs for your to troubleshoot any issues that might occur. The system uses Apache log4j for logging. Apache log4j is a Java-based logging utility that allows logging to a variety of outputs such as files, syslog, NT event log, databases, and so forth.

You configure the logging settings through the Configuration Editor and you view the logs through the administration console for Self Service Password Reset. The system also outputs a number of logs to the file system depending on the options you configure.

12.5.1 Configuring Logging Settings

You configure the setting for logging in the Configuration Editor. A number of settings use the same log levels. Depending on what you need to see, you set a different level of severity for the logs. The following list includes available log levels for all settings in order of severity:

6 - Trace

Most detailed information. Use this level during initial configuration.

5 - Debug

Detailed information on the flow through the system.

4 - Info

Informational messages that highlight the progress of the application at coarse-grained level. Use this level for normal operations. This is the default log level for StdOut.

3 - Warn

Potentially harmful situations.

2 - Error

Runtime errors or unexpected conditions.

1 - Fatal

Severe errors that cause premature termination.

To configure logging:

  1. Log in to Self Service Password Reset at https://dns-name/sspr as an administrator.

  2. In the toolbar, click your name.

  3. Click Configuration Editor.

  4. Click Settings > Logging.

  5. Configure the following settings:

    Console (StdOut) Log Level

    Select the appropriate log level for StdOut. Most servlet containers redirect StdOut to a log file. For example, Tomcat logs StdOut output to the tomcat/logs/catalina.out file by default.

    LocalDB Log Level

    Select the appropriate log level for the local database. You view the log events written to the local database in the Administrator event log viewer. For more information, see Viewing Logs.

    File Log Level

    Select the appropriate log level to log events to the local file log. The system writes the log files to the WEB-INF/logs directory of the servlet.

    Maximum LocalDB Events

    Set the maximum log events stored in the local database. Each 100,000 log events consumes approximately 100 MB of disk space. The local database retains this number of events and uses these events to display in the log viewer. For more information, see Viewing Logs.

    This setting does not affect the normal log files configured in the log4jconfig.xml file or the log file settings for Tomcat.

    Maximum Age LocalDB Events

    Set the maximum age of events stored in the local database (seconds). The system periodically purges events older than the configured value. The default value is four weeks (60s * 60m * 24h * 7d * 4w = 2419200). The system does not remove events due to age if you specify a value of 0.

    Daily Summary Alerts

    Enable this option to send an email alert once a day (at 0:00 GMT) that contains a summary of the statistics and health for the day.

  6. In the toolbar, click Save changes.

  7. (Conditional) To log all LDAP events to the Trace logging level:

    1. In the Configuration Editor, click LDAP > LDAP Settings > Global.

    2. Select Enable LDAP Wire Trace. For more information, see Configuring LDAP Settings.

    3. In the toolbar, click Save changes.

12.5.2 Viewing Logs

Self Service Password Reset allows you to view the logs through the administration console. The option you set in Configuring Logging Settings determines what the log shows. You can also change the log level through the viewer.

To view the log:

  1. Log in to Self Service Password Reset at https://dns-name/sspr as an administrator.

  2. In the toolbar, click your name.

  3. Click View Log.

  4. Select the appropriate log level, then click Refresh to see that level.

  5. (Conditional) To save the information to a file, right click and select Save page as.

  6. Close the separate browser window to return to the administration console.