UiPath Orchestrator Guide

Monitoring Queues

General View

Displays information about all the existing queues on an aggregate basis, and allows you to check the overall health of the queues in your system. On this page, you may control the granularity of the displayed data, to have a more accurate overview on the metrics of your queues.

Filters

Interval - allows you to control the granularity of the data, and display either the last hour or last day (last 24 hours) of your queues context.

Note

Filtering impacts all widgets, unless specified otherwise in the dedicated section.

Queues Overview

Allows you to see a real-time overview of the queue's health state so you can assess if there are any problems that would impact the entire system. The total number of queues is displayed in parentheses after the widget name.

The health of your queues is represented with colored blocks as follows:

  • Green - all items in the queue have been successfully processed;
  • Grey - no items were processed;
  • Orange - items are close to being overdue;
  • Red - there are items which have either failed with application exceptions or they are overdue.

As a queue's state changes, the chart gets updated in real time and the block color changes accordingly. Hovering over a block displays detailed information on the corresponding queue. Clicking the block displays the corresponding detailed view page. Click the arrow at the top-left of the page to return to the general view.

Filtering by Interval does not impact the red blocks in this widget.

Unprocessed Items

Allows you to see unprocessed queue items broken down into three categories:

  • Newly Added Items - Items that were added in the selected interval regardless of their status.
  • Remaining Items - Items remaining to be processed.
  • Items in Progress - Items which are in progress.

This enables you to see an overall status of all queue items so as to assess if your system is overloaded, and more robots are needed to process everything in time. Starting an item-processing job causes the Items in Progress section to update accordingly in real time.

Filtering by Interval only impacts the Newly Added Items section in this widget.

Transactions Overview

Allows you to see precise figures on items that were processed. It enables you to asses whether your queue items are failing or not. Please note that for failed items that were retried, each retry status is taken into account.

Transactions states are represented with colors as follows:

  • Green - successful transactions;
  • Orange - transactions failed with business exceptions;
  • Red - transactions failed with application exceptions or retried as a consequence.

The number in the middle of the chart represents the total number of transactions as illustrated by this widget. The number on each slice represents the transactions in that specific state. Once an item is processed, successfully or not, the chart gets accordingly updated in real time. You may filter out states by clicking the labels below the chart.

Transactions Timeline

Allows you to see the timeline of processed items broken down according to their final status, in the selected interval. Please note that for failed items that were retried, each retry status is taken into account.

Transaction states are represented with colors as follows:

  • Green - successful transactions;
  • Yellow - transactions failed with business exceptions;
  • Orange - transactions failed with application exceptions or retried as a consequence;
  • Red - abandoned transactions.

Once an item-processing job has finished or it has been stopped, the chart gets accordingly updated in real time. Click a marker in the chart to see the exact corresponding value. You may filter out states by clicking the labels below the chart.

Queues Details

Allows you to see information pertaining to each queue and the corresponding items metrics. The total number of queues is displayed in parentheses after the widget name.

Field
Description

Queue

The name of the queue. Click the arrows at the left of the column name once to sort data by queue name in ascending alphabetical order, or twice to sort it in descending alphabetical order.

No. of Items

The total number in the queue. It is the same as on the Queues page.

Deferred

The number of deferred queue items.

Overdue

The number of overdue items.

On Time

The number of items whose processing falls in the expected estimated time.

AHT (Per Item)

The average handling time of a processed item, calculated on all items in the selected queue since it was created.

Completion

The estimated completion time for the rest of the items based on the average handling time.

Search

Enables you to search by queue name.

Filtering by Interval does not impact this widget.

Individual View

Displays information concerning one queue, as selected by the user from the general view, specifically on the Queues Overview widget. Each widget in this view contains the exact same information as on the Queues page. Changing the properties there automatically causes the information here to update accordingly.

Filters

Interval - allows you to control the granularity of the data, and display either the last hour or last day (last 24 hours) of the selected queue's health state.

Transactions Overview

Allows you to see precise figures on items that were processed in the selected queue. It provides metrics about the encountered exceptions such that are able you to asses whether your queue items are failing or not. Please note that for failed items that were retried, each retry status is taken into account.

Transactions states are represented with colors as follows:

  • Green - successful transactions;
  • Orange - transactions failed with business exceptions;
  • Red - transactions failed with application exceptions or retried as a consequence.

The number in the middle of the chart represents the total number of transactions as illustrated by this widget. The number on each slice represents the transactions in that specific state. Once an item is processed, successfully or not, the chart gets accordingly updated in real time. You may filter out states by clicking the labels below the chart.

Unprocessed Items

Allows you to see unprocessed items in a queue broken down into two categories:

  • Items remaining to be processed
  • Items which are in progress.

This enables you to see an overall status of all the items in a queue so as to assess if your system is overloaded, and more robots are needed to process everything in time. Starting an item-processing job causes the Items in Progress section to update accordingly in real time. You may filter out states by clicking the labels below the chart.

Queue Dynamics

Allows you to see the number of items in the selected queue that were either added or processed, in the selected interval, thus enabling you to assess the efficiency of your system concerning to item processing. You may filter out states by clicking the labels below the chart.

Retry Rate

Allows you to see your successfully processed queue items broken down according to the number of retries. You may filter out states by clicking the labels below the chart.

Transactions Timeline

Allows you to see the timeline of processed items in the selected queue, broken down according to their final status, in the selected interval. Please note that for failed items that were retried, each retry status is taken into account.

Transactions states are represented with colors as follows:

  • Green - successful transactions;
  • Yellow - transactions failed with business exceptions;
  • Orange - transactions failed with application exceptions or retried as a consequence;
  • Red - abandoned transactions.

Once an item-processing job has finished or it has been stopped, the chart gets accordingly updated in real time. Click a marker in the chart to see the exact corresponding value. You may filter out states by clicking the labels below the chart.

Processing Time

Allows you to see the average handling time of an item, calculated on all items in the selected queue since it was created, and the estimated completion time for the rest of the items based on that average. The Estimated Completion value is influenced by the number of Robots which are currently processing items, as well as by items that have a Defer Date. When no more unprocessed items are left in the queue, the value is set to N/A.

Filtering by Interval does not impact this widget.

Error Feed

Allows you to see the a list of the errors encountered on the selected queue. The errors are displayed in reverse chronological order as they occur, meaning a new error is always displayed at the top of the feed. The total number of errors is displayed in parentheses after the widget name as follows:

  • The exact number - for less than 99 errors;
  • 99+ - for more than 99 and less than 199 errors;
  • 199+ - for more than 199 and less than 299 errors.

Similarly for more.

You can dismiss an error after having acknowledged it, however please take into account that multiple users might check the feed simultaneously, so we recommend carefully using the Dismiss button. A dismissed error is still taken into account in the error counter. After an error was dismissed, the name of the user who performed the action is displayed adjacently. Note that you need Edit Permissions on Monitoring in order to dismiss errors. Details here.

Field
Description

Time

The time when the error occurred.

Error Message

The actual error message.

Dismiss

Enables you to dismiss the specific error message. Clicking the Dismiss button removes the formatting from the text.
A dismissed error is still taken into account in the error counter. After an error was dismissed, the name of the user who performed the action is displayed adjacently. Note that you need Edit Permissions on Monitoring in order to dismiss errors. Details here.

Copy

Enables you to copy the text of the error message to the clipboard.

SLA Overview

Precise figures of the unprocessed items that either fall into the expected processing time, are deferred, or overdue.

The unprocessed items are represented with colors as follows:

  • Green - items that fall into the expected processing time;
  • Red - items that are overdue;
  • Orange - items that are deferred.

You may filter out states by clicking the labels below the chart.


Monitoring Queues


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.