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

Conversation

GSmithApps
Copy link

@GSmithApps GSmithApps commented Jan 7, 2025

Closes #2359 (which is to help clarify this Slack thread)

@GSmithApps GSmithApps requested a review from a team as a code owner January 7, 2025 10:56
@GSmithApps GSmithApps force-pushed the 2359-exception-doc-enhancement branch from a71d0c8 to 06855df Compare January 7, 2025 11:03
"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."

@GSmithApps
Copy link
Author

GSmithApps commented Jan 8, 2025

Hi Quinn, thanks so much for looking at this PR!

I'm not sure if you saw the Slack thread in the comment from me above, but I was trying to get ahead of a question similar to that in the future, because judging by Tiho's comment, Kapa went down the wrong path. I figured if we gave it a little more direction in the exception description, we might be able to avoid that.

Do you think there's any clarifying or expanding to do, or should we leave it as it was before this PR?

Also, if this warrants more discussion or anything, I'm happy to chat over Slack 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify UnableToAcquireLockException
2 participants