テレメトリー

テレメトリが有効になっている場合、TiDB、 TiUP 、および TiDB ダッシュボードは使用状況に関する情報を収集し、その情報を PingCAP と共有して、製品を改善する方法を理解するのに役立ちます。たとえば、この使用状況情報は、新機能の優先順位付けに役立ちます。

ノート：

• 2023 年 2 月 20 日以降、新しいバージョンの TiDB および TiDB ダッシュボードではテレメトリ機能がデフォルトで無効になり、使用状況に関する情報は収集されず、PingCAP と共有されません。これらのバージョンにアップグレードする前に、クラスタがデフォルトのテレメトリ構成を使用している場合、アップグレード後にテレメトリ機能が無効になります。特定のバージョンについては、 TiDB リリースのタイムライン参照してください。
• v1.11.3 以降、新たに展開されたTiUPではテレメトリ機能がデフォルトで無効になり、使用状況情報は収集されません。 v1.11.3 より前のTiUPバージョンから v1.11.3 以降のバージョンにアップグレードした場合、テレメトリ機能はアップグレード前と同じ状態を維持します。

何が共有されますか？

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

ノート：

すべての場合において、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

ティスパーク

ノート：

v3.3 以降、TiSpark ではテレメトリ収集がデフォルトで無効になっており、使用状況に関する情報は収集されず、PingCAP と共有されません。

TiSpark のテレメトリ収集機能が有効になっている場合、Spark モジュールは TiSpark の使用状況の詳細を共有します。

• ランダムに生成されたテレメトリ ID。
• 読み取りエンジンやストリーミング読み取りが有効かどうかなど、TiSpark の一部の構成情報。
• マシンのハードウェア情報、OS 情報、TiSpark が配置されているノードのコンポーネントバージョン番号などのクラスタ展開情報。

Spark ログで収集された TiSpark の使用情報を表示できます。 Spark ログ レベルを INFO 以下に設定できます。次に例を示します。

cat {spark.log} | grep Telemetry report | tail -n 1

テレメトリを無効にする

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

既存の TiDB クラスターでテレメトリが有効になっている場合、各 TiDB インスタンスでenable-telemetry = falseを構成して、そのインスタンスでの TiDB テレメトリ コレクションを無効にすることができます。これは、クラスターを再起動するまで有効になりません。

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

enable-telemetry = false

enable-telemetry = false

tiup playground --db.config tidb_config.toml

server_configs:
  tidb:
    enable-telemetry: false

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

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

SET GLOBAL tidb_enable_telemetry = 0;

ノート：

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

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

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

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

[dashboard]
enable-telemetry = false

[dashboard]
enable-telemetry = false

tiup playground --pd.config pd_config.toml

server_configs:
  pd:
    dashboard.enable-telemetry: false

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

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

tiup telemetry disable

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

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

ADMIN SHOW TELEMETRY;

実行結果のDATA_PREVIEW列が空の場合、TiDB テレメトリは無効になっています。そうでない場合は、TiDB テレメトリが有効になっています。また、 LAST_STATUS列目から利用情報がいつ共有されたか、共有が成功したかどうかも確認できます。

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

tiup telemetry status

コンプライアンス

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

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

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