Examples of using metering | Metering | OpenShift Container Platform 4.5

Prerequisites
Measure cluster capacity hourly and daily
Measure cluster usage with a one-time report
Measure cluster utilization using cron expressions

Use the following example reports to get started measuring capacity, usage, and utilization in your cluster. These examples showcase the various types of reports metering offers, along with a selection of the predefined queries.

Prerequisites

Install metering
Review the details about writing and viewing reports.

Measure cluster capacity hourly and daily

The following report demonstrates how to measure cluster capacity both hourly and daily. The daily report works by aggregating the hourly report’s results.

The following report measures cluster CPU capacity every hour.

Hourly CPU capacity by cluster example

apiVersion: metering.openshift.io/v1
kind: Report
metadata:
  name: cluster-cpu-capacity-hourly
spec:
  query: "cluster-cpu-capacity"
  schedule:
    period: "hourly" (1)

1	You could change this period to `daily` to get a daily report, but with larger data sets it is more efficient to use an hourly report, then aggregate your hourly data into a daily report.

The following report aggregates the hourly data into a daily report.

Daily CPU capacity by cluster example

apiVersion: metering.openshift.io/v1
kind: Report
metadata:
  name: cluster-cpu-capacity-daily (1)
spec:
  query: "cluster-cpu-capacity" (2)
  inputs: (3)
  - name: ClusterCpuCapacityReportName
    value: cluster-cpu-capacity-hourly
  schedule:
    period: "daily"

1	To stay organized, remember to change the `name` of your report if you change any of the other values.
2	You can also measure `cluster-memory-capacity`. Remember to update the query in the associated hourly report as well.
3	The `inputs` section configures this report to aggregate the hourly report. Specifically, `value: cluster-cpu-capacity-hourly` is the name of the hourly report that gets aggregated.

Measure cluster usage with a one-time report

The following report measures cluster usage from a specific starting date forward. The report only runs once, after you save it and apply it.

CPU usage by cluster example

apiVersion: metering.openshift.io/v1
kind: Report
metadata:
  name: cluster-cpu-usage-2019 (1)
spec:
  reportingStart: '2019-01-01T00:00:00Z' (2)
  reportingEnd: '2019-12-30T23:59:59Z'
  query: cluster-cpu-usage (3)
  runImmediately: true (4)

1	To stay organized, remember to change the `name` of your report if you change any of the other values.
2	Configures the report to start using data from the `reportingStart` timestamp until the `reportingEnd` timestamp.
3	Adjust your query here. You can also measure cluster usage with the `cluster-memory-usage` query.
4	Configures the report to run immediately after saving it and applying it.

Measure cluster utilization using cron expressions

You can also use cron expressions when configuring the period of your reports. The following report measures cluster utilization by looking at CPU utilization from 9am-5pm every weekday.

Weekday CPU utilization by cluster example

apiVersion: metering.openshift.io/v1
kind: Report
metadata:
  name: cluster-cpu-utilization-weekdays (1)
spec:
  query: "cluster-cpu-utilization" (2)
  schedule:
   period: "cron"
   expression: 0 0 * * 1-5 (3)

1	To say organized, remember to change the `name` of your report if you change any of the other values.
2	Adjust your query here. You can also measure cluster utilization with the `cluster-memory-utilization` query.
3	For cron periods, normal cron expressions are valid.