Skip to content

Commit

Permalink
[Doc Update] - Monitoring Task Queues
Browse files Browse the repository at this point in the history
  • Loading branch information
RizaFarheen committed Jul 22, 2024
1 parent da602ea commit b574e1f
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions docs/developer-guides/monitoring-task-queues.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,29 @@
# Monitoring Task Queues

The task queues are the collection of tasks waiting to be executed. It is useful for viewing the details, such as the number of workers polling and monitoring the queue backlog.
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.

## Viewing Task Queues

You can monitor your task queues by navigating to **Executions > Queue Monitor**.
To monitor your task queues:

1. Navigate to **Executions > Queue Monitor** from the left menu on your Orkes Conductor cluster.

<p align="center"><img src="/content/img/task-queue-monitor-view.png" alt="Monitoring Task Queues in Conductor" width="100%" height="auto"></img></p>

The task queue monitoring page shows the following details:
The task queue monitoring page provides the following details:

- **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.

You can filter task queues based on queue size, worker count, and last poll time.

<p align="center"><img src="/content/img/filtering-task-queues.png" alt="Filtering task queues in Orkes Conductor" width="20%" height="auto"></img></p>

- Queue Size - Displays the number of tasks waiting to be executed.
- Worker Count - Displays the number of worker instances polling for the task.
- Last Poll Time - Displays the last polled time.
To view worker details:

In addition, you also have the provision to filter the task queues based on queue size, worker count, and last poll time.
To view the worker details polling for the task, select the required task queue, and you can view the worker name along with the [task to domain](/content/developer-guides/task-to-domain) mapping as shown below:
1. Select the desired task queue.
2. View the worker name, task-to-domain mapping (if any), and last poll time as shown below:

<p align="center"><img src="/content/img/worker-details-in-task-queue-monitor.jpg" alt="Worker details in task queue monitor" width="100%" height="auto"></img></p>

Binary file added static/img/filtering-task-queues.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b574e1f

Please sign in to comment.