Report engine

Important

You must be a BMC AMI Cloud administrator to use the report engine.

You can use the report engine to periodically collect statistics about object storage usage.

Related topic

You can collect the following built-in report types:

Storage consumption grouped by policy name
Storage consumption grouped by data set high level qualifier (HLQ) and type (archive or backup)
Storage consumption grouped by CLI resource type, data set backup, or archive
Storage consumption of each resource type (unix backups, data set archive, data set backup, cloud data set, and full volume backup)

Each report is saved to the BMC AMI Cloud server file system located by default within the $MODEL9_HOME/reports. You can alter this by updating the model9-local.yml server configuration file by using the model9.reports.baseDir setting.

Important

model9.reports.baseDir is appended to the $MODEL9_HOME directory.

For example, model9.reports.baseDir: DailyReports generates reports under $MODEL9_HOME/DailyReports.

Create the report directory of choice by using the following command:

mkdir $MODEL9_HOME/reports

All reports are formatted to a raw CSV report that you can load into any analytics or metric application of choice.

To control the scheduling of the report generation, use the following sample and add it to the model9-local.yml server configuration file:

model9.reports.reportList:
-       reportName:     report_storage_consumption_by_hlq
        viewName:       report_storage_consumption_by_hlq_v
        schedulingCron: 0 0 0 ? * MON *
        outputFormat:   CSV
-       reportName:     report_policy_storage_consumption
        viewName:       report_policy_storage_consumption_v
        schedulingCron: 0 0 0 ? * MON *
        outputFormat:   CSV
-       reportName:     report_cli_storage_consumption
        viewName:       report_cli_storage_consumption_v
        schedulingCron: NONE
        outputFormat:   CSV
-       reportName:     report_resource_storage_consumption
        viewName:       report_resource_storage_consumption_v
        schedulingCron: 0 0 0 ? * MON *
        outputFormat:   CSV

Important

The schedulingCron value is a quartz cron expression.
You can create only one report in a day. Creating more than one report in a day results in an error.

In the preceding example, the first two reports are scheduled to run every week on Mondays at 12:00 A.M.

For more information about Quartz Cron expression generation samples, see Cron Expression Generator & Explainer - Quartz in Free Formatter.

To disable the scheduling of a specific report generation, set schedulingCron to NONE.

Warning

The expiration of historical reports is manually handled by the admin who deletes the files from the server's file system.

The generated reports reside in the file system of the BMC AMI Cloud server like the example below:

root@model9-server:/data/model9/reports# ls -lR

drwxr-xr-x 2 root root 4096 Jul  7 17:07 report_storage_consumption_by_hlq
drwxr-xr-x 2 root root 4096 Jul  7 17:06 report_policy_storage_consumption
drwxr-xr-x 2 root root 4096 Jul  7 17:06 report_cli_storage_consumption

./report_storage_consumption_by_hlq:
-rw-r--r-- 1 root root 56 Jul 7 17:07 20220622-111600.csv
-rw-r--r-- 1 root root 52 Jul 7 17:07 20220621-111600.csv

./report_policy_storage_consumption:
-rw-r--r-- 1 root root 42 Jul 7 17:06 20220622-111600.csv
-rw-r--r-- 1 root root 41 Jul 7 17:07 20220621-111600.csv

./report_cli_storage_consumption:
-rw-r--r-- 1 root root 22 Jul 7 17:06 20220622-111600.csv
-rw-r--r-- 1 root root 20 Jul 7 17:07 20220621-111600.csv

Report engine

On this page