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
**What is a Workflow Execution Timeout in Temporal?**
33
33
@@ -51,7 +51,7 @@ If this timeout is reached, the Workflow Execution changes to a Timed Out status
51
51
This timeout is different from the [Workflow Run Timeout](#workflow-run-timeout).
52
52
This timeout is most commonly used for stopping the execution of a [Temporal Cron Job](/cron-job) after a certain amount of time has passed.
53
53
54
-
## Workflow Run Timeout?{#workflow-run-timeout}
54
+
## Workflow Run Timeout {#workflow-run-timeout}
55
55
56
56
**What is a Workflow Run Timeout in Temporal?**
57
57
@@ -79,7 +79,7 @@ This timeout is most commonly used to limit the execution time of a single [Temp
79
79
80
80
If the Workflow Run Timeout is reached, the Workflow Execution will be Timed Out.
81
81
82
-
## Workflow Task Timeout?{#workflow-task-timeout}
82
+
## Workflow Task Timeout {#workflow-task-timeout}
83
83
84
84
**What is a Workflow Task Timeout in Temporal?**
85
85
@@ -104,3 +104,23 @@ This Timeout is primarily available to recognize whether a Worker has gone down
104
104
This timeout is primarily available to recognize whether a Worker has gone down so that the Workflow Execution can be recovered on a different Worker.
105
105
The main reason for increasing the default value is to accommodate a Workflow Execution that has an extensive Workflow Execution History, requiring more than 10 seconds for the Worker to load.
106
106
It's worth mentioning that although you can extend the timeout up to the maximum value of 120 seconds, it's not recommended to move beyond the default value.
107
+
108
+
## Detecting Workflow Task Failures
109
+
110
+
Use the `TemporalReportedProblems` Search Attribute to detect Workflows with failed Workflow Tasks.
111
+
A failed Workflow Task does not cause the Workflow to fail. Some Tasks within a Workflow may be intended to fail.
112
+
For example, a Workflow Task may check a remote data source for new messages. If there aren't any, the Task will fail as intended.
113
+
If your Task has code to handle the failure, the Workflow will proceed.
114
+
However, if your Workflow has a Task that fails and the failure is not handled, the Workflow will continue to run, but will not complete.
115
+
Detecting Workflows in this state is a common troubleshooting issue.
116
+
117
+
To identify Workflows with Task failures, you can use the Temporal Web UI. See [Task Failures View](/web-ui/#task-failures-view) for more details.
118
+
119
+
You can also detect Workflows with Task failures by searching for the `TemporalReportedProblems` search attribute with your observability tools.
120
+
121
+
:::warning Activating Workflow Task Failure in AWS Namespaces
122
+
123
+
To enable the Task Failures View for a Namespace running on AWS, you need to update the Dynamic Config for that Namespace.
124
+
See [Activating Task Failure View for AWS Namespaces](/web-ui/#activate-task-failures-view-for-aws).
Copy file name to clipboardExpand all lines: docs/encyclopedia/visibility/search-attributes.mdx
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,6 +73,7 @@ These Search Attributes are created when the initial index is created.
73
73
| StateTransitionCount | Int | The number of times that Workflow Execution has persisted its state. Available only for closed Workflows. |
74
74
| TaskQueue | Keyword | Task Queue used by Workflow Execution. |
75
75
| TemporalChangeVersion | Keyword List | Stores change/version pairs if the GetVersion API is enabled. |
76
+
| TemporalReportedProblems | Keyword List | Stores information about Workflow task failures. Formatted as `category=<category> cause=<cause>`.
76
77
| TemporalScheduledStartTime | Datetime | The time that the Workflow is schedule to start according to the Schedule Spec. Can be manually triggered. Set on Schedules. |
77
78
| TemporalScheduledById | Keyword | The Id of the Schedule that started the Workflow. |
78
79
| TemporalSchedulePaused | Boolean | Indicates whether the Schedule has been paused. Set on Schedules. |
0 commit comments