Skip to content

Commit 4ddd6c7

Browse files
Document Worker Status UI in worker performance and worker health (#4493)
* Document Worker Status UI on worker-performance and worker-health * Note 60s heartbeat is the default * specify entry points
1 parent e5eb9c1 commit 4ddd6c7

2 files changed

Lines changed: 15 additions & 0 deletions

File tree

docs/cloud/worker-health.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,12 @@ This page is a guide to monitoring a Temporal Worker fleet and covers the follow
3939
- [How to detect misconfigured Workers](#detect-misconfigured-workers)
4040
- [How to configure Sticky cache](#configure-sticky-cache)
4141

42+
:::tip
43+
44+
You can also inspect Workers and the Workers assigned to a Task Queue directly in the Temporal UI. See [Visualize Workers in the UI](/develop/worker-performance#visualize-workers).
45+
46+
:::
47+
4248
## Minimal Observations {#minimal-observations}
4349

4450
These alerts should be configured and understood first to gain intelligence into your application health and behaviors.

docs/develop/worker-performance.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,15 @@ The above figure shows Eager Workflow Start in action:
176176

177177
To recover from errors, Eager Workflow Start falls back to the non-eager path. For example, when the first Task is returned eagerly, but the local Worker fails or times out while processing the task, the server retries this task non-eagerly after WorkflowTaskTimeout.
178178

179+
## Visualize Workers in the UI {#visualize-workers}
180+
181+
The Temporal SDK includes a heartbeat for Worker processes that is sent to the Server, carrying information such as available task slots, CPU usage, and Worker configuration.
182+
The Server exposes this data through APIs that surface Worker details in the Temporal UI. See a list of all running Workers by selecting Workers in the left navigation menu.
183+
View the list of Workers assigned to the Workflow Task Queue and inspect Worker details to troubleshoot Workflows with delayed processing by selecting the Workers tab in the Workflow details page.
184+
185+
This feature requires Temporal Server 1.30 or higher with API version 1.62 or higher, and is also available in Temporal Cloud.
186+
Worker Heartbeating is required; see [Manage Worker Heartbeating](/cloud/worker-health#manage-worker-heartbeating) for the minimum SDK versions.
187+
179188
## Performance metrics for tuning {#metrics}
180189

181190
The Temporal SDKs emit metrics from Temporal Client usage and Worker Processes.

0 commit comments

Comments
 (0)