- Overview
- Requirements
- Installation
- Post-installation
- Migration and upgrade
- Upgrading Automation Suite on EKS/AKS
- Step 1: Moving the Identity organization data from standalone to Automation Suite
- Step 2: Restoring the standalone product database
- Step 3: Backing up the platform database in Automation Suite
- Step 4: Merging organizations in Automation Suite
- Step 5: Updating the migrated product connection strings
- Step 6: Migrating standalone Orchestrator
- Step 7: Migrating standalone Insights
- Step 8: Deleting the default tenant
- Performing a single tenant migration
- Migrating from Automation Suite on Linux to Automation Suite on EKS/AKS
- Monitoring and alerting
- Using the monitoring stack
- Alert runbooks
- Cluster administration
- Product-specific configuration
- Troubleshooting
- The backup setup does not work due to a failure to connect to Azure Government
- Pods in the uipath namespace stuck when enabling custom node taints
- Unable to launch Automation Hub and Apps with proxy setup
- Pods cannot communicate with FQDN in a proxy environment
- Test Automation SQL connection string is ignored
- EKS backup failure due to Velero version

Automation Suite on EKS/AKS installation guide
The monitoring stack for Automation Suite clusters includes Prometheus, Grafana, and Alertmanager, which are automatically installed unless you choose to bring your own monitoring stack.
This page describes a series of monitoring scenarios optimized to work with the monitoring tool, which is bundled with the Automation Suite cluster. If you choose to bring your own monitoring stack, make sure to follow the official documentation of your tools to monitor the health of the cluster.
When using collectors to export metrics to third-party tools, enabling application monitoring may disrupt the functionality of Automation Suite.
Overview
The monitoring stack for Automation Suite clusters includes Prometheus, Grafana, and Alert Manager.
You can access the Automation Suite monitoring tools individually using the following URLs:
|
Application |
Tool |
URL |
Example |
|---|---|---|---|
|
Metrics |
Prometheus |
|
|
|
Dashboard |
Grafana |
|
|
|
Alert Management |
Alert Manager |
|
|
Monitoring tool authentication
To access the monitoring tools for the first time, follow the instructions in Accessing Automation Suite.
https://monitoring.fqdn/metrics and select the Alerts tab. Here you can see all the alerts configured in Automation Suite.
-
To view the active alerts, filter the alert status by using the Firing checkbox.
-
Check Show annotations to display messages corresponding to alerts.
If alerts are too noisy, you can silence them. To do that, take the following steps:
uipathctl in the Automation Suite installation folder: .../UiPathAutomationSuite/UiPath_Installer/bin.
Before starting configuring the alerts, make sure to enable kubectl.
Adding a new email configuration
To add a new email configuration after an installation, run the following command:
./uipathctl config alerts add-email \
--name test \
--to "[email protected]" \
--from "[email protected]" \
--smtp server.mycompany.com \
--username admin \
--password somesecret \
--require-tls \
--ca-file <path_to_ca_file> \
--cert-file <path_to_cert_file> \
--key-file <path_to_key_file> \
--send-resolved
--ASEA./uipathctl config alerts add-email \
--name test \
--to "[email protected]" \
--from "[email protected]" \
--smtp server.mycompany.com \
--username admin \
--password somesecret \
--require-tls \
--ca-file <path_to_ca_file> \
--cert-file <path_to_cert_file> \
--key-file <path_to_key_file> \
--send-resolved
--ASEA|
Flag |
Description |
Example |
|---|---|---|
|
|
The name of the email configuration |
|
|
|
The email address of the receiver | |
|
|
The email address of the sender | |
|
|
SMTP server URL or IP address and port number |
|
|
|
Authentication username |
|
|
|
Authentication password |
|
|
|
Boolean flag to denote that TLS is enabled at the SMTP server. |
N/A |
|
|
File path containing the CA Certificate of the SMTP server. This is optional if the CA is private. |
|
|
|
File path containing the certificate of the SMTP server. This is optional if the certificate is private. |
|
|
|
File path containing the private key of the certificate of the SMTP server. This is required if the certificate is private. |
|
|
|
Boolean flag to send an email once the alert is resolved. |
N/A |
|
|
Boolean flag to indicate that you installed Automation Suite on EKS or AKS. |
N/A |
Removing an email configuration
To remove an email configuration, you must run the following command. Make sure to pass the name of the email configuration you want to remove.
./uipathctl config alerts remove-email --name test --ASEA./uipathctl config alerts remove-email --name test --ASEAUpdating an email configuration
To update an email configuration, you must run the following command. Make sure to pass the name of the email configuration you want to update and the additional optional parameters you want to edit. These parameters are the same as the ones for adding a new email configuration. You can pass one or more flags at the same time.
./uipathctl config alerts update-email --name test --ASEA [additional_flags]./uipathctl config alerts update-email --name test --ASEA [additional_flags]To access Grafana dashboards, you must retrieve your credentials and use them to log in:
-
Username:
kubectl -n monitoring get secrets/grafana-creds -o "jsonpath={.data.admin-user}" | base64 -d; echokubectl -n monitoring get secrets/grafana-creds -o "jsonpath={.data.admin-user}" | base64 -d; echo -
Password:
kubectl -n monitoring get secrets/grafana-creds -o "jsonpath={.data.admin-password}" | base64 -d; echokubectl -n monitoring get secrets/grafana-creds -o "jsonpath={.data.admin-password}" | base64 -d; echo
You can monitor persistent volumes via the Kubernetes / Persistent Volumes dashboard. You can keep track of the free and used space for each volume.
You can also check the status of each volume by selecting the PersistentVolumes item within the Storage menu of the Cluster Explorer.
To check the hardware utilization per node, you can use the Nodes dashboard. Data on the CPU, Memory, Disk, and Network is available.
You can monitor the hardware utilization for specific workloads using the Kubernetes / Compute Resources / Namespace (Workloads) dashboard. Select the uipath namespace to get the needed data.
- Select the downwards pointing arrow next to the chart title, and then select Share.
- Select the Snapshot tab, and set the Snapshot name,Expire, and Timeout.
- Select Publish to snapshot.raintank.io.
For more details, see the Grafana documentation on sharing dashboards.
For details on how to create custom persisten Grafana dashboards, see Grafana documentation.
Documentation on the available metrics is here:
- Accessing the monitoring tools
- Overview
- Monitoring tool authentication
- Checking currently firing alerts
- Silencing alerts
- Configuring the alerts
- Adding a new email configuration
- Removing an email configuration
- Updating an email configuration
- Accessing Grafana dashboard
- Monitoring Persistent Volumes
- Monitoring hardware utilization
- Creating shareable visual snapshot of a Grafana chart
- Creating custom persistent Grafana dashboards
- Querying Prometheus