Oracle Cloud Infrastructureドキュメント

Prometheusメトリックを収集するための管理エージェントの設定

Oracle Cloud Infrastructure Management Agentsサービス(管理エージェント)では、Prometheus形式でメトリック・データを公開する任意のリソースからの時系列パフォーマンス・メトリック・データの収集がサポートされます。Prometheusの詳細は、Prometheusの公式のスタート・ガイド・ドキュメントを参照してください。

Prometheusおよび管理エージェント

次のステップでは、管理エージェントを使用してPrometheusメトリックを収集する方法について説明します。

  • ステップ1. Prometheusメトリック・エンドポイントにアクセスできる管理エージェントのインストール。
  • ステップ2. Prometheusメトリック使用可能
  • ステップ3. Prometheusデータ・ソースの構成
  • ステップ4. Prometheusダッシュボードの作成

    ステップ1: 管理エージェントのインストール

    まず、管理エージェントをインストールして、エージェントをOracle Cloud Infrastructure (OCI)に登録する必要があります。
    使用している環境に応じて、次のいずれかの方法を選択して管理エージェントをインストールできます。
    • OCIインスタンスに管理エージェントをインストールします。

      OCIコンピュート・インスタンスがある場合は、指示に従ってOCIコンピュート・インスタンスで管理エージェントを有効にする必要があります。前提条件およびインストール・プロセスの詳細は、コンピュート・インスタンスへの管理エージェントのデプロイを参照してください。

    • 非OCIインスタンスに管理エージェントをインストールします。

      スタンドアロンVMがある場合は、指示に従ってVMに管理エージェントをインストールする必要があります。Prometheusエンドポイントにアクセスできる同じVMまたはVMに管理エージェントをインストールする必要があります。前提条件およびインストール・プロセスの詳細は、管理エージェントのインストールを参照してください。

      動的グループの作成とポリシーの添付

      次に、次のポリシーを使用して管理エージェント動的グループを作成します。
      1. まだ存在しない場合は、管理エージェントの動的グループを作成します。たとえば: Management-Agent-Dynamic-Group。<AGENT_COMPARTMENT_OCID>を管理エージェントのコンパートメントOCIDに置き換えます。 
        ALL {resource.type='managementagent' resource.compartment.id='<AGENT_COMPARTMENT_OCID>'}
      2. 次のポリシーをアタッチして、エージェントがメトリックをOCIモニタリング・ネームスペースにポストできるようにします。 
        allow dynamic-group Management-Agent-Dynamic-Group to use metrics in compartment <METRIC_COMPARTMENT_OCID> where target.metrics.namespace = '<OCI_MONITORING_NAMESPACE>'
      ノート

      メトリックをすぐに表示する場合は、管理エージェントを再起動する必要があります。
      動的グループの詳細は、動的グループの管理およびポリシーの管理に関する項を参照してください。

      ステップ 2 Prometheusメトリックの有効化

      ソフトウェアまたはハードウェアのPrometheusメトリックを有効にするには、モニターする対象に関する公式の指示に移動して、どの方法を使用するかを決定します。

      たとえば、このブログ投稿では、Prometheusメトリックを使用するためのDockerコンテナをOracle Cloudで構成する方法について説明します。この例では、公式WebサイトのDocker命令に、DockerコンテナでPrometheusを有効にする方法に関する最新の指示が含まれています。

      ステップ 3 Prometheusデータ・ソースの構成

      次に、Oracle Cloudで、Oracle CloudコンソールでPrometheusデータ・ソースを追加および構成することで、Prometheusメトリックを収集するように管理エージェントを構成できます。

      このビデオは、Prometheusデータ・ソースを構成する方法を示しています。このビデオでは、Kafkaサービス用にPrometheusデータ・ソースが構成されています。Oracle Cloudコンソールでデータ・ソースを追加、編集および構成するプロセスは、URLを介してPrometheusメトリックを公開するデータ・ソースで同じです。

      Prometheusデータ・ソースを追加および構成するには:

      1. 「データ・ソースの追加」ダイアログ・ボックスを開くステップは、「データ・ソースの管理」を参照してください。
      2. 「データ・ソース・タイプ」ドロップダウン・リストから「Prometheus」を選択し、「メトリック・ネームスペース」(「URL」)を追加して、「メトリック・コンパートメント」を選択します。必要に応じて、カスタム・メトリック・ディメンションを追加するか、任意のオプション・プロパティを設定できます。オプションのリストは、必須データ・ソース・プロパティおよびオプション・データ・ソース・プロパティを参照してください。
        ノート

        メトリック・ネームスペースおよびメトリック・コンパートメントの値は、ポリシーの値と同じである必要があります。

      3. 「追加」をクリックします。

        これで、正しく構成されている場合は、数分後にOCIモニタリング・サービスにメトリックが表示されます。

        ノート

        必要なポリシーが欠落している場合、管理エージェント・ログにHTTP 404 NotAuthorizedエラー・メッセージが表示されます。詳細は、動的グループの作成およびポリシーの添付を参照してください。

      Prometheusデータ・ソースを表示または編集するには、データ・ソースの管理を参照してください。

必要なデータ・ソース・プロパティ

Prometheusデータ・ソースを作成する場合は、次のプロパティが必要です。

名前 単位/フォーマット 説明
URL 文字列 Prometheusエクスポータがメトリックを公開するURL。HTTPリクエストのみをサポートします。次に例を示します。

http://localhost:9100/metrics
名前空間 文字列 スクラップされたメトリックがアップロードされるOCIモニタリング・ネームスペース。
compartmentId 文字列 スクラップされたメトリックがアップロードされるコンパートメントのOCID。

オプションのデータ・ソース・プロパティ

Prometheusデータ・ソースを作成する場合、次のプロパティはオプションです。Prometheusメトリックのより具体的な範囲を収集するには、データ・ソースの作成時にこれらのオプションのプロパティを追加できます。

名前 単位/フォーマット 説明
allowMetrics 文字列- カンマ区切りのメトリック名リスト 目的のスクレイプされたメトリックの完全なセット。このプロパティを使用して、必要に応じてアップロードされるメトリックのセットを制限します。
connection-timeout 数(ミリ秒) Prometheus Exporterのエンドポイントに接続するためのタイムアウト。
metricDimensions 文字列- カンマ区切りのプロパティ名リスト アップロードされるすべてのデータ・ポイントのディメンションとして使用される固定値として表される、他のユーザー指定プロパティの名前。
proxy-url 文字列- URL Prometheus Exporterのエンドポイント、URL requiredプロパティへのアクセスを提供するネットワーク・プロキシのURL。
read-data-limit 数値をキロバイト単位で指定します 送信されるデータの制限。たとえば、400KBを入力した場合、管理エージェントの固定制限である400KBのディスク領域を超えません。
read-timeout 数(ミリ秒) Prometheusエクスポータのエンドポイントからレスポンスを読み取るためのタイムアウト。
resourceGroup 文字列。これには、英数字、ピリオド(.)、アンダースコア(_)、ハイフン(-)およびドル記号($)のみが含まれます。 OCIモニタリング・サービスのリソース・グループ。

指定した場合、リソース・グループは発行される各メトリックに割り当てられます。
scheduleMins スクレイピング間隔(分) この値を指定すると、この特定の時間間隔でデータの収集またはスクレイピングが発生します。

最小値は1分です。

この値が指定されていない場合、デフォルト値は5分です。

ノート: 収集間隔を短くすると、CPUパフォーマンスにプラスの影響を与える可能性があります。

例: scheduleMins=1

Prometheusダッシュボードの作成

前述のステップを実行してPrometheusメトリックをエクスポートするように管理エージェントを設定した後、OCI管理ダッシュボード・サービスを使用してダッシュボードを作成し、Prometheusメトリックをビジュアル化できます。ビジュアル化するメトリックごとに1つのメトリック・データ・エクスプローラ・ウィジェットを構成できます。詳細は、メトリック・データ・エクスプローラ・ウィジェットの作成を参照してください。