TiDB CloudをPrometheusおよびGrafanaと統合する

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

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

Prometheus統合バージョン

TiDB Cloudは、2022年3月15日よりプロジェクトレベルのPrometheus統合（ベータ版）をサポートしてきました。2025年10月21日より、TiDB CloudレベルのPrometheus統合（プレビュー版）を導入します。2025年12月2日より、クラスターレベルのPrometheus統合が一般提供（GA）となります。

• クラスタレベルのPrometheus統合：2025年10月21日までに組織内に削除されていない従来のプロジェクトレベルのPrometheus統合が残っていない場合、 TiDB Cloudは組織が最新の機能強化を体験できるように、クラスタレベルのPrometheus統合を提供します。

• 従来のプロジェクトレベルの Prometheus 統合 (ベータ版) : 2025 年 10 月 21 日時点で組織内に少なくとも 1 つの従来のプロジェクトレベルの Prometheus 統合が削除されずに残っている場合、 TiDB Cloud は、現在のダッシュボードへの影響を回避するために、組織向けにプロジェクトレベルで既存および新規の統合の両方を保持します。

  注記

  従来のプロジェクトレベルのPrometheus統合は、2026年1月9日に廃止されます。組織がまだこれらの従来の統合を使用している場合は、 Prometheus統合の移行手順に従って、新しいクラスタレベルの統合に移行し、メトリクス関連サービスへの影響を最小限に抑えてください。

前提条件

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

• TiDB Cloudのサードパーティ メトリクス統合を設定するには、 TiDB CloudでOrganization OwnerまたはProject Ownerアクセス権が必要です。統合ページを表示するには、 TiDB Cloudのプロジェクト内の対象のTiDB Cloud DedicatedクラスターにアクセスするためのProject Viewerロール以上が必要です。

制限

• PrometheusとGrafanaの統合機能は、現在TiDB Cloud Dedicatedクラスターでのみ利用可能です。
• クラスターの状態がCREATING 、 RESTORING 、 PAUSED 、またはRESUMINGの場合、Prometheus および Grafana の統合は利用できません。

手順

ステップ1. Prometheus用のscrape_configファイルを取得する

Prometheus サービスでTiDB Cloudのメトリクスを読み取るように設定する前に、まずTiDB Cloudでscrape_config YAML ファイルを生成する必要があります。 scrape_configファイルには、Prometheus サービスが対象のTiDB Cloud Dedicatedクラスターを監視できるようにする一意のベアラー トークンが含まれています。

Prometheus統合バージョンバージョンに応じて、Prometheus のscrape_configファイルを取得して統合ページにアクセスする手順は異なります。

注記：

セキュリティ上の理由から、 TiDB Cloud新しく生成されたscrape_configファイルは一度しか表示されません。ファイル ウィンドウを閉じる前に、必ず内容をコピーしてください。コピーを忘れた場合は、 TiDB Cloudでscrape_configファイルを削除して、新しいファイルを生成する必要があります。 scrape_configファイルを削除するには、ファイルを選択し、[ **...]をクリックしてから [削除]**をクリックします。

ステップ2．Prometheusとの統合

1. Prometheusサービスで指定された監視ディレクトリ内で、Prometheusの設定ファイルを探してください。

   例えば、 /etc/prometheus/prometheus.yml 。

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

3. Prometheusサービスで、 [ステータス] > [ターゲット]を確認し、新しいscrape_configファイルが読み込まれていることを確認してください。読み込まれていない場合は、Prometheusサービスを再起動する必要があるかもしれません。

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

PrometheusサービスがTiDB Cloudからメトリクスを読み取るようになったら、Grafana GUIダッシュボードを使用して、次のようにメトリクスを視覚化できます。

1. Prometheus統合バージョンバージョンに応じて、 TiDB Cloud for Prometheus の Grafana ダッシュボード JSON をダウンロードするリンクは異なります。

   • クラスターレベルでのPrometheus統合については、 ここGrafanaダッシュボードJSONファイルをダウンロードしてください。
   • 従来のプロジェクトレベルでのPrometheus統合（ベータ版）については、 ここGrafanaダッシュボードJSONファイルをダウンロードしてください。

2. メトリクスを視覚化するには、 このJSONをGrafana GUIにインポートしてください。

   注記：

   既にPrometheusとGrafanaを使用してTiDB Cloudを監視しており、新たに利用可能になったメトリクスを組み込みたい場合は、既存のダッシュボードのJSONを直接更新するのではなく、新しいダッシュボードを作成することをお勧めします。

3. （オプション）パネルの追加や削除、データソースの変更、表示オプションの修正などにより、必要に応じてダッシュボードをカスタマイズできます。

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

scrape_configをローテーションするベストプラクティス

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

1. ステップ1に従って、Prometheus 用の新しいscrape_configファイルを作成します。
2. 新しいファイルの内容をPrometheusの設定ファイルに追加してください。
3. Prometheus サービスがTiDB Cloudから引き続き読み取れることを確認したら、Prometheus 設定ファイルから古いscrape_configファイルの内容を削除します。
4. プロジェクトまたはクラスターの統合ページで、対応する古いscrape_configファイルを削除して、他のユーザーがTiDB Cloud Prometheus エンドポイントから読み取るために使用できないようにします。

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

Prometheusは、TiDBクラスタに関して以下のメトリックデータを追跡します。

クラスターレベルのPrometheus統合では、以下の追加メトリクスも利用可能です。

FAQ

• なぜ同じメトリックが、GrafanaとTiDB Cloudコンソールで同時に異なる値を示すのでしょうか？

  GrafanaとTiDB Cloudでは集計計算ロジックが異なるため、表示される集計値が異なる場合があります。より詳細なメトリック値を取得するには、Grafanaのmini step設定を調整してください。