Self-managed

Vespa Support CLI

The Vespa Enterprise image includes a built-in command-line tool called vespa-support. It is designed to simplify the process of collecting diagnostic information from your deployment, making it easier to request and receive support from the Vespa team.

You should run this tool whenever you are:

Experiencing unexpected behaviour or degraded performance in your Vespa deployment
Preparing to open or respond to a Vespa support ticket
Asked by Vespa support to provide diagnostic information

Accessing the Tool

vespa-support is available in the shell of any running Vespa Enterprise container. To access it, open a shell session into the container using your platform's standard method, then verify the tool is available:

$ vespa support --help

To confirm the tool version and the container version:

$ vespa support version

Commands

vespa support version

Prints the version of the vespa-support tool and the Vespa Enterprise container version.

vespa support diagnostics sysinfo

Collects host-level system information from the node where the command is run. --dest-dir is required. The command will fail if it is not provided.

$ vespa support diagnostics sysinfo --dest-dir <output-directory>

vespa support diagnostics application

Collects the currently deployed Vespa application package configuration. --dest-dir is required. The command will fail if it is not provided.

$ vespa support diagnostics application --dest-dir <output-directory>

Options

The following options apply to all diagnostics subcommands.

Option	Required	Default	Description
`--dest-dir`	Yes	—	Directory where the diagnostic output files will be written.
`--config-server-host`	No	Auto-detected	Host address of the Vespa config server. If not set, the tool resolves it automatically from the environment.
`--config-server-port`	No	19071	Port of the Vespa config server.
`--timeout-secs`	No	60	Timeout in seconds for operations that contact the config server.

What Is Collected

sysinfo

The output is written as a ZIP file named diag-sysinfo.zip in the specified destination directory. It contains the following information about the host:

Vespa version
Hostname, operating system, kernel version, and CPU architecture
CPU model and core count
Memory usage (total, free, and available)
Disk usage per mounted filesystem (size, free space, usage percentage)
Network interfaces, routing table, DNS servers, and firewall rules as seen from within the container

application

The output is written as a ZIP file named diag-application.zip in the specified destination directory. It contains the full Vespa application package as currently deployed, preserving the original directory structure.

Creating a Support Bundle

The following steps walk you through collecting a complete set of diagnostic files to share with the Vespa support team.

1. Open a shell session into the Vespa Enterprise container.

2. Create a directory to store the output:

$ mkdir /tmp/vespa-diagnostics

3. Collect system information:

$ vespa support diagnostics sysinfo --dest-dir /tmp/vespa-diagnostics

4. Collect application diagnostics:

$ vespa support diagnostics application --dest-dir /tmp/vespa-diagnostics

5. Verify the output:

$ ls /tmp/vespa-diagnostics
diag-sysinfo.zip
diag-application.zip

Once complete, copy the ZIP files from the container and attach them to your support ticket.

Attach the ZIP files generated in the previous step to your Vespa support ticket. If you have not yet opened a ticket, include the files when submitting your request.

If the files are too large to attach directly, the Vespa support team will provide an alternative upload method.