Chapter 14. Usage reporting with metrics-utility

Procedure

1. Create two scripts in your user’s home directory to set correct variables to ensure that metrics-utility gathers all relevant data:

   1. In /home/my-user/cron-gather:

      #!/bin/sh
      
      # Specify the following variables to indicate where the report is deposited in your file system:
      export METRICS_UTILITY_SHIP_TARGET=directory
      export METRICS_UTILITY_SHIP_PATH=/awx_devel/awx-dev/metrics-utility/shipped_data/billing
      
      # Run the following command to gather and store the data in the provided SHIP_PATH directory:
      metrics-utility gather_automation_controller_billing_data --ship --until=10m

   2. In /home/my-user/cron-report:

      #!/bin/sh
      
      # Specify the following variables to indicate where the report is deposited in your file system:
      export METRICS_UTILITY_SHIP_TARGET=directory
      export METRICS_UTILITY_SHIP_PATH=/awx_devel/awx-dev/metrics-utility/shipped_data/billing
      
      # Set these variables to generate a report:
      export METRICS_UTILITY_REPORT_TYPE=CCSPv2
      export METRICS_UTILITY_PRICE_PER_NODE=11.55 # in USD
      export METRICS_UTILITY_REPORT_SKU=MCT3752MO
      export METRICS_UTILITY_REPORT_SKU_DESCRIPTION="EX: Red Hat Ansible Automation Platform, Full Support (1 Managed Node, Dedicated, Monthly)"
      @@ -44,21 +51,31 @@ export METRICS_UTILITY_REPORT_EMAIL="email@email.com"
      export METRICS_UTILITY_REPORT_RHN_LOGIN="test_login"
      export METRICS_UTILITY_REPORT_COMPANY_BUSINESS_LEADER="BUSINESS LEADER"
      export METRICS_UTILITY_REPORT_COMPANY_PROCUREMENT_LEADER="PROCUREMENT LEADER"
      
      # Build the report
      metrics-utility build_report

2. To ensure that these files are executable, run:

   chmod a+x /home/my-user/cron-gather /home/my-user/cron-report

3. To open the cron file for editing, run:

   crontab -e

4. To configure the run schedule, add the following parameters to the end of the file and specify how often you want metrics-utility to gather information and build a report using the cron syntax. In the following example, the gather command is configured to run every hour at 00 minutes. The build_report command is configured to run on the second day of each month at 4:00 AM.

   0 */1 * * * /home/my-user/cron-gather
   0 4 2 * * /home/my-user/cron-report

5. Save and close the file.

6. To verify that you saved your changes, run:

   crontab -l

7. To ensure that data is being collected, run:

   cat /var/log/cron

   The following is an example of the output. Note that time and date might vary depending on how your configure the run schedule:

   May  8 09:45:03 ip-10-0-6-23 CROND[51623]: (root) CMDOUT (No billing data for month: 2024-04)
   May  8 09:45:03 ip-10-0-6-23 CROND[51623]: (root) CMDEND (metrics-utility build_report)
   May  8 09:45:19 ip-10-0-6-23 crontab[51619]: (root) END EDIT (root)
   May  8 09:45:34 ip-10-0-6-23 crontab[51659]: (root) BEGIN EDIT (root)
   May  8 09:46:01 ip-10-0-6-23 CROND[51688]: (root) CMD (metrics-utility gather_automation_controller_billing_data --ship --until=10m)
   May  8 09:46:03 ip-10-0-6-23 CROND[51669]: (root) CMDOUT (/tmp/9e3f86ee-c92e-4b05-8217-72c496e6ffd9-2024-05-08-093402+0000-2024-05-08-093602+0000-0.tar.gz)
   May  8 09:46:03 ip-10-0-6-23 CROND[51669]: (root) CMDEND (metrics-utility gather_automation_controller_billing_data --ship --until=10m)
   May  8 09:46:26 ip-10-0-6-23 crontab[51659]: (root) END EDIT (root)

   The generated report will have the default name CCSP-<YEAR>-<MONTH>.xlsx and will be deposited in the ship path that you specified in step 1a.

Procedure

1. Run:

Procedure

1. From the command line, run:

   crontab -e

2. After the code editor has opened, update the gather and build parameters using cron syntax as shown below:

   0 */1 * * * /home/my-user/cron-gather
   0 4 2 * * /home/my-user/cron-report

3. Save and close the file.

Procedure

1. From the navigation panel, select Workloads Deployments.
2. On the next screen, select automation-controller-operator-controller-manager.
3. Beneath the heading Deployment Details, click the down arrow button to change the number of pods to zero. This will pause the deployment so you can update the running schedule.
4. From the navigation panel, select Installed Operators.
5. From the list of installed operators, select Ansible Automation Platform.
6. On the next screen, select the automation controller tab.
7. From the list that appears, select your automation controller instance.
8. On the next screen, select the YAML tab.

9. In the YAML file, find the following parameters and enter a variable representing how often metrics-utility should gather data and how often it should produce a report:

   metrics_utility_cronjob_gather_schedule:
   metrics_utility_cronjob_report_schedule:

10. Click Save.
11. From the navigation menu, select Deployments and then select automation-controller-operator-controller-manager.
12. Increase the number of pods to 1.

13. To verify that you have changed the metrics-utility running schedule successfully, you can take one or both of the following steps:

    1. return to the YAML file and ensure that the parameters described above reflect the correct variables.
    2. From the navigation menu, select Workloads Cronjobs and ensure that your cronjobs show the updated schedule.