第12章 metrics-utility による使用状況レポート

手順

1. ナビゲーションパネルから、ConfigMaps を選択します。
2. Create ConfigMap をクリックします。
3. 次の画面で、YAML view タブを選択します。

4. YAML フィールドに、次のパラメーターを入力して適切な変数を設定します。

   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: CCSPv2
     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. Create をクリックします。

手順

1. ナビゲーションパネルから、Installed Operators を選択します。
2. Ansible Automation Platform を選択します。
3. Operator の詳細で、Automation Controller タブを選択します。
4. Create automation controller をクリックします。

5. YAML view オプションを選択します。YAML に Automation Controller のデフォルトパラメーターが表示されます。metrics-utility に関連するパラメーターは次のとおりです。

   Expand

   パラメーター	変数
   metrics_utility_enabled	True
   metrics_utility_cronjob_gather_schedule	@hourly または @daily。
   metrics_utility_cronjob_report_schedule	@daily または @monthly

   Show more
6. metrics_utility_enabled パラメーターを見つけて、変数を true に変更します。
7. metrics_utility_cronjob_gather_schedule パラメーターを見つけて、ユーティリティーによって使用状況情報を収集する頻度を表す変数を入力します (たとえば、@hourly または @daily)。
8. metrics_utility_cronjob_report_schedule パラメーターを見つけて、ユーティリティーによってレポートを生成する頻度を表す変数を入力します (たとえば、@daily または @monthly)。
9. Create をクリックします。

手順

1. インベントリーファイルを変更して、[all:vars] セクションの下に次の行を追加し、metrics-utility コンテナーのデプロイメントを有効にします。

   metrics_utility_enabled=true

   この設定は、Ansible Automation Platform デプロイメントの一部として専用の automation-controller-metrics-utility コンテナーを作成して設定するようにインストーラーに指示します。この行を、他のグローバル変数と一緒に、インベントリーファイルの [all:vars] ヘッダーの下に必ず配置してください。Ansible Automation Platform のデプロイメントがすでに設定されている場合は、インストーラースクリプトを再実行してコンテナーをアクティブ化します。

2. 次のコマンドを実行して、ホストレポートの保存先ディレクトリーを作成します。

   mkdir -p /home/my-user/aap/controller/data/

   ホストマシン上のこのディレクトリーには、最終的に生成されたレポートが保存されます。

3. /home/my-user/cron-gather という名前のファイルを作成し (/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=/metrics_utility/data
   
   # Run metrics-utility inside the running container
   podman exec \
     -e METRICS_UTILITY_SHIP_TARGET="$METRICS_UTILITY_SHIP_TARGET" \
     -e METRICS_UTILITY_SHIP_PATH="$METRICS_UTILITY_SHIP_PATH" \
     automation-controller-task \
     metrics-utility gather_automation_controller_billing_data --ship --until=10m

   このスクリプトは metrics-utility を実行して、Ansible Automation Platform インスタンスから課金データを収集し、コンテナー内に一時的に保存します。

4. /home/my-user/cron-report という名前のファイルを作成し (/home/my-user/ を目的のパスに置き換えます)、次のコンテンツを追加して cron-report スクリプトを作成します。

   #!/bin/sh
   
   # --- Configuration Variables ---
   # Define variables for the metrics utility parameters
   export METRICS_UTILITY_SHIP_TARGET="directory"
   export METRICS_UTILITY_SHIP_PATH="/metrics_utility/data" # This is the *internal* path in the container
   export METRICS_UTILITY_REPORT_TYPE="CCSPv2"
   export METRICS_UTILITY_PRICE_PER_NODE="11.55"
   export METRICS_UTILITY_REPORT_SKU="MCT3752MO"
   export METRICS_UTILITY_REPORT_SKU_DESCRIPTION="EX: Red Hat {PlatformNameShort}, 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"
   
   podman exec \
     -e METRICS_UTILITY_SHIP_TARGET="$METRICS_UTILITY_SHIP_TARGET" \
     -e METRICS_UTILITY_SHIP_PATH="$METRICS_UTILITY_SHIP_PATH" \
     -e METRICS_UTILITY_REPORT_TYPE="$METRICS_UTILITY_REPORT_TYPE" \
     -e METRICS_UTILITY_PRICE_PER_NODE="$METRICS_UTILITY_PRICE_PER_NODE" \
     -e METRICS_UTILITY_REPORT_SKU="$METRICS_UTILITY_REPORT_SKU" \
     -e METRICS_UTILITY_REPORT_SKU_DESCRIPTION="$METRICS_UTILITY_REPORT_SKU_DESCRIPTION" \
     -e METRICS_UTILITY_REPORT_H1_HEADING="$METRICS_UTILITY_REPORT_H1_HEADING" \
     -e METRICS_UTILITY_REPORT_COMPANY_NAME="$METRICS_UTILITY_REPORT_COMPANY_NAME" \
     -e METRICS_UTILITY_REPORT_EMAIL="$METRICS_UTILITY_REPORT_EMAIL" \
     -e METRICS_UTILITY_REPORT_RHN_LOGIN="$METRICS_UTILITY_REPORT_RHN_LOGIN" \
     -e METRICS_UTILITY_REPORT_COMPANY_BUSINESS_LEADER="$METRICS_UTILITY_REPORT_COMPANY_BUSINESS_LEADER" \
     -e METRICS_UTILITY_REPORT_COMPANY_PROCUREMENT_LEADER="$METRICS_UTILITY_REPORT_COMPANY_PROCUREMENT_LEADER" \
     "automation-controller-metrics-utility" \
     metrics-utility build_report

   このスクリプト METRICS_UTILITY_REPORT_SKU_DESCRIPTION metrics-utility は、収集されたデータからレポートを作成し、最終レポートをコンテナーから指定されたホストディレクトリーにコピーします。

手順

1. 以下のコマンドを実行します。

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

   注記

   /home/my-user/ は実際のパスに置き換えます。

手順

1. cron ファイルを開いて編集します。

   crontab -e

2. cron スケジュールエントリーを追加するには、crontab ファイルの末尾に次の行を追加します。

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

   これらの例では、gather コマンドを毎時 0 分に実行するように設定し、build_report コマンドを毎月 2 日の午前 4 時に実行するように設定しています。

3. 希望するスケジュールに合わせて、必要に応じて cron 構文を調整します。以下に例を示します。

   1. 0 */1 * * *: 毎時 0 分に実行されます。
   2. 0 4 2 * *: 2 日の 04:00 に実行されます。
4. ファイルを保存してから閉じます。

1. cron ジョブのエントリーが正しく保存されたことを確認するには、次のコマンドを実行します。

   crontab -l

   cron ジョブのエントリーが正しく保存されている場合は、cron-gather と cron-report に追加した 2 行が表示されます。

2. cron ログを調べて、cron デーモンがコマンドを実行しているかどうか、および metrics-utility が出力を生成しているかどうかを確認します。

   cat /var/log/cron

   参考までに、次の出力例を参照してください。

   # Example Output:
   
   Aug 20 09:55:01 aap CROND[72746]: (aap) CMD (/home/aap/Documents/scripts/cron-gather)
   Aug 20 09:55:03 aap CROND[72744]: (aap) CMDOUT (2025-08-20 08:55:03,581 INFO     [-] awx.main.analytics /tmp/3292ca44-3314-4f0b-b3f6-ba4a1e47a2b1-2025-08-20-083506+0000-2025-08-20-084503+0000-0.tar.gz)
   Aug 20 09:55:03 aap CROND[72744]: (aap) CMDOUT (/tmp/3292ca44-3314-4f0b-b3f6-ba4a1e47a2b1-2025-08-20-083506+0000-2025-08-20-084503+0000-0.tar.gz)
   Aug 20 09:55:03 aap CROND[72744]: (aap) CMDOUT (2025-08-20 08:55:03,581 INFO     [-] awx.main.analytics /tmp/3292ca44-3314-4f0b-b3f6-ba4a1e47a2b1-2025-08-20-083506+0000-2025-08-20-084503+0000-1.tar.gz)
   Aug 20 09:55:03 aap CROND[72744]: (aap) CMDOUT (/tmp/3292ca44-3314-4f0b-b3f6-ba4a1e47a2b1-2025-08-20-083506+0000-2025-08-20-084503+0000-1.tar.gz)
   Aug 20 09:55:03 aap CROND[72744]: (aap) CMDEND (/home/aap/Documents/scripts/cron-gather)
   Aug 20 10:00:02 aap CROND[77629]: (aap) CMD (/home/aap/Documents/scripts/cron-report)
   Aug 20 10:00:02 aap CROND[77623]: (aap) CMDOUT (Generating metrics report inside the container...)
   Aug 20 10:00:04 aap CROND[77623]: (aap) CMDOUT (2025-08-20 09:00:04,639 INFO     [-] awx.main.analytics No billing data for month 2025-07)
   Aug 20 10:00:04 aap CROND[77623]: (aap) CMDOUT (No billing data for month 2025-07)
   Aug 20 10:00:05 aap CROND[77623]: (aap) CMDOUT (Copying generated reports from container to host: /tmp/ansible_metrics_reports)
   Aug 20 10:00:05 aap CROND[77623]: (aap) CMDOUT (Reports successfully moved to: /tmp/ansible_metrics_reports)
   Aug 20 10:00:05 aap CROND[77623]: (aap) CMDOUT (Files in destination:)
   Aug 20 10:00:05 aap CROND[77623]: (aap) CMDOUT (total 0)
   Aug 20 10:00:05 aap CROND[77623]: (aap) CMDOUT (drwxr-xr-x. 3 aap aap 18 Aug 20 09:43 data)
   Aug 20 10:00:05 aap CROND[77623]: (aap) CMDEND (/home/aap/Documents/scripts/cron-report)

3. 生成されたレポートを見つけます。

   • 生成されたレポートのデフォルトの名前の形式は CCSP-<YEAR>-<MONTH>.xlsx (例: CCSP-2024-07.xlsx) です。レポートは、手順 2 で指定した接頭辞付きパス (例: /home/my-user/aap/controller/data/metrics_utility/data) を持つ METRICS_UTILITY_SHIP_PATH に保存されます。