Skip to content

Commit 8dd94a9

Browse files
authored
[Wf-Diagnostics] add a section on HB timeout set qual to StartToCloseTimeout (#235)
1 parent 9d5074d commit 8dd94a9

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

docs/08-workflow-troubleshooting/01-timeouts.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ Activities time out StartToClose or ScheduleToClose if the activity took longer
3535

3636
For long running activities, while the activity is executing, the worker can die due to regular deployments or host restarts or failures. Cadence doesn't know about this and will wait for StartToClose or ScheduleToClose timeouts to kick in.
3737

38+
[Read more abut long running activites](https://cadenceworkflow.io/docs/concepts/activities/#long-running-activities)
39+
3840
Mitigation: Consider configuring heartbeat timeout and a retry policy
3941

4042
[Example](https://github.com/cadence-workflow/cadence-samples/blob/df6f7bdba978d6565ad78e9f86d9cd31dfac9f78/cmd/samples/expense/workflow.go#L23)

docs/08-workflow-troubleshooting/03-retries.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,8 @@ In both activity retries and workflow retries it is sufficient to mention a maxi
3030

3131
In both activity retries and workflow retries it is sufficient to specify a maximum number of attempts or an expiration interval. The first retry attempt waits for the InitialIntervalInSeconds before starting and when an expiration interval is set lower than the initial interval, the retry policy becomes invalid and the activity or workflow will not be retried.
3232

33+
## Heartbeat timeout being equal or higher than StartToClose timeout
3334

35+
Heartbeat timeouts are used to detect when a worker died or restarted. With heartbeat timeout configured equal or higher than StartToClose timeout, cadence will timeout on the StartToClose timeout which essentially makes the configured heartbeat timeout to become useless. Ideally heartbeat timeouts should be configured to a few minutes so you can catch issues with the worker faster.
36+
37+
[Read more abut long running activites](https://cadenceworkflow.io/docs/concepts/activities/#long-running-activities)

0 commit comments

Comments
 (0)