Reporting

K10 Reporting provides regular insights into key performance and operational states of the system. When reporting is enabled, K10 periodically collects information from the system and compiles it into a report. Generated reports include information such as license status, actions run, configured policies and profiles, compliance information, and service information.

Enabling K10 Reports

K10 Reports can be enabled by selecting the "Usage & Reports" card on the dashboard.

../_images/dashboard_top.png

On the Usage & Reports page, select "Enable Reports".

../_images/reports_toggle.png

When enabled, a policy is created to manage the generation of reports. Reports are generated according to the policy and then stored in the cluster. The policy is also be visible on the policies page.

Viewing Generated Reports

A generated report contains information about the state of the system at the time the report was generated as well as select metrics collected from the K10 Prometheus service.

Note

If some of the information is unavailable at the time the report is generated, it is omitted from the report. For example, if the K10 Prometheus service is disabled or otherwise unavailable, metrics are omitted from the report.

Viewing Reports With The Dashboard

Recent reports can be viewed on the Usage & Reports page. The full details of a given report can be viewed by clicking on a report in the list.

../_images/reports_recent_list.png

Viewing Reports With kubectl

Reports can be listed and viewed using kubectl.

$ kubectl get -n kasten-io reports.reporting.kio.kasten.io
NAME                    LICENSE   DR         TIME                   AGE
scheduled-45cfn-qwmcw   Valid     Disabled   2021-10-06T22:58:54Z   24h
scheduled-568xd-s2qgh   Valid     Disabled   2021-10-07T22:57:49Z   16m

Tip

By default, kubectl get doesn't sort results, they're displayed in the same order they're received from the API server. This means reports may not be listed in the order they were generated.

The --sort-by=.spec.reportTimestamp option can be added to ensure the most recent reports are listed last.

An individual report can also be shown using the -o yaml option for kubectl get:

$ kubectl get -n kasten-io -o yaml reports.reporting.kio.kasten.io scheduled-568xd-s2qgh
apiVersion: reporting.kio.kasten.io/v1alpha1
kind: Report
metadata:
  name: scheduled-568xd-s2qgh
  namespace: kasten-io
results:
  # …
spec:
  reportTimestamp: "2021-10-06T22:40:54Z"
  statsIntervalDays: 1
  statsIntervalEndTimestamp: "2021-10-06T22:40:54Z"
  statsIntervalStartTimestamp: "2021-10-05T22:40:54Z"