Long Running Thread Diagnostics

Overview

Long running thread diagnostics provide administrators with more tools to isolate and resolve performance issues. Prior to this enhancement, administrators had to shut down and restart an entire site to terminate long running actions. Diagnostics for long running requests that exceed a customizable time threshold are now provided for all Commerce and Configuration actions. There are three Timeout action settings: Kill and Log, Log Only, and No Action.

The following table summarizes actions performed for each of the Timeout Action settings.

Timeout Action Kill Action
Request
Error Message
Displayed
Event Set to
Slow Thread Log
Event Sent to
Performance Log

Kill and Log

ü ü ü ü

Log Only

    ü ü

No Action

       

For example, when an action exceeds the Time Threshold and the Timeout Action is Kill and Log, the system will perform the following actions:

Long Running Thread Diagnostics Error Message

Note: When the system sends a Kill Request, the terminating action waits for an interruptible point in the long running action.

Administration

View Logs

The system records events in the Slow Thread and Performance Logs to aid administrators in troubleshooting. Event logging occurs when actions exceed the Timeout Threshold and the Timeout Action is set to Kill and Log or Log Only.

ClosedPerformance Log

The Performance Log provides an overall snapshot of system performance. Administrators can access Performance Logs from the Admin Home page under Developer Tools.

Performance Logs

ClosedSlow Thread Log

The Slow Thread Log file provides detailed information regarding errors. To view or download the Slow Thread Log:

  1. Navigate to the Admin Home Page.
  2. Click Error Logs under Developer Tools.
  3. (Optional) Click Download Arrow (download arrow) next to the slow_thread_executions.log to download the log file. The log file is downloaded as a text file to a local location.

    Slow Thread Executions Log in Logging Properties

  4. Click slow_thread_executions.log to view the log.

    Slow Thread Log

  5. (Optional) Click Download at the bottom of the log file window to download the log file. The log file is downloaded as a text file to a local location.

Setting Timeout Actions

The LRTD settings are available from the Commerce Settings and Configuration Settings pages. The LRTD setup on these pages controls all actions for their respective areas. The default Timeout Action setting is Log Only, and the Timeout Threshold is set to 2 minutes.

ClosedCommerce Timeout Action Settings

Administrators can set Timeout Actions and Thresholds for all Commerce actions from the Commerce Options page.

Commerce Timeout Action

In addition, administrators can set Timeout Thresholds on individual Commerce actions. The specific Commerce action Timeout Threshold setting takes precedence over the general Commerce setting. This allows the administrator to isolate performance issues on a single commerce action.

Admin Action - Action Timeout option


ClosedConfiguration Timeout Action Setting

Administrators can set Timeout Actions and Thresholds for all Configuration actions from the Configuration Options page.

Configuration Timeout Action Setting

When the system sends a Kill Request, the terminating action waits for an interruptible point in the long running action.

Related Topics

Related Topics Link IconSee Also