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に管理エージェントをインストールする手順に従う必要があります。管理エージェントは、同じVMまたはPrometheusエンドポイントにアクセスできるVMにインストールする必要があります。前提条件およびインストール・プロセスの詳細は、管理エージェントのインストールを参照してください。
動的グループの作成とポリシーのアタッチ
次に、次のポリシーを使用して管理エージェント動的グループを作成します。- 管理エージェントの動的グループが存在しない場合は作成します。たとえば:
Management-Agent-Dynamic-Group
。<AGENT_COMPARTMENT_OCID>
を管理エージェントのコンパートメントOCIDに置き換えます。ALL {resource.type='managementagent' resource.compartment.id='<AGENT_COMPARTMENT_OCID>'}
- エージェントがOCIモニタリング・ネームスペースにメトリックを投稿できるようにするには、次のポリシーをアタッチします。
allow dynamic-group Management-Agent-Dynamic-Group to use metrics in compartment <METRIC_COMPARTMENT_OCID> where target.metrics.namespace = '<OCI_MONITORING_NAMESPACE>'
ノート動的グループの詳細については、Managing Dynamic Groupsおよび Managing Policiesを参照してください。
メトリックをすぐに表示する場合は、管理エージェントを再起動する必要があります。ステップ 2Prometheusメトリックの有効化
ソフトウェアまたはハードウェアのPrometheusメトリックを有効にするには、モニターする内容の公式手順に従って、使用する方法を判断します。
たとえば、このブログ投稿では、Prometheusメトリックを使用するようにOracle CloudでDockerコンテナを構成する方法について説明します。この例では、公式WebサイトのDockerの指示に、DockerコンテナでPrometheusを有効にする方法に関する最新の手順が含まれています。 ステップ 3Prometheusデータ・ソースの構成次に、Oracle Cloudで、Oracle CloudコンソールでPrometheusデータ・ソースを追加および構成することで、Prometheusメトリックを収集するように管理エージェントを構成できます。
このビデオでは、Prometheusデータ・ソースの構成方法を示します。このビデオでは、Prometheusデータ・ソースがKafkaサービス用に構成されています。Oracle Cloudコンソールでデータ・ソースを追加、編集および構成するプロセスは、URLを介してPrometheusメトリックを公開するすべてのデータ・ソースで同じです。
Prometheusデータソースを追加および構成するには:
- Oracle Cloudコンソールで、「ナビゲーション」メニューに移動し、「監視および管理」を選択し、「管理エージェント」に移動して、「エージェント」を選択します。
- 「エージェントおよびゲートウェイ」を選択し、必要な「コンパートメント」を選択して、「エージェント」を選択します。
- 「データ・ソースの管理」、「データ・ソースの追加」の順に選択します。
- 「データ・ソース・タイプ」ドロップダウン・リストから「Prometheus」を選択し、「メトリック・ネームスペース」、「URL」、「メトリック・コンパートメント」の順に選択します。必要に応じて、カスタム・メトリック・ディメンションを追加したり、オプションのプロパティを設定できます。オプションのリストは、必須データ・ソース・プロパティおよびオプション・データ・ソース・プロパティを参照してください。
ノート
メトリック・ネームスペースおよびメトリック・コンパートメントの値は、ポリシーの値と同じである必要があります。 - 「追加」をクリックします。
正しく構成されている場合、数分後にメトリックがOCIモニタリング・サービスに表示されます。
ノート
必要なポリシーが欠落している場合は、管理エージェント・ログにHTTP 404 NotAuthorized
エラー・メッセージが表示されます。詳細は、動的グループの作成とポリシーのアタッチを参照してください。
Prometheusデータ・ソースを表示または編集するには:
データ・ソースを追加した後、「データ・ソースの管理」に移動して、表示または編集するデータ・ソースの横にある垂直楕円を選択できます。
- 管理エージェントの動的グループが存在しない場合は作成します。たとえば:
- OCIインスタンスに管理エージェントをインストールします。
必須データ・ソース・プロパティ
Prometheusデータ・ソースを作成する場合、次のプロパティが必要です。
名前 | ユニット/フォーマット | 説明 |
---|---|---|
url | 文字列 | Prometheus Exporterがメトリックを公開するURL。HTTPリクエストのみをサポートします。たとえば:
|
ネームスペース | 文字列 | スクレイピングされたメトリックがアップロードされるOCIモニタリング・ネームスペース。 |
compartmentId | 文字列 | スクレイピングされたメトリックがアップロードされるコンパートメントのOCID。 |
オプション・データソース・プロパティ
Prometheusデータ・ソースを作成する場合、次のプロパティはオプションです。より具体的な範囲のPrometheusメトリックを収集するには、データ・ソースの作成時にこれらのオプション・プロパティを追加できます。
名前 | ユニット/フォーマット | 説明 |
---|---|---|
allowMetrics | 文字列- カンマで区切られたメトリック名リスト | 目的のスクレイピングされたメトリックの完全なセット。このプロパティを使用して、必要に応じてアップロードされるメトリックのセットを制限します。 |
connection-timeout | ミリ秒数 | Prometheus Exporterのエンドポイントに接続するためのタイムアウト。 |
metricDimensions | 文字列- カンマで区切られたプロパティ名リスト | アップロードされるすべてのデータ・ポイントのディメンションとして使用される固定値として表される、他のユーザー指定プロパティの名前。 |
proxy-url | 文字列- URL | Prometheusエクスポータのエンドポイント、URL必須プロパティへのアクセスを提供するネットワーク・プロキシのURL。 |
読み取りデータ制限 | 数(KB) | 送信されるデータの制限。たとえば、400KBを入力した場合、管理エージェントの固定制限である400KBのディスク領域を超えません。 |
read-timeout | ミリ秒数 | Prometheus Exporterのエンドポイントからレスポンスを読み取るためのタイムアウト。 |
resourceGroup | 文字列。英数字、ピリオド(.)、アンダースコア(_)、ハイフン(-)およびドル記号($)のみが含まれます。 | OCIモニタリング・サービスのリソース・グループ。
指定した場合、リソース・グループは、発行される各メトリックに割り当てられます。 |
scheduleMins | スクレイピング間隔(分) | この値を指定すると、この特定の時間間隔でデータ収集またはスクレイピングが発生します。
最小値は1分です。 この値を指定しない場合、デフォルト値は5分です。 ノート: 収集間隔を短くすると、CPUのパフォーマンスにプラスの影響を与える可能性があります。 例: |
Prometheusダッシュボードの作成 🔗
前述のステップでPrometheusメトリックをエクスポートするように管理エージェントを設定した後、OCI管理ダッシュボード・サービスを使用してダッシュボードを作成し、Prometheusメトリックをビジュアル化できます。ビジュアル化するメトリックごとに1つのメトリック・データ・エクスプローラ・ウィジェットを構成できます。詳細は、メトリック・データ・エクスプローラ・ウィジェットの作成を参照してください。