Skip to content

Latest commit

 

History

History
133 lines (109 loc) · 5.96 KB

ref-configuring-metrics-utility.adoc

File metadata and controls

133 lines (109 loc) · 5.96 KB

Configuring metrics-utility

On {RHEL}

Prerequisites

  • An active {PlatformName} subscription

  • An existing installation of {PlatformName} on {RHEL}

metrics-utility is included with {PlatformName}, so you do not need a separate installation. The following commands gather the relevant data and generate a CCSP report containing your usage metrics. You can configure these commands as cron jobs to ensure they run at the beginning of every month. See How to schedule jobs using the Linux 'cron' utility for more on configuring using the cron syntax.

Procedure

  1. In the cron file, set the correct variables to ensure metrics-utility gathers the relevant data. To open the cron file for editing, run:

    crontab -e

  2. 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

  3. Set these variables to generate a report:

    export METRICS_UTILITY_REPORT_TYPE=CCSP
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)"
export METRICS_UTILITY_REPORT_H1_HEADING="CCSP Reporting <Company>: ANSIBLE Consumption"
export METRICS_UTILITY_REPORT_COMPANY_NAME="Company Name"
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"

  4. 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

  5. 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 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 every second day of each month at 4:00 AM.

    0 */1 * * * metrics-utility gather_automation_controller_billing_data --ship --until=10m
0 4 2 * *  metrics-utility build_report

  6. Save and close the file.

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

    crontab -l

  8. You can also check the logs to ensure that data is being collected. Run:

    cat /var/log/cron

  9. 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-24 CROND[51623]: (root) CMDOUT (No billing data for month: 2024-04)
May  8 09:45:03 ip-10-0-6-24 CROND[51623]: (root) CMDEND (metrics-utility build_report)
May  8 09:45:19 ip-10-0-6-24 crontab[51619]: (root) END EDIT (root)
May  8 09:45:34 ip-10-0-6-24 crontab[51659]: (root) BEGIN EDIT (root)
May  8 09:46:01 ip-10-0-6-24 CROND[51688]: (root) CMD (metrics-utility gather_automation_controller_billing_data --ship --until=10m)
May  8 09:46:03 ip-10-0-6-24 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-24 CROND[51669]: (root) CMDEND (metrics-utility gather_automation_controller_billing_data --ship --until=10m)
May  8 09:46:26 ip-10-0-6-24 crontab[51659]: (root) END EDIT (root)

  10. Run the following command to build a report for the previous month:

    metrics-utility build_report

  11. The generated report will have the default name CCSP-<YEAR>-<MONTH>.xlsx and is located in the ship path that you specified in step 2.

On {OCPShort} from the {PlatformNameShort} operator

metrics-utility is included in the {OCPShort} image beginning with version 4.12. If your system does not have metrics-utility installed, update your OpenShift image to the latest version. Follow the steps below to configure the run schedule for metrics-utility on {OCPShort} using the {PlatformName} Operator.

  1. Prerequisites:

    • A running OpenShift cluster

    • An operator-based installation of {PlatformNameShort} on {OCPShort}.

      metrics-utility runs as indicated by the parameters you set in the configuration file. The utility cannot be run manually on {OCPShort}.

Create a ConfigMap in the OpenShift UI YAML view

Procedure

  1. From the navigation panel, select menu::ConfigMaps[].

  2. Click btn:[Create ConfigMap].

  3. On the next screen, select the YAML view tab.

  4. In the YAML field, enter the following parameters with the appropriate variables set:

    apiVersion: v1
kind: ConfigMap
metadata:
  name: automationcontroller-metrics-utility-configmap
data:
  METRICS_UTILITY_SHIP_TARGET: directory
  METRICS_UTILITY_SHIP_PATH: /metrics-utility
  METRICS_UTILITY_REPORT_TYPE: CCSP
  METRICS_UTILITY_PRICE_PER_NODE: '11' # in USD
  METRICS_UTILITY_REPORT_SKU: MCT3752MO
  METRICS_UTILITY_REPORT_SKU_DESCRIPTION: "EX: Red Hat Ansible Automation Platform, Full Support (1 Managed Node, Dedicated, Monthly)"
  METRICS_UTILITY_REPORT_H1_HEADING: "CCSP Reporting <Company>: ANSIBLE Consumption"
  METRICS_UTILITY_REPORT_COMPANY_NAME: "Company Name"
  METRICS_UTILITY_REPORT_EMAIL: "email@email.com"
  METRICS_UTILITY_REPORT_RHN_LOGIN: "test_login"
  METRICS_UTILITY_REPORT_COMPANY_BUSINESS_LEADER: "BUSINESS LEADER"
  METRICS_UTILITY_REPORT_COMPANY_PROCUREMENT_LEADER: "PROCUREMENT LEADER"

  5. Click btn:[Create].

  6. To verify that the ConfigMap was created and metric utility is installed, select menu::ConfigMap[] from the navigation panel and look for your ConfigMap in the list.