第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. インベントリーファイルを変更して、[automationcontroller] セクションの下に次の行を追加し、metrics-utility コンテナーのデプロイメントを有効にします。

   metrics_utility_enabled=true

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

2. metrics_utility_extra_settings 変数を追加してレポートパラメーターを設定します。この変数は、レポートが保存される場所、レポートに含まれる内容、その他のメタデータを制御します。

   metrics_utility_extra_settings=[
   {"setting": "METRICS_UTILITY_SHIP_TARGET", "value": "directory"},
   {"setting": "METRICS_UTILITY_SHIP_PATH", "value": "~/aap/controller/data/metrics/"},
   {"setting": "METRICS_UTILITY_REPORT_TYPE", "value": "CCSPv2"},
   {"setting": "METRICS_UTILITY_PRICE_PER_NODE", "value": "100"},
   {"setting": "METRICS_UTILITY_REPORT_COMPANY_NAME", "value": "My Company Inc"},
   {"setting": "METRICS_UTILITY_REPORT_EMAIL", "value": "admin@mycompany.com"},
   {"setting": "METRICS_UTILITY_REPORT_SKU", "value": "MCT3752MO"}]

3. オプション: systemd timer 式に次の変数を追加して、デフォルトのデータ収集スケジュールをオーバーライドします。

   注記

   systemd timer 式は cron 式とは異なります。

   # Gathers data every 30 minutes
   metrics_utility_cronjob_gather_schedule=*:0/30
   # Generates the report at midnight on the 2nd of the month
   metrics_utility_cronjob_report_schedule=*-*-02 00:00:00

検証

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

   systemctl --user list-timers --no-pager | grep metrics-utility

   出力例:

   Wed 2025-08-13 10:45:00 IST 8min left Wed 2025-08-13 10:30:04 IST 6min ago   metrics-utility-build-report.timer metrics-utility-build-report.service
   Wed 2025-08-13 10:45:00 IST 8min left Wed 2025-08-13 10:30:04 IST 6min ago   metrics-utility-gather.timer   	metrics-utility-gather.service

2. 実行しているサービスの出力ログを調べてデータ収集を確認するには、次のコマンドを使用します。

   systemctl --user status metrics-utility-gather.service

   出力例:

   metrics-utility-gather.service - Podman metrics-utility-gather.service
    	Loaded: loaded (/home/aap/.config/systemd/user/metrics-utility-gather.service; disabled; preset: disabled)
    	Active: inactive (dead) since Wed 2025-08-13 10:00:06 IST; 5min ago
      Duration: 2.008s
   TriggeredBy: ● metrics-utility-gather.timer
      	Docs: man:podman-generate-systemd(1)
   	Process: 1472847 ExecStart=/usr/bin/podman start metrics-utility-gather (code=exited, status=0/SUCCESS)
   	Process: 1472927 ExecStop=/usr/bin/podman stop -t 10 metrics-utility-gather (code=exited, status=0/SUCCESS)
   	Process: 1472937 ExecStopPost=/usr/bin/podman stop -t 10 metrics-utility-gather (code=exited, status=0/SUCCESS)
      Main PID: 1472874 (code=exited, status=0/SUCCESS)
       	CPU: 197ms
   
   Aug 13 10:00:04 aap.example.org podman[1472847]: metrics-utility-gather
   Aug 13 10:00:04 aap.example.org systemd[993]: Started Podman metrics-utility-gather.service.
   Aug 13 10:00:05 aap.example.org metrics-utility-gather[1472874]: 2025-08-13 09:00:05,806 INFO 	[-] awx.main.analytics /tmp/3292ca44-3314-4f>
   Aug 13 10:00:05 aap.example.org metrics-utility-gather[1472874]: /tmp/3292ca44-3314-4f0b-b3f6-ba4a1e47a2b1-2025-08-13-083505+0000-2025-08-13-0>
   Aug 13 10:00:05 aap.example.org metrics-utility-gather[1472874]: 2025-08-13 09:00:05,808 INFO 	[-] awx.main.analytics /tmp/3292ca44-3314-4f>
   Aug 13 10:00:05 aap.example.org metrics-utility-gather[1472874]: /tmp/3292ca44-3314-4f0b-b3f6-ba4a1e47a2b1-2025-08-13-083505+0000-2025-08-13-0>
   Aug 13 10:00:06 aap.example.org podman[1472912]: 2025-08-13 10:00:06.169271763 +0100 IST m=+0.019922418 container died 5dc8d5674f1d1745258530f>
   Aug 13 10:00:06 aap.example.org podman[1472912]: 2025-08-13 10:00:06.187584135 +0100 IST m=+0.038234790 container cleanup 5dc8d5674f1d17452585>
   Aug 13 10:00:06 aap.example.org podman[1472927]: metrics-utility-gather
   Aug 13 10:00:06 aap.example.org podman[1472937]: metrics-utility-gather

3. 生成されたレポートを見つけます。レポートは、METRICS_UTILITY_SHIP_PATH 設定で指定したディレクトリーに保存されます。

   • パス: このドキュメントで提供されている例を使用すると、レポートパスは /aap/controller/data/metrics/ になります。
   • ファイル名: レポート名は CCSP-<YEAR>-<MONTH>.xlsx の形式に従います。たとえば、2025 年 8 月に生成されたレポートの名前は CCSP-2025-08.xlsx になります。