diff --git a/docs/developer-guides/monitoring-task-queues.md b/docs/developer-guides/monitoring-task-queues.md index 3d7dd593..5b20ed82 100644 --- a/docs/developer-guides/monitoring-task-queues.md +++ b/docs/developer-guides/monitoring-task-queues.md @@ -1,29 +1,34 @@ # Monitoring Task Queues -Monitoring task queues is essential for ensuring optimal performance and efficiency in task processing. Task queues hold tasks that are pending execution. By monitoring these queues, you can track key metrics such as the number of tasks waiting, the number of workers polling for tasks, and the time of the last poll. This information helps manage workflow efficiency, identify potential issues, and maintain system reliability. +When an application or workflow needs to execute a task in the background, it adds tasks to task queues. These queues hold tasks that are pending execution and are processed later by worker services. + +Monitoring task queues is crucial for maintaining optimal performance and efficiency. By tracking key metrics, such as the number of tasks waiting, the number of workers polling for tasks, and the last poll time, you can manage workflow efficiency, identify potential issues, and ensure system reliability. ## Viewing Task Queues -To monitor your task queues: +To monitor task queues: -1. Navigate to **Executions > Queue Monitor** from the left menu on your Orkes Conductor cluster. +1. Go to **Executions > Queue Monitor** from the left menu on your Orkes Conductor cluster.

Monitoring Task Queues in Conductor

-The task queue monitoring page provides the following details: +The Queue Monitor page displays the following information: -- **Queue Size** : Shows the number of tasks waiting to be executed. -- **Worker Count** : Displays the number of worker instances polling for tasks. -- **Last Poll Time** : Indicates the time of the last poll. +- **Queue Size** : The number of tasks waiting to be executed. +- **Worker Count** : The number of worker instances polling for tasks. +- **Last Poll Time** : The time the task was last polled. -You can filter task queues based on queue size, worker count, and last poll time. +Use the filter options to narrow down task queues based on queue size, worker count, and last poll time. -

Filtering task queues in Orkes Conductor

+## Viewing Worker Details -To view worker details: +To view worker details for a specific task queue: -1. Select the desired task queue. -2. View the worker name, task-to-domain mapping (if any), and last poll time as shown below: +1. Select the desired task queue from the list in the **Queue Monitor**. +2. Scroll down to the **Worker** section for details about the worker's polling tasks. This includes: + - Worker name + - Task-to-domain mapping (if applicable) + - Last poll time -

Worker details in task queue monitor

+

Worker details in task queue monitor

diff --git a/static/img/task-queue-monitor-view.png b/static/img/task-queue-monitor-view.png index 4197e0fc..c2ec8eae 100644 Binary files a/static/img/task-queue-monitor-view.png and b/static/img/task-queue-monitor-view.png differ diff --git a/static/img/worker-details-in-task-queue-monitor.png b/static/img/worker-details-in-task-queue-monitor.png new file mode 100644 index 00000000..ad235dbc Binary files /dev/null and b/static/img/worker-details-in-task-queue-monitor.png differ