UiPath Documentation
automation-suite
2023.10
false
UiPath logo, featuring letters U and I in white

Automation Suite on Linux installation guide

Last updated Mar 26, 2026

Using the Automation Suite support bundle

Overview​

Note:

You can get the Automation Suite Support Bundle tool in the following ways:

Before running the Automation Suite Support Bundle tool, navigate to the installer folder. You can find the installer in the following location or anywhere you downloaded it:

cd /opt/UiPathAutomationSuite/{version}/installer
cd /opt/UiPathAutomationSuite/{version}/installer

To start using the Automation Suite Support Bundle tool, run the following commands:

cd ./Support-Tools/support-bundle
./support-bundle.sh
cd ./Support-Tools/support-bundle
./support-bundle.sh
Note:

In Azure, make sure your IP is added to the Network Security Group.

The following image shows a typical output for this command:

docs image

Automation Suite Support Bundle Tool parameters​

  • Running only bash support-bundle.sh collects logs for the last 2 days from the S3-compatible objectstore, if you use an external objectstore, or from Ceph, if you use the in-cluster objectstore.
  • To set the start date for the log collection process, use the -F argument and enter the date in the YYYY-MM-DD format. To set the number of days for which you want to collect logs, calculated from the start date, use the -D argument and enter the number of days as an integer. For example, to collect logs for the interval between July 20, 2024, and July 24, 2024, run bash support-bundle.sh -F 2024-07-20 -D 5.

To collect logs for a particular date, use the -F argument to specify the date and the -D argument to set an interval of one day. For example, to collect logs for July 20, 2024, run bash support-bundle.sh -F 2024-07-20 -D 1.

If you do not set the number of days for which you want to collect logs, the tool uses a default interval of 7 days, calculated from the start date. For example, running bash support-bundle.sh -F 2024-07-20 collects logs for the interval between July 20, 2024, and July 26, 2024.

  • We collect logs for almost all the namespaces used in Automation Suite. To collect logs only for particular namespaces, run bash support-bundle.sh -N uipath,uipath-infra. Use -N as list of namespaces for which you want to collect the logs.
  • The RKE2, uipath, Redis, and Longhorn bundles are generated by default.
    • To disable the RKE2 bundle, run the support-bundle.sh -e command.
    • Long-running commands in the RKE bundle are disabled. To enable them, run the scripts/rke2-support-bundle.sh -a command.
    • To disable Redis bundle generation, run the support-bundle.sh -s command.
  • 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 using -c in the RKE environments for Automation Suite 2023.10 and lower.

Automation Suite Support Bundle Structure​

The .zip archive contains following files and folders:

File/folderDescription
logsContains logs collected from the S3 store.
eventsContains event descriptions from all the namespaces.
nodes.infoContains descriptions of all the nodes in the cluster.
jobs/deployments/pods/daemonsetsContains descriptions of corresponding objects from all namespaces.
current-logsContains last 4 hour logs from currently running pods. We are collecting this to handle the scenario where Ceph S3 store is down.
service-metricsContains high level usage telemetry stored in individual XML files.

If passed specific namespace list to the command, the structure would look similar to the one shown in the following image:

docs image

Exploring Logs​

As we are providing a publicly downloadable link to the Automation Suite Support Bundle tool, you can download it on any machine and open it in any editor, such as VS Code, to use it.

To get the logs from the past 30 days, run support-bundle.sh -F 2023-09-18 -D 30.

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated