12.5. レポートタイプ


このセクションでは、レポートタイプに基づき、データ収集とレポート作成の追加設定について説明します。Ansible Automation Platform のインストールに基づき、各レポートタイプに環境変数を適用します。

12.5.1. CCSPv2

CCSPv2 は次の内容を示すレポートです。

  • 直接および間接的に管理されるノードの使用状況
  • すべてのインベントリーの内容
  • コンテンツの使用状況

このレポートは主に CCSP プログラムのパートナー様が使用しますが、すべてのお客様がこのレポートを使用して、Automation Controller の組織全体の管理対象ノード、ジョブ、コンテンツの使用状況を示すオンプレミスレポートを取得できます。

METRICS_UTILITY_REPORT_TYPE=CCSPv2 を使用してレポートタイプを設定します。

12.5.1.1. gather コマンドのオプションのコレクター

gather コマンドでは、次のオプションのコレクターを使用できます。

  • main_jobhostsummary

    • デフォルトで存在する場合、ジョブの実行と自動化された管理対象ノードに関する情報が含まれる Automation Controller データベースの main_jobhostsummary テーブルから、データが増分収集されます。
  • main_host

    • Automation Controller データベース内の main_host テーブルのスナップショットが毎日収集され、Automation Controller インベントリー全体に管理対象ノードとホストが存在します。
  • main_jobevent

    • Automation Controller データベースの main_jobevent テーブルからデータが増分収集され、使用中のモジュール、ロール、および Ansible コレクションに関する情報が含まれます。
  • main_indirectmanagednodeaudit

    • Automation Controller データベースの main_indirectmanagednodeaudit テーブルからデータが増分的に収集され、間接的に管理されるノードに関する情報が含まれます。
Copy to Clipboard Toggle word wrap
# Example with all optional collectors
export METRICS_UTILITY_OPTIONAL_COLLECTORS="main_host,main_jobevent,main_indirectmanagednodeaudit"

12.5.1.2. build_report コマンドのオプションシート

build_report コマンドでは、次のオプションシートを使用できます。

  • ccsp_summary

    • これは、CCSP プログラムのパートナー様専用のランディングページです。このレポートでは、概要ページをカスタマイズするために追加のパラメーターを使用します。詳細は、以下の例を参照してください。

      Copy to Clipboard Toggle word wrap
      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 NA Direct Reporting Template"
      export METRICS_UTILITY_REPORT_COMPANY_NAME="Partner A"
      export METRICS_UTILITY_REPORT_EMAIL="email@email.com"
      export METRICS_UTILITY_REPORT_RHN_LOGIN="test_login"
      export METRICS_UTILITY_REPORT_PO_NUMBER="123"
      export METRICS_UTILITY_REPORT_END_USER_COMPANY_NAME="Customer A"
      export METRICS_UTILITY_REPORT_END_USER_CITY="Springfield"
      export METRICS_UTILITY_REPORT_END_USER_STATE="TX"
      export METRICS_UTILITY_REPORT_END_USER_COUNTRY="US"
  • jobs

    • 起動された Automation Controller ジョブのリストです。ジョブテンプレートごとにグループ化されています。
  • managed_nodes

    • Automation Controller によって自動化された管理対象ノードの重複排除リストです。
  • indirectly_managed_nodes

    • Automation Controller によって自動化された間接管理対象ノードの重複排除リストです。
  • inventory_scope

    • Automation Controller のすべてのインベントリーに存在する管理対象ノードの重複排除リストです。
  • usage_by_organizations

    • 組織の使用状況を示すいくつかのメトリクスが含まれる、すべての Automation Controller 組織のリストです。内部チャージバックを実行するために適したデータが提供されます。
  • usage_by_collections

    • これは、Automation Controller ジョブ実行で使用される Ansible コレクションのリストです。
  • usage_by_roles

    • Automation Controller のジョブ実行で使用されるロールのリストです。
  • usage_by_modules

    • Automation Controller のジョブ実行で使用されるモジュールのリストです。
  • managed_nodes_by_organization

    • 組織ごとにシートが生成され、managed_nodes シートと同じ内容で、すべての組織の管理対象ノードがリストされます。
  • data_collection_status

    • レポートが作成された日付範囲について、gather コマンドで実行されたすべてのデータ収集のステータスが含まれるシートが生成されます。

収集されたデータの品質を概説するために、次の内容もリストされています。

  • コレクション間の異常なギャップ (collection_start_timestamp に基づく)
  • 収集間隔のギャップ (since と until に基づく)

    Copy to Clipboard Toggle word wrap
    # Example with all optional sheets
    export METRICS_UTILITY_OPTIONAL_CCSP_REPORT_SHEETS='ccsp_summary,jobs,managed_nodes,indirectly_managed_nodes,inventory_scope,usage_by_organizations,usage_by_collections,usage_by_roles,usage_by_modules,data_collection_status'

12.5.1.3. 組織別にレポートをフィルタリングする

特定の組織のみが表示されるようにレポートをフィルタリングするには、セミコロンで区切られた組織名のリストと、この環境変数を使用します。

export METRICS_UTILITY_ORGANIZATION_FILTER="ACME;Organization 1"

これにより、作成されたレポートには該当する組織のデータのみが表示されます。このフィルターは現在、次のオプションシートには影響しません。

  • usage_by_collections
  • usage_by_roles
  • usage_by_modules

12.5.1.4. CCSPv2 レポートの日付範囲の選択

CCSPv2 レポートのデフォルトの動作は、前の月のレポートを構築することです。次の例では、このデフォルトの動作をオーバーライドして、レポートの特定の日付範囲を選択する方法について説明します。

Copy to Clipboard Toggle word wrap
# Build report for a specific month
metrics-utility build_report --month=2025-03

# Build report for a specific date range, icluding the prvided days
metrics-utility build_report --since=2025-03-01 --until=2025-03-31

# Build report for a last 6 months from a current date
metrics-utility build_report --since=6months

# Build report for a last 6 months from a current date overriding an exisitng report
metrics-utility build_report --since=6months --force

12.5.2. RENEWAL_GUIDANCE

RENEWAL_GUIDANCE レポートは、HostMetric テーブルから使用状況履歴を提供します。その際には、重複排除を適用して、更新を案内するために実際の使用状況履歴を表示します。

このレポートを生成するには、レポートタイプを METRICS_UTILITY_REPORT_TYPE=RENEWAL_GUIDANCE に設定します。

重要

このレポートは現在、テクノロジープレビューソリューションです。awx-manage host_metric コマンドに組み込まれた場合、Automation Controller よりも多くの情報を提供するように設計されています。

12.5.2.1. ストレージと呼び出し

RENEWAL_GUIDANCE レポートでレポート結果を保存するために使用できるのはローカルディスクストレージのみです。このレポートにはデータ収集ステップがありません。コントローラーの HostMetric テーブルから直接読み取るため、METRICS_UTILITY_SHIP_PATH 配下に生データは保存されません。

Copy to Clipboard Toggle word wrap
# All parameters the RENEWAL_GUIDANCE report needs
export METRICS_UTILITY_SHIP_TARGET=controller_db
export METRICS_UTILITY_REPORT_TYPE=RENEWAL_GUIDANCE
export METRICS_UTILITY_SHIP_PATH=/path_to_built_report/...

# Will generate report for 12 months back with epehemeral nodes being nodes
# automated for less than 1 month.
metrics-utility build_report --since=12months --ephemeral=1month

12.5.2.2. 一時的な使用状況の表示

RENEWAL_GUIDANCE レポートには、–ephemeral パラメーターが指定されている場合、一時的に使用する追加シートをリストする機能があります。--ephemeral=1month パラメーターを使用すると、最大 1 カ月間自動化され、その後は再度自動化されない管理対象ノードとしてエフェメラルノードを定義できます。このパラメーターを使用すると、12 カ月間の合計エフェメラル使用量は、1 カ月間という期間をローリングした場合のエフェメラルノードの最大使用量として算出されます。このシートもレポートに追加されます。

Copy to Clipboard Toggle word wrap
# Will generate report for 12 months back with epehemeral nodes being nodes
# automated for less than 1 month.
metrics-utility build_report --since=12months --ephemeral=1month

12.5.2.3. RENEWAL_GUIDANCE レポートの日付範囲の選択

RENEWAL_GUIDANCE レポートには since パラメーターが必要です。これは、HostMetric データの性質上、パラメーターがサポートされておらず、常に now に設定されているためです。すでに作成されているレポートの日付範囲をオーバーライドするには、コマンドでパラメーター -force を使用します。詳細は、以下の例を参照してください。

Copy to Clipboard Toggle word wrap
# Build report for a specific date range, including the provided days
metrics-utility build_report --since=2025-03-01

# Build report for a last 12 months from a current date
metrics-utility build_report --since=12months

# Build report for a last 12 months from a current date overriding an existing report
metrics-utility build_report --since=12months --force

12.5.3. CCSP

CCSP はオリジナルのレポート形式です。CCSPv2 のカスタマイズの多くは含まれておらず、CCSP パートナープログラムのみでの使用を目的としています。

12.5.3.1. gather コマンドのオプションのコレクター

gather コマンドでは、次のオプションのコレクターを使用できます。

  • main_jobhostsummary

    • デフォルトで存在する場合、ジョブの実行と自動化された管理対象ノードに関する情報が含まれる main_jobhostsummary テーブルが、Automation Controller データベースから増分収集されます。
  • main_host

    • Automation Controller データベースから main_host テーブルのスナップショットが毎日収集され、Automation Controller インベントリー全体に管理対象ノードまたはホストが存在します。
  • main_jobevent

    • Automation Controller データベースから main_jobevent テーブルが増分収集され、使用中のモジュール、ロール、および Ansible コレクションに関する情報が含まれます。
  • main_indirectmanagednodeaudit

    • Automation Controller データベースから main_indirectmanagednodeaudit テーブルを増分収集し、間接的に管理されているノードに関する情報が含まれます。
Copy to Clipboard Toggle word wrap
# Example with all optional collectors
export METRICS_UTILITY_OPTIONAL_COLLECTORS="main_host,main_jobevent,main_indirectmanagednodeaudit"

12.5.3.2. build_report コマンドのオプションシート

build_report コマンドでは次のオプションシートを使用できます。

  • ccsp_summary

    • CCSP プログラムのパートナー様専用のランディングページです。各 Automation Controller 組織による管理対象ノードの使用状況を表示します。
    • このレポートでは、概要ページをカスタマイズするために追加のパラメーターを使用します。詳細は、以下の例を参照してください。
Copy to Clipboard Toggle word wrap
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"
  • managed_nodes

    • Automation Controller によって自動化された管理対象ノードの重複排除リストです。
  • indirectly_managed_nodes

    • Automation Controller によって自動化された間接管理対象ノードの重複排除リストです。
  • inventory_scope

    • Automation Controller のすべてのインベントリーに存在する管理対象ノードの重複排除リストです。
  • usage_by_collections

    • Automation Controller のジョブ実行で使用される Ansible コレクションのリストです。
  • usage_by_roles

    • Automation Controller のジョブ実行で使用されるロールのリストです。* usage_by_modules
    • Automation Controller のジョブ実行で使用されるモジュールのリストです。
Copy to Clipboard Toggle word wrap
# Example with all optional sheets
export METRICS_UTILITY_OPTIONAL_CCSP_REPORT_SHEETS='ccsp_summary,managed_nodes,indirectly_managed_nodes,inventory_scope,usage_by_collections,usage_by_roles,usage_by_modules'

12.5.3.3. CCSP レポートの日付範囲の選択

このレポートのデフォルトの動作では、前月のレポートが作成されます。次の例では、このデフォルトの動作をオーバーライドして、レポートの特定の日付範囲を選択する方法について説明します。

Copy to Clipboard Toggle word wrap
# Builds report for a previous month
metrics-utility build_report

# Build report for a specific month
metrics-utility build_report --month=2025-03

# Build report for a specific month overriding an existing report
metrics-utility build_report --month=2025-03 --force
トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat, Inc.