重要
このページは英語版のページを機械翻訳しています。原文はこちらからご覧ください。

テレメトリー

デフォルトでは、TiDB、TiUP、およびTiDBダッシュボードは使用状況情報を収集し、その情報をPingCAPと共有して、製品を改善する方法を理解するのに役立ちます。たとえば、この使用法情報は、新機能の優先順位付けに役立ちます。

何が共有されますか？

次のセクションでは、各コンポーネントの共有使用情報について詳しく説明します。共有される使用法の詳細は、時間の経過とともに変更される可能性があります。これらの変更（ある場合）はリリースノートで発表されます。

ノート：

すべての場合において、TiDBクラスタに保存されているユーザーデータは共有されません。 PingCAPプライバシーポリシーも参照できます。

TiDB

TiDBでテレメトリ収集機能が有効になっている場合、TiDBクラスタは6時間ごとに使用状況の詳細を収集します。これらの使用法の詳細には、以下が含まれますが、これらに限定されません。

  • ランダムに生成されたテレメトリID。
  • ハードウェアのサイズ（CPU、メモリ、ディスク）、TiDBコンポーネントのバージョン、OS名などの展開特性。
  • クエリ要求の数や期間など、システム内のクエリ要求のステータス。
  • コンポーネントの使用法、たとえば、非同期コミット機能が使用されているかどうか。
  • TiDBテレメトリデータ送信者の仮名化されたIPアドレス。

PingCAPに共有される使用情報の全内容を表示するには、次のSQLステートメントを実行します。

ADMIN SHOW TELEMETRY;

TiDBダッシュボード

テレメトリ収集機能がTiDBダッシュボードで有効になっている場合、TiDBダッシュボードWeb UIの使用情報が共有されます（ただし、これらに限定されません）。

  • ランダムに生成されたテレメトリID。
  • ユーザーがアクセスしたTiDBダッシュボードWebページの名前などのユーザー操作情報。
  • ブラウザ名、OS名、画面解像度などのブラウザとOSの情報。

PingCAPに共有される使用情報の全内容を表示するには、 ChromeDevToolsのネットワークアクティビティインスペクターまたはFirefox開発ツールのネットワークモニターを使用します。

TiUP

TiUPでテレメトリ収集機能が有効になっている場合、TiUPを使用したユーザー操作は、以下を含む（ただしこれらに限定されない）共有されます。

  • ランダムに生成されたテレメトリID。
  • 実行が成功したかどうかや実行時間など、TiUPコマンドの実行ステータス。
  • ハードウェアのサイズ、TiDBコンポーネントのバージョン、変更された展開構成名などの展開特性。

PingCAPに共有される使用情報の全内容を表示するには、TiUPコマンドの実行時にTIUP_CLUSTER_DEBUG=enable環境変数を設定します。例えば：

TIUP_CLUSTER_DEBUG=enable tiup cluster list

テレメトリを無効にする

展開時にTiDBテレメトリを無効にする

TiDBクラスターを展開するときは、すべてのTiDBインスタンスでTiDBテレメトリコレクションを無効にするようにenable-telemetry = falseを構成します。この設定を使用して、既存のTiDBクラスタでテレメトリを無効にすることもできます。テレメトリは、クラスタを再起動するまで有効になりません。

さまざまな展開ツールでテレメトリを無効にする詳細な手順を以下に示します。

バイナリ展開

次の内容で構成ファイルtidb_config.tomlを作成します。

enable-telemetry = false

上記の構成ファイルを有効にするには、TiDBを起動するときに--config=tidb_config.tomlのコマンドラインパラメーターを指定します。

詳細については、 TiDBConfiguration / コンフィグレーションオプションとTiDBConfiguration / コンフィグレーションファイルを参照してください。

TiUPPlaygroundを使用した展開

次の内容で構成ファイルtidb_config.tomlを作成します。

enable-telemetry = false

TiUP Playgroundを起動するときは、上記の構成ファイルの--db.config tidb_config.tomlコマンドラインパラメーターを指定して有効にします。例えば：

tiup playground --db.config tidb_config.toml

詳細については、 ローカルTiDBクラスターを迅速にデプロイするを参照してください。

TiUPクラスターを使用した展開

デプロイメントトポロジファイルtopology.yamlを変更して、次のコンテンツを追加します。

server_configs:
  tidb:
    enable-telemetry: false
TiDB Operatorを介したKubernetesでのデプロイ

tidb-cluster.yaml分のspec.tidb.config.enable-telemetry: falseまたはTidbClusterカスタムリソースを構成します。

詳細については、 KubernetesにTiDB Operatorをデプロイを参照してください。

ノート：

この構成アイテムを有効にするには、 TiDB Operatorv1.1.3以降が必要です。

デプロイされたTiDBクラスターのTiDBテレメトリを無効にする

既存のTiDBクラスターでは、システム変数tidb_enable_telemetryを変更して、TiDBテレメトリコレクションを動的に無効にすることもできます。

SET GLOBAL tidb_enable_telemetry = 0;

ノート：

テレメトリを無効にすると、構成ファイルの優先度がシステム変数よりも高くなります。つまり、テレメトリ収集が構成ファイルによって無効にされた後、システム変数の値は無視されます。

TiDBダッシュボードテレメトリを無効にする

dashboard.enable-telemetry = falseを構成して、すべてのPDインスタンスでTiDBダッシュボードテレメトリコレクションを無効にします。構成を有効にするには、実行中のクラスターを再起動する必要があります。

さまざまな展開ツールのテレメトリを無効にする詳細な手順を以下に示します。

バイナリ展開

次の内容で構成ファイルpd_config.tomlを作成します。

[dashboard]
enable-telemetry = false

PDを開始するときに、 --config=pd_config.tomlのコマンドラインパラメータを指定して有効にします。

詳細については、 PDConfiguration / コンフィグレーションフラグとPDConfiguration / コンフィグレーションファイルを参照してください。

TiUPPlaygroundを使用した展開

次の内容で構成ファイルpd_config.tomlを作成します。

[dashboard]
enable-telemetry = false

TiUP Playgroundを起動するときに、有効にする--pd.config pd_config.tomlのコマンドラインパラメーターを指定します。次に例を示します。

tiup playground --pd.config pd_config.toml

詳細については、 ローカルTiDBクラスターを迅速にデプロイするを参照してください。

TiUPクラスターを使用した展開

デプロイメントトポロジファイルtopology.yamlを変更して、次のコンテンツを追加します。

server_configs:
  pd:
    dashboard.enable-telemetry: false
TiDB Operatorを介したKubernetesでのデプロイ

tidb-cluster.yaml分のspec.pd.config.dashboard.enable-telemetry: falseまたはTidbClusterカスタムリソースを構成します。

詳細については、 KubernetesにTiDB Operatorをデプロイを参照してください。

ノート：

この構成アイテムを有効にするには、 TiDB Operatorv1.1.3以降が必要です。

TiUPテレメトリを無効にする

TiUPテレメトリ収集を無効にするには、次のコマンドを実行します。

tiup telemetry disable

テレメトリステータスを確認する

TiDBテレメトリの場合、次のSQLステートメントを実行してテレメトリステータスを確認します。

ADMIN SHOW TELEMETRY;

実行結果のDATA_PREVIEW列が空の場合、TiDBテレメトリは無効になります。そうでない場合、TiDBテレメトリが有効になります。また、 LAST_STATUS列目で以前に利用情報を共有した時期や共有に成功したかどうかを確認することもできます。

TiUPテレメトリの場合、次のコマンドを実行してテレメトリステータスを確認します。

tiup telemetry status

コンプライアンス

さまざまな国または地域のコンプライアンス要件を満たすために、使用情報は送信者のマシンのIPアドレスに従ってさまざまな国にあるサーバーに送信されます。

  • 中国本土からのIPアドレスの場合、使用情報は中国本土のクラウドサーバーに送信されて保存されます。
  • 中国本土以外のIPアドレスの場合、使用情報は米国のクラウドサーバーに送信されて保存されます。

詳細については、 PingCAPプライバシーポリシーを参照してください。

このページの内容