重要

TiDB v6.2 (DMR) のドキュメントを表示しています。PingCap は v6.2 のバグ修正を提供していません。バグは将来のリリースで修正される予定です。

一般的な目的では、TiDBデータベースの最新の安定バージョンを使用してください。
重要
このページは英語版のページを機械翻訳しています。原文はこちらからご覧ください。

テレメトリー

デフォルトでは、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 に共有される使用情報の全内容を表示するには、 Chrome DevTools の Network Activity InspectorまたはFirefox 開発者ツールのネットワーク モニターを使用します。

TiUP

TiUP でテレメトリ収集機能が有効になっている場合、TiUP でのユーザー操作が共有されます。

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

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

TIUP_CLUSTER_DEBUG=enable tiup cluster list

テレメトリを無効にする

デプロイ時に TiDB テレメトリを無効にする

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

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

バイナリ展開

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

enable-telemetry = false

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

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

TiUP Playground を使用した展開

次の内容で構成ファイル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 へのデプロイ

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

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

ノート:

この構成項目を有効にするには、 TiDB Operator v1.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 / コンフィグレーションファイルを参照してください。

TiUP Playground を使用した展開

次の内容で構成ファイル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 へのデプロイ

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

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

ノート:

この構成項目を有効にするには、 TiDB Operator v1.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 プライバシー ポリシーを参照してください。