Uploading Logs and Diagnostic Files to Yugabyte Support

This article documents the methods YugabyteDB provides to allow users to send logs—such as Support Bundles, individual files, and diagnostic data—to Yugabyte Support while working through a support case.

Also Read: How to collect the Support Bundle from the YugabyteDB Universe

Table of Contents

• Attach the File with Case Comment
• Attach the File Using yb-support-tool
  • Download the Tool
  • Unzip the Package
  • Run the Tool
  • Upload a File
  • Handling Large Files

Attach the File with Case Comment

• Make a comment on the support case (you must include a comment to enable file uploads).
• In the "Attachments" section, drag and drop or click to attach your file before submitting the case.

Attach the File Using yb-support-tool

Download the Tool

1. Download the appropriate version of the yb-support-tool for your distribution.
2. It is recommended to use wget or curl to download the attachment.
3. Right-click on the correct target and choose "Copy link address".

Example:

wget https://support.yugabyte.com/hc/en-us/article_attachments/17289027759117/yb-support-tool-LINUX-x86_64.zip
# OR
curl -O https://support.yugabyte.com/hc/en-us/article_attachments/17289027759117/yb-support-tool-LINUX-x86_64.zip

Unzip the Package

unzip yb-support-tool-linux-amd64.zip

Run the Tool

./yb-support-tool --help

Output:

Yugabyte Support Tool

Usage:
  yb-support-tool [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  upload      Upload attachment to a support case
  version

Flags:
  -h, --help      help for yb-support-tool
      --verbose   Print verbose logs

Use "yb-support-tool [command] --help" for more information about a command.

Upload a File

./yb-support-tool upload --case 1234 --email user@example.com file1 file2 file3

Handling Large Files

• Yugabyte’s upload partner has a 100GB upload limit per file or set of files.
• Always compress large files using tar before uploading.
• If the tarball exceeds 100GB, split the file before uploading.

Command to split a large file:

split -b <size> <tar_file> <output_prefix>

Example:

split -b 100M example.tar.gz split_part_

This command splits the example.tar.gz file into 100MB parts named split_part_aa, split_part_ab, and so on.