Error Report
Overview
This section describe the Error Report utility in ClusterControl. It is a compressed file (tarball) containing diagnostic information about the cluster (cmon logs, database error logs, and the contents of some important CMON database tables). This is very useful for troubleshooting purposes, especially when working with the Severalnines Support team on a support issue. Attach the generated compressed file to your support request.
Generating an Error Report
Follow the following steps to generate an error report:
-
To create a new error report for a cluster, go to ClusterControl GUI → Clusters → choose a cluster → Reports, click the Create Error Report button.
-
There will be an option to mask passwords so that if any are contained in the configuration, ClusterControl will mask them. The default is always ON.
-
Download the tarball file through Action → Download.
Execute the following command in ClusterControl host as root/sudo user:
The <cluster_id> is the identifier of the cluster where the error report is to be generated. Where 1 is the cluster ID of the corresponding cluster. For other clusters, just change the cluster ID accordingly. The cluster ID can be retrieved from ClusterControl GUI → Clusters → locate the cluster → ID, using s9s cluster --list command or by looking into the CMON configuration file for the respective cluster inside /etc/cmon.d.
Example
The following command generates an error report for cluster ID 15:
At the end of the execution, it will print out something like this:
Tip
If you have no cluster managed by ClusterControl, you might want to specify 0 instead, where 0 has a special meaning in ClusterControl – collect information about ClusterControl installation, configurations, and logs on the local node only.
Please attach the generated tarball to your support ticket. If the tarball exceeds the 20MB attachment limit of our support system, please upload it to a cloud storage service such as Google Drive, Dropbox, or WeTransfer. Then, share the HTTPS download link in your support ticket. Be aware that the error report might contain sensitive and confidential information, so restrict public access and only share the download URL with us.
Tip
We also recommend you to take screenshots showing the area of the problem, e.g, the Overview page from the UI allows us to understand the current state of nodes and clusters.
ClusterControl GUI diagnostic
For ClusterControl GUI-related issue, you can use the Diagnostic feature available at ClusterControl GUI → Settings → Diagnostics and toggle ON UI audit data collection. This allows user to record and capture the necessary data while reproducing an issue in the user interface.
After replicating the issue, immediately disable the setting to halt audit data collection. Then, click Download audit data for your analysis or to share with our Support team for troubleshooting and debugging. This audit data allows our team to replay the exact error users encountered in their specific configurations and environments, eliminating the need for screen sharing.
Warning
Remember to switch off the setting afterward to stop audit data collection otherwise it will impact the web browser's performance after a period of time.
Note
Note that we are not collecting any personal data during this process.