Generating a Cluster Report

A cluster report is exceedingly helpful in diagnosing issues without unnecessary back and forth asking for information. Most support requests which are related to recent events on the cluster, cluster health, and most non-product questions will benefit from a cluster report being sent to Support.

Generating the Report

To generate a report using the SingleStore Toolbox, run sdb-report collect to gather a report across the cluster or sdb-report collect-local to generate a report for the local machine.

This is an example of using sdb-report collect:

sdb-report collect
✓ Collected report for host
✓ Collected report for host

Unless an output path is specified, the report is available in the current directory with the file name report-<yyyy>-<mm>-<dd>T<current_time>.tar.gz.

Submitting the Report to SingleStore Support

The reports can be attached to a support request submitted through the regular means; however, there are size restrictions that limit how large a file sent over email or uploaded to our ticketing system can be. Some cluster reports can be very large.

Many organizations have preferred methods of transferring large files that comply with their internal requirements (OneDrive, Box, Google Drive, self-hosting, etc.) if there is a preferred way to transfer large documents that complies with the org requirements, we will work with you to acquire it with the information provided.

If the organization does not have a preferred method of transferring such files, you can contact SingleStore Support and we will generate credentials for you to upload the files to us directly.

Last modified: November 22, 2022

Was this article helpful?