Operational Reports

Operational Reports offer a detailed view of the cluster's health, performance, and outstanding issues, serving as a comprehensive reporting tool for administrators. This feature is designed to facilitate the creation of stakeholder reports on the cluster's condition over a specified time frame.

Reports can be generated manually or scheduled for automatic creation, with the option to include email recipients during the setup process. Only users belonging to the admin team are authorized to create or access Operational Reports. Non-admin users are strictly prohibited from performing these actions.

Report templates

ClusterControl offers several predefined report templates to address various operational requirements. These templates are:

Template	Description
Database Availability Reports	Details the uptime, downtime, and overall availability for each managed database cluster during the specified reporting period.
System Reports	Provides a summary of overall system health, covering node status, performance metrics, resource utilization, cluster events, and service availability over the reporting period.
Backup Reports	Summarizes the backup activities for each managed database cluster during the selected period.
Upgrade Reports	Offers an upgrade report for a managed cluster, including available package versions for the cluster (database packages, security packages, and libraries).
Database Growth Reports	Summarizes database growth over different timeframes, such as the last day, week, and month.
Schema Change Reports (MySQL-based systems only)	Provides reports for any modifications executed on the monitored databases. To utilize these predefined templates, you must configure the schema_change_detection_address and schema_change_detection_databases parameters in the ClusterControl settings. More information on these parameters can be found in the references section.

Note

Operational reports are produced in HTML format, with each report corresponding to a specific cluster.

Info

The reports generated may contain confidential information. It is essential to ensure that they are shared exclusively with the appropriate personnel.

Generating a report

The following steps show how to generate an operational report:

ClusterControl GUIClusterControl CLI

1. Go to Operational Reports → Reports → Create report:

   

2. Under the Create report section, specify the following information:

   • Cluster: Select a cluster from the dropdown.
   • Type: Select a report to be generated from the dropdown for this cluster.
   • Data range: Specify the report's data range in days.
   • Recipients: Specify the email recipients. This field supports adding multiple email addresses after an Enter. You can specify any email address, not limited to what has been configured in ClusterControl.

3. Click Create to generate the report.

4. The generated report will be listed under the Reports tab.

1. List available template repots:

   s9s report --list-templates
   

   Example

   $ s9s report --list-templates
   report1
   availability
   backup
   upgrade
   schemachange
   dbgrowth
   

2. Generate an availability report for cluster ID 37:

   s9s report --create --cluster-id=37 --type='availability'
   

Listing and viewing reports

The following steps show how to list and view generated operational reports:

ClusterControl GUIClusterControl CLI

1. Go to Operational Reports → Reports to see the list of generated reports.

2. Each report can be viewed or deleted by clicking the action button and choose View or Delete. When viewing via the GUI, the report will be opened in a new web browser window.

1. List all generated operational reports:

   s9s report --list
   

2. List all generated operational reports for cluster ID 37:

   s9s report --list --cluster-id=37
   

3. View a generated report for cluster ID 37:

   s9s report --cat --report-id=2 --cluster-id=37
   

Scheduling a report

A report can be scheduled to be generated and delivered via email at specified intervals (e.g., daily, weekly, monthly).

The following steps show how to schedule an operational report:

ClusterControl GUI

1. Go to Operational Reports → Schedules → Create schedule:

   

2. Under the Schedule report section, specify the following information:

   • Cluster: Select a cluster from the dropdown.
   • Type: Select a report to be generated from the dropdown for this cluster.
   • Data range: Specify the report's data range in days.
   • Recipients: Specify the email recipients. This field supports adding multiple email addresses after an Enter. You can specify any email address, not limited to what has been configured in ClusterControl.
   • Set schedule: Set the frequency or specific time to generate the report. The schedule can be configured to run minutely, hourly, daily, weekly, monthly, or yearly.

3. Click Create to save the schedule.

4. After the schedule is created, it can be edited or deleted by clicking the action button and choose Edit or Delete: