Administration Tools

Logging Configuration

Overview

This section of the Administration area provides system administrators with the ability to configure additional logging for troubleshooting purposes.

Note - In general, you should not change the default logging configuration unless troubleshooting a problem with the help of the Hannon Hill support team. Increasing logging may impact the performance of the system and should only be done for a limited time.

Configuring Additional Logging

To configure additional logging for various areas of the system:

  1. Click the system menu button (  ) > Administration > Logging Configuration.
  2. Under the Add Log Category or Package section, click the first dropdown menu to display a list of available categories for logging. Alternatively, specific class names (provided to you by Hannon Hill) may be entered into this field.
  3. After selecting a category/package, use the dropdown menu below that field to select the type of logging to enable for the selected category (Fatal, Error, Warn, Info, Debug).
  4. Click Add Category.
  5. Repeat steps 2-4 above to add logging for additional categories or classes if needed.

Reset Logging

To reset all logging back to the default configuration:

  1. Click the system menu button (  ) > Administration > Logging Configuration.
  2. Click Reset to Default.
  3. Click OK on the confirmation screen that appears.

Performance Logging

Whenever DEBUG level logging is enabled for a particular class, performance information for that class will also be logged. Performance logging statements are written to a separate file named cascade-performance.log. This log contains information about how long it took to execute specific parts of the class being logged.

It is also possible to enable performance logging for all classes in the system by selecting the Performance category and enabling the DEBUG logging level for it.

Warning - enabling Performance Logging should only be done at the request of the Hannon Hill support team.

Slow Execution Logging

Whenever DEBUG level logging is enabled for a particular class, information about operations that take an excessive amount of time will also be logged to a separate slow execution log. This log file is named cascade-slow-execution.log.

In addition to the information included in the Performance log, the Slow Execution log also includes a full stack trace for slow operations.

It is also possible to enable Slow Execution log for all classes in the system by selecting the Slow Execution category and enabling the DEBUG logging level for it.
Back to Top ↑