1. Home
  2. Docs
  3. ClusterControl
  4. User Guide (GUI)
  5. Sidebar
  6. Operational Reports

Operational Reports

Generates or schedules operational reports, as well as incident reports. An operational report is a comprehensive way to understand the state of your database cluster along the time. The reports can be generated in-place or can be delivered to you via email, which makes things conveniently easy if you have a reporting silo. For incident reports, ClusterControl will auto-generate an incident report via a feature called MySQL Freeze Frame when these two states are triggered:

  • CLUSTER_DEGRADED
  • CLUSTER_FAILURE
Note

Further reading on ClusterControl’s MySQL Freeze Frame feature in this blog post, Why Did My MySQL Database Crash? Get Insights with the New MySQL Freeze Frame.

For operational reports, there are 5 types of reports available:

  • Availability report – All clusters.
  • Backup report – All clusters.
  • Schema change report – MySQL/MariaDB-based clusters only.
  • Daily system report – Per cluster.
  • Package upgrade report – Per cluster.

See Types of Operational Reports for more details. Check out the operational report examples in this blog post, Become a ClusterControl DBA: Operational Reports for MySQL, MariaDB, PostgreSQL & MongoDB.

Generated Reports

Provides list of generated operational reports. Click on any of the entries will open the generated operational report in a new window.

Field Description
Create
Delete
  • Specify the cluster name and operational type. Optionally, you can click on the ‘Add Email’ button to add recipients to the list.
Refresh
  • Refresh the operational report list.

Schedules

List of scheduled operational reports and incident reports (if any).

Field Description
Schedule
  • Schedules an operational report at an interval. You can schedule it daily, weekly, and monthly. Optionally, you can click on the ‘Add Email’ button to add recipients to the list.
Edit
  • Edit the selected schedule.
Delete
  • Delete the selected schedule.
Refresh
  • Refresh the schedule list.

Types of Operational Reports

Availability Report

All Clusters

The report generates the uptime/downtime and availability report for each cluster managed by ClusterControl. You can see information about availability statistics of your databases, the cluster type, total uptime and downtime, current state of the cluster, and when that state last changed.

Backup Report

All Clusters

The report summarizes backups for each cluster managed by ClusterControl. It contains two sections – backup summary and backup details, where the former basically gives you a short summary of when the last backup was created, if it completed successfully or failed, backup verification status, success rate, and retention period. The latter section provides the list of backups executed on the cluster with the state, type, and size within the specified interval.

ClusterControl also provides examples of the backup policy if it finds any of the monitored database cluster running without any scheduled backup or delayed slave configured.

Schema Change Report

MySQL/MariaDB-based cluster only

This report compares the selected MySQL/MariaDB database changes in table structure which happened between two different generated reports. In the MySQL/MariaDB older versions, DDL operation is a non-atomic operation (pre 8.0) and requires full table copy (pre 5.6 for most operations) – blocking other transactions until it completes. Schema changes could become a huge pain once your tables get a significant amount of data and must be carefully planned especially in a clustered setup. In a multi-tiered development environment, we have seen many cases where developers silently modify the table structure, resulting in a significant impact to query performance.

In order for ClusterControl to produce an accurate report, special options must be configured inside the CMON configuration file for the respective cluster:

  • schema_change_detection_address – Checks will be executed using SHOW TABLES or SHOW CREATE TABLE to determine if the schema has changed. The checks are executed on the address specified and is of the format {HOSTNAME}:{PORT}. The schema_change_detection_databases must also be set. A differential of a changing table is created (using diff).
  • schema_change_detection_databases – Comma-separated list of databases to monitor for schema changes. If empty, no checks are made.
Note

Only CREATE TABLE and ALTER TABLE are detected. DROP TABLE is not supported yet.

Supposedly we have a MariaDB Galera Cluster with cluster ID 27 and we would like to monitor schema changes for database “myapp” and “sbtest”. Pick one of the database nodes as the value of schema_change_detection_address. For MySQL replication, this should be the master host or any slave host that holds the databases (in case of partial replication is active). Then, inside, /etc/cmon.d/cmon_27.cnf, add the two following lines:

schema_change_detection_address=10.0.0.30:3306
schema_change_detection_databases=myapp,sbtest

Restart CMON service to load the change:

$ systemctl restart cmon # systemd
$ service cmon restart # SysVinit

Take note only new tables or changing tables are printed in the report. The first report is only for metadata collection for comparison in the subsequent rounds, thus we have to run it at least twice to see the difference. For the first and foremost report, ClusterControl only returns the result of metadata collection. With the first report as the baseline, the subsequent reports will return the output that we are expecting.

Daily System Report

Per Cluster

The current default report shows a cluster’s health and performance at the time it was generated compared to one day ago. Under the summary section, it lists out the nodes in the cluster, their type, role (master or slave), the status of the node, uptime, and the OS. It also reports the top queries summary as well as node status overview in histogram formats like CPU usage, data throughput, load average, disk usage, and throughput, RAM usage, network throughput, server load, and handler.

Package Upgrade Report

Per Cluster

This report gives a summary of packages available for an upgrade by the repository manager on the monitored hosts. It summarizes the total number of packages available for upgrade as well as the related managed service for the cluster like a load balancer, virtual IP address, and arbitrator. This report can greatly help us plan our maintenance window efficiently. For critical upgrades like security and database packages, we could prioritize it over non-critical upgrades, which could be consolidated with other less priority maintenance windows.

For accurate reporting, ensure you always use stable and trusted repositories on every host. In some undesirable occasions, the monitored hosts could be configured with an outdated repository after an upgrade (e.g, every MariaDB major version uses a different repository), incomplete internal repository (e.g, partially mirrored from the upstream), or bleeding edge repository (commonly for unstable nightly-build packages).

Was this article helpful to you? Yes No

How can we help?