第12章 metrics-utility による使用状況レポート
Ansible Automation Platform メトリクスユーティリティーツール (metrics-utility
) は、Automation Controller のインスタンスを含むシステムにインストールされるコマンドラインユーティリティーです。
metrics-utility
は、インストールおよび設定されると、システムから請求関連のメトリクスを収集し、消費量に基づく請求レポートを作成します。metrics-utility
ツールは、管理対象ホストが複数あり、消費量ベースの請求を使用するユーザーに特に適しています。レポートが生成されると、設定ファイルで指定した保存先の場所に保存されます。
metrics-utility
は、システムから設定データとレポートデータの 2 種類のデータを収集します。
設定データには次の情報が含まれます。
- Automation Controller とオペレーティングシステムのバージョン情報
- サブスクリプション情報
- ベース URL
レポートデータには次の情報が含まれます。
- ジョブ名と ID
- ホスト名
- インベントリー名
- 組織名
- プロジェクト名
- 成功または失敗に関する情報
- レポート日時
metrics-utility
が設定どおりに動作し続けるように、レポートディレクトリーから古いレポートを定期的に消去してください。
12.1. metrics-utility の設定 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat Enterprise Linux と OpenShift Container Platform の両方で、Ansible Automation Platform の使用状況データを収集して報告するように metrics-utility を設定します。
12.1.1. Red Hat Enterprise Linux の metrics-utility の設定 リンクのコピーリンクがクリップボードにコピーされました!
前提条件:
- 有効な Ansible Automation Platform サブスクリプション
metrics-utility は Ansible Automation Platform に含まれているため、別途インストールする必要はありません。次の手順では、関連データを収集し、使用状況メトリクスを含む CCSP レポートを生成します。これらのコマンドを cronjob として設定して毎月初めに実行することができます。cron 構文を使用した設定の詳細は、How to schedule jobs using the Linux 'cron' utility を参照してください。
手順
metrics-utility
にすべての関連データを収集させるための正しい変数を設定するために、ユーザーのホームディレクトリー内に次の 2 つのスクリプトを作成します。/home/my-user/cron-gather
内:Copy to Clipboard Copied! Toggle word wrap Toggle overflow /home/my-user/cron-report
内:Copy to Clipboard Copied! Toggle word wrap Toggle overflow
これらのファイルを実行可能にするために、次のコマンドを実行します。
chmod a+x /home/my-user/cron-gather /home/my-user/cron-report
cron ファイルを開いて編集するために、次のコマンドを実行します。
crontab -e
実行スケジュールを設定するために、ファイルの末尾に次のパラメーターを追加し、
metrics-utility
によって情報を収集してレポートを作成する頻度を cron 構文 を使用して指定します。次の例では、gather
コマンドは毎時 00 分に実行されるように設定されています。build_report
コマンドは、毎月 2 日の午前 4 時に実行されるように設定されています。0 */1 * * * /home/my-user/cron-gather
0 4 2 * * /home/my-user/cron-report
- ファイルを保存してから閉じます。
変更が保存されたことを確認するために、次のコマンドを実行します。
crontab -l
データが収集されていることを確認するために、次を実行します。
cat /var/log/cron
以下は一般的な出力です。時間と日付は、実行スケジュールの設定方法に応じて異なる場合があります。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 生成されたレポートには、
CCSP-<YEAR>-<MONTH>.xlsx
というデフォルトの名前が付けられます。レポートはステップ 1a で指定した送信先パスに保存されます。
12.1.2. Ansible Automation Platform Operator から OpenShift Container Platform の metrics-utility を設定する リンクのコピーリンクがクリップボードにコピーされました!
metrics-utility
は、バージョン 4.12、4.512、および 4.6 以降の OpenShift Container Platform イメージに含まれています。システムに metrics-utility
がインストールされていない場合は、OpenShift イメージを最新バージョンに更新してください。
Ansible Automation Platform Operator を使用して OpenShift Container Platform で metrics-utility
の実行スケジュールを設定するには、次の手順を実行します。
12.1.2.1. OpenShift UI の YAML ビューで ConfigMap を作成する リンクのコピーリンクがクリップボードにコピーされました!
設定データを含む metrics-utility
cronjobs を注入するには、次の手順に従って、OpenShift UI の YAML ビューで ConfigMap を作成します。
前提条件:
- 実行中の OpenShift クラスター
- Operator によって OpenShift Container Platform にインストールされた Ansible Automation Platform
metrics-utility
は、設定ファイルで設定したパラメーターに従って実行されます。OpenShift Container Platform では、このユーティリティーを手動で実行することはできません。
手順
- ナビゲーションパネルから、 を選択します。
- をクリックします。
- 次の画面で、YAML view タブを選択します。
YAML フィールドに、次のパラメーターを入力して適切な変数を設定します。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - をクリックします。
検証
-
ConfigMap が作成され、
metrics-utility
がインストールされていることを確認するには、ナビゲーションパネルから ConfigMap を選択し、リストで ConfigMap を探します。
12.1.2.2. Automation Controller のデプロイ リンクのコピーリンクがクリップボードにコピーされました!
Automation Controller をデプロイし、metrics-utility
によって使用状況情報を収集してレポートを生成する頻度を表す変数を指定するには、次の手順を使用します。
手順
- ナビゲーションパネルから、Installed Operators を選択します。
- Ansible Automation Platform を選択します。
- Operator の詳細で、Automation Controller タブを選択します。
- をクリックします。
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
-
metrics_utility_enabled
パラメーターを見つけて、変数を true に変更します。 -
metrics_utility_cronjob_gather_schedule
パラメーターを見つけて、ユーティリティーによって使用状況情報を収集する頻度を表す変数を入力します (たとえば、@hourly
または@daily
)。 -
metrics_utility_cronjob_report_schedule
パラメーターを見つけて、ユーティリティーによってレポートを生成する頻度を表す変数を入力します (たとえば、@daily
または@monthly
)。 - をクリックします。