PingCAPクリニックの概要

PingCAPクリニック診断サービス（PingCAPクリニック）は、TiUPまたはTiDB Operatorのいずれかを使用して展開されるTiDBクラスター用にPingCAPによって提供される診断サービスです。このサービスは、クラスタの問題をリモートでトラブルシューティングするのに役立ち、クラスタのステータスをローカルですばやく確認できます。 PingCAPクリニックを使用すると、TiDBクラスタのライフサイクル全体にわたる安定した動作を保証し、潜在的な問題を予測し、問題の可能性を減らし、クラスタの問題を迅速にトラブルシューティングし、クラスタの問題を修正できます。

PingCAPクリニックは、クラスタの問題を診断するために次の2つのコンポーネントを提供します。

• クライアントの診断：

  Diagクライアント（Diag）は、クラスタ側にデプロイされた診断ツールです。 Diagは、クラスタ診断データの収集、クリニックサーバーへの診断データのアップロード、およびクラスタでローカルのクイックヘルスチェックを実行するために使用されます。 Diagが収集できる診断データの完全なリストについては、 PingCAPクリニックの診断データを参照してください。

  ノート：

  DiagはTiDBv4.0以降のバージョンをサポートしていますが、TiDBAnsibleを使用してデプロイされたクラスターからのデータの収集はサポートしていません。

• クリニックサーバー：

  Clinic Serverは、クラウドにデプロイされたクラウドサービスです。 SaaSモデルで診断サービスを提供することにより、Clinic Serverはアップロードされた診断データを受信できるだけでなく、データの保存、データの表示、クラスタ診断レポートの提供を行うオンライン診断環境としても機能します。 Clinic Serverは、保管場所に応じて2つの独立したサービスを提供します。

  • 米国のクリニックサーバー ：データは米国のAWSに保存されます。
  • 中国本土のクリニックサーバー ：データは中国（北京）地域のAWSに保存されます。

ユーザーシナリオ

• クラスタの問題をリモートでトラブルシューティングする

  クラスタにすぐに修正できない問題がある場合は、 TiDBコミュニティのスラックチャネルでサポートを依頼するか、PingCAPテクニカルサポートに連絡してください。リモートアシスタンスについてテクニカルサポートに連絡するときは、クラスタからさまざまな診断データを保存し、そのデータをサポートスタッフに転送する必要があります。この場合、Diagを使用してワンクリックで診断データを収集できます。 Diagを使用すると、完全な診断データをすばやく収集できるため、複雑な手動のデータ収集操作を回避できます。データを収集した後、PingCAPテクニカルサポートスタッフがクラスタの問題をトラブルシューティングするために、データをClinicServerにアップロードできます。 Clinic Serverは、アップロードされた診断データ用の安全なストレージを提供し、オンライン診断をサポートします。これにより、トラブルシューティングの効率が大幅に向上します。

• クラスタステータスをすばやく確認する

  現在、クラスタを定期的にチェックして、潜在的な安定性のリスクを検出する必要があります。 PingCAPクリニックが提供するローカルおよびサーバー側のクイックチェック機能を使用して、クラスタの潜在的なヘルスリスクを特定できます。

実装の原則

このセクションでは、Diagがクラスタから診断データを収集する方法に関する実装原則を紹介します。

まず、Diagは、展開ツールTiUP（tiup-cluster）またはTiDB Operator （tidb-operator）からクラスタトポロジ情報を取得します。次に、Diagは、次のようなさまざまなデータ収集方法を通じて、さまざまなタイプの診断データを収集します。

• SCPを介してサーバーファイルを転送する

  TiUPを使用して展開されたクラスターの場合、Diagは、セキュリティコピープロトコル（SCP）を介して、ターゲットコンポーネントのノードから直接ログファイルと構成ファイルを収集できます。

• SSHを介してリモートでコマンドを実行してデータを収集する

  TiUPを使用して展開されたクラスターの場合、DiagはSSH（セキュリティ Shell）を介してターゲットコンポーネントシステムに接続し、コマンド（Insightなど）を実行して、カーネルログ、カーネルパラメーター、システムとハードウェアの基本情報などのシステム情報を取得できます。

• HTTP呼び出しを介してデータを収集する

  • Diagは、TiDBコンポーネントのHTTPインターフェイスを呼び出すことにより、TiDB、TiKV、PD、およびその他のコンポーネントのリアルタイム構成サンプリング情報とリアルタイムパフォーマンスサンプリング情報を取得できます。
  • PrometheusのHTTPインターフェースを呼び出すことにより、Diagはアラート情報を取得してメトリックデータを監視できます。

• SQLステートメントを介してデータベースパラメータをクエリする

  Diagは、SQLステートメントを使用して、システム変数やTiDBの他の情報を照会できます。この方法を使用するには、データを収集するときにTiDBにアクセスするためのユーザー名とパスワードを追加で指定する必要があります。

クリニックサーバーの制限

ノート：

• クリニックサーバーは2022年7月15日から2023年1月14日まで無料です。サービスがその後料金の請求を開始した場合、2023年1月14日までに電子メールで通知されます。
• 使用制限を調整する場合は、PingCAPテクニカルサポートに連絡してください。

次のステップ

• オンプレミス環境でPingCAPクリニックを使用する

  • PingCAPクリニックのクイックスタート
  • PingCAPクリニックを使用したTiDBクラスターのトラブルシューティング
  • PingCAPクリニックの診断データ

• KubernetesでPingCAPクリニックを使用する

  • PingCAPクリニックを使用したTiDBクラスターのトラブルシューティング
  • PingCAPクリニックの診断データ