Orchestrator
latest
false
Banner background image
Orchestrator User Guide
Last updated Apr 24, 2024

Monitoring

Tenant level monitoring allows you to visualize data in your system via a collection of dashboards that are grouped together based on a certain dimension, machines for example. Tenant monitoring dashboards display aggregated data from all folders and personal workspaces in which you have access. See monitoring permissions for details on access control.

Available Sections

Section

Description

Overview

Aggregated overview data from all your folders (job count and statuses, transaction count and statuses).

Machines

Aggregated machine data from all your folders. See details about machine monitoring and dashboards at the folder level.

Processes

Aggregated processes data from all your folders. See details about processes monitoring and dashboards at the folder level.

Queues

Aggregated queues data from all your folders. See details about queue monitoring and dashboards at the folder level.

SLA

Aggregated SLA data from all your folders. See details about SLA monitoring dashboards at the folder level.

License

Unattended sessions

User sessions

API audit [Preview]

API audit

API audit

Important:

This feature is currently available as a preview.

This displays the number of calls made to GetAll - Jobs and QueueItems endpoints over the last 30 days, with the option to drill down into a particular day.

The graphs display a green bar if our 100 requests/minute/tenant rate limit is observed, and an orange bar if it is exceeded.

Each graph includes a View API button which directs you to the corresponding Swagger endpoint.

This requires the Audit - View permission.

Important notes:

  • The count starts after the first 10 API calls.
  • The data is displayed with a delay of maximum 20 minutes.
  • Some internal calls may be included in the graphs, but they are not counted towards the rate limit. You may, however, see internal calls exceeding the limit, but they will have a success status code.

Spike details

You can view spike details for each minute logged in the API audit panel.

To do that, select the spike corresponding to the desired minute. This opens a side panel which lists a maximum of 100 results with the most requests, and which includes information such as the process, the folder where the process resides, the host name, the number of calls performed to that endpoint during the selected minute, the status code, and the user agent.

If the API call originates from an external source or if we do not have enough details about the process, the corresponding columns display N/A.
These are the actions that you can perform within the selected spike details side panel:
  • Click the expand button in the top right corner to open the panel in a full-sized window.
  • Click the eye icon corresponding to a process to see the details of the associated job.
    Note: This option is not available if you do not have view permissions for the folder where the process is configured.
Important:

The number of requests is counted starting with the very moment that a request is made, down to the exact second. However, for simplicity, our charts display one-minute increments instead of second increments.

This means that you can have the following scenario:

  • You make 50 requests between 1:10:30 PM and 1:10:59:99 PM.

  • You then make another 60 requests between 1:11:00 PM and 1:11:30 PM.

The chart bars corresponding to each minute will be green, but, in reality, the extra 10 requests will be rate limited.

Monitoring Permissions

The monitoring functionality is controlled by a general-purpose permission set (Monitoring) and per-object permissions (Machines, Robots, Queues, Jobs). In order to give permissions on one object, you need to grant View permissions on Monitoring, and View permissions on the object itself, otherwise the corresponding pages are not displayed.

  • View on Monitoring and View on Machines - allows you to see the content of the Monitoring > Machines pages.
  • View on Monitoring and View on Queues - allows you to see the content of the Monitoring > Queues pages.
  • View on Monitoring and View on Jobs - allows you to see the content of the Monitoring > Jobs pages.
  • Edit on Monitoring and View on Queues - allows you to disable errors from the Error Feed widget on the Monitoring > Queues page.
  • Edit on Monitoring and View on Jobs - allows you to disable errors from the Error Feed widget on the Monitoring > Jobs page.
  • View on Audit - allows you to view API usage data on the API audit tab.

Historical monitoring

The Historical (Insights) tab, powered by the Insights service, provides information that dates back to up to two years. The data it displays is refreshed every 20 minutes.

Note:

This is only available if you have the Insights service enabled.

Tab features

Filtering - Each component includes a series of filters that you can combine to reach the desired result. Filter changes only take effect once you click Reload in the top right of the chart.

Downloading - Download the entire dashboard or each tile in the format of your choice.

Scheduling - Schedule the delivery of a report based on the current chart. This can be sent to your email address with the frequency and in the format you select.

Click-to-filter - Click a component in the chart to filter the entire data set based on it.

  • Available Sections
  • API audit
  • Monitoring Permissions
  • Historical monitoring
  • Tab features

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.