Subscribe

UiPath Automation Suite

The UiPath Automation Suite Guide

Using the Automation Suite Support Bundle tool

Overview


📘

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

  1. By unzipping the sf-installer.zip installer package.
  2. By downloading the supportability-tools.zip

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

cd /opt/UiPathAutomationSuite/{version}/installer

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

./Support-Tools/support-tools/support-bundle/

📘

Note:

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

The following image shows a typical output for this command:

33603360

 

Automation Suite Support Bundle tool parameters


  • Running only bash support-bundle.sh collects logs from the S3 store of the past 7 days.
  • If you want to collect logs from a particular date, run bash support-bundle.sh -F 2021-06-22 -D 1
    • use -F as date in YYYY-MM-DD format
    • use -D as number of days for which you want to collect the logs from the start date in -F (default value is 7 days).
  • Currently we are collecting logs for almost all the namespaces used in Automation Suite. If you want to collect logs for only 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.
  • If you want to generate the support bundle for MongoDB, use -m at the end of the command (bash support-bundle.sh -m). This command generates a .tgz compressed file named mongo_support_bundle_<current_timestamp>.tgz under the same folder where the bash command is run. Attach this file and send it to UiPath Support Team.

 

Automation Suite Support Bundle structure


The .zip archive contains following files and folders:

14321432
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.

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

10341034

 

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.

Updated 2 months ago


Using the Automation Suite Support Bundle tool


Suggested Edits are limited on API Reference Pages

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