Automation Suite: Collect Logs using Support Bundle

News Knowledge Base
1

How to collect logs using support bundle in Automation Suite?

Using the Automation Suite Support Bundle Tool

A support bundle is a collection of diagnostic information, logs, and relevant data that can help support teams analyze and troubleshoot issues more effectively.

Get the Automation Suite Support Bundle tool by downloading the file supportability-tools.zip. The latest version of supportability-tools works with all Automation Suite versions.

Before running the Automation Suite Support Bundle tool, navigate to the installer folder. Find the installer in the following location or anywhere downloaded.

Versions 24.10.X and above

As of 2024.10.X we now utilize the uipathctl tool. To run this tool:

  1. For AKS/EKS: https://docs.uipath.com/automation-suite/automation-suite/2024.10/installation-guide-eks-aks/running-the-support-bundle-tool
  2. For embedded: https://docs.uipath.com/automation-suite/automation-suite/2024.10/installation-guide/using-support-bundle-tool
    1. Make sure to export the KUBECONFIG before running: 
      1. sudo su -
export KUBECONFIG="/etc/rancher/rke2/rke2.yaml" \
&& export PATH="$PATH:/usr/local/bin:/var/lib/rancher/rke2/bin"
    2. In most embedded instances the tool will be in the installation directory of automation suite. In most cases this is /opt/UiPathAutomationSuite/latest/installer 
      1. cd /opt/UiPathAutomationSuite/latest/installer
    3. Run the following command: 
      1. ./bin/uipathctl health bundle cluster_config.json --versions versions/helm-charts.json
    4. The tool should take 5-10 minutes to run. If it fails or seems to have failures, from the install directory run the following command: 
      1. bash Support-Tools/support-bundle/scripts/rke2-support-bundle.sh
      2. If the uipathctl fails, it may mean that the cluster itself is down. The rke2-support-bundle.sh will gather all system logs which would allow us to see why the system is down.

Versions 23.10.X and below:

Here are the steps to download the support bundle for the latest version 2023.10.0:

  1. Navigate to the installer folder using the following command: 
    # cd /opt/UiPathAutomationSuite/{version}/installer

    1. Download the latest support bundle tool using the following command: 
      # wget -O ~/supportability-tools.zip https://download.uipath.com/automation-suite/2023.10.0/supportability-tools-2023.10.0.zip

      1. Unzip the support bundle using the following command: 
        # unzip supportability-tools-2023.10.0.zip -d support-tools

        1. Navigate to support-tools folder using the following command: 
          # cd support-tools

          1. To start using the Automation Suite Support Bundle tool, run the following command: 
            # bash support-bundle.sh

            Automation Suite Support Bundle Tool Parameters

            1. Running only bash support-bundle.sh collects logs from the S3 store of the past 7 days
            2. 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
              • -D as number of days for which you want to collect the logs from the start date in -F (default value is 7 days).
            3. Currently, logs are collected for almost all the namespaces used in Automation Suite. If required to collect logs for only particular namespaces, run bash support-bundle.sh -N uipath,uipath-infra, use
              • -N as list of required namespaces to collect the logs.