PrometheusとGrafanaの統合

TiDB CloudはプロメテウスのAPIエンドポイントを提供します。 Prometheusサービスを使用している場合は、エンドポイントからTiDB Cloudの主要なメトリックを簡単に監視できます。

このドキュメントでは、 TiDB Cloudエンドポイントから主要なメトリックを読み取るようにPrometheusサービスを構成する方法と、 Grafanaを使用してメトリックを表示する方法について説明します。

前提条件

• TiDB CloudをPrometheusと統合するには、セルフホストまたはマネージドのPrometheusサービスが必要です。

• TiDB Cloudのサードパーティ統合設定を編集するには、組織へのOrganization Ownerつのアクセス、またはTiDB CloudのターゲットプロジェクトへのProject Memberのアクセスが必要です。

制限

PrometheusとGrafanaの統合を開発者層で使用することはできません。

手順

手順1.Prometheusのscrape_configファイルを取得します

TiDB Cloudのメトリックを読み取るようにPrometheusサービスを構成する前に、まずTiDBCloudでTiDB Cloudファイルを生成する必要があります。 scare_configファイルには、Prometheusサービスが現在のプロジェクト内のデータベースクラスターを監視できるようにする一意のベアラートークンが含まれています。

Prometheusのscrape_configファイルを取得するには、次の手順を実行します。

1. TiDB Cloudコンソールで、Prometheus統合のターゲットプロジェクトを選択し、[プロジェクト設定]タブをクリックします。

2. 左側のペインで、[統合]をクリックします。

3. Prometheusへの統合をクリックします。

4. [ファイルの追加]をクリックして、現在のプロジェクトのscrape_configファイルを生成して表示します。

5. 後で使用するために、scrape_configファイルの内容のコピーを作成します。

   ノート：

   セキュリティ上の理由から、 TiDB Cloudは新しく生成されたscrap_configファイルを1回だけ表示します。ファイルウィンドウを閉じる前に、必ずコンテンツをコピーしてください。そうするのを忘れた場合は、 TiDB Cloudのscrap_configファイルを削除して、新しいファイルを生成する必要があります。 scare_configファイルを削除するには、ファイルを選択し、[ ... ]をクリックして、[削除]をクリックします。

ステップ2.Prometheusと統合する

1. Prometheusサービスによって指定された監視ディレクトリで、Prometheus構成ファイルを見つけます。

   たとえば、 /etc/prometheus/prometheus.yml 。

2. Prometheus構成ファイルでscrape_configsセクションを見つけ、 TiDB Cloudから取得したscrape_configファイルの内容をそのセクションにコピーします。

3. Prometheusサービスで、[ステータス]> [ターゲット]をチェックして、新しいscrap_configファイルが読み取られたことを確認します。そうでない場合は、Prometheusサービスを再起動する必要があります。

ステップ3.GrafanaGUIダッシュボードを使用してメトリックを視覚化する

PrometheusサービスがTiDB Cloudからメトリックを読み取った後、GrafanaGUIダッシュボードを使用してメトリックを視覚化できます。

Grafanaの使用方法の詳細については、 Grafanaのドキュメントを参照してください。

回転するscrap_configのベストプラクティス

データのセキュリティを向上させるには、scrape_configファイルベアラートークンを定期的にローテーションするのが一般的なベストプラクティスです。

1. ステップ1に従って、Prometheusの新しいscrap_configファイルを作成します。
2. 新しいファイルの内容をPrometheus構成ファイルに追加します。
3. Prometheusサービスが引き続きTiDB Cloudから読み取ることができることを確認したら、Prometheus構成ファイルから古いscrap_configファイルの内容を削除します。
4. プロジェクトの[統合]ページで、対応する古いscrap_configファイルを削除して、他のユーザーがそのファイルを使用してTiDB Cloudエンドポイントから読み取るのをブロックします。

Prometheusで利用可能なメトリック

Prometheusは、TiDBクラスターの次のメトリックデータを追跡します。