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 MemSQL Tools, run memsql-report collect to gather a report across the cluster or memsql-report collect-local to generate a report for the local machine.

This is an example of using memsql-report collect:

memsql-report collect

✓ Collected report for host 172.18.1.4
✓ Collected report for host 172.18.1.5

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.

If you are using MemSQL Ops, run memsql-ops report. An example run is shown below:

memsql-ops report

The diagnostic report is being built. When finished, it will be available at /var/lib/memsql-ops/data/cache/cluster-report-20181117T153344.tar.gz

2018-11-17 15:33:46: J47bf6d [INFO] Building a diagnostic report for agent A471cd30769874ed19152855d2fa608f5
2018-11-17 15:34:03: J47bf6d [INFO] Successfully built a diagnostic report for agent A471cd30769874ed19152855d2fa608f5
2018-11-17 15:34:04: J3b7a7c [INFO] Building a combined diagnostic report for all agents
2018-11-17 15:34:04: J3b7a7c [INFO] 1/1 agent reports completed
2018-11-17 15:34:04: J3b7a7c [INFO] Successfully built a combined diagnostic report for all agents
Your diagnostic report is available at /var/lib/memsql-ops/data/cache/cluster-report-20181117T153344.tar.gz

When running Ops using the default installation directory on premises, the diagnostic report is available at /var/lib/memsql-ops/data/cache/cluster-report-<yyyymmddT_current_time>.tar.gz.

For cloud deployments using an EBS volume, the default location is /ebs/ops/data/cache/cluster-report-<yyyymmddT_current_time>.tar.gz.

Finding the Report

The report location may differ depending on the particular installation setup of the machine. Regardless, the output of the report command should indicate the location of the report itself.

Submitting the Report to MemSQL 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 MemSQL Support and we will generate credentials for you to upload the files to us directly.

Was this article useful?