- Overview
- Requirements
- Pre-installation
- Installation
- Post-installation
- Migration and upgrade
- Upgrading Automation Suite
- Migrating standalone products to Automation Suite
- Step 1: Restoring the standalone product database
- Step 2: Updating the schema of the restored product database
- Step 3: Moving the Identity organization data from standalone to Automation Suite
- Step 4: Backing up the platform database in Automation Suite
- Step 5: Merging organizations in Automation Suite
- Step 6: Updating the migrated product connection strings
- Step 7: Migrating standalone Orchestrator
- Step 8: Migrating standalone Insights
- Step 9: Migrating standalone Test Manager
- Step 10: Deleting the default tenant
- Performing a single tenant migration
- Migrating between Automation Suite clusters
- Migrating from Automation Suite on EKS/AKS to Automation Suite on OpenShift
- Monitoring and alerting
- Cluster administration
- Product-specific configuration
- Orchestrator advanced configuration
- Configuring Orchestrator parameters
- Configuring appSettings
- Configuring the maximum request size
- Overriding cluster-level storage configuration
- Configuring NLog
- Saving robot logs to Elasticsearch
- Configuring credential stores
- Configuring encryption key per tenant
- Cleaning up the Orchestrator database
- Skipping host library creation
- 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
- Robot cannot connect to an Automation Suite Orchestrator instance
- Log streaming does not work in proxy setups
- Velero backup fails with FailedValidation error
- Accessing FQDN returns RBAC: access denied error
- Running the diagnostics tool
- Running the support bundle tool
- Exploring summarized telemetry
Automation Suite on EKS/AKS installation guide
Running the support bundle tool
The Automation Suite support bundle tool collects application-level logs of UiPath® services and other software components, such as Istio, ArgoCD, etc. The Automation Suite support bundle tool also contains historical records you can use to analyze patterns when troubleshooting a problem. Detailed logs are particularly helpful when the potential root cause of an issue is not evident just by looking at the state of the cluster.
The Automation Suite support bundle tool is also needed when asking for guidance or a fix from the UiPath® Support team as they need it for analysis purposes.
The Automation Suite support bundle tool does not collect or store any PII or confidential data of you, your user, or your automation. UiPath® applications not not leak or log any confidential information in their records. At the platform level, the log collector is designed to mask any such critical information.
High-level summarized usage telemetry is also exported with this tool generating an XML file. This telemetry includes:
- Robot execution duration per month by robot type.
- Robot concurrency - the maximum number of robots that executed at the same time.
- Metrics on jobs run, processes run, queue items, job failure rate, and users.
- Environment information.
- AI Units usage summary if you use AI Center.
You can upload the XML file in the Customer Portal to share your high-level self-hosted usage telemetry with the UiPath Support team.
You can opt out of generating this summarized telemetry by listing service-metrics in the excluded list in Automation Suite 2024.10 and higher.
Generating the support bundle
To generate the support bundle, run the following command:
./uipathctl health bundle input.json --versions versions.json
./uipathctl health bundle input.json --versions versions.json
This tool takes some time to gather and store all the logs in a temporary location on your local / management machine.
The following table lists the optional flags the support bundle tool support:
| Flags | Description |
|---|---|
--output-dir string | Specify the directory to store the support bundle. |
--namespace string | Specify the namespace where UiPath Automation Suite is deployed. |
--include string | Specify additional components (comma separated) to include in the bundle (such as --include=historical-logs). |
--exclude string | Specify components (comma separated) to exclude from the bundle (such as service-metrics). |
--from YYYY-MM-DD | The start date to collect the historical logs in YYYY-MM-DD format. |
--days int | The number of days from the start date for which to collect the historical logs. |
--limit-bytes int | Limits the size of the logs of running pods by providing the integer value in bytes. |
- By default, if the
--fromflag is not specified, then the historical logs will be collected for the past 2 days starting from today, irrespective of the--daysspecified. - If the
--fromis specified and--daysis not specified, then the historical logs will be collected for 2 days starting from the specified start date.
Automation Suite Support Bundle Structure
The .tar.gz archive contains following files and folders:
| File/folder | Description |
|---|---|
current-logs | Contains the live logs (such as logs for current and previous instance of pods). |
events.json | Contains the event descriptions from all the namespaces. |
alerts | Contains the active prometheus alerts in the cluster. |
namespace/resource/object.yaml | Contains the object descriptions for the server-preferred/custom namespace and cluster-scoped resources. |
service-metrics | Contains high level usage telemetry stored in individual XML files. |
Historical logs are not supported in EKS/AKS environments.