1. Home
  2. Docs
  3. ClusterControl
  4. User Guide (GUI)
  5. MongoDB
  6. Logs

Logs

Provides an interface for log messages, CMON jobs, and error reporting for troubleshooting and auditing purposes. The tab is embedded with a counter (highlighted in red) indicating there are new jobs executed by ClusterControl under ClusterControl → Logs → Jobs that might require your attention.

Jobs

Any action performed by the user will trigger the creation of a new job, which is added to a job queue. ClusterControl then schedules each job in the order they are added to the queue. When a job is executed, detailed workflow messages related to the execution of the job are logged. This is useful for troubleshooting, especially if a job starts execution but fails to complete.

You can see which user performed an action in the Job log, what that action actually entailed, and from which IP the action originated.

Status Description
FINISHED The job was successfully executed.
RUNNING The job is currently running.
DEFINED The job has been defined and queued.
FAILED The job was stopped due to an error.

CMON Logs

A centralized list of log events from the ClusterControl server. You can filter the output by hostname and log level (ALL, DEBUG, INFO, WARNING, ERROR, CRITICAL, ALERT). Log events listed on this page can also be retrieved directly from the CMON log file of the respective cluster-ID, e.g (default is <span class="pre">/var/log/cmon.log</span>).

Error Reports

Generates a compressed file (tarball) containing 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.

Field Description
Create Error Report
  • Create an error report. This will trigger a CMON job. Once it completes, the error report package will be listed on this page. You can then download it directly from ClusterControl UI.
Delete Error Report
  • Removes the selected error report from the ClusterControl node.
Note

We recommend you take a screenshot showing the problem area, e.g, the Cluster Overview dashboard from the UI is useful if there are node failures, cluster issues, or missing data.

System Logs

Tree view of corresponding database logs across the cluster. Clicking on a log file will appear in a new tab in the viewing panel on the right-hand side. Browsing through the appropriate error logs is a vital step when troubleshooting.

Click on Refresh Logs will trigger a job for ClusterControl to perform log collection. By default, the logs are fetched every <span class="pre">db_stats_collection</span> which is 30 minutes. You can verify this from the ‘Last Updated’ value at the bottom of the section.

Attention

Starting from ClusterControl 1.9.7 (September 2023), ClusterControl GUI v2 is the default frontend graphical user interface (GUI) for ClusterControl. Note that the GUI v1 is considered a feature-freeze product with no future development. All new developments will be happening on ClusterControl GUI v2. See User Guide (GUI v2).

Was this article helpful to you? Yes No