TiDB Cloud をPrometheus および Grafana と統合する (ベータ版)

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

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

前提条件

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

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

制限

  • TiDB Cloudサーバーレスクラスターでは Prometheus と Grafana の統合は使用できません。

  • クラスターのステータスがCREATINGRESTORINGPAUSED 、またはRESUMINGの場合、Prometheus と Grafana の統合は使用できません。

手順

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

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

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

  1. TiDB Cloudコンソールで、左上隅のコンボ ボックスを使用してターゲット プロジェクトに切り替えます。

  2. 左側のナビゲーション ペインで、 [プロジェクト設定] > [統合]をクリックします。

  3. 「統合」ページで、 「Prometheus への統合 (ベータ版)」をクリックします。

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

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

    注記:

    セキュリティ上の理由から、 TiDB Cloud新しく生成されたscrape_configファイルは一度しか表示されません。ファイルウィンドウを閉じる前に、必ず内容をコピーしてください。コピーを忘れた場合は、 TiDB Cloud内のscrape_configファイルを削除し、新しいファイルを生成する必要があります。5 ファイル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. TiDB Cloud ここの 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 クラスターの次のメトリック データを追跡します。

メトリック名メトリックタイプラベル説明
tidbcloud_db_queries_totalカウントSQL_type: Select\|Insert\|...
クラスター名: <cluster name>
インスタンス: tidb-0\|tidb-1…
コンポーネント: tidb
実行されたステートメントの合計数
tidbcloud_db_failed_queries_totalカウントタイプ: planner:xxx\|executor:2345\|...
クラスター名: <cluster name>
インスタンス: tidb-0\|tidb-1…
コンポーネント: tidb
実行エラーの総数
tidbcloud_db_connectionsゲージクラスター名: <cluster name>
インスタンス: tidb-0\|tidb-1…
コンポーネント: tidb
TiDBサーバーの現在の接続数
tidbcloud_db_query_duration_secondsヒストグラムSQL_type: Select\|Insert\|...
クラスター名: <cluster name>
インスタンス: tidb-0\|tidb-1…
コンポーネント: tidb
発言の持続時間ヒストグラム
tidbcloud_changefeed_latencyゲージチェンジフィードIDチェンジフィードの上流と下流間のデータ複製のレイテンシー
tidbcloud_changefeed_checkpoint_tsゲージチェンジフィードIDダウンストリームに正常に書き込まれた最大のTSO(Timestamp Oracle)を表す、変更フィードのチェックポイントタイムスタンプ
tidbcloud_changefeed_replica_rowsゲージチェンジフィードIDチェンジフィードが下流に1秒あたりに書き込む複製行の数
tidbcloud_node_storage_used_bytesゲージクラスター名: <cluster name>
インスタンス: tikv-0\|tikv-1…\|tiflash-0\|tiflash-1…
コンポーネント: tikv\|tiflash
TiKV/ TiFlashノードのディスク使用量バイト
tidbcloud_node_storage_capacity_bytesゲージクラスター名: <cluster name>
インスタンス: tikv-0\|tikv-1…\|tiflash-0\|tiflash-1…
コンポーネント: tikv\|tiflash
TiKV/ TiFlashノードのディスク容量バイト
tidbcloud_node_cpu_seconds_totalカウントクラスター名: <cluster name>
インスタンス: tidb-0\|tidb-1…\|tikv-0…\|tiflash-0…
コンポーネント: tidb\|tikv\|tiflash
TiDB/TiKV/ TiFlashノードのCPU使用率
tidbcloud_node_cpu_capacity_coresゲージクラスター名: <cluster name>
インスタンス: tidb-0\|tidb-1…\|tikv-0…\|tiflash-0…
コンポーネント: tidb\|tikv\|tiflash
TiDB/TiKV/ TiFlashノードのCPU制限コア
tidbcloud_node_memory_used_bytesゲージクラスター名: <cluster name>
インスタンス: tidb-0\|tidb-1…\|tikv-0…\|tiflash-0…
コンポーネント: tidb\|tikv\|tiflash
TiDB/TiKV/ TiFlashノードの使用メモリバイト
tidbcloud_node_memory_capacity_bytesゲージクラスター名: <cluster name>
インスタンス: tidb-0\|tidb-1…\|tikv-0…\|tiflash-0…
コンポーネント: tidb\|tikv\|tiflash
TiDB/TiKV/ TiFlashノードのメモリ容量バイト
tidbcloud_node_storage_available_bytesゲージインスタンス: tidb-0\|tidb-1\|...
コンポーネント: tikv\|tiflash
クラスター名: <cluster name>
TiKV/ TiFlashノードで使用可能なディスク容量(バイト単位)
tidbcloud_disk_read_latencyヒストグラムインスタンス: tidb-0\|tidb-1\|...
コンポーネント: tikv\|tiflash
クラスター名: <cluster name>
devicenvme.*\|dm.*
storageデバイスあたりの読み取りレイテンシー(秒)
tidbcloud_disk_write_latencyヒストグラムインスタンス: tidb-0\|tidb-1\|...
コンポーネント: tikv\|tiflash
クラスター名: <cluster name>
devicenvme.*\|dm.*
storageデバイスあたりの書き込みレイテンシー(秒)
tidbcloud_kv_request_durationヒストグラムインスタンス: tidb-0\|tidb-1\|...
コンポーネント: tikv
クラスター名: <cluster name>
typeBatchGet\|Commit\|Prewrite\|...
タイプ別の TiKV リクエストの継続時間(秒)
tidbcloud_component_uptimeヒストグラムインスタンス: tidb-0\|tidb-1\|...
コンポーネント: tidb\|tikv\|pd\|...
クラスター名: <cluster name>
TiDBコンポーネントの稼働時間(秒)
tidbcloud_ticdc_owner_resolved_ts_lagゲージチェンジフィードID: <changefeed-id>
クラスター名: <cluster name>
チェンジフィード所有者の解決されたタイムスタンプの遅延(秒)
tidbcloud_changefeed_statusゲージチェンジフィードID: <changefeed-id>
クラスター名: <cluster name>
チェンジフィードステータス:
-1 :不明
0 :正常
1 : 警告
2 : 失敗
3 : 停止
4 :終了
6 :警告
7 : その他
tidbcloud_resource_manager_resource_unit_read_request_unitゲージクラスター名: <cluster name>
リソースグループ: <group-name>
リソースマネージャによって消費される読み取り要求単位
tidbcloud_resource_manager_resource_unit_write_request_unitゲージクラスター名: <cluster name>
リソースグループ: <group-name>
リソースマネージャによって消費される書き込み要求ユニット

FAQ

  • 同じメトリックが Grafana とTiDB Cloudコンソールで同時に異なる値になるのはなぜですか?

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

このページは役に立ちましたか?