Report Engine

The report engine allows to periodically collect usage statistics about object storage usage. The Model9 administrator can collect three 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

Each report is saved to the Model9 server file system located by default within the $MODEL9_HOME/reports. This can be altered by updating the model9-local.yml server configuration file using the model9.reports.baseDir setting.

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

mkdir $MODEL9_HOME/reports

All reports are formatted to a raw CSV report which can be loaded into any analytics or metric application of choice.

To control the scheduling of the report generation use the following sample to be added 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

The schedulingCron value is a quartz cron expression

In the example above the first two reports are scheduled to run every week on Mondays at 12:00AM.

More Quartz Cron expression generation samples can be found in the following link.

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

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

The generated reports would reside in the file system of the Model9 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

Last updated