You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11Lines changed: 11 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,6 +54,17 @@ For a fuller deployable example, see
54
54
[`examples/order_processing`](examples/order_processing), which runs a
55
55
multi-activity order workflow against a local server with Docker Compose.
56
56
57
+
## Retry policy scopes
58
+
59
+
Retry and timeout settings are scoped to the layer where you configure them:
60
+
61
+
-`TransportRetryPolicy` on `Client(...)` retries SDK HTTP requests only. It handles transient connection failures, request timeouts, 5xx responses, and 429 rate limits. It does not retry workflow code, activity code, child workflows, or failed workflow runs.
62
+
-`ActivityRetryPolicy` on `ctx.schedule_activity(...)` is recorded into durable history with that activity command. It controls server-side attempts for that one activity execution.
63
+
-`ChildWorkflowRetryPolicy` on `ctx.start_child_workflow(...)` is recorded with that child-start command. It controls server-side attempts for that child workflow execution.
64
+
-`non_retryable_error_types` belongs to durable activity/child retry policies. `non_retryable=True` on an activity failure bypasses the activity retry budget and surfaces the failure to the workflow.
65
+
66
+
Timeout names are also layer-specific. `start_to_close_timeout` limits one activity attempt, `schedule_to_start_timeout` limits queue wait before an activity starts, `schedule_to_close_timeout` limits the whole activity execution including retries, and `heartbeat_timeout` limits the gap between activity heartbeats. For child workflows, `execution_timeout_seconds` covers the overall child workflow execution and `run_timeout_seconds` covers one run.
67
+
57
68
## Activity retries and timeouts
58
69
59
70
Configure per-call activity retries and deadlines from workflow code:
-**[Activity](reference/activity.md)** — activity decorator and execution context.
23
23
-**[Errors](reference/errors.md)** — typed exceptions raised by the client and worker.
24
-
-**[Retry policy](reference/retry_policy.md)** — HTTP transport retry configuration for the client.
24
+
-**[Retry policy](reference/retry_policy.md)** — HTTP transport retry configuration for the client. Durable activity and child workflow retry policies are workflow primitives, not transport settings.
25
25
-**[Metrics](reference/metrics.md)** — pluggable recorders, including a Prometheus adapter.
26
26
-**[Serializer](reference/serializer.md)** — payload encoding and decoding helpers.
27
27
-**[Sync helpers](reference/sync.md)** — blocking wrappers around the async client for scripts and tests.
0 commit comments