Generating a support bundle

For DCT Appliance (OVA) deployments, use the setup UI for support logs in the Creating support logs page.

1. Find the collect_bundle.sh script

  • Download the support bundle containing the support-tools tar file from the downloads site.

  • Once the file is downloaded, untar it and find the collect_bundle.sh script.

Copy
$ tar -xzvf dct-support-tools-test-02132025.tar.gz
x ./
x ./backup-restore/
x ./backup-restore/README
X ./backup-restore/appliance_backup_restore.sh
x ./backup-restore/backup_restore.sh
x ./support-bundle/
x ./support-bundle/collect_bundle.sh
x ./support-bundle/README
x ./VERSION

2. Execute collect_bundle.sh when DCT is running in Kubernetes

  • Transfer the collect_bundle.sh script to the machine where you have permissions to execute kubectl commands against the DCT pods.

    • You must install the bash shell to generate a DCT support bundle, if it is not already.

  • Execute the collect_bundle.shscript, which assumes a Kubernetes deployment by default. The script may need to run with sudo if root permissions are needed to run the kubectl commands.

  • If the namespace is not the default "dct-services", use the -n flag and pass the correct namespace.

Copy
dlpxuser@delphix:~/test/tools/support-scripts/$ ./collect_bundle.sh -n <custom_namespace>
....
DCT support bundle collection started at Thu Jun 22 12:35:05 EDT 2023
Collecting logs from all DCT containers...
....

3. Execute collect_bundle.sh when DCT is running in Docker-Compose

  • Transfer the collect_bundle.sh script to the machine where you have permissions to execute docker commands against the DCT Docker-Compose application.

You must install the bash shell to generate a DCT support bundle, if it is not already.

  • Execute the collect_bundle.sh script with the -d parameter. The script may need to run with sudo if root permissions are needed to run the docker commands.

Copy
dlpxuser@delphix:~/test/tools/support-scripts/$ ./collect_bundle.sh -n <custom_namespace>
....
DCT support bundle collection started at Thu Jun 22 12:35:05 EDT 2023
Collecting logs from all DCT containers...
....

4. Find the generated support bundle tar file

  • The resulting support bundle will be located at dct-support-****.tar.gz, inside the current directory.

    Copy
    dlpxuser@delphix:~/test$ ls -ltr
    total 316
    -rw-r--r-- 1 65436 staff 104189 Feb 17 08:52 dct-support-<current_timestamp>.tar.gz
  • The support bundle tar file contains the following information:

    • DCT logs for all of the containers.

    • A java heap dump, .hprof, if one exists.

    • A java thread dump and memory stats.

    • The output of docker stats, if running in Docker-Compose.

    • The output of cpuinfo, meminfo, and mpstat for each container, if running in Kubernetes.

    • The output of kubectl get pods -o json for each container, if running in Kubernetes.

    • The collect_bundle.sh generates a support bundle from a DCT engine running in Docker or Kubernetes.

    • The resulting support bundle will be at ./dct-support-****.tar.gz inside the container.

    • The user must have privileges or permission to execute the docker or kubectl, commands in order to generate the support bundle.