Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Clarify UnableToAcquireLockException (#2359) #2360

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -355,8 +355,12 @@ public void handle(WorkflowTask task) throws Exception {

if (!locked) {
throw new UnableToAcquireLockException(
"Workflow lock for the run id hasn't been released by one of previous execution attempts, "
+ "consider increasing workflow task timeout.");
"Workflow lock for the run id hasn't been released by one of previous execution attempts. "
+ "This likely means the workflow task timed out, and the Service attempted to "
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This exception can be thrown any time the workflow lock cannot be acquire because another task is holding the lock. It can happen because of workflow task timeout, but that is misleading to suggest it is likely or to recommend investigating Workflow Task timed out without doing some triage. This error can have multiple causes including something happening on the Temporal Server side

Suggested change
+ "This likely means the workflow task timed out, and the Service attempted to "
"Workflow lock for the run id hasn't been released by one of previous execution attempts. This means another workflow task is holding the lock. If seen repeatedly users should investigate the failing workflow executions for more details."

+ "retry the task on the same Worker while the timed out Task had not finished yet. "
+ "We suggest investigating why the Workflow Task timed out. This could mean "
+ "looking at Worker resource utilization at the time in which this exception was thrown or "
+ "increasing workflow task timeout.");
}
}

Expand Down
Loading