Skip to content

AxonOps — AI-Native Control Plane for Open Source Data Platforms

Reporting

The Reporting feature produces a report on the state and metrics of a cluster over a chosen time range. A report is generated as a single self-contained HTML file that includes cluster information, backup and security summaries, the alerts raised during the period, and utilisation charts rendered from a selected dashboard.

A report can be produced in two ways:

  • On demand, for a fixed time range. The report is generated immediately and downloaded in the browser.
  • On a recurring schedule, defined by a cron expression. Each run covers a relative period (for example the previous week) and is delivered by email through a configured integration.

The feature is accessible from the Reports item in the left navigation.

The New Report tab of the Reports page

The page has three tabs:

TabPurpose
New ReportConfigure and generate a report, or create a schedule.
SchedulesList, inspect, and delete the schedules that produce recurring reports.
HistoryA record of the scheduled report runs that have been generated.

The Report Sections control selects which sections the report contains. The report information header is always included; the remaining sections are individually selectable.

SectionContentAlways included
Report informationOrganization, dashboard, date range, timezone, and generation time.Yes
Cluster informationCluster type and name, node count, data centers, and the Cassandra, OS, and Java versions.No
BackupsPer backup schedule: the cron expression, tag, data centers, remote storage type, and the count of successful and failed backups in the period.No
Security & complianceFailed authentication and authorization counts for the period.No
AlertsEach alert raised in the period, with its time, name, severity, state, and message.No
Utilization chartsCharts rendered from a selected dashboard over the report time range.No

The generated report is a single self-contained HTML document titled Cluster Utilization Report. It renders the selected sections in order, with each utilisation chart embedded as an image, so the file displays without network access and can be archived as a standalone record of the period.

Example generated HTML report

All options are configured on the New Report tab.

The Schedule control selects between the two modes:

  • Immediate generates the report once, for a fixed time range, and downloads it in the browser.
  • Cron Schedule creates a recurring schedule that generates and delivers a report on a repeating interval.

For an immediate report, the Time range field sets the fixed start and end of the reporting period. Selecting the field opens a picker with separate start and end calendars. Set the start and end dates, set the time of each with the hour, minute, and second fields, then select Apply Changes. The report covers that fixed period.

Selecting the time range for an immediate report

For a scheduled report, this fixed range is replaced by the relative Report range described under Scheduled reports.

The Report timezone sets the timezone used to interpret the range and to label times in the report. It defaults to Etc/UTC (UTC).

The optional Tag field labels the report. For an immediate report the tag is added to the downloaded file name; for a schedule it identifies the schedule in the Schedules tab.

When the Utilization charts section is enabled, the Dashboard field selects which dashboard is rendered into the report. The built-in Reporting dashboard covers system resource utilisation and coordinator performance metrics suited to capacity planning and operational review. Any other dashboard, including a custom dashboard, may be selected instead.

Selecting the source dashboard

Each chart group on the selected dashboard can be expanded, and individual charts within it selected or deselected. The count of selected charts is shown next to the section heading.

Chart selection and scope filters

The Scope controls restrict the data included in the utilisation charts. Leaving the scope blank reports on the whole cluster.

FieldEffect
Data CenterLimit the charts to one or more data centers.
RackLimit the charts to one or more racks.
NodeLimit the charts to specific nodes.
PercentileSelect the percentile for latency charts (for example 99thPercentile).
GroupByAggregate results by dc, rack, or node.
Mount PointFilter disk charts by mount point.
PartitionFilter disk charts by partition.
ConsistencyFilter coordinator charts by consistency level.

The scope fields shown depend on the selected dashboard, because they correspond to the template variables the dashboard's charts use. Charts scoped to a keyspace require a keyspace, and where applicable a table, to be set; without them a keyspace chart has no data to render.

With Immediate selected, set the time range, timezone, sections, charts, and scope, then generate the report. The report is generated for the fixed range and downloaded in the browser as an HTML file.

On-demand reports are not recorded in history

An immediate report is delivered only as its browser download. It is not sent to an integration and does not appear on the History tab, which records scheduled report runs.

With Cron Schedule selected, the schedule is defined by a cron expression. As the expression is edited, its meaning and next run time are shown in the configured timezone.

Defining a cron schedule

Selecting the schedule field opens a visual editor for the five cron fields: minute (0 to 59), hour (0 to 23), day of the month (1 to 31), month (1 to 12), and day of the week (0 to 6, where Sunday is 0 or 7). The editor shows the resulting expression and the next run time.

Visual cron editor

Each run covers a relative Report range rather than a fixed time range, resolved at the moment the run executes. The available windows are This Week, Last Week, This Month, Last Month, and the last 7, 14, 30, 60, or 90 days.

Report range options for a scheduled report

A scheduled report must be delivered to an integration, set in the Send report to field. See Delivering reports by email below.

Selecting CREATE SCHEDULE saves the schedule. It then appears on the Schedules tab and runs at each scheduled time.

A scheduled report is delivered as an email with the report attached as an HTML file. The recipients are defined by an email integration, which must be configured before a schedule can send to it. Until one exists, the Send report to field reads No integrations can deliver a report.

Email integrations are configured under Settings > Integrations. The integration types available depend on the deployment:

  • AxonOps Cloud provides both the AxonOps-managed Emails service and self-managed SMTP.
  • Self-hosted AxonOps provides SMTP only, sending through an SMTP server that the operator defines.

Either type can deliver a report.

The Integrations setup page

Creating an Emails integration requires a name and a comma-separated list of recipient addresses. Test sends a test message to the recipients, and Create saves the integration.

Creating an email integration

Once an integration exists, it can be selected in the Send report to field on the New Report tab.

Selecting an integration to receive the report

At each scheduled run, the recipients receive an email with the report attached.

The delivered report email

The Schedules tab lists the schedules configured for the cluster.

The Schedules tab

ColumnContent
TagThe label assigned to the schedule.
DashboardThe dashboard the schedule renders.
Send ToThe integration the report is delivered to.
ScheduleThe cron expression controlling when the report runs.
Report RangeThe relative window each run covers.
Last RunThe time of the most recent run, or Never if it has not yet run.
Next RunThe time of the next scheduled run.

Selecting a row opens the schedule's details, including its identifier, creator, cluster, timezone, and the sections and charts it includes.

Scheduled report details

A schedule is removed with Delete in its details view. Several schedules can be selected in the list and deleted together.

The History tab lists the scheduled report runs for the cluster. Each entry records the report's tag, the time it was generated, the user the schedule belongs to, the source dashboard, the run's status, and the parameters of the run, such as the time range it covered.

The History tab

Reports are not stored in AxonOps

AxonOps does not retain the generated report itself. The History tab records that a report was generated and the parameters of the run, but it is not a store from which a past report can be reopened or downloaded. If email delivery fails, the report cannot be retrieved and must be generated again; the History entry preserves the time range and the other parameters needed to reproduce it.