Fixed timeout property documentation #411
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
flossypurse
reviewed
Mar 31, 2021
| /** | ||
| * Maximum activity execution time after it was sent to a worker. If schedule to close is not | ||
| * provided then both this and schedule to start are required. | ||
| * Maximum time of a single activity execution attempt. |
There was a problem hiding this comment.
Suggested change
| * Maximum time of a single activity execution attempt. | |
| * Maximum time of a single Activity execution attempt. |
We want to capitalize these and treat them as proper nouns.
flossypurse
suggested changes
Mar 31, 2021
| * provided then both this and schedule to start are required. | ||
| * Maximum time of a single activity execution attempt. | ||
| * | ||
| * <p>Note that Temporal doesn't detect worker process failures directly. It relies on this |
There was a problem hiding this comment.
Suggested change
| * <p>Note that Temporal doesn't detect worker process failures directly. It relies on this | |
| * <p>Note that the Temporal Server doesn't detect Worker process failures directly. It relies on this |
| * Maximum time of a single activity execution attempt. | ||
| * | ||
| * <p>Note that Temporal doesn't detect worker process failures directly. It relies on this | ||
| * timeout to detect an activity that didn't complete on time. So this timeout should be as |
There was a problem hiding this comment.
Suggested change
| * timeout to detect an activity that didn't complete on time. So this timeout should be as | |
| * timeout to detect that an Activity that didn't complete on time. So this timeout should be as |
| * | ||
| * <p>Note that Temporal doesn't detect worker process failures directly. It relies on this | ||
| * timeout to detect an activity that didn't complete on time. So this timeout should be as | ||
| * short as the longest possible execution of the activity body. Potentially long running |
There was a problem hiding this comment.
Suggested change
| * short as the longest possible execution of the activity body. Potentially long running | |
| * short as the longest possible execution of the Activity body. Potentially long running |
| * <p>Note that Temporal doesn't detect worker process failures directly. It relies on this | ||
| * timeout to detect an activity that didn't complete on time. So this timeout should be as | ||
| * short as the longest possible execution of the activity body. Potentially long running | ||
| * activities must specify HeartbeatTimeout and call {@link |
There was a problem hiding this comment.
Suggested change
| * activities must specify HeartbeatTimeout and call {@link | |
| * Activities must specify HeartbeatTimeout and call {@link |
| * activities must specify HeartbeatTimeout and call {@link | ||
| * ActivityExecutionContext#heartbeat(Object)} periodically for timely failure detection. | ||
| * | ||
| * <p>If schedule to close is not provided then this timeout is required. |
There was a problem hiding this comment.
Suggested change
| * <p>If schedule to close is not provided then this timeout is required. | |
| * <p>If ScheduleToClose is not provided then this timeout is required. |
|
|
||
| /** Maximum execution time of a single workflow task. Default is 10 seconds. */ | ||
| /** | ||
| * Maximum execution time of a single workflow task. In the majority of cases there is no need |
There was a problem hiding this comment.
Suggested change
| * Maximum execution time of a single workflow task. In the majority of cases there is no need | |
| * Maximum execution time of a single Workflow Task. In the majority of cases there is no need |
| /** Maximum execution time of a single workflow task. Default is 10 seconds. */ | ||
| /** | ||
| * Maximum execution time of a single workflow task. In the majority of cases there is no need | ||
| * to change this timeout. Note that this timeout is not related to the overall workflow |
There was a problem hiding this comment.
Suggested change
| * to change this timeout. Note that this timeout is not related to the overall workflow | |
| * to change this timeout. Note that this timeout is not related to the overall Workflow |
| /** | ||
| * Maximum execution time of a single workflow task. In the majority of cases there is no need | ||
| * to change this timeout. Note that this timeout is not related to the overall workflow | ||
| * duration in any way. It defines for how long workflow can get blocked in case of a workflow |
There was a problem hiding this comment.
Suggested change
| * duration in any way. It defines for how long workflow can get blocked in case of a workflow | |
| * duration in any way. It defines how long the Workflow can get blocked in the case of a Workflow |
| * Maximum execution time of a single workflow task. In the majority of cases there is no need | ||
| * to change this timeout. Note that this timeout is not related to the overall workflow | ||
| * duration in any way. It defines for how long workflow can get blocked in case of a workflow | ||
| * worker crash. |
There was a problem hiding this comment.
Suggested change
| * worker crash. | |
| * Worker crash. |
| * duration in any way. It defines for how long workflow can get blocked in case of a workflow | ||
| * worker crash. | ||
| * | ||
| * <p>Default is 10 seconds. Maximum value allowed by the service is 1 minute. |
There was a problem hiding this comment.
Suggested change
| * <p>Default is 10 seconds. Maximum value allowed by the service is 1 minute. | |
| * <p>Default is 10 seconds. Maximum value allowed by the Temporal Server is 1 minute. |
flossypurse
reviewed
Mar 31, 2021
| * task queue (use {@link #setScheduleToStartTimeout(Duration)} to limit it) plus activity | ||
| * execution time (use {@link #setStartToCloseTimeout(Duration)} to limit it). Either this | ||
| * option or both schedule to start and start to close are required. | ||
| * Overall timeout workflow is willing to wait for activity to complete. |
There was a problem hiding this comment.
Suggested change
| * Overall timeout workflow is willing to wait for activity to complete. | |
| * Total time that a Workflow is willing to wait for an Activity to complete. |
| * option or both schedule to start and start to close are required. | ||
| * Overall timeout workflow is willing to wait for activity to complete. | ||
| * | ||
| * <p>ScheduleToCloseTimeout limits total time of the activity execution including retries (use |
There was a problem hiding this comment.
Suggested change
| * <p>ScheduleToCloseTimeout limits total time of the activity execution including retries (use | |
| * <p>ScheduleToCloseTimeout limits the total time of an Activity's execution including retries (use |
| * Overall timeout workflow is willing to wait for activity to complete. | ||
| * | ||
| * <p>ScheduleToCloseTimeout limits total time of the activity execution including retries (use | ||
| * StartToCloseTimeout to limit a time of a single attempt). |
There was a problem hiding this comment.
Suggested change
| * StartToCloseTimeout to limit a time of a single attempt). | |
| * StartToCloseTimeout to limit the time of a single attempt). |
| * <p>ScheduleToCloseTimeout limits total time of the activity execution including retries (use | ||
| * StartToCloseTimeout to limit a time of a single attempt). | ||
| * | ||
| * <p>Either this option or StartToClose are required. |
There was a problem hiding this comment.
Suggested change
| * <p>Either this option or StartToClose are required. | |
| * <p>Either this option or StartToClose is required. |
| /** | ||
| * Time activity can stay in task queue before it is picked up by a worker. If schedule to close | ||
| * is not provided then both this and start to close are required. | ||
| * Time activity can stay in task queue before it is picked up by a worker. |
There was a problem hiding this comment.
Suggested change
| * Time activity can stay in task queue before it is picked up by a worker. | |
| * Time that the Activity Task can stay in the Task Queue before it is picked up by a Worker. |
| * is not provided then both this and start to close are required. | ||
| * Time activity can stay in task queue before it is picked up by a worker. | ||
| * | ||
| * <p>Do not specify this timeout unless using host specific task queues for activity task |
There was a problem hiding this comment.
Suggested change
| * <p>Do not specify this timeout unless using host specific task queues for activity task | |
| * <p>Do not specify this timeout unless host specific Task Queues for Activity Tasks are being used for routing |
| * Time activity can stay in task queue before it is picked up by a worker. | ||
| * | ||
| * <p>Do not specify this timeout unless using host specific task queues for activity task | ||
| * routing. |
There was a problem hiding this comment.
Just remove and combine with above comment.
| * routing. | ||
| * | ||
| * <p>ScheduleToStartTimeout is always non-retryable. Retrying after this timeout doesn't make | ||
| * sense as it would just put the activity task back into the same task queue. |
There was a problem hiding this comment.
Suggested change
| * sense as it would just put the activity task back into the same task queue. | |
| * sense as it would just put the Activity Task back into the same Task Queue. |
vitarb
approved these changes
Apr 1, 2021
flossypurse
approved these changes
Apr 6, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What was changed:
Fixed documentation of activity timeouts and workflow task timeout.
Why?
Documentation was outdated and confusing.