Skip to content

Commit b1395b9

Browse files
committed
Update 01-timeouts.md
1 parent 1d93e55 commit b1395b9

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Optionally you can also increase the number of pollers per worker by providing t
2727
[Link to options in go client](https://pkg.go.dev/go.uber.org/[email protected]/internal#WorkerOptions)
2828
[Link to options in java client](https://github.com/uber/cadence-java-client/blob/master/src/main/java/com/uber/cadence/internal/worker/PollerOptions.java#L124)
2929

30-
## Timeouts without heartbeat timeout or retry policy configured
30+
## No heartbeat timeout or retry policy configured
3131

3232
Activities time out StartToClose or ScheduleToClose if the activity took longer than the configured timeout.
3333

@@ -37,35 +37,35 @@ For long running activities, while the activity is executing, the worker can die
3737

3838
Mitigation: Consider configuring heartbeat timeout and a retry policy
3939

40-
[Configuring heartbeat timeout example](https://github.com/uber-common/cadence-samples/blob/df6f7bdba978d6565ad78e9f86d9cd31dfac9f78/cmd/samples/expense/workflow.go#L23)
40+
[Example](https://github.com/uber-common/cadence-samples/blob/df6f7bdba978d6565ad78e9f86d9cd31dfac9f78/cmd/samples/expense/workflow.go#L23)
4141
[Check retry policy for activity](https://cadenceworkflow.io/docs/concepts/activities/#retries)
4242

4343
For short running activities, heart beating is not required but maybe consider increasing the timeout value to suit the actual activity execution time.
4444

45-
## Timeouts without heartbeat timeout configured but a retry policy configured
45+
## Retry policy configured without setting heartbeat timeout
4646

47-
Retry policies are good to be configured so that activities can be retried after timeouts or failures. 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. The retry is attempted only after this timeout. Enabling heartbeating would cause the activity to timeout earlier and will be retried on another worker.
47+
Retry policies are good to be configured so that activities can be retried after timeouts or failures. 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. The retry is attempted only after this timeout. Configuring heartbeat timeout would cause the activity to timeout earlier and will be retried on another worker.
4848

4949
Mitigation: Consider configuring heartbeat timeout
5050

51-
[Configuring heartbeat timeout example](https://github.com/uber-common/cadence-samples/blob/df6f7bdba978d6565ad78e9f86d9cd31dfac9f78/cmd/samples/expense/workflow.go#L23)
51+
[Example](https://github.com/uber-common/cadence-samples/blob/df6f7bdba978d6565ad78e9f86d9cd31dfac9f78/cmd/samples/expense/workflow.go#L23)
5252

53-
## Timeouts with heartbeating enabled but without a retry policy configured
53+
## Heartbeat timeout configured without a retry policy
5454

55-
Heartbeat timeouts are used to detect when a worker died or restarted during deployments. With heartbeat timeout enabled, the activity will timeout faster. But without a retry policy, it will not be scheduled again on a healthy worker.
55+
Heartbeat timeouts are used to detect when a worker died or restarted during deployments. With heartbeat timeout configured, the activity will timeout faster. But without a retry policy, it will not be scheduled again on a healthy worker.
5656

5757
Mitigation: Consider adding retry policy to an activity
5858

5959
[Check retry policy for activity](https://cadenceworkflow.io/docs/concepts/activities/#retries)
6060

61-
## Heartbeat Timeouts after enabling heartbeating
61+
## Heartbeat Timeouts after configuring heartbeat timeout
6262

63-
Activity has enabled heart beating but the activity timed out with heart beat timeout. This is because the server did not receive a heart beat in the time interval configured as the heart beat timeout.
63+
Activity has configured heartbeat timeout and the activity timed out with heart beat timeout. This is because the server did not receive a heart beat in the time interval configured as the heart beat timeout.
6464

6565
Mitigation: Once heartbeat timeout is configured in activity options, you need to make sure the activity periodically sends a heart beat to the server to make sure the server is aware of the activity being alive.
6666

6767
[Example to send periodic heart beat](https://github.com/uber-common/cadence-samples/blob/df6f7bdba978d6565ad78e9f86d9cd31dfac9f78/cmd/samples/fileprocessing/activities.go#L111)
6868

6969
In go client, there is an option to register the activity with auto heart beating so that it is done automatically
7070

71-
[Enabling auto heart beat during activity registration example](https://pkg.go.dev/go.uber.org/[email protected]/internal#WorkerOptions)
71+
[Configuring auto heart beat during activity registration example](https://pkg.go.dev/go.uber.org/[email protected]/internal#WorkerOptions)

0 commit comments

Comments
 (0)